PHP Класс UserType

Наследование: extends Eloquent
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$m_columnNames
$m_config
$m_dbTableName
$m_exists
$m_keyColumnNames
$m_keyIsAutoIncrement

Открытые методы

Метод Описание
GetByName ( $p_name ) : mixed Get the user type that matches the given name.
GetUserTypeFromConfig ( $p_configVars ) : mixed Get the user type that matches the given config variables.
GetUserTypes ( ) : array Get all the user types with the exception of those with the Reader permission.
UserType ( $p_userTypeId = null ) : void Constructor
create ( $p_name = null, $p_configVars = [] ) : boolean Create the new UserType with the config variables given.
delete ( ) : boolean Delete the user type.
exists ( ) : boolean Whether the user type exists or not
getConfig ( ) : array Return an array of config values in the form array("varname" => "value");
getId ( ) : integer Get the id of this user type.
getName ( ) : string Get the name of this user type.
getValue ( string $p_varName ) : mixed Return the value of the given variable name.
hasPermission ( string $p_permissionString ) : boolean Return true if the user type has the permission specified.
setPermission ( $p_permissionString, $p_permissionValue ) Set the specified permission.
setValue ( string $p_varName, mixed $p_value ) : void Set the default config value for the given variable.

Описание методов

GetByName() публичный статический Метод

Get the user type that matches the given name.
public static GetByName ( $p_name ) : mixed
$p_name The name of the user type
Результат mixed null If the user type does not exists or any error UserType object

GetUserTypeFromConfig() публичный статический Метод

Get the user type that matches the given config variables.
public static GetUserTypeFromConfig ( $p_configVars ) : mixed
$p_configVars An array of permissions variables
Результат mixed bool False The config passed does not match any user type object $userType The user type object matching

GetUserTypes() публичный статический Метод

Get all the user types with the exception of those with the Reader permission.
public static GetUserTypes ( ) : array
Результат array An array of UserType objects.

UserType() публичный Метод

Constructor
public UserType ( $p_userTypeId = null ) : void
$p_userTypeId (optional) The user type identifier
Результат void

create() публичный Метод

If a config variable is not set, the default value will be used.
public create ( $p_name = null, $p_configVars = [] ) : boolean
$p_configVars The privileges list to be granted
Результат boolean TRUE on success, FALSE on failure

delete() публичный Метод

Delete the user type.
public delete ( ) : boolean
Результат boolean TRUE on success, FALSE on failure

exists() публичный Метод

Whether the user type exists or not
public exists ( ) : boolean
Результат boolean $this->m_exists TRUE on success, FALSE on failure

getConfig() публичный Метод

Return an array of config values in the form array("varname" => "value");
public getConfig ( ) : array
Результат array

getId() публичный Метод

Get the id of this user type.
public getId ( ) : integer
Результат integer

getName() публичный Метод

Get the name of this user type.
public getName ( ) : string
Результат string

getValue() публичный Метод

If the variable name does not exist, return null.
public getValue ( string $p_varName ) : mixed
$p_varName string
Результат mixed

hasPermission() публичный Метод

Return true if the user type has the permission specified.
public hasPermission ( string $p_permissionString ) : boolean
$p_permissionString string
Результат boolean

setPermission() публичный Метод

Set the specified permission.
public setPermission ( $p_permissionString, $p_permissionValue )
$p_permissionString
$p_permissionValue

setValue() публичный Метод

This creates the new config variable if it didn't exist.
public setValue ( string $p_varName, mixed $p_value ) : void
$p_varName string
$p_value mixed
Результат void

Описание свойств

$m_columnNames публичное свойство

public $m_columnNames

$m_config публичное свойство

public $m_config

$m_dbTableName публичное свойство

public $m_dbTableName

$m_exists публичное свойство

public $m_exists

$m_keyColumnNames публичное свойство

public $m_keyColumnNames

$m_keyIsAutoIncrement публичное свойство

public $m_keyIsAutoIncrement