/ 
SIOC-v1.0.0
River stage zero No dependents
/ SIOC::User

NAME

SIOC::User -- SIOC User class

VERSION

This documentation refers to SIOC::User version 1.0.0.

SYNOPSIS

use SIOC::User;

DESCRIPTION

A User is an online account of a member of an online community. It is connected to Items and Posts that a User creates or edits, to Containers and Forums that it is subscribed to or moderates and to Sites that it administers. Users can be grouped for purposes of allowing access to certain Forums or enhanced community site features (weblogs, webmail, etc.).

A foaf:Person will normally hold a registered User account on a Site (through the property foaf:holdsAccount), and will use this account to create content and interact with the community.

sioc:User describes properties of an online account, and is used in combination with a foaf:Person (using the property sioc:account_of) which describes information about the individual itself.

CLASS ATTRIBUTES

email

An electronic mail address of the User.

foaf_uri

Link to a FOAF record.

email_sha1

An electronic mail address of the User, encoded using SHA1.

account_of

Refers to the foaf:Agent or foaf:Person who owns this sioc:User online account.

avatar

An image or depiction used to represent this User.

functions

Roles that this User has.

usergroups

A Usergroup that this User is a member of.

created_items

Items that the User is a creator of.

modified_items

Items that this User has modified.

administered_sites

Sites that the User is an administrator of.

moderated_forums

Forums that User is a moderator of.

owned_containers

Containers owned by a particular User, for example, a weblog or image gallery.

subscriptions

Containers that a User is subscribed to.

SUBROUTINES/METHODS

TODO: document methods

DIAGNOSTICS

For diagnostics information, see the SIOC base class.

CONFIGURATION AND ENVIRONMENT

This module doesn't need configuration.

DEPENDENCIES

This module depends on the following modules:

  • Moose -- OOP framework (CPAN)

  • SIOC -- SIOC abstract base class (part of this module's distribution)

INCOMPATIBILITIES

There are no known incompatibilities.

BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems via the bug tracking system on the perl-SIOC project website: http://developer.berlios.de/projects/perl-sioc/.

Patches are welcome.

AUTHOR

Jochen Lillich <geewiz@cpan.org>

LICENSE AND COPYRIGHT

Copyright (c) 2008, Jochen Lillich <geewiz@cpan.org> All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

* The names of its contributors may not be used to endorse or promote
  products derived from this software without specific prior written
  permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.