David Golden > Metabase-Fact-0.023 > Metabase::User::Profile

Download:
Metabase-Fact-0.023.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.023   Source   Latest Release: Metabase-Fact-0.024

NAME ^

Metabase::User::Profile - Metabase report class for user-related facts

VERSION ^

version 0.023

SYNOPSIS ^

  use Metabase::User::Profile;

  my $profile = Metabase::User::Profile->create(
    full_name     => 'John Doe',
    email_address => 'jdoe@example.com',
  );

DESCRIPTION ^

Metabase report class encapsulating Facts about a metabase user

USAGE ^

The short way

  my $profile = Metabase::User::Profile->create(
    full_name     => 'John Doe',
    email_address => 'jdoe@example.com',
  );

The long way

  my $profile = Metabase::User::Profile->open(
    resource => 'metabase:user:b66c7662-1d34-11de-a668-0df08d1878c0'
    creator  => 'metabase:user:b66c7662-1d34-11de-a668-0df08d1878c0'
  );

  $profile->add( 'Metabase::User::EmailAddress' => 'jdoe@example.com' );
  $profile->add( 'Metabase::User::FullName'     => 'John Doe' );
    
  $profile->close;

METHODS ^

create

  my $new_profile = Metabase::User::Profile->create(%arg);

This method creates a new user profile object from the given parameters.

Valid parameters include:

  full_name      - the user's full name
  email_address  - the user's email address

load

  my $profile = Metabase::User::Profile->load($filename);

This method loads a profile from disk and returns it.

save

  $profile->save($filename);

This method writes out the profile to a file. If the file cannot be written, an exception is raised. If the save is successful, a true value is returned.

BUGS ^

Please report any bugs or feature using the CPAN Request Tracker. Bugs can be submitted through the web interface at http://rt.cpan.org/Dist/Display.html?Queue=Metabase-Fact

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2013 by David Golden.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
syntax highlighting: