DotKernel/admin/Admin.php
Properties
Description
DotBoost Technologies Inc.
DotKernel Application Framework
Classes
Admin
Properties
No
No
Description
Admin Model
Here are all the actions related to the user
Methods
__construct,
activateUser,
addUser,
authorizeLogin,
deleteUser,
getLogins,
getUserBy,
getUserList,
registerLogin,
sendEmailFailedLogin,
updateUser,
__construct(
)
:
n/a
Description
Constructor
Return value
Tags
Name |
Description |
access |
public |
activateUser(
int
$id,
int
$isActive,
)
:
void
Description
Update active field for admin user
Arguments
Name |
Type |
Description |
Default |
$id |
int |
|
|
$isActive |
int |
|
|
Return value
Tags
Name |
Description |
access |
public |
addUser(
array
$data,
)
:
void
Description
Add new user
Arguments
Name |
Type |
Description |
Default |
$data |
array |
|
|
Return value
Tags
Name |
Description |
access |
public |
authorizeLogin(
array
$validData,
)
:
void
Description
Authorize user login
Arguments
Name |
Type |
Description |
Default |
$validData |
array |
|
|
Return value
Tags
Name |
Description |
access |
public |
deleteUser(
int
$id,
)
:
void
Description
Delete admin user
Arguments
Name |
Type |
Description |
Default |
$id |
int |
|
|
Return value
Tags
Name |
Description |
access |
public |
getLogins(
int
$id,
int
$page
= 1,
)
:
array
Description
Get admin users logins archive list
Arguments
Name |
Type |
Description |
Default |
$id |
int |
|
|
$page |
int |
[optional] |
1 |
Return value
Tags
Name |
Description |
access |
public |
getUserBy(
string
$field,
string
$value,
)
:
array
Description
Get admin by field
Arguments
Name |
Type |
Description |
Default |
$field |
string |
|
|
$value |
string |
|
|
Return value
Tags
Name |
Description |
access |
public |
getUserList(
int
$page
= 1,
)
:
array
Description
Get user list
Arguments
Name |
Type |
Description |
Default |
$page |
int |
[optional] |
1 |
Return value
Tags
Name |
Description |
access |
public |
registerLogin(
array
$data,
)
:
void
Description
Register logins data
Arguments
Name |
Type |
Description |
Default |
$data |
array |
|
|
Return value
Tags
Name |
Description |
access |
public |
sendEmailFailedLogin(
$value,
)
:
void
Description
Failed admin login - send email notice to valid admin account
Arguments
Name |
Type |
Description |
Default |
$value |
n/a |
|
|
Return value
Tags
Name |
Description |
access |
private |
updateUser(
array
$data,
)
:
void
Description
Update user
Arguments
Name |
Type |
Description |
Default |
$data |
array |
|
|
Return value
Tags
Name |
Description |
access |
public |