Ricardo SIGNES > Metabase-Fact-0.001 > Metabase::User::Profile

Download:
Metabase-Fact-0.001.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.001   Source   Latest Release: Metabase-Fact-0.024

NAME ^

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

SYNOPSIS ^

  use Metabase::User::Profile;

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

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',
    secret        => 'aixuZuo8',
  );

The long way

  my $profile = Metabase::User::Profile->open(
    resource => 'metabase:user:B66C7662-1D34-11DE-A668-0DF08D1878C0'
  );

  $profile->add( 'Metabase::User::EmailAddress' => 'jdoe@example.com' );
  $profile->add( 'Metabase::User::FullName'     => 'John Doe' );
  $profile->add( 'Metabase::User::Secret'       => 'aixuZuo8' );
    
  $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
  secret         - the shared secret to use for authentication

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.

AUTHOR ^

COPYRIGHT AND LICENSE ^

Copyright (c) 2009 by David A. Golden

Licensed under the same terms as Perl itself (the "License"). You may not use this file except in compliance with the License. A copy of the License was distributed with this file or you may obtain a copy of the License from http://dev.perl.org/licenses/

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

syntax highlighting: