Methods
Try to authenticate a user
auth(string $user, string $pass) : \sso\AuthUser
Parameters
$pass
stringuser password
Returns
\sso\AuthUserThe user object, identified of not (isLogged())
Return group element type
getGroupType()
Static
| see |
|
| inherited_from |
\sso\SsoGroupable::getGroupType() |
Retrieve the local auth method
getLocal() : \sso\SsoAuthMethod
Static
Returns
\sso\SsoAuthMethod
Field name that contain name of group element
getNameField()
| see |
|
| inherited_from |
\sso\SsoGroupable::getNameField() |
Retrieve options of auth type
getOptions(array<mixed,mixed> $value = NULL) : array<mixed,\salt\Field>
Parameters
$value
array<mixed,mixed>current values as key => value
Returns
array<mixed,\salt\Field>Options list
{@inheritDoc}
initAfterCreateTable(\salt\DBHelper $db)
Parameters
$db
\salt\DBHelperdatabase where table is created
Retrieve objects
search(array<mixed,mixed> $criteria, \salt\Pagination $pagination = NULL)
Static
| see |
|
| inherited_from |
\sso\SsoAdministrable::search() |
Parameters
$criteria
array<mixed,mixed>criteria as key => value
$pagination
\salt\Paginationpagination object
Search a user
searchUser(array<mixed,string>|string $search) : \sso\AuthUser
Parameters
$search
array<mixed,string>stringUser ID or fields to search as key => value
Returns
\sso\AuthUserThe user object
Properties
$create
$create : boolean
$default
$default : boolean
$options
$options : string
List of type classes
$TYPES : array<mixed,\sso\SsoAuthMethodInterface>
Static
Constants
Class type
TYPE_CLASS = 3
Database type
TYPE_DB = 2
Local type
TYPE_LOCAL = 0