PHP Класс Gc\User\Model

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

Защищенные свойства (Protected)

Свойство Тип Описание
$name string Table name

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

Метод Описание
authenticate ( string $login, string $password ) : boolean Authenticate user
delete ( ) : boolean Delete user
fromArray ( array $array ) : Model Initiliaze from array
fromId ( integer $userId ) : Model Initiliaze from id
getAcl ( boolean $forceReload = false ) : Model Get User Role
getName ( ) : string Return user name
getRole ( boolean $forceReload = false ) : Model Get User Role
save ( ) : integer Save user
sendForgotPasswordEmail ( string $email ) : boolean Send new password
setEmail ( string $userEmail ) : boolean Set User email
setPassword ( string $userPassword, boolean $encrypt = true ) : void Set user password

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

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

Authenticate user
public authenticate ( string $login, string $password ) : boolean
$login string Login
$password string Password
Результат boolean

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

Delete user
public delete ( ) : boolean
Результат boolean

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

Initiliaze from array
public static fromArray ( array $array ) : Model
$array array Data
Результат Model

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

Initiliaze from id
public static fromId ( integer $userId ) : Model
$userId integer User id
Результат Model

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

Get User Role
public getAcl ( boolean $forceReload = false ) : Model
$forceReload boolean Force reload
Результат Gc\User\Role\Model

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

Return user name
public getName ( ) : string
Результат string

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

Get User Role
public getRole ( boolean $forceReload = false ) : Model
$forceReload boolean Force reload
Результат Gc\User\Role\Model

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

Save user
public save ( ) : integer
Результат integer

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

Send new password
public sendForgotPasswordEmail ( string $email ) : boolean
$email string Email address
Результат boolean

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

Set User email
public setEmail ( string $userEmail ) : boolean
$userEmail string Email address
Результат boolean

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

Set user password
public setPassword ( string $userPassword, boolean $encrypt = true ) : void
$userPassword string User password
$encrypt boolean Encrypt or not the password
Результат void

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

$name защищенное свойство

Table name
protected string $name
Результат string