CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($dnrObj, $parent)
  __get ($name)
  __set ($name, $value)
  addNameserver ($address, $priority, $timeout, $retries)
  getCacheSize ()
  getDnrObj ()
  getLogHost ()
  getLogLevel ()
  getLogType ()
  getRetries ()
  getSessionObj ()
  getTimeout ()
  listNameservers ()
  removeNameserver ($priority)
  reset ()
  save ()
  setCacheSize ($value)
  setLogHost ($value)
  setLogLevel ($value)
  setLogType ($value)
  setRetries ($value)
  setTimeout ($value)
  updateNameserver ($priority, $newAddress=null, $newPriority=null, $newTimeout=null, $newRetries=null)

Member Function Documentation

Dnr::__get ( name  ) 

Get member.

member

description

timeout

the default timeout nameservers have

retries

the default number of retries nameservers have

cacheSize

the cache size in KB for the DNR service

logLevel

the log level for the DNR service

logHost

the address of the host that offers log services

logType

the log type for the DNR service

Dnr::__set ( name,
value  
)

Set member.

member

description

timeout

the default timeout nameservers have

retries

the default number of retries nameservers have

cacheSize

the cache size in KB for the DNR service

logLevel

the log level for the DNR service

logHost

the address of the host that offers log services

logType

the log type for the DNR service

Dnr::addNameserver ( address,
priority,
timeout,
retries  
)

start ThisfunctionstartstheDNRservice

Returns:
bool stop ThisfunctionstopstheDNRservice
bool
Dnr::getCacheSize (  ) 

This function gets the cache size in KB for the DNR service

Returns:
int
Dnr::getLogHost (  ) 

This function returns the host which handles the logging (if the log type is not local)

Returns:
string
Dnr::getLogLevel (  ) 

This function returns the log level for this service.

Returns:
int
Dnr::getLogType (  ) 

This function returns the log the for this service.

Returns:
String Expected values are: "internal", "system" or "remote"
Dnr::getRetries (  ) 

This function gets the default number of retries nameservers have

Returns:
int
Dnr::getTimeout (  ) 

This function gets the default timeout nameservers have

Returns:
int
Dnr::listNameservers (  ) 

This function lists the nameservers from the DNR list

Returns:
array
Dnr::removeNameserver ( priority  ) 

This function removes a nameserver from the DNR list

Returns:
bool
Parameters:
$priority  int the priority of the nameserver
Dnr::reset (  ) 

This function resets the changes made but not yet saved

Returns:
bool
Dnr::save (  ) 

This function saves the DNR configuration on the Axigen server

Returns:
bool
Dnr::setCacheSize ( value  ) 

This function sets the maximum cache size for the DNR service

Returns:
bool
Parameters:
$value  int the maximum cache size for the DNR service
Dnr::setLogHost ( value  ) 

This function sets the address of the host that offers log services for Axigen

Returns:
bool
Parameters:
$value  string log host
Dnr::setLogLevel ( value  ) 

This function sets the log level for this service

Returns:
bool
Parameters:
$value  int log level
Dnr::setLogType ( value  ) 

This function sets the log type for this service

Returns:
bool
Parameters:
$value  string Valid values for the 'value' parameter are: "internal"(used at logging in a local file), "system"(used at logging in system log) or "remote"(used at logging on a dedicated logging machine)
Dnr::setRetries ( value  ) 

This function sets the default number of retries used at DNR requests

Returns:
bool
Parameters:
$value  int the default number of retries used at DNR requests
Dnr::setTimeout ( value  ) 

This function sets the default timeout used at DNR requests

Returns:
bool
Parameters:
$value  int the default timeout
Dnr::updateNameserver ( priority,
newAddress = null,
newPriority = null,
newTimeout = null,
newRetries = null  
)

This function updates a nameserver from the DNR list

Returns:
bool
Parameters:
$priority  int the priority of the nameserver
$newAddress  int the new value of the address
$newPriority  int the new value of the priority
$newTimeout  int the new value of the timeout
$newRetries  int the new value of the number of retries