Difference between revisions of "API:EPrints/DataObj/User"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
  -->[[Category:API]]<!-- End of Pod2Wiki -->
+
  -->{{API:Source|file=EPrints/DataObj/User.pm|package_name=EPrints::DataObj::User}}[[Category:API|User]]<!-- End of Pod2Wiki -->
<!-- Pod2Wiki=head_name -->=NAME=
+
<!-- Pod2Wiki=head_name -->'''EPrints::DataObj::User''' - Class representing a single user.
'''EPrints::DataObj::User''' - Class representing a single user.
+
__TOC__
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
 
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
Line 126: Line 126:
 
   $dataset = EPrints::DataObj::User-&gt;get_dataset_id
 
   $dataset = EPrints::DataObj::User-&gt;get_dataset_id
  
Returns the id of the [[API:EPrints/DataSet]] object to which this record belongs.
+
Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_get_defaults -->==get_defaults==
 
<!-- Pod2Wiki=item_get_defaults -->==get_defaults==
Line 259: Line 259:
 
For non item related privs the result will normally be 2.
 
For non item related privs the result will normally be 2.
 
Nb. That create eprint is NOT a priv related to an eprint, as you don't own it at that stage.
 
Nb. That create eprint is NOT a priv related to an eprint, as you don't own it at that stage.
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
 +
{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=item_can_edit -->==can_edit==
 +
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=item_create -->==create==
 +
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=item_create_from_data -->==create_from_data==
 +
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=item_get_control_url -->==get_control_url==
 +
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=item_get_privs -->==get_privs==
 +
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=item_get_roles -->==get_roles==
 +
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=item_has_role -->==has_role==
 +
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->

Revision as of 11:00, 11 August 2009

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki

EPrints::DataObj::User - Class representing a single user.

DESCRIPTION

This class represents a single eprint user record and the metadata associated with it. EPrints::DataObj::User is a subclass of EPrints::DataObj with the followingmetadata fields (plus those defined in ArchiveMetadataFieldsConfig:

SYSTEM METADATA

userid

 userid (int)

The unique ID number of this user record. Unique within the current repository.

rev_number

 rev_number (int)

The revision number of this record. Each time it is changed the revisionnumber is increased. This is not currently used for anything but it maybe used for logging later.

username

 username (text)

The username of this user. Used for logging into the system. Unique withinthis repository.

password

 password (secret)

The password of this user encoded with crypt. This may be ignored if therepository is using an alternate authentication system, eg. LDAP.

usertype

 usertype (namedset)

The type of this user. The options are configured in metadata-phrases.xml.

newemail

 newemail (email)

Used to store a new but as yet unconfirmed email address.

newpassword

 newpassword (secret)

Used to store a new but as yet unconfirmed password.

pin

 pin (text)

A code required to confirm a new username or password. This code is emailedto the user to confirm they are who they say they are.

pinsettime

 pinsettime (int)

When the pin code was set, so we can make it time out.

joined

 joined (time)

The date and time that the user account was created. Before EPrints 2.4 thiswas a date field so users created before the upgrade will appear to have been created at midnight.

email

 email (email)

The email address of this user. Unique within the repository.

lang

 lang (namedset) 

The ID of the prefered language of this user. Only really used in multilingualrepositories.

editperms

 editperms (search, multiple)

This field is used to filter what eprints a staff member can approve and modify. If it's unset then they can modify any (given the correct privs. butif it is set then an eprint must match at least one of the searches to bewithin their scope.

frequency

 frequency (set)

Only relevant to staff accounts. Is the frequency they want to be mailed about eprints matching their scope that are in editorial review. never, daily, weekly or monthly.

mailempty

 mailempty (boolean)

Only relevant to staff accounts. If set to true then emails are senteven if there are no items matching the scope.

METHODS

get_system_field_info

 $field_info = EPrints::DataObj::User->get_system_field_info

Return an array describing the system metadata of the this dataset.

new

 $user = EPrints::DataObj::User->new( $session, $userid )

Load the user with the ID of $userid from the database and returnit as an EPrints::DataObj::User object.

new_from_data

 $user = EPrints::DataObj::User->new_from_data( $session, $data )

Construct a new EPrints::DataObj::User object based on the $data hash reference of metadata. Used to create an object from the data retrieved from the database.

get_dataset_id

 $dataset = EPrints::DataObj::User->get_dataset_id

Returns the id of the EPrints::DataSet object to which this record belongs.

get_defaults

 $defaults = EPrints::DataObj::User->get_defaults( $session, $data )

Return default values for this object based on the starting data.

user_with_email

 $user = EPrints::DataObj::User::user_with_email( $session, $email )

Return the EPrints::user with the specified $email, or undef if theyare not found.

user_with_username

 $user = EPrints::DataObj::User::user_with_username( $session, $username )

Return the EPrints::user with the specified $username, or undef if they are not found.

validate

 $problems = $thing->validate

Validate the user - find out if all the required fields are filledout, and that what's been filled in is OK. Returns a reference to anarray of problem descriptions. If there are no probelms then the array is empty. The problems are XHTML DOM objects describing the problem.

commit

 $user->commit( [$force] )

Write this object to the database. If $force isn't true then it only actually modifies the databaseif one or more fields have been changed.

remove

 $success = $user->remove

Remove this user from the database. Also, remove their saved searches,but do not remove their eprints.

get_eprints

 $list = $user->get_eprints( $dataset )

Return EPrints in the given EPrints::DataSet which have this useras their creator. Since 2.4 this returns an EPrints::List object, not an array of eprints.

get_editable_eprints

 $list = $user->get_editable_eprints

Return eprints currently in the editorial review buffer. If this userhas editperms set then only return those records which match. Since 2.4 this returns an EPrints::List object, not an array of eprints.

get_owned_eprints

 $list = $user->get_owned_eprints( $dataset );

Return a list of the eprints which this user owns. This is by defaultthe same as $user->get_eprints( $dataset) but may be over-ridden byget_users_owned_eprints. Since 2.4 this returns an EPrints::List object, not an array of eprints.

has_owner

 $boolean = $user->has_owner( $possible_owner )

True if the users are the same record.

mail

 $ok = $user->mail( $subjectid, $message, [$replyto], [$email] )

Send an email to this user. $subjectid is the ID of a phrase to use as the subject of this email. $message is an XML DOM object describing the message in simple XHTML. $replyto is the reply to address for this email, if different to therepository default. $email is the email address to send this email to if different fromthis users configured email address. Return true if the email was sent OK.

render

 ( $page, $title ) = $user->render

Render this user into HTML using the "user_render" method inArchiveRenderConfig.pm. Returns both the rendered information andthe title as XHTML DOM.

render_full

 ( $page, $title ) = $user->render_full

The same as $user->render, but renders all fields, not just those intended for public viewing. This is the admin view of the user.

get_url

 $url = $user->get_url

Return the URL which will display information about this user. If $staff is true then return the URL for an administrator to viewand modify this record.

get_type

 $type = $user->get_type

Return the type of this user. Equivalent of $user->get_value( "usertype" );

get_saved_searches

 @saved_searches = $eprint->get_saved_searches

Return an array of all EPrint::DataObj::SavedSearch objects associated with thisuser.

send_out_editor_alert

 $user->send_out_editor_alert

Called on users who are editors, when it's time to send their updateon what items are in the editorial review buffer. Sends the email if needed.

process_editor_alerts

 EPrints::DataObj::User::process_editor_alerts( $session, $frequency );

Static method. Called to send out all editor alerts of a given frequency (daily,weekly, monthly) for the current repository.

allow

 $result = $user->allow( $priv, [$item] )

Returns true if $user can perform this action/view this screen. A true result is 1..15 where the value indicates what about the userallowed the priv to be performed. This is used for filtering owner/editor actions in eprint control screens. 1 = anybody (not currently used)2 = only if logged in 4 = only if owner of item8 = only if editor of item For non item related privs the result will normally be 2. Nb. That create eprint is NOT a priv related to an eprint, as you don't own it at that stage.

UNDOCUMENTED METHODS

Warning These methods were found in the source code but didn't have any POD associated with them. This may be because we haven't got around to documenting them yet or it could be because they are internal to the API and not intended for use by other parts of EPrints.

can_edit

create

create_from_data

get_control_url

get_privs

get_roles

has_role