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

Latest revision as of 18:50, 10 January 2022

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

API: Core API

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

NAME

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

User Comments

DESCRIPTION

This class represents a single eprint user record and the metadata associated with it.

This class is a subclass of EPrints::DataObj with the following metadata fields, along with fields in cfg.d/user_fields.pl.

User Comments

CORE METADATA FIELDS

User Comments

userid (int)

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

User Comments

rev_number (int)

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

User Comments

username (text)

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

User Comments

password (secret)

The crypted password for this user as generated by EPrints::Utils/crypt. This may be ignored if for example LDAP authentication is being used.

User Comments

usertype (namedset)

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

User Comments

newemail (email)

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

User Comments

newpassword (secret)

Used to store a new but as yet unconfirmed password.

User Comments

pin (text)

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

User Comments

pinsettime (int)

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

User Comments

loginattempts (int)

Number of login attempts since last successful login.

User Comments

unlocktime (int)

Time at which user account will be unlocked after too many failed login attempts.

User Comments

joined (time)

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

User Comments

email (email)

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

User Comments

lang (arclanguage)

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

User Comments

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. but if it is set then an eprint must match at least one of the searches to be within their scope.

User Comments

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.

User Comments

mailempty (boolean)

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

User Comments

latitude (float)

The latitude of the location where the user is based.

User Comments

longitude (float)

The longitude of the location where the user is based.

User Comments

preference (storable)

User preferences which need to be persistent. Stored as a serialization of simple key-value pairs.

User Comments

captcha (recaptcha)

A ReCAPTCHA field to use to protect user password resets and similar forms from being spammed.

User Comments

REFERENCES AND RELATED OBJECTS

User Comments

saved_searches (subobject, multiple)

Saved searches created by this user.

User Comments

item_fields (fields, multiple)

Stores bespoke metafields created by this user and stored in the database.

User Comments

INSTANCE VARIABLES

See EPrints::DataObj.

User Comments

METHODS

User Comments

Constructor Methods

User Comments

new

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

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

User Comments

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.

User Comments

create

$user = EPrints::DataObj::User::create( $session, $user_type )

Create a new user in the database with the specified user type.

User Comments

create_from_data

$dataobj = EPrints::DataObj->create_from_data( $session, $data, $dataset )

Create a new object of this type in the database.

$dataset is the dataset it will belong to.

$data is the data structured as with new_from_data.

User Comments

Class Methods

User Comments

get_system_field_info

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

Returns an array describing the system metadata of the the user dataset.

User Comments

get_dataset_id

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

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

User Comments

Object Methods

User Comments

validate

$problems = $user->validate

Validate the user - find out if all the required fields are filled out, and that what's been filled in is OK. Returns a reference to an array of problem descriptions.

If there are no problems then the array is empty.

The problems are XHTML DOM objects describing the problem.

User Comments

commit

$success = $user->commit( [ $force ] )

Writes this user data object to the database.

If $force is set and true then dave to the database even if no fields have changed. Otherwise, only save if at least one field has changed.

Returns a boolean depending on whether the user data object was successfully committed.

User Comments

close_non_current_login_tickets

$user->close_non_current_login_tickets

Close all login tickets for this user except the one they are currently logged in on.

User Comments

remove

$success = $user->remove

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

User Comments

is_staff

$bool = $user->is_staff

Returns true if the user has_role is editor or admin.

User Comments

language

$lang = $user->language

Get the preferred language of this user.

User Comments

owned_eprints_list

$list = $user->owned_eprints_list( %opts )

Returns a EPrints::List of all the EPrints::DataObj::EPrints owned by this user.

%opts is passed to a EPrints::Search, which is used to filter the results.

User Comments

editable_eprints_list

$list = $user->editable_eprints_list( %opts )

Returns a EPrints::List of EPrints::DataObj::EPrints that match this user's editorial search expressions. If the user has no editorial scope a list of all eprints that match the given %opts is returned.

%opts is passed to a EPrints::Search which is used to filter the results.

$list = $user->editable_eprints_list(
    dataset => $repo->dataset( "buffer" ),
);

User Comments

has_owner

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

Returns true if $possible_owner is the same as this user.

User Comments

mail

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

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 the repository default.

$email is the email address to send this email to if different from this users configured email address.

$cc_list is an optional CC list (array reference)

Returns true if the email was sent OK.

User Comments

render

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

Returns XHTML DOM renderings of the page and the title for this user's page. This uses the configurable $user_render method that can typically be found in cfg.d/user_render.pl.

User Comments

render_full

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

The same as render, but returns page and title renderings for all fields, not just those intended for public viewing. This is the admin view of the user.

User Comments

get_url

$url = $user->get_url

Returns the URL which will display information about this user.

User Comments

get_control_url

$url = $dataobj->get_control_url

Returns the URL for the control page for this user.

User Comments

get_type

$type = $user->get_type

Return the type of this user.

Alias for:

$user->get_value( "usertype" )

User Comments

get_saved_searches

@saved_searches = $eprint->get_saved_searches

Returns an array of all EPrint::DataObj::SavedSearch objects associated with this user.

User Comments

preference

$value = $user->preference( $key )

Returns the preference value for $key. Otherwise, returns undef.

User Comments

set_preference

$user->set_preference( $key, $value )

Set a preference $key to $value for this user.

User Comments

send_out_editor_alert

$user->send_out_editor_alert

Called on users who are editors, when it's time to send their update on what items are in the editorial review buffer. Typically called by process_editor_alerts.

Only sends the email if needed.

User Comments

allow

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

Returns true if user can perform an action specified by $priv.

If set, further checks whether the user is permitted to perform the action of $priv on a particular $item data object.

User Comments

has_privilege

$boolean = $user->has_privilege( $priv )

Returns true if $priv is in the user's privileges list.

User Comments

get_privs

$privs = $user->get_privs

Returns the privileges this user has. Currently just based on roles, but could do more later.

Returns a reference to a hash. Caching the result to save time in future.

User Comments

get_roles

@roles = $user->get_roles;

Returns the roles this user has. Each role represents a whole bunch of privileges.

User Comments

has_role

$user->has_role( $roleid )

Returns boolean dependent on whether this user has the role $roleid.

User Comments

Utility Methods

User Comments

user_with_email

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

Returns the use with the specified $email, or undef if they cannot benot found.

User Comments

user_with_username

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

Returns the user with the specified $username, or undef if they cannot be not found.

User Comments

process_editor_alerts

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

Called to send out all editor alerts of a given frequency (daily, weekly, monthly) for the current repository by the bin/send_alerts script that is configured as daily, weekly and monthly cron jobs.

User Comments

COPYRIGHT

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.

User Comments

@@ Line 1: / Line 1: @@
 <!-- Pod2Wiki=_preamble_
-This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
+This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
-  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/User.pm|package_name=EPrints::DataObj::User}}[[Category:API|USER]][[Category:API:EPrints/DataObj|USER]][[Category:API:EPrints/DataObj/User|USER]]<div><!-- Edit below this comment -->
+  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/User.pm|package_name=EPrints::DataObj::User}}[[Category:API|USER]][[Category:API:EPrints/DataObj|USER]]<div><!-- Edit below this comment -->
@@ Line 19: / Line 19: @@
 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 following metadata fields (plus those defined in ArchiveMetadataFieldsConfig:
+This class is a subclass of [[API:EPrints/DataObj|EPrints::DataObj]] with the following metadata fields, along with fields in <tt>cfg.d/user_fields.pl</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 28: / Line 28: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=head_system_metadata -->
+<!-- Pod2Wiki=head_core_metadata_fields -->
-==SYSTEM METADATA==
+==CORE METADATA FIELDS==
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 40: / Line 40: @@
 ===userid (int)===
-The unique ID number of this user record. Unique within the current repository.
+The unique ID number of this user record. Unique within the current  repository.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 52: / Line 52: @@
 ===rev_number (int)===
-The revision number of this record. Each time it is changed the revision number is increased. This is not currently used for anything but it may be used for logging later.
+The revision number of this record. Each time it is changed the  revision number is increased. This is not currently used for anything  but it may be used for logging later.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 64: / Line 64: @@
 ===username (text)===
-The username of this user. Used for logging into the system. Unique within this repository.
+The username of this user. Used for logging into the system. Unique  within this repository.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 76: / Line 76: @@
 ===password (secret)===
-The password of this user encoded with crypt. This may be ignored if the repository is using an alternate authentication system, eg. LDAP.
+The crypted password for this user as generated by  [[API:EPrints/Utils#crypt|EPrints::Utils/crypt]]. This may be ignored if for example LDAP  authentication is being used.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 88: / Line 88: @@
 ===usertype (namedset)===
-The type of this user. The options are configured in metadata-phrases.xml.
+The type of this user. The options are configured in  <tt>metadata-phrases.xml</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 124: / Line 124: @@
 ===pin (text)===
-A code required to confirm a new username or password. This code is emailed to the user to confirm they are who they say they are.
+A code required to confirm a new username or password. This code is  emailed to the user to confirm they are who they say they are.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 137: / Line 137: @@
 When the pin code was set, so we can make it time out.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_loginattempts -->
+===loginattempts (int)===
+Number of login attempts since last successful login.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_unlocktime -->
+===unlocktime (int)===
+Time at which user account will be unlocked after too many failed  login attempts.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 148: / Line 172: @@
 ===joined (time)===
-The date and time that the user account was created. Before EPrints 2.4 this was a date field so users created before the upgrade will appear to have been  created at midnight.
+The date and time that the user account was created. Before EPrints  2.4 this was a date field so users created before the upgrade will  appear to have been created at midnight.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 170: / Line 194: @@
 </div>
 <!-- Pod2Wiki=item_lang -->
-===lang (namedset) ===
+===lang (arclanguage) ===
-The ID of the prefered language of this user. Only really used in multilingual repositories.
+The ID of the prefered language of this user. Only really used in  multilingual repositories.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 184: / Line 208: @@
 ===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. but if it is set then an eprint must match at least one of the searches to be within their scope.
+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. but if it is set then an eprint must match at  least one of the searches to be within their scope.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 196: / Line 220: @@
 ===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.
+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.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 208: / Line 232: @@
 ===mailempty (boolean)===
-Only relevant to staff accounts. If set to true then emails are sent even if there are no items matching the scope.
+Only relevant to staff accounts. If set to true then emails are  sent even if there are no items matching the scope.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_latitude -->
+===latitude (float)===
+The latitude of the location where the user is based.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_longitude -->
+===longitude (float)===
+The longitude of the location where the user is based.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 218: / Line 266: @@
 </div>
 <!-- Pod2Wiki=item_preference -->
-===preference (compound)===
+===preference (storable)===
-User preferences which need to be persistent (simple key-value pairs).
+User preferences which need to be persistent. Stored as a  serialization of simple key-value pairs.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_captcha -->
+===captcha (recaptcha)===
+A ReCAPTCHA field to use to protect user password resets and  similar forms from being spammed.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=head_references_and_related_objects -->
+==REFERENCES AND RELATED OBJECTS==
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_saved_searches -->
+===saved_searches (subobject, multiple)===
+Saved searches created by this user.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_item_fields -->
+===item_fields (fields, multiple)===
+Stores bespoke metafields created by this user and stored in the database.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=head_instance_variables -->
+==INSTANCE VARIABLES==
+See [[API:EPrints/DataObj#INSTANCE_VARIABLES|EPrints::DataObj]].
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 238: / Line 342: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_get_system_field_info -->
+<!-- Pod2Wiki=head_constructor_methods -->
-===get_system_field_info===
+===Constructor Methods===
- $field_info = EPrints::DataObj::User-&gt;get_system_field_info
-Return an array describing the system metadata of the this  dataset.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 252: / Line 352: @@
 </div>
 <!-- Pod2Wiki=item_new -->
-===new===
+====new====
   $user = EPrints::DataObj::User-&gt;new( $session, $userid )
@@ Line 265: / Line 365: @@
 </div>
 <!-- Pod2Wiki=item_new_from_data -->
-===new_from_data===
+====new_from_data====
   $user = EPrints::DataObj::User-&gt;new_from_data( $session, $data )
@@ Line 279: / Line 379: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_get_dataset_id -->
+<!-- Pod2Wiki=item_create -->
-===get_dataset_id===
+====create====
- $dataset = EPrints::DataObj::User-&gt;get_dataset_id
-Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
+ $user = EPrints::DataObj::User::create( $session, $user_type )
+Create a new user in the database with the specified user type.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 292: / Line 392: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_get_defaults -->
+<!-- Pod2Wiki=item_create_from_data -->
-===get_defaults===
+====create_from_data====
+ $dataobj = EPrints::DataObj-&gt;create_from_data( $session, $data, $dataset )
+Create a new object of this type in the database.
+$dataset is the dataset it will belong to.
+$data is the data structured as with new_from_data.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
- $defaults = EPrints::DataObj::User-&gt;get_defaults( $session, $data )
-Return default values for this object based on the starting data.
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=head_class_methods -->
+===Class Methods===
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 305: / Line 418: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_user_with_email -->
+<!-- Pod2Wiki=item_get_system_field_info -->
-===user_with_email===
+====get_system_field_info====
-  $user = EPrints::DataObj::User::user_with_email( $session, $email )
+  $fields = EPrints::DataObj::User-&gt;get_system_field_info
-Return the EPrints::user with the specified $email, or undef if they are not found.
+Returns an array describing the system metadata of the the user  dataset.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 318: / Line 431: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_user_with_username -->
+<!-- Pod2Wiki=item_get_dataset_id -->
-===user_with_username===
+====get_dataset_id====
+ $dataset = EPrints::DataObj::User-&gt;get_dataset_id
+Returns the ID of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record  belongs.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
- $user = EPrints::DataObj::User::user_with_username( $session, $username )
-Return the EPrints::user with the specified $username, or undef if  they are not found.
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=head_object_methods -->
+===Object Methods===
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 332: / Line 454: @@
 </div>
 <!-- Pod2Wiki=item_validate -->
-===validate===
+====validate====
-  $problems = $thing-&gt;validate
+  $problems = $user-&gt;validate
 Validate the user - find out if all the required fields are filled out, and that what's been filled in is OK. Returns a reference to an array of problem descriptions.
-If there are no probelms then the array is empty.
+If there are no problems then the array is empty.
 The problems are XHTML DOM objects describing the problem.
@@ Line 349: / Line 471: @@
 </div>
 <!-- Pod2Wiki=item_commit -->
-===commit===
+====commit====
-  $user-&gt;commit( [$force] )
+  $success = $user-&gt;commit( [ $force ] )
-Write this object to the database.
+Writes this user data object to the database.
-If $force isn't true then it only actually modifies the database if one or more fields have been changed.
+If <tt>$force</tt> is set and <tt>true</tt> then dave to the database even if no  fields have changed.  Otherwise, only save if at least one field has changed.
+Returns a boolean depending on whether the user data object was  successfully committed.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 363: / Line 487: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_remove -->
+<!-- Pod2Wiki=item_close_non_current_login_tickets -->
-===remove===
+====close_non_current_login_tickets====
-  $success = $user-&gt;remove
+  $user-&gt;close_non_current_login_tickets
-Remove this user from the database. Also, remove their saved searches, but do not remove their eprints.
+Close all login tickets for this user except the one they are  currently logged in on.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 376: / Line 500: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_owned_eprints_list -->
+<!-- Pod2Wiki=item_remove -->
-===owned_eprints_list===
+====remove====
-  $list = $user-&gt;owned_eprints_list( %opts )
+  $success = $user-&gt;remove
-Returns a [[API:EPrints/List|EPrints::List]] of all the [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]]s owned by this user.
+Remove this user from the database. Also, remove their saved searches, but do not remove their eprints.
-%opts is passed to a [[API:EPrints/Search|EPrints::Search]] which is used to filter the results.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 391: / Line 513: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_editable_eprints_list -->
+<!-- Pod2Wiki=item_is_staff -->
-===editable_eprints_list===
+====is_staff====
- $list = $user-&gt;editable_eprints_list( %opts )
-Returns a [[API:EPrints/List|EPrints::List]] of [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]]s that match this user's editorial search expressions. If the user has no editorial scope a list of all buffered eprints is returned.
-%opts is passed to a [[API:EPrints/Search|EPrints::Search]] which is used to filter the results.
+ $bool = $user-&gt;is_staff
+Returns true if the user [[API:EPrints/DataObj/User#has_role|has_role]] is <tt>editor</tt> or <tt>admin</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 406: / Line 526: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_get_eprints -->
+<!-- Pod2Wiki=item_language -->
-===get_eprints===
+====language====
- $list = $user-&gt;get_eprints( $dataset )
-DEPRECATED
-Return EPrints in the given EPrints::DataSet which have this user as their creator.
-Since 2.4 this returns an EPrints::List object, not an array of eprints.
+ $lang = $user-&gt;language
+Get the preferred language of this user.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 423: / Line 539: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_get_editable_eprints -->
+<!-- Pod2Wiki=item_owned_eprints_list -->
-===get_editable_eprints===
+====owned_eprints_list====
-  $list = $user-&gt;get_editable_eprints
+  $list = $user-&gt;owned_eprints_list( %opts )
-DEPRECATED
+Returns a [[API:EPrints/List|EPrints::List]] of all the [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]]s  owned by this user.
-Return eprints currently in the editorial review buffer. If this user has editperms set then only return those records which match.
+<tt>%opts</tt> is passed to a [[API:EPrints/Search|EPrints::Search]], which is used to filter  the results.
-Since 2.4 this returns an EPrints::List object, not an array of eprints.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 440: / Line 554: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_get_owned_eprints -->
+<!-- Pod2Wiki=item_editable_eprints_list -->
-===get_owned_eprints===
+====editable_eprints_list====
-  $list = $user-&gt;get_owned_eprints( $dataset );
+  $list = $user-&gt;editable_eprints_list( %opts )
-DEPRECATED
+Returns a [[API:EPrints/List|EPrints::List]] of [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]]s that match  this user's editorial search expressions. If the user has no editorial  scope a list of all eprints that match the given <tt>%opts</tt> is returned.
-Return a list of the eprints which this user owns. This is by default the same as $user-&gt;get_eprints( $dataset) but may be over-ridden by get_users_owned_eprints.
-Since 2.4 this returns an EPrints::List object, not an array of eprints.
+<tt>%opts</tt> is passed to a [[API:EPrints/Search|EPrints::Search]] which is used to filter the  results.
+ $list = $user-&gt;editable_eprints_list(
+     dataset =&gt; $repo-&gt;dataset( "buffer" ),
+ );
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 458: / Line 574: @@
 </div>
 <!-- Pod2Wiki=item_has_owner -->
-===has_owner===
+====has_owner====
   $boolean = $user-&gt;has_owner( $possible_owner )
-True if the users are the same record.
+Returns <tt>true</tt> if <tt>$possible_owner</tt> is the same as this user.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 471: / Line 587: @@
 </div>
 <!-- Pod2Wiki=item_mail -->
-===mail===
+====mail====
-  $ok = $user-&gt;mail( $subjectid, $message, [$replyto], [$email] )
+  $ok = $user-&gt;mail( $subjectid, $message, [$replyto, $email, $cc_list] )
 Send an email to this user.
-$subjectid is the ID of a phrase to use as the subject of this email.
+<tt>$subjectid</tt> is the ID of a phrase to use as the subject of this  email.
+<tt>$message</tt> is an XML DOM object describing the message in simple  XHTML.
-$message is an XML DOM object describing the message in simple XHTML.
+<tt>$replyto</tt> is the reply to address for this email, if different to  the repository default.
-$replyto is the reply to address for this email, if different to the repository default.
+<tt>$email</tt> is the email address to send this email to if different from this users configured email address.
-$email is the email address to send this email to if different from this users configured email address.
+<tt>$cc_list</tt> is an optional CC list (array reference)
-Return true if the email was sent OK.
+Returns <tt>true</tt> if the email was sent OK.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 494: / Line 612: @@
 </div>
 <!-- Pod2Wiki=item_render -->
-===render===
+====render====
   ( $page, $title ) = $user-&gt;render
-Render this user into HTML using the "user_render" method in ArchiveRenderConfig.pm. Returns both the rendered information and the title as XHTML DOM.
+Returns XHTML DOM renderings of the page and the title for this user's page. This uses the configurable <tt>$user_render</tt> method that can  typically be found in <tt>cfg.d/user_render.pl</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 507: / Line 625: @@
 </div>
 <!-- Pod2Wiki=item_render_full -->
-===render_full===
+====render_full====
   ( $page, $title ) = $user-&gt;render_full
-The same as $user-&gt;render, but renders all fields, not just those  intended for public viewing. This is the admin view of the user.
+The same as [[API:EPrints/DataObj/User#render|render]], but returns page and title renderings for all  fields, not just those intended for public viewing. This is the admin  view of the user.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 520: / Line 638: @@
 </div>
 <!-- Pod2Wiki=item_get_url -->
-===get_url===
+====get_url====
   $url = $user-&gt;get_url
-Return the URL which will display information about this user.
+Returns the URL which will display information about this user.
-If $staff is true then return the URL for an administrator to view and modify this record.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_get_control_url -->
+====get_control_url====
+ $url = $dataobj-&gt;get_control_url
+Returns the URL for the control page for this user.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 535: / Line 664: @@
 </div>
 <!-- Pod2Wiki=item_get_type -->
-===get_type===
+====get_type====
   $type = $user-&gt;get_type
-Return the type of this user. Equivalent of  $user-&gt;get_value( "usertype" );
+Return the type of this user.
+Alias for:
+ $user-&gt;get_value( "usertype" )
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 548: / Line 681: @@
 </div>
 <!-- Pod2Wiki=item_get_saved_searches -->
-===get_saved_searches===
+====get_saved_searches====
   @saved_searches = $eprint-&gt;get_saved_searches
-Return an array of all EPrint::DataObj::SavedSearch objects associated with this user.
+Returns an array of all {{API:PodLink|file=EPrint/DataObj/SavedSearch|package_name=EPrint::DataObj::SavedSearch|section=|text=EPrint::DataObj::SavedSearch}} objects  associated with this user.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 561: / Line 694: @@
 </div>
 <!-- Pod2Wiki=item_preference -->
-===preference===
+====preference====
   $value = $user-&gt;preference( $key )
-Retrieve the preference $key.
+Returns the preference value for <tt>$key</tt>. Otherwise, returns <tt>undef</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 574: / Line 707: @@
 </div>
 <!-- Pod2Wiki=item_set_preference -->
-===set_preference===
+====set_preference====
   $user-&gt;set_preference( $key, $value )
-Set a preference $key for the user to $value.
+Set a preference <tt>$key</tt> to <tt>$value</tt> for this user.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 587: / Line 720: @@
 </div>
 <!-- Pod2Wiki=item_send_out_editor_alert -->
-===send_out_editor_alert===
+====send_out_editor_alert====
   $user-&gt;send_out_editor_alert
-Called on users who are editors, when it's time to send their update on what items are in the editorial review buffer.
+Called on users who are editors, when it's time to send their update on what items are in the editorial review buffer. Typically called  by [[API:EPrints/DataObj/User#process_editor_alerts|process_editor_alerts]].
+Only sends the email if needed.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_allow -->
+====allow====
+ $result = $user-&gt;allow( $priv, [ $item ] )
+Returns <tt>true</tt> if user can perform an action specified by <tt>$priv</tt>.
+If set, further checks whether the user is permitted to perform the action of <tt>$priv</tt> on a particular <tt>$item</tt> data object.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_has_privilege -->
+====has_privilege====
+ $boolean = $user-&gt;has_privilege( $priv )
+Returns <tt>true</tt> if <tt>$priv</tt> is in the user's privileges list.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_get_privs -->
+====get_privs====
+ $privs = $user-&gt;get_privs
+Returns the privileges this user has. Currently just based on roles, but could do more later.
+Returns a reference to a hash. Caching the result to save time in future.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_get_roles -->
+====get_roles====
-Sends the email if needed.
+ @roles = $user-&gt;get_roles;
+Returns the roles this user has. Each role represents a whole bunch of privileges.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 601: / Line 790: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_process_editor_alerts -->
+<!-- Pod2Wiki=item_has_role -->
-===process_editor_alerts===
+====has_role====
+ $user-&gt;has_role( $roleid )
+Returns boolean dependent on whether this user has the role <tt>$roleid</tt>.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=head_utility_methods -->
+===Utility Methods===
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_user_with_email -->
+====user_with_email====
+ $user = EPrints::DataObj::User::user_with_email( $repo, $email )
+Returns the use with the specified <tt>$email</tt>, or <tt>undef</tt> if they cannot benot found.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
- EPrints::DataObj::User::process_editor_alerts( $session, $frequency );
+<!-- Pod2Wiki= -->
-Static method.
+</div>
+<!-- Pod2Wiki=item_user_with_username -->
+====user_with_username====
-Called to send out all editor alerts of a given frequency (daily, weekly, monthly) for the current repository.
+ $user = EPrints::DataObj::User::user_with_username( $session, $username )
+Returns the user with the specified <tt>$username</tt>, or <tt>undef</tt> if they cannot be not found.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 616: / Line 838: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_allow -->
+<!-- Pod2Wiki=item_process_editor_alerts -->
-===allow===
+====process_editor_alerts====
-  $result = $user-&gt;allow( $priv, [$item] )
+  EPrints::DataObj::User::process_editor_alerts( $session, $frequency );
-Returns true if $user can perform this action/view this screen.
+Called to send out all editor alerts of a given frequency (daily, weekly, monthly) for the current repository by the <tt>bin/send_alerts</tt> script that is configured as daily, weekly and monthly cron jobs.
-A true result is 1..15 where the value indicates what about the user allowed the priv to be performed. This is used for filtering owner/ editor actions in eprint control screens.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
-= anybody (not currently used) 2 = only if logged in  4 = only if owner of item 8 = only if editor of item
-For non item related privs the result will normally be 2.
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=head_see_also -->
+==SEE ALSO==
+[[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
-Nb. That create eprint is NOT a priv related to an eprint, as you  don't own it at that stage.
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=head_copyright -->
+==COPYRIGHT==
+{{API:Copyright}}
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>

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

Latest revision as of 18:50, 10 January 2022

Contents

NAME

DESCRIPTION

CORE METADATA FIELDS

userid (int)

rev_number (int)

username (text)

password (secret)

usertype (namedset)

newemail (email)

newpassword (secret)

pin (text)

pinsettime (int)

loginattempts (int)

unlocktime (int)

joined (time)

email (email)

lang (arclanguage)

editperms (search, multiple)

frequency (set)

mailempty (boolean)

latitude (float)

longitude (float)

preference (storable)

captcha (recaptcha)

REFERENCES AND RELATED OBJECTS

saved_searches (subobject, multiple)

item_fields (fields, multiple)

INSTANCE VARIABLES

METHODS

Constructor Methods

new

new_from_data

create

create_from_data

Class Methods

get_system_field_info

get_dataset_id

Object Methods

validate

commit

close_non_current_login_tickets

remove

is_staff

language

owned_eprints_list

editable_eprints_list

has_owner

mail

render

render_full

get_url

get_control_url

get_type

get_saved_searches

preference

set_preference

send_out_editor_alert

allow

has_privilege

get_privs

get_roles

has_role

Utility Methods

user_with_email

user_with_username

process_editor_alerts

SEE ALSO

COPYRIGHT

LICENSE

Navigation menu

Search