library/Dot/Auth.php
Properties
Description
DotBoost Technologies Inc.
DotKernel Application Framework
Classes
Dot_Auth
Properties
No
No
Description
Authorize user methods, used in all DotKernel Applications
Methods
__clone,
__construct,
_getAuthAdapter,
checkIdentity,
clearIdentity,
getIdentity,
getInstance,
hasIdentity,
process,
setRoles,
__clone(
)
:
void
Description
Singleton pattern implementation makes 'clone' unavailable
Return value
Tags
| Name |
Description |
| access |
protected |
__construct(
)
:
void
Description
Singleton pattern implementation makes 'new' unavailable
Return value
Tags
| Name |
Description |
| access |
protected |
_getAuthAdapter(
string
$who,
)
:
Zend_Auth_Adapter_DbTable
Description
Get the auth adapter
Arguments
| Name |
Type |
Description |
Default |
| $who |
string |
|
|
Return value
| Type |
Description |
| Zend_Auth_Adapter_DbTable |
|
Tags
| Name |
Description |
| access |
private |
checkIdentity(
string
$who,
)
:
bool
Description
Check permission based on the ACL roles
Set wanted url if user is not logged
Arguments
| Name |
Type |
Description |
Default |
| $who |
string |
- who is checking the identity |
|
Return value
Tags
| Name |
Description |
| todo |
extension to check user level |
| access |
public |
clearIdentity(
string
$who
= user,
)
:
void
Description
Clear the identity - log out
Arguments
| Name |
Type |
Description |
Default |
| $who |
string |
[optional] |
user |
Return value
Tags
| Name |
Description |
| access |
public |
| static |
|
getIdentity(
)
:
object
Description
Return identity
Return value
Tags
| Name |
Description |
| access |
public |
getInstance(
)
:
Dot_Aut
Description
Returns an instance of Dot_Aut
Singleton pattern implementation
Return value
Tags
| Name |
Description |
| access |
public |
| static |
|
hasIdentity(
)
:
bool
Description
Check to see if identity exists - is log in
Return value
Tags
| Name |
Description |
| access |
public |
process(
string
$who,
array
$values,
)
:
bool
Description
Process the authentification with Zend_Auth.Return TRUE or FALSE if succedded or not
Arguments
| Name |
Type |
Description |
Default |
| $who |
string |
- who to authentificate |
|
| $values |
array |
- values to process |
|
Return value
Tags
| Name |
Description |
| access |
public |
setRoles(
array
$roles,
)
:
void
Description
Set the roles for authentification
Arguments
| Name |
Type |
Description |
Default |
| $roles |
array |
|
|
Return value
Tags
| Name |
Description |
| access |
public |
Properties
$_instance,
protected
static $_instance
=
null
Singleton instanceDot_Aut
