XLRstats v3 - League Edition
  • Package
  • Class
  • Tree

Packages

  • app
    • Controller
      • Component
    • Model
    • Plugin
      • Dashboard
        • Controller
        • Model
    • View
      • Helper

Classes

  • AppUsersController
  • DashboardAppController
  • DashboardController
  • GroupsController
  • HomeController
  • MaintenanceController
  • OptionsController
  • PlayerSoldiersController
  • ServerGroupsController
  • ServerOptionsController
  • ServersController

Class AppUsersController

Class AppUsersController

UsersController
Extended by AppUsersController
Package: app\Plugin\Dashboard\Controller
License: Commons BY-NC-SA 3.0 License (http://creativecommons.org/licenses/by-nc-sa/3.0/)
Located at Controller/AppUsersController.php

Methods summary

public
# beforeFilter( )

Executes logic before action

Executes logic before action

protected
# _setupAuth( )

Override the _setupAuth() from the Users Plugin

Override the _setupAuth() from the Users Plugin

public
# edit( )

User Profile action

User Profile action

public
# add( )

User register action

User register action

public
# admin_index( )

Admin Index

Admin Index

Lists users via dataTables handled admin_indexJson()

public mixed
# admin_indexJson( )

Returns an array of users and pass data to plugin view file at Users/json/admin_index_json.ctp to be processed by dataTables.

Returns an array of users and pass data to plugin view file at Users/json/admin_index_json.ctp to be processed by dataTables.

If subDomain option is set to true in global config, subdomain admins can list only users belong to the subdomain.

Super Admins can list all users.

Sample data returned: Array ( [sEcho] => 1 [iTotalRecords] => 38 [iTotalDisplayRecords] => 38 [aaData] => Array ( [0] => Array ( [0] => 1 // User Id [1] => superuser // Name [2] => Super Admin // Group Name [3] => superuser@example.com // Email [4] => 1 // Email Verified [5] => 1 // Active [6] => 2013-03-30 19:38:12 // Joined [7] => 2013-10-27 14:41:24 // Last Login [8] => // Empty field for action buttons ) ) )

Returns

mixed
public
# admin_add( )

Admin add

Admin add

If the user is an admin, new users are assigned a server group id automatically. When subDomain is set to true, this is the current server group id. In a normal installation, this is the default server group id which is "1".

Super Admins can choose the server group when adding new users.

public
# admin_edit( null $userId = null )

Edit user data.

Edit user data.

If subDomain option is set to true in global config, subdomain admins:

  • cannot edit non subdomain users
  • cannot change a user's server group.

Admins:

  • cannot set a user as Super Admin

Parameters

$userId
null
$userId
public
# admin_delete( string $userId = null )

Delete a user account

Delete a user account

Admins cannot delete a Super Admin account

Parameters

$userId
string
$userId User ID
public
# login( )

Common login action

Common login action

public
# change_password( )

Allows the user to enter a new password, it needs to be confirmed by entering the old password

Allows the user to enter a new password, it needs to be confirmed by entering the old password

public
# reset_password( string $token = null, string $user = null )

Reset Password Action

Reset Password Action

Handles the trigger of the reset, also takes the token, validates it and let the user enter a new password.

Parameters

$token
string
$token Token
$user
string
$user User Data

Magic methods summary

Properties summary

public array $components
#

Components

Components

XLRstats v3 - League Edition API documentation generated by ApiGen 2.8.0