Class Zenphoto_Administrator

This is a simple class so that we have a convienient "handle" for manipulating Administrators.

NOTE: one should use the Zenphoto_Authority newAdministrator() method rather than directly instantiating an administrator object

PersistentObject

Zenphoto_Administrator

Package: core\classes\authorization
Located at lib-auth.php

Methods summary
`public Administrator`	# `__construct( string $user, integer $valid )` Constructor for an Administrator Constructor for an Administrator Parameters `$user` $user. `$valid` used to signal kind of admin object Returns Administrator Overrides `PersistentObject::__construct()`
`public date`	# `getDateTime( )` Returns the unformatted date Returns the unformatted date Returns date
`public`	# `setDateTime( string $datetime )` Stores the date Stores the date Parameters `$datetime` formatted date
`public string`	# `getID( )` Returns the id Returns the id Returns string Overrides `PersistentObject::getID()`
`public`	# `setPass( $pwd )` Hashes and stores the password Hashes and stores the password Parameters `$pwd`
`public`	# `getPass( )` Returns stored password hash Returns stored password hash
`public`	# `setName( $admin_n )` Stores the user name Stores the user name
`public`	# `getName( )` Returns the user name Returns the user name
`public static string`	# `getNameByUser( string $user )` Gets the full name if set Gets the full name if set Parameters `$user` User id Returns string Since ZenphotoCNS 1.5.8
`public`	# `setEmail( $admin_e )` Stores the user email Stores the user email
`public`	# `getEmail( )` Returns the user email Returns the user email
`public`	# `setRights( $rights )` Stores user rights Stores user rights
`public`	# `getRights( )` Returns user rights Returns user rights
`public`	# `setObjects( $objects )` Returns local copy of managed objects. Returns local copy of managed objects.
`public`	# `getObjects( $what = NULL )` Saves local copy of managed objects. NOTE: The database is NOT updated by this, the user object MUST be saved to cause an update Saves local copy of managed objects. NOTE: The database is NOT updated by this, the user object MUST be saved to cause an update
`public`	# `setCustomData( $custom_data )` Stores custom data Stores custom data
`public`	# `getCustomData( )` Returns custom data Returns custom data
`public`	# `setValid( $valid )` Sets the "valid" flag. Valid is 1 for users, 0 for groups and templates Sets the "valid" flag. Valid is 1 for users, 0 for groups and templates
`public`	# `getValid( )` Returns the valid flag Returns the valid flag
`public`	# `setGroup( $group )` Sets the user's group. NOTE this does NOT set rights, etc. that must be done separately Sets the user's group. NOTE this does NOT set rights, etc. that must be done separately
`public`	# `getGroup( )` Returns user's group Returns user's group
`public`	# `setUser( $user )` Sets the user's user id Sets the user's user id
`public`	# `getUser( )` Returns user's user id Returns user's user id
`public`	# `setQuota( $v )` Sets the users quota Sets the users quota
`public`	# `getQuota( )` Returns the users quota Returns the users quota
`public`	# `getLanguage( )` Returns the user's prefered language Returns the user's prefered language
`public`	# `setLanguage( $locale )` Sets the user's preferec language Sets the user's preferec language
`public`	# `save( boolean $checkupdates = false )` Uptates the database with all changes Uptates the database with all changes Parameters `$checkupdates` Default false. If true the internal $updates property is checked for actual changes so unnecessary saving is skipped. Applies to already existing objects only. Overrides `PersistentObject::save()`
`public boolean`	# `remove( )` Removes a user from the system Removes a user from the system Returns boolean Overrides `PersistentObject::remove()`
`public`	# `getAlbum( )` Returns the user's "prime" album. See setAlbum(). Returns the user's "prime" album. See setAlbum().
`public`	# `setAlbum( $album )` Records the "prime album" of a user. Prime albums are linked to the user and removed if the user is removed. Records the "prime album" of a user. Prime albums are linked to the user and removed if the user is removed.
`public`	# `getCredentials( )` Data to support other credential systems integration Data to support other credential systems integration
`public`	# `setCredentials( $cred )`
`public`	# `createPrimealbum( $new = true, $name = NULL )` Creates a "prime" album for the user. Album name is based on the userid Creates a "prime" album for the user. Album name is based on the userid
`public`	# `getChallengePhraseInfo( )`
`public`	# `setChallengePhraseInfo( $challenge, $response )`
`public`	# `getLastLogon( )` returns the last time the user has logged on
`public strig`	# `getLastVisit( )` Returns the last time the user visited the site being loggedin Returns the last time the user visited the site being loggedin Returns strig Since ZenphotoCMS 1.5.8
`public`	# `setLastVisit( $datetime = '' )` Sets the last time the user visited the site being loggedin Sets the last time the user visited the site being loggedin Since ZenphotoCMS 1.5.8
`public`	# `updateLastVisit( )` Updates the last visit date if enabled on the options and the time frame defined has passed. Updates the last visit date if enabled on the options and the time frame defined has passed. Since ZenphotoCMS 1.5.8
`public`	# `preservePrimeAlbum( )` Preserves the user's prime album as managed album even if he is in a group the album is actually set as managed Preserves the user's prime album as managed album even if he is in a group the album is actually set as managed

Methods inherited from PersistentObject
`__toString(), checkChanges(), clearCache(), copy(), get(), getData(), getLastChange(), getLastChangeUser(), instantiate(), move(), set(), setDefaults(), setLastChange(), setLastchangeUser()`

Properties summary
`public`	`$objects`	# `NULL`
`public boolean`	`$master`	# `false`
`public`	`$msg`	# `NULL`
`public boolean`	`$logout_link`	# `true`
`public boolean`	`$reset`	# `false`
`public`	`$passhash`	#

Properties inherited from PersistentObject
`$exists, $id, $loaded, $table, $transient`

Classes

Interfaces

Exceptions

Functions

Class Zenphoto_Administrator

Parameters

Returns

Overrides

Returns

Parameters

Returns

Overrides

Parameters

Parameters

Returns

Since

Parameters

Overrides

Returns

Overrides

Returns

Since

Since

Since