CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($aaclObj, $parentObj)
  addAdminGroup ($name)
  addAdminUser ($name, $password)
  getAaclObj ()
  getSessionObj ()
  listAdminGroups ()
  listAdminUsers ()
  listDomainPrincipals ($domain)
  listResources ()
  listServerPrincipals ()
  purgeResources ()
  removeAdminGroup ($name, $forced=false)
  removeAdminUser ($name)
  updateAdminGroup ($name)
  updateAdminUser ($name)

Member Function Documentation

Aacl::addAdminGroup ( name  ) 

Adds a new admin group

Returns:
bool
Parameters:
$name  string the new group name
Aacl::addAdminUser ( name,
password  
)

Adds a new admin user

Returns:
bool
Parameters:
$name  string the new user name
$password  string the new user password
Aacl::listAdminGroups (  ) 

Returns an array with all the available admin groups

Returns:
array
Aacl::listAdminUsers (  ) 

Returns an array with all the available admin users

Returns:
array
Aacl::listDomainPrincipals ( domain  ) 

Returns an array with all the available domain principals (per specific domain)

Returns:
array
Parameters:
$domain  string the domain name for which you want to see the principals
Aacl::listResources (  ) 

Returns an array with all the available resources

Returns:
array
Aacl::listServerPrincipals (  ) 

Returns an array with all the available server principals

Returns:
array
Aacl::purgeResources (  ) 

this method purges all resources

Returns:
bool
Aacl::removeAdminGroup ( name,
forced = false  
)

Removes an admin group

Returns:
bool
Parameters:
$name  string the group name that will be removed
$forced  string force group removal
Aacl::removeAdminUser ( name  ) 

This method removes an admin user

Returns:
bool
Parameters:
$name  string the name of the user to be removed
Aacl::updateAdminGroup ( name  ) 

Updates an admin group

Returns:
object AdminGroup
Parameters:
$name  string the name of the group you want to update
Aacl::updateAdminUser ( name  ) 

Updates an admin user

Returns:
object AdminUser
Parameters:
$name  string the name of the user to be updated