ZenphotoCMS 1.6.6

Zenphoto_Authority extends Authority

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

  • Use the class Authority instead

Table of Contents

Properties

$admin_all  : mixed
$admin_groups  : mixed
$admin_other  : mixed
$admin_realusers  : mixed
$admin_users  : mixed
$hashList  : mixed
$preferred_version  : mixed
$rightsset  : mixed
$supports_version  : mixed
$master_user  : mixed

Methods

__construct()  : lib_auth_options
class instantiation function
checkAuthorization()  : bit
Retuns the administration rights of a saved authorization code Will promote an admin to ADMIN_RIGHTS if he is the most privileged admin
checkCookieCredentials()  : mixed
Checks saved cookies to see if a user is logged in
checkLogon()  : object
Checks a logon user/password against admins
checkUniqueMailaddress()  : bool
Checks if the email address being set is already used by another user Returns true if it is, false if not
getAdminEmail()  : array<string|int, mixed>
Returns the email addresses of the Admin with ADMIN_USERS rights
getAdministrators()  : array<string|int, mixed>
Returns an array of admin users, indexed by the userid and ordered by "privileges"
getAnAdmin()  : Administrator
Returns an admin object from the $pat:$criteria
getAuthCookies()  : mixed
returns an array of the active "password" cookies
getLogoutURL()  : string
Gets the logout link for backend or frontend if the visitor is a logged in user
getLogoutURLPageParams()  : array<string|int, mixed>|string
Gets the current page params to generate a logout link of the current page if not using modrewrite
getMasterUser()  : object
Returns the object of the master user
getMasterUserName()  : type
Gets the name of the current master user
getOptionsSupported()  : array<string|int, mixed>
Declares options used by lib-auth
getResetTicket()  : mixed
getRights()  : mixed
Returns an array of the rights definitions for $version (default returns current version rights)
getVersion()  : mixed
handleLogon()  : mixed
User authentication support
handleLogout()  : mixed
Cleans up on logout
handleOption()  : mixed
Dummy for object inheritance purposes
hasAdminTable()  : bool
Checks if the administrator table and actual admins exist
isMasterUser()  : bool
Check if the user name is the master user
isUniqueMailaddress()  : bool
Checks if the email address being set is already used by another user Returns true if it is, false if not
logUser()  : mixed
Set log-in cookie for a user
migrateAuth()  : mixed
Migrates credentials
newAdministrator()  : object
Instantiates and returns administrator object
passwordHash()  : string
Returns the hash of the zenphoto password
pbkdf2()  : mixed
PBKDF2 Implementation (described in RFC 2898)
printLoginForm()  : mixed
Print the login form for ZP. This will take into account whether mod_rewrite is enabled or not.
printPasswordForm()  : mixed
printPasswordFormJS()  : mixed
Javascript for password change input handling
sendAdminNotificationEmail()  : string
Sends an email to either all full administrators or the the master user only
sendAdminNotificationMail()  : mixed
updateAdminField()  : mixed
Updates a field in admin record(s)
validateTicket()  : mixed

Properties

$hashList

public static mixed $hashList = array('pbkdf2' => 3, 'pbkdf2*' => 2, 'sha1' => 1, 'md5' => 0)

Methods

__construct()

class instantiation function

public __construct() : lib_auth_options
  • Use the class Authority instead
Return values
lib_auth_options

checkAuthorization()

Retuns the administration rights of a saved authorization code Will promote an admin to ADMIN_RIGHTS if he is the most privileged admin

public checkAuthorization(string $authCode, int $id) : bit
Parameters
$authCode : string

the hash code to check

$id : int

whom we think this is

Return values
bit

checkCookieCredentials()

Checks saved cookies to see if a user is logged in

public checkCookieCredentials() : mixed

checkLogon()

Checks a logon user/password against admins

public checkLogon(string $user, string $pass) : object

Returns the user object if there is a match

Parameters
$user : string
$pass : string
Return values
object

checkUniqueMailaddress()

Checks if the email address being set is already used by another user Returns true if it is, false if not

public checkUniqueMailaddress(string $email_to_check, type $current_user) : bool

– Use the method isUniqueMailaddress() instead

Parameters
$email_to_check : string

email address to check

$current_user : type

user id of the user trying to set this email address

Return values
bool

getAdminEmail()

Returns the email addresses of the Admin with ADMIN_USERS rights

public getAdminEmail([bit $rights = NULL ]) : array<string|int, mixed>
Parameters
$rights : bit = NULL

what kind of admins to retrieve

Return values
array<string|int, mixed>

getAdministrators()

Returns an array of admin users, indexed by the userid and ordered by "privileges"

public getAdministrators([string $what = 'users' ][, string $returnvalues = 'coredata' ][, string $sortorder = null ][, string $sortdir = 'desc' ][, int $rights = null ]) : array<string|int, mixed>

The array contains the id, hashed password, user's name, email, and admin privileges

Parameters
$what : string = 'users'

'allusers' for all standard users, 'users' for all valid stanndard users 'groups' for groups and templates, empty for all types of users

$returnvalues : string = 'coredata'

Several sets of database columns

  • "minimaldata": id, user, rights, valid (as needed for creating admininistrator objects directly)
  • "basedata": id, user, rights, valid, name, group (as used in several places)
  • "coredata": id, user, rights, name, group, email, pass, custom_data, valid, date, other_credentials
  • 'fulldata" full data with all columns
$sortorder : string = null

Default null for "ORDER BY rights DESC, id" (order determined by $sortdir param!), otherwise the column to order by

$sortdir : string = 'desc'

Default "desc" for descending (also if not set) or "asc" for ascending.

$rights : int = null

Rights value via constant like ADMIN_RIGHTS to get users by. Default null for all users

Return values
array<string|int, mixed>

getAnAdmin()

Returns an admin object from the $pat:$criteria

public static getAnAdmin(mixed $criteria) : Administrator
  • Use the class Authority method instead
Parameters
$criteria : mixed

[ match => criteria ]

Return values
Administrator

getAuthCookies()

returns an array of the active "password" cookies

public static getAuthCookies() : mixed
  • Use the class Authority method instead

getLogoutURL()

Gets the logout link for backend or frontend if the visitor is a logged in user

public static getLogoutURL([mixed $mode = 'backend' ][, mixed $redirect = '' ]) : string
  • Use the class Authority method instead
Parameters
$mode : mixed = 'backend'

"backend" (default) for the main backend logout link, or "frontend" for theme usages like the user-loginout plugin

$redirect : mixed = ''

non rewritten page query string to redirect to another frontend page than the current if in "frontend" mode

Return values
string

getLogoutURLPageParams()

Gets the current page params to generate a logout link of the current page if not using modrewrite

public static getLogoutURLPageParams([mixed $returnvalue = 'string' ]) : array<string|int, mixed>|string
  • Use the class Authority method instead
Parameters
$returnvalue : mixed = 'string'

'string' for a ready to use string for an logout url or 'array' for an indexed array

Return values
array<string|int, mixed>|string

getMasterUser()

Returns the object of the master user

public getMasterUser() : object
Return values
object

getMasterUserName()

Gets the name of the current master user

public getMasterUserName() : type
Tags
since
1.6
global

type $_zp_db

Return values
type

getOptionsSupported()

Declares options used by lib-auth

public getOptionsSupported() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResetTicket()

public static getResetTicket(mixed $user, mixed $pass) : mixed
  • Use the class Authority method instead
Parameters
$user : mixed
$pass : mixed

getRights()

Returns an array of the rights definitions for $version (default returns current version rights)

public static getRights([mixed $version = NULL ]) : mixed
  • Use the class Authority method instead
Parameters
$version : mixed = NULL

handleLogon()

User authentication support

public handleLogon() : mixed

handleLogout()

Cleans up on logout

public static handleLogout() : mixed
  • Use the class Authority method instead

handleOption()

Dummy for object inheritance purposes

public handleOption(mixed $option, mixed $currentValue) : mixed
Parameters
$option : mixed
$currentValue : mixed

hasAdminTable()

Checks if the administrator table and actual admins exist

public hasAdminTable() : bool
Tags
since
1.6
global

obj $_zp_db

Return values
bool

isMasterUser()

Check if the user name is the master user

public isMasterUser(strung $user) : bool
Parameters
$user : strung

User name

Return values
bool

isUniqueMailaddress()

Checks if the email address being set is already used by another user Returns true if it is, false if not

public isUniqueMailaddress(string $email_to_check, type $current_user) : bool
Parameters
$email_to_check : string

email address to check

$current_user : type

user id of the user trying to set this email address

Return values
bool

logUser()

Set log-in cookie for a user

public static logUser(mixed $user) : mixed
  • Use the class Authority method instead
Parameters
$user : mixed

migrateAuth()

Migrates credentials

public migrateAuth(mixed $to) : mixed
Parameters
$to : mixed

newAdministrator()

Instantiates and returns administrator object

public static newAdministrator(mixed $name[, mixed $valid = 1 ]) : object
  • Use the class Authority method instead
Parameters
$name : mixed
$valid : mixed = 1
Return values
object

passwordHash()

Returns the hash of the zenphoto password

public static passwordHash(mixed $user, mixed $pass[, mixed $hash_type = NULL ]) : string
  • Use the class Authority method instead
Parameters
$user : mixed
$pass : mixed
$hash_type : mixed = NULL
Return values
string

pbkdf2()

PBKDF2 Implementation (described in RFC 2898)

public static pbkdf2(mixed $p, mixed $s[, mixed $c = 1000 ][, mixed $kl = 32 ][, mixed $a = 'sha256' ]) : mixed
  • Use the class Authority method instead
Parameters
$p : mixed
$s : mixed
$c : mixed = 1000
$kl : mixed = 32
$a : mixed = 'sha256'

printLoginForm()

Print the login form for ZP. This will take into account whether mod_rewrite is enabled or not.

public printLoginForm([string $redirect = null ][, bool $logo = true ][, bool $showUserField = true ][, bool $showCaptcha = true ][, string $hint = '' ]) : mixed
Parameters
$redirect : string = null

URL to return to after login

$logo : bool = true

set to true to display the ADMIN zenphoto logo.

$showUserField : bool = true

set to true to display the user input

$showCaptcha : bool = true

set to false to not display the forgot password captcha.

$hint : string = ''

optional hint for the password

printPasswordForm()

public static printPasswordForm([mixed $id = '' ][, mixed $pad = false ][, mixed $disable = NULL ][, mixed $required = false ][, mixed $flag = '' ]) : mixed
  • Use the class Authority method instead
Parameters
$id : mixed = ''
$pad : mixed = false
$disable : mixed = NULL
$required : mixed = false
$flag : mixed = ''

printPasswordFormJS()

Javascript for password change input handling

public static printPasswordFormJS() : mixed
  • Use the class Authority method instead

sendAdminNotificationEmail()

Sends an email to either all full administrators or the the master user only

public sendAdminNotificationEmail([string $subject = '' ][, string $message = '' ][, string $whom = 'alladmins' ]) : string
Parameters
$subject : string = ''
$message : string = ''
$whom : string = 'alladmins'
Tags
since
1.6.6
Return values
string

sendAdminNotificationMail()

public static sendAdminNotificationMail() : mixed

updateAdminField()

Updates a field in admin record(s)

public static updateAdminField(mixed $update, mixed $value, mixed $constraints) : mixed
  • Use the class Authority method instead
Parameters
$update : mixed

name of the field

$value : mixed

what to store

$constraints : mixed

on the update [ field,value ]

Return values
mixed

Query result

validateTicket()

public validateTicket(mixed $ticket, mixed $user) : mixed
Parameters
$ticket : mixed
$user : mixed

        
On this page

Search results