

[ 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 1049]

PersistentObject
   |
   --Zenphoto_Administrator

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PersistentObject

PersistentObject::$cache_by

PersistentObject::$data

PersistentObject::$id

PersistentObject::$loaded

PersistentObject::$table

PersistentObject::$tempdata

PersistentObject::$transient

PersistentObject::$unique_set

PersistentObject::$updates

PersistentObject::$use_cache

Inherited From PersistentObject

PersistentObject::PersistentObject()

Prime instantiator for Zenphoto objects

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::getID()

Returns the id

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.

[ Top ]

Property Summary

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

[ Top ]

Method Summary

Administrator	Zenphoto_Administrator()	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 $master = false [line 1059]

[ Top ]

mixed $msg = NULL [line 1060]

[ Top ]

mixed $no_zp_login = false [line 1061]

[ Top ]

mixed $objects = NULL [line 1058]

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 ]

Methods

Constructor Zenphoto_Administrator [line 1070]

Administrator Zenphoto_Administrator(

$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 1383]

void createPrimealbum(
)

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

[ Top ]

getAlbum [line 1340]

void getAlbum(
)

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

[ Top ]

getChallengePhraseInfo [line 1416]

void getChallengePhraseInfo(
)

[ Top ]

getCredentials [line 1368]

void getCredentials(
)

Data to support other credential systems integration

[ Top ]

getCustomData [line 1198]

void getCustomData(
)

Returns custom data

[ Top ]

getDateTime [line 1084]

date getDateTime(
)

Returns the unformatted date

[ Top ]

getEmail [line 1142]

void getEmail(
)

Returns the user email

[ Top ]

getGroup [line 1225]

void getGroup(
)

Returns user's group

[ Top ]

getID [line 1097]

void getID(
)

Redefinition of:

PersistentObject::getID(): Returns the id

[ Top ]

getLanguage [line 1258]

void getLanguage(
)

Returns the user's prefered language

[ Top ]

getLastLogon [line 1433]

void getLastLogon(
)

returns the last time the user has logged on

[ Top ]

getName [line 1129]

void getName(
)

Returns the user name

[ Top ]

getObjects [line 1170]

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 1116]

void getPass(
)

Returns stored password hash

[ Top ]

getQuota [line 1251]

void getQuota(
)

Returns the users quota

[ Top ]

getRights [line 1155]

void getRights(
)

Returns user rights

[ Top ]

getUser [line 1238]

void getUser(
)

Returns user's user id

[ Top ]

getValid [line 1211]

void getValid(
)

Returns the valid flag

[ Top ]

remove [line 1322]

void remove(
)

Removes a user from the system

Redefinition of:

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

[ Top ]

save [line 1271]

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 1357]

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 1425]

void setChallengePhraseInfo(

$challenge, 
$response 
)

Parameters:

	$challenge:
	$response:

[ Top ]

setCredentials [line 1376]

void setCredentials(

$cred 
)

Parameters:

$cred:

[ Top ]

setCustomData [line 1192]

void setCustomData(

$custom_data 
)

Stores custom data

Parameters:

$custom_data:

[ Top ]

setDateTime [line 1093]

void setDateTime(
string
$datetime 
)

Stores the date

Parameters:

string

$datetime:

formatted date

[ Top ]

setEmail [line 1136]

void setEmail(

$admin_e 
)

Stores the user email

Parameters:

$admin_e:

[ Top ]

setGroup [line 1219]

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 1264]

void setLanguage(

$locale 
)

Sets the user's preferec language

Parameters:

$locale:

[ Top ]

setName [line 1123]

void setName(

$admin_n 
)

Stores the user name

Parameters:

$admin_n:

[ Top ]

setObjects [line 1162]

void setObjects(

$objects 
)

Returns local copy of managed objects.

Parameters:

$objects:

[ Top ]

setPass [line 1105]

void setPass(
$pwd
$pwd 
)

Hashes and stores the password

Parameters:

$pwd

$pwd:

[ Top ]

setQuota [line 1245]

void setQuota(

$v 
)

Sets the users quota

Parameters:

$v:

[ Top ]

setRights [line 1149]

void setRights(

$rights 
)

Stores user rights

Parameters:

$rights:

[ Top ]

setUser [line 1232]

void setUser(

$user 
)

Sets the user's user id

Parameters:

$user:

[ Top ]

setValid [line 1205]

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
GoogleMapAPI
JSMin
OpenID
PHPMailer
plugins
Services_JSON

Files:

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

Classes:

Album
Comment
Gallery
MediaObject
PersistentObject
SearchEngine
ThemeObject
Transientimage
Video
VideoObject_Options
Zenphoto_Administrator
Zenphoto_Authority
_Image

Documentation generated on Tue, 20 Dec 2011 16:07:33 +0100 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