CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($userDbObj, $parent)
  __get ($name)
  __set ($name, $value)
  addLdapConnector ($name, $hostUrl)
  getLdapConnectors ()
  getLogHost ()
  getLogLevel ()
  getLogType ()
  getMaxThreads ()
  getSessionObj ()
  getUserDbObj ()
  listLdapConnectors ()
  removeLdapConnector ($name)
  save ()
  setLogHost ($value)
  setLogLevel ($value)
  setLogType ($value)
  setMaxThreads ($value)
  updateLdapConnector ($name)

Member Function Documentation

UserDb::__get ( name  ) 

Get member.

member

description

maxThreads

the maximum number of threads

logLevel

the log level

logHost

the address of the host that offers log services

logType

the log type

UserDb::__set ( name,
value  
)

Set member.

member

description

maxThreads

the maximum number of threads

logLevel

the log level

logHost

the address of the host that offers log services

logType

the log type

UserDb::addLdapConnector ( name,
hostUrl  
)

adds a new Ldap connector

Returns:
bool
Parameters:
$name  string the name of the Ldap connector
$hostUrl  string the Ldap Host URL
UserDb::listLdapConnectors (  ) 

lists the Ldap connectors

Returns:
array
UserDb::removeLdapConnector ( name  ) 

removes a Ldap connector

Returns:
bool
Parameters:
$name  string the name of the Ldap connector
UserDb::save (  ) 

this method must be called if one of the members has been changed

Returns:
bool
UserDb::updateLdapConnector ( name  ) 

updates a Ldap connector

Returns:
object LdapConnector
Parameters:
$name  string the name of the Ldap connector