PHP Класс Devise\Users\Permissions\RuleList

Показать файл Открыть проект

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

Свойство Тип Описание
$closures array Closures are kept in an array and can be used to execute user-defined condition(s) permissions/closures by key
$rules array Rules are a list of built-in methods in this class which are kept in an array; They are used to find and execute methods by name

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

Свойство Тип Описание
$Framework Devise\Support\Framework Framework components being used from Laravel's framework
$User User User model to fetch database table "users"
$isLoggedIn boolean Is this user logged in? Cache the value on this object for performance reasons

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

Метод Описание
__call ( string $method, array $arguments = [] ) : Void | Exceptio\Exception Handle execution of the different types of methods
__construct ( DvsUser $User, Framework $Framework ) Construct a new RuleList

Защищенные методы

Метод Описание
hasEmail ( string $email ) : boolean Check if email field equals specified email
hasFieldValue ( string $field, string $value ) : boolean Check if database field is equal to the specified value
hasName ( string $name ) : boolean Check if name field equals specified name value
hasUserName ( string $username ) : boolean Check if username equals specified username value
isInGroup ( string $groupname ) : boolean Checks if user is in a group
isInGroups ( [type] $groupname ) : boolean Check to see if user is in all groups
isLoggedIn ( ) : boolean Is user logged in system
isNotInGroup ( string $groupname ) : boolean Check user is not in a group
isNotInGroups ( [type] $groupname ) : boolean Check to see if user is not in all the groups
isNotLoggedIn ( ) : boolean Is user not logged in system
showDeviseSpan ( [type] $key, $collection ) : [type] Determines if we should show the devise span

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

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

Handle execution of the different types of methods
public __call ( string $method, array $arguments = [] ) : Void | Exceptio\Exception
$method string Name of function/method
$arguments array Any arguments required by method
Результат Void | Exceptio\Exception | Exception

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

Construct a new RuleList
public __construct ( DvsUser $User, Framework $Framework )
$User DvsUser
$Framework Devise\Support\Framework

hasEmail() защищенный Метод

Check if email field equals specified email
protected hasEmail ( string $email ) : boolean
$email string
Результат boolean

hasFieldValue() защищенный Метод

Check if database field is equal to the specified value
protected hasFieldValue ( string $field, string $value ) : boolean
$field string
$value string
Результат boolean

hasName() защищенный Метод

Check if name field equals specified name value
protected hasName ( string $name ) : boolean
$name string
Результат boolean

hasUserName() защищенный Метод

Check if username equals specified username value
protected hasUserName ( string $username ) : boolean
$username string
Результат boolean

isInGroup() защищенный Метод

you can pass multiple groups in here isInGroup('group1', 'group2') means the user is in either 'group1' or 'group2'
protected isInGroup ( string $groupname ) : boolean
$groupname string
Результат boolean

isInGroups() защищенный Метод

isInGroup('group1', 'group2') means user is in both 'group1' AND 'group1'
protected isInGroups ( [type] $groupname ) : boolean
$groupname [type]
Результат boolean

isLoggedIn() защищенный Метод

Is user logged in system
protected isLoggedIn ( ) : boolean
Результат boolean

isNotInGroup() защищенный Метод

Check user is not in a group
protected isNotInGroup ( string $groupname ) : boolean
$groupname string
Результат boolean

isNotInGroups() защищенный Метод

Check to see if user is not in all the groups
protected isNotInGroups ( [type] $groupname ) : boolean
$groupname [type]
Результат boolean

isNotLoggedIn() защищенный Метод

Is user not logged in system
protected isNotLoggedIn ( ) : boolean
Результат boolean

showDeviseSpan() защищенный Метод

Determines if we should show the devise span
protected showDeviseSpan ( [type] $key, $collection ) : [type]
$key [type]
Результат [type]

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

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

Framework components being used from Laravel's framework
protected Framework,Devise\Support $Framework
Результат Devise\Support\Framework

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

User model to fetch database table "users"
protected User $User
Результат User

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

Closures are kept in an array and can be used to execute user-defined condition(s) permissions/closures by key
public array $closures
Результат array

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

Is this user logged in? Cache the value on this object for performance reasons
protected bool $isLoggedIn
Результат boolean

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

Rules are a list of built-in methods in this class which are kept in an array; They are used to find and execute methods by name
public array $rules
Результат array