Class Zenphoto_Authority

Provides the methods used for user authorization and management store an instantiation of this class in $_zp_authority.

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

Methods summary
`public lib_auth_options`	# `__construct( )` class instantiation function class instantiation function Returns lib_auth_options
`public`	# `getMasterUser( )`
`public`	# `isMasterUser( $user )`
`public array`	# `getOptionsSupported( )` Declares options used by lib-auth Declares options used by lib-auth Returns array
`public`	# `handleOption( $option, $currentValue )` Dummy for object inheritance purposes Dummy for object inheritance purposes
`public static`	# `getVersion( )`
`public static string`	# `passwordHash( string $user, string $pass, $hash_type = NULL )` Returns the hash of the zenphoto password Returns the hash of the zenphoto password Parameters `$user` `$pass` `$hash_type` Returns string
`public array`	# `getAdministrators( string $what = 'users' )` Returns an array of admin users, indexed by the userid and ordered by "privileges" Returns an array of admin users, indexed by the userid and ordered by "privileges" The array contains the id, hashed password, user's name, email, and admin privileges Parameters `$what` $what: 'all' for everything, 'users' for just users 'groups' for groups and templates Returns array
`public static Zenphoto_Administrator`	# `getAnAdmin( array $criteria )` Returns an admin object from the $pat:$criteria Returns an admin object from the $pat:$criteria Parameters `$criteria` [ match => criteria ] Returns `Zenphoto_Administrator`
`public bit`	# `checkAuthorization( string $authCode, integer $id )` Retuns the administration rights of a saved authorization code Will promote an admin to ADMIN_RIGHTS if he is the most privileged admin Retuns the administration rights of a saved authorization code Will promote an admin to ADMIN_RIGHTS if he is the most privileged admin Parameters `$authCode` the hash code to check `$id` whom we think this is Returns bit
`public object`	# `checkLogon( string $user, string $pass )` Checks a logon user/password against admins Checks a logon user/password against admins Returns the user object if there is a match Parameters `$user` `$pass` Returns object
`public array`	# `getAdminEmail( bit $rights = NULL )` Returns the email addresses of the Admin with ADMIN_USERS rights Returns the email addresses of the Admin with ADMIN_USERS rights Parameters `$rights` what kind of admins to retrieve Returns array
`public`	# `migrateAuth( integer $to )` Migrates credentials Migrates credentials Parameters `$to` $oldversion
`public static mixed`	# `updateAdminField( string $update, mixed $value, array $constraints )` Updates a field in admin record(s) Updates a field in admin record(s) Parameters `$update` name of the field `$value` what to store `$constraints` on the update [ field,value ] Returns mixed Query result
`public static object`	# `newAdministrator( $name, $valid = 1 )` Instantiates and returns administrator object Instantiates and returns administrator object Parameters `$name` `$valid` Returns object
`public static`	# `getRights( $version = NULL )` Returns an array of the rights definitions for $version (default returns current version rights) Returns an array of the rights definitions for $version (default returns current version rights) Parameters `$version`
`public static`	# `getResetTicket( $user, $pass )`
`public`	# `validateTicket( $ticket, $user )`
`public static`	# `logUser( object $user )` Set log-in cookie for a user Set log-in cookie for a user Parameters `$user`
`public`	# `handleLogon( )` User authentication support User authentication support
`public static`	# `getAuthCookies( )` returns an array of the active "password" cookies NOTE: this presumes the general form of an authrization cookie is: zp_xxxxx_auth{_dddd) where xxxxx is the authority (e.g. gallery, image, search, ...) and dddd if present is the object id.
`public static`	# `handleLogout( )` Cleans up on logout Cleans up on logout
`public`	# `checkCookieCredentials( )` Checks saved cookies to see if a user is logged in Checks saved cookies to see if a user is logged in
`public`	# `printLoginForm( string $redirect = null, boolean $logo = true, boolean $showUserField = true, boolean $showCaptcha = true, string $hint = '' )` Print the login form for ZP. This will take into account whether mod_rewrite is enabled or not. Print the login form for ZP. This will take into account whether mod_rewrite is enabled or not. Parameters `$redirect` URL to return to after login `$logo` set to true to display the ADMIN zenphoto logo. `$showUserField` set to true to display the user input `$showCaptcha` set to false to not display the forgot password captcha. `$hint` optional hint for the password
`public static`	# `printPasswordFormJS( )` Javascript for password change input handling
`public static`	# `printPasswordForm( $id = '', $pad = false, $disable = NULL, $required = false, $flag = '' )`
`public static string`	# `pbkdf2( string $p, string $s, integer $c = 1000, integer $kl = 32, string $a = 'sha256' )` PBKDF2 Implementation (described in RFC 2898) PBKDF2 Implementation (described in RFC 2898) Parameters `$p` password `$s` salt `$c` iteration count (use 1000 or higher) `$kl` derived key length `$a` hash algorithm Returns string derived key
`public boolean`	# `checkUniqueMailaddress( string $email_to_check, type $current_user )` Checks if the email address being set is already used by another user Returns true if it is, false if not Checks if the email address being set is already used by another user Returns true if it is, false if not Parameters `$email_to_check` email address to check `$current_user` user id of the user trying to set this email address Returns boolean

Properties summary
`public`	`$admin_users`	# `NULL`
`public`	`$admin_groups`	# `NULL`
`public`	`$admin_other`	# `NULL`
`public`	`$admin_all`	# `NULL`
`public`	`$rightsset`	# `NULL`
`protected`	`$master_user`	# `NULL`
`public static integer`	`$preferred_version`	# `4`
`public static integer`	`$supports_version`	# `4`
`public static array`	`$hashList`	# `array('pbkdf2' => 3, 'pbkdf2*' => 2, 'sha1' => 1, 'md5' => 0)`

Classes

Interfaces

Exceptions

Functions

Class Zenphoto_Authority

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns