

[ class tree: classes ] [ index: classes ] [ all elements ]

Class: Zenphoto_Administrator

Source Location: /lib-auth.php

Class Zenphoto_Administrator

Class Overview

Located in /lib-auth.php [line 1270]

PersistentObject
   |
   --Zenphoto_Administrator

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PersistentObject

PersistentObject::$exists

PersistentObject::$id

PersistentObject::$loaded

PersistentObject::$table

PersistentObject::$transient

Inherited From PersistentObject

PersistentObject::PersistentObject()

PersistentObject::copy()

Copy this record to another unique set. Checks if the record exists there first, if so returns false. If successful returns true. No changes are made to this object and no other objects are created, just the database entry.

PersistentObject::get()

Get the value of a variable. If $current is false, return the value as of the last save of this object.

PersistentObject::getData()

returns the database record of the object

PersistentObject::getID()

Returns the id

PersistentObject::instantiate()

Prime instantiator for Zenphoto objects

PersistentObject::move()

Change one or more values of the unique set assigned to this record.

PersistentObject::remove()

Deletes object from the database

PersistentObject::save()

Save the updates made to this object since the last update. Returns true if successful, false if not.

PersistentObject::set()

Set a variable in this object. Does not persist to the database until save() is called. So, IMPORTANT: Call save() after set() to persist.

PersistentObject::setDefaults()

Sets default values for new objects using the set() method.

PersistentObject::__toString()

"Magic" function to return a string identifying the object when it is treated as a string

[ Top ]

Property Summary

mixed	$logout_link
mixed	$master
mixed	$msg
mixed	$objects	This is a simple class so that we have a convienient "handle" for manipulating Administrators.
mixed	$passhash
mixed	$reset

[ Top ]

Method Summary

Administrator	__construct()	Constructor for an Administrator
void	createPrimealbum()	Creates a "prime" album for the user. Album name is based on the userid
void	getAlbum()	Returns the user's "prime" album. See setAlbum().
void	getChallengePhraseInfo()
void	getCredentials()	Data to support other credential systems integration
void	getCustomData()	Returns custom data
date	getDateTime()	Returns the unformatted date
void	getEmail()	Returns the user email
void	getGroup()	Returns user's group
void	getID()
void	getLanguage()	Returns the user's prefered language
void	getLastLogon()	returns the last time the user has logged on
void	getName()	Returns the user name
void	getObjects()	Saves local copy of managed objects.
void	getPass()	Returns stored password hash
void	getQuota()	Returns the users quota
void	getRights()	Returns user rights
void	getUser()	Returns user's user id
void	getValid()	Returns the valid flag
void	remove()	Removes a user from the system
void	save()	Uptates the database with all changes
void	setAlbum()	Records the "prime album" of a user. Prime albums are linked to the user and removed if the user is removed.
void	setChallengePhraseInfo()
void	setCredentials()
void	setCustomData()	Stores custom data
void	setDateTime()	Stores the date
void	setEmail()	Stores the user email
void	setGroup()	Sets the user's group.
void	setLanguage()	Sets the user's preferec language
void	setName()	Stores the user name
void	setObjects()	Returns local copy of managed objects.
void	setPass()	Hashes and stores the password
void	setQuota()	Sets the users quota
void	setRights()	Stores user rights
void	setUser()	Sets the user's user id
void	setValid()	Sets the "valid" flag. Valid is 1 for users, 0 for groups and templates

[ Top ]

Properties

mixed $logout_link = true [line 1282]

[ Top ]

mixed $master = false [line 1280]

[ Top ]

mixed $msg = NULL [line 1281]

[ Top ]

mixed $objects = NULL [line 1279]

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

[ Top ]

mixed $passhash [line 1284]

[ Top ]

mixed $reset = false [line 1283]

[ Top ]

Methods

Constructor __construct [line 1294]

Administrator __construct(

$user, int
$valid, string
$user. 
)

Constructor for an Administrator

Parameters:

string	$user.:
int	$valid:	used to signal kind of admin object
	$user:

[ Top ]

createPrimealbum [line 1657]

void createPrimealbum(
[
$new = true], [
$name = NULL] 
)

Creates a "prime" album for the user. Album name is based on the userid

Parameters:

	$new:
	$name:

[ Top ]

getAlbum [line 1618]

void getAlbum(
)

Returns the user's "prime" album. See setAlbum().

[ Top ]

getChallengePhraseInfo [line 1694]

void getChallengePhraseInfo(
)

[ Top ]

getCredentials [line 1646]

void getCredentials(
)

Data to support other credential systems integration

[ Top ]

getCustomData [line 1468]

void getCustomData(
)

Returns custom data

[ Top ]

getDateTime [line 1346]

date getDateTime(
)

Returns the unformatted date

[ Top ]

getEmail [line 1407]

void getEmail(
)

Returns the user email

[ Top ]

getGroup [line 1497]

void getGroup(
)

Returns user's group

[ Top ]

getID [line 1359]

void getID(
)

Redefinition of:

PersistentObject::getID(): Returns the id

[ Top ]

getLanguage [line 1532]

void getLanguage(
)

Returns the user's prefered language

[ Top ]

getLastLogon [line 1711]

void getLastLogon(
)

returns the last time the user has logged on

[ Top ]

getName [line 1393]

void getName(
)

Returns the user name

[ Top ]

getObjects [line 1437]

void 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

Parameters:

$what:

[ Top ]

getPass [line 1379]

void getPass(
)

Returns stored password hash

[ Top ]

getQuota [line 1525]

void getQuota(
)

Returns the users quota

[ Top ]

getRights [line 1421]

void getRights(
)

Returns user rights

[ Top ]

getUser [line 1511]

void getUser(
)

Returns user's user id

[ Top ]

getValid [line 1482]

void getValid(
)

Returns the valid flag

[ Top ]

remove [line 1599]

void remove(
)

Removes a user from the system

Redefinition of:

PersistentObject::remove(): Deletes object from the database

[ Top ]

save [line 1546]

void save(
)

Uptates the database with all changes

Redefinition of:

PersistentObject::save(): Save the updates made to this object since the last update. Returns true if successful, false if not.

[ Top ]

setAlbum [line 1635]

void setAlbum(

$album 
)

Records the "prime album" of a user. Prime albums are linked to the user and removed if the user is removed.

Parameters:

$album:

[ Top ]

setChallengePhraseInfo [line 1703]

void setChallengePhraseInfo(

$challenge, 
$response 
)

Parameters:

	$challenge:
	$response:

[ Top ]

setCredentials [line 1650]

void setCredentials(

$cred 
)

Parameters:

$cred:

[ Top ]

setCustomData [line 1461]

void setCustomData(

$custom_data 
)

Stores custom data

Parameters:

$custom_data:

[ Top ]

setDateTime [line 1355]

void setDateTime(
string
$datetime 
)

Stores the date

Parameters:

string

$datetime:

formatted date

[ Top ]

setEmail [line 1400]

void setEmail(

$admin_e 
)

Stores the user email

Parameters:

$admin_e:

[ Top ]

setGroup [line 1490]

void setGroup(

$group 
)

Sets the user's group.

NOTE this does NOT set rights, etc. that must be done separately

Parameters:

$group:

[ Top ]

setLanguage [line 1539]

void setLanguage(

$locale 
)

Sets the user's preferec language

Parameters:

$locale:

[ Top ]

setName [line 1386]

void setName(

$admin_n 
)

Stores the user name

Parameters:

$admin_n:

[ Top ]

setObjects [line 1428]

void setObjects(

$objects 
)

Returns local copy of managed objects.

Parameters:

$objects:

[ Top ]

setPass [line 1367]

void setPass(
$pwd
$pwd 
)

Hashes and stores the password

Parameters:

$pwd

$pwd:

[ Top ]

setQuota [line 1518]

void setQuota(

$v 
)

Sets the users quota

Parameters:

$v:

[ Top ]

setRights [line 1414]

void setRights(

$rights 
)

Stores user rights

Parameters:

$rights:

[ Top ]

setUser [line 1504]

void setUser(

$user 
)

Sets the user's user id

Parameters:

$user:

[ Top ]

setValid [line 1475]

void setValid(

$valid 
)

Sets the "valid" flag. Valid is 1 for users, 0 for groups and templates

Parameters:

$valid:

[ Top ]

classes

Packages:

core
admin
classes
functions
plugins

Files:

class-album.php
class-comment.php
class-feed.php
class-gallery.php
class-image.php
class-search.php
classes.php
lib-auth.php

media
class-video.php

Classes:

Album
AlbumBase
Comment
dynamicAlbum
favorites
feed
Gallery
Image
MediaObject
PersistentObject
SearchEngine
ThemeObject
Transientimage
Zenphoto_Administrator
Zenphoto_Authority

media
pseudoPlayer
Video
VideoObject_Options

Documentation generated on Sat, 07 Jun 2014 18:03:35 +0200 by phpDocumentor 1.4.3

RSS feeds!

Social networks

Join the Google Groups!

zenphoto-announce
Release announcements and security alerts only (no support)
Subscribe right here:

Email:
Zenphoto Translate
Support and discussion for translators only

Zenphoto

Class: Zenphoto_Administrator