DotKernel/admin/Admin.php

Properties

Description

DotBoost Technologies Inc.

DotKernel Application Framework


Classes

Admin

Properties

 
 
Admin  
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

Type Description
n/a n/a

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

Type Description
void

Tags

Name Description
access public

addUser( array   $data, ) : void

Description

Add new user

Arguments

Name Type Description Default
$data array

Return value

Type Description
void

Tags

Name Description
access public

authorizeLogin( array   $validData, ) : void

Description

Authorize user login

Arguments

Name Type Description Default
$validData array

Return value

Type Description
void

Tags

Name Description
access public

deleteUser( int   $id, ) : void

Description

Delete admin user

Arguments

Name Type Description Default
$id int

Return value

Type Description
void

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

Type Description
array

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

Type Description
array

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

Type Description
array

Tags

Name Description
access public

registerLogin( array   $data, ) : void

Description

Register logins data

Arguments

Name Type Description Default
$data array

Return value

Type Description
void

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

Type Description
void

Tags

Name Description
access private

updateUser( array   $data, ) : void

Description

Update user

Arguments

Name Type Description Default
$data array

Return value

Type Description
void

Tags

Name Description
access public
Documentation was generated by DocBlox.

Packages

  • Admin
    • Admin
      Admin Model Here are all the actions related to the user
    • Admin_View
      Admin View Class class that prepare output related to User controller
    • System
      System Model Here are all the actions related to the system settings
    • System_View
      System View Class class that prepare output related to User controller
    • User
      User Model Here are all the actions related to the user
    • User_View
      User View Class class that prepare output related to User controller
    • View
      Admin View abstract over the Dot_Template class
  • DotKernel
    • DotLibrary
    • Frontend
      • Page
        Page Model Dummy class, is not doing anything
      • Page
        Page Model Dummy class, is not doing anything yet
      • Page_View
        Page View Class functions that prepare output related to Page controller
      • User
        User Model Here are all the actions related to the user
      • User_View
        User View Class class that prepare output related to User controller
      • View
        View Model abstract over the Dot_Template class
    • Mobile
      • Page_View
        Page View Class functions that prepare output related to Page controller
      • View
        View Model abstract over the Dot_Template class
    • Rss
      • Sample
        Sample Model Here are all the actions related to the Sample
      • Sample_View
        Sample View Class
      • View
        View class - used for outputting rss content