CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($admingroupObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  addParentGroup ($parentGroup)
  getAdminGroupObj ()
  getEffectivePermissions ($domain=null)
  getPermissions ($domain=null)
  getSessionObj ()
  listAvailableDomains ()
  listMembers ()
  listParents ()
  removeParentGroup ($parentGroup)
  savePermissions ($permissions)

Member Function Documentation

AdminGroup::__get ( varName  ) 

Get member.

member

description

name

group name

description

group description

AdminGroup::__set ( varName,
varValue  
)

Set member.

member

description

name

group name

description

group description

AdminGroup::addParentGroup ( parentGroup  ) 

This method adds a new parent group

Returns:
bool
Parameters:
$parentGroup  string the parent group that you want to add
AdminGroup::getEffectivePermissions ( domain = null  ) 

this method returns an object with all the effective permissions loaded

Returns:
object Permissions
Parameters:
$domain  string the domain name from where the permission will be loaded; if it is null, the server permissions will be loaded (this parameter is optional - server is default)
AdminGroup::getPermissions ( domain = null  ) 

this method returns an object with all the permissions loaded

Returns:
object Permissions
Parameters:
$domain  string the domain name from where the permission will be loaded; if it is null, the server permissions will be loaded (this parameter is optional - server is default)
AdminGroup::listAvailableDomains (  ) 

Returns an array with all the avaible domains

Returns:
array
AdminGroup::listMembers (  ) 

Returns an array with all the members

Returns:
array
AdminGroup::listParents (  ) 

Returns an array with all the group's parents

Returns:
array
AdminGroup::removeParentGroup ( parentGroup  ) 

Removes a parent group

Returns:
bool
Parameters:
$parentGroup  string the parent group that you want to remove