Index | PHP SDK by CNIC

A

Client::autoIDNConvert() — Method in class Client: Auto convert API command parameters to punycode, if necessary.
Response::addColumn() — Method in class Response: Add a column to the column list
Response::addRecord() — Method in class Response: Add a record to the record list
ResponseTemplateManager::addTemplate() — Method in class ResponseTemplateManager: Add response template to template container
Client::autoIDNConvert() — Method in class Client: Auto convert API command parameters to punycode, if necessary.
Response::addColumn() — Method in class Response: Add a column to the column list
Response::addRecord() — Method in class Response: Add a record to the record list
ResponseTemplateManager::addTemplate() — Method in class ResponseTemplateManager: Add response template to template container
ResponseInterface::addColumn() — Method in class ResponseInterface: Add a column to the column list
ResponseInterface::addRecord() — Method in class ResponseInterface: Add a record to the record list

C

Client — Class in namespace CNIC\CNR: CNR API Client
$ Client#context — Property in class Client: context data for the client
$ Client#curlopts — Property in class Client: additional curl options to use
$ Client#chandle — Property in class Client: curl handle cache
Client::close() — Method in class Client: Close all curl handles
Column — Class in namespace CNIC\CNR: CNR Column
$ Response#command — Property in class Response: The API Command used within this request
$ Response#columnkeys — Property in class Response: Column names available in this response
$ Response#columns — Property in class Response: Container of Column Instances
$ Response#context — Property in class Response: Context data for the response
ClientFactory — Class in namespace CNIC: ClientFactory
ColumnInterface — Class in namespace CNIC: Common Column Interface
CommandFormatter — Class in namespace CNIC: CommandFormatter
Client — Class in namespace CNIC\IBS: IBS API Client
Column — Class in namespace CNIC\IBS: IBS Column
$ Response#context — Property in class Response: Context data for the response

D

$ Client#debugMode — Property in class Client: activity flag for debug mode
Client::disableDebugMode() — Method in class Client: Disable Debug Output

E

Client::enableDebugMode() — Method in class Client: Enable Debug Output to STDOUT

F

CommandFormatter::flattenCommand() — Method in class CommandFormatter: Flatten API command's nested arrays for easier handling
CommandFormatter::formatCommand() — Method in class CommandFormatter: Format the command array into a plain text string

G

Client::getPOSTData() — Method in class Client: Serialize given command for POST request including connection configuration data
Client::getSession() — Method in class Client: Get the API Session ID that is currently set
Client::getURL() — Method in class Client: Get the API connection url that is currently set
Client::getUserAgent() — Method in class Client: Get the user agent string
Client::getProxy() — Method in class Client: Get proxy configuration for API communication
Client::getReferer() — Method in class Client: Get Referer configuration for API communication
Client::getVersion() — Method in class Client: Get the current module version
Column::getKey() — Method in class Column: Get column name
Column::getData() — Method in class Column: Get column data
Column::getDataByIndex() — Method in class Column: Get column data at given index
Record::getData() — Method in class Record: get row data
Record::getDataByKey() — Method in class Record: get row data for given column
Response::getContext() — Method in class Response: Get context data for the response
Response::getRequestURL() — Method in class Response: Get Request URL
Response::getCode() — Method in class Response: Get API response code
Response::getDescription() — Method in class Response: Get API response description
Response::getPlain() — Method in class Response: Get Plain API response
Response::getQueuetime() — Method in class Response: Get Queuetime of API response
Response::getHash() — Method in class Response: Get API response as Hash
Response::getRuntime() — Method in class Response: Get Runtime of API response
Response::getColumn() — Method in class Response: Get column by column name
Response::getColumnIndex() — Method in class Response: Get Data by Column Name and Index
Response::getColumnKeys() — Method in class Response: Get Column Names
Response::getColumns() — Method in class Response: Get List of Columns
Response::getCommand() — Method in class Response: Get Command used in this request
Response::getCommandPlain() — Method in class Response: Get Command used in this request in plain text format
Response::getCurrentPageNumber() — Method in class Response: Get Page Number of current List Query
Response::getCurrentRecord() — Method in class Response: Get Record of current record index
Response::getFirstRecordIndex() — Method in class Response: Get Index of first row in this response
Response::getLastRecordIndex() — Method in class Response: Get last record index of the current list query
Response::getListHash() — Method in class Response: Get Response as List Hash including useful meta data for tables
Response::getNextRecord() — Method in class Response: Get next record in record list
Response::getNextPageNumber() — Method in class Response: Get Page Number of next list query
Response::getNumberOfPages() — Method in class Response: Get the number of pages available for this list query
Response::getPagination() — Method in class Response: Get object containing all paging data
Response::getPreviousPageNumber() — Method in class Response: Get Page Number of previous list query
Response::getPreviousRecord() — Method in class Response: Get previous record in record list
Response::getRecord() — Method in class Response: Get Record at given index
Response::getRecords() — Method in class Response: Get all Records
Response::getRecordsCount() — Method in class Response: Get count of rows in this response
Response::getRecordsTotalCount() — Method in class Response: Get total count of records available for the list query
Response::getRecordsLimitation() — Method in class Response: Get limit(ation) setting of the current list query This is the count of requested rows
ResponseTemplateManager::generateTemplate() — Method in class ResponseTemplateManager: Generate API response template string for given code and description
ResponseTemplateManager::getTemplate() — Method in class ResponseTemplateManager: Get response template instance from template container
ResponseTemplateManager::getTemplates() — Method in class ResponseTemplateManager: Return all available response templates
SocketConfig::getPOSTDataParams() — Method in class SocketConfig: Get POST data container of connection data
SocketConfig::getPOSTData() — Method in class SocketConfig: Create POST data string out of connection data
SocketConfig::getPersistent() — Method in class SocketConfig: Get persistent parameter returned
SocketConfig::getSession() — Method in class SocketConfig: Get API Session ID in use
SocketConfig::getLogin() — Method in class SocketConfig: Get current login (including role)
ClientFactory::getClient() — Method in class ClientFactory: Returns Client Instance by configuration
ColumnInterface::getKey() — Method in class ColumnInterface: Get column name
ColumnInterface::getData() — Method in class ColumnInterface: Get column data
ColumnInterface::getDataByIndex() — Method in class ColumnInterface: Get column data at given index
CommandFormatter::getSortedCommand() — Method in class CommandFormatter: Get the sorted command array based on priority
Client::getPOSTData() — Method in class Client: Serialize given command for POST request including connection configuration data
Client::getSession() — Method in class Client: Get the API Session ID that is currently set Note: not supported.
Response::getCode() — Method in class Response: Get API response code
Response::getStatus() — Method in class Response: Get API response code
Response::getDescription() — Method in class Response: Get API response description
Response::getPlain() — Method in class Response: Get Plain API response
Response::getQueuetime() — Method in class Response: Get Queuetime of API response
Response::getHash() — Method in class Response: Get API response as Hash
Response::getRuntime() — Method in class Response: Get Runtime of API response
Response::getColumn() — Method in class Response: Get column by column name
Response::getColumnIndex() — Method in class Response: Get Data by Column Name and Index
Response::getColumnKeys() — Method in class Response: Get Column Names
Response::getColumns() — Method in class Response: Get List of Columns
Response::getCommand() — Method in class Response: Get Command used in this request
Response::getCommandPlain() — Method in class Response: Get Command used in this request in plain text format
Response::getCurrentPageNumber() — Method in class Response: Get Page Number of current List Query
Response::getCurrentRecord() — Method in class Response: Get Record of current record index
Response::getFirstRecordIndex() — Method in class Response: Get Index of first row in this response
Response::getLastRecordIndex() — Method in class Response: Get last record index of the current list query
Response::getListHash() — Method in class Response: Get Response as List Hash including useful meta data for tables
Response::getNextRecord() — Method in class Response: Get next record in record list
Response::getNextPageNumber() — Method in class Response: Get Page Number of next list query
Response::getNumberOfPages() — Method in class Response: Get the number of pages available for this list query
Response::getPagination() — Method in class Response: Get object containing all paging data
Response::getPreviousPageNumber() — Method in class Response: Get Page Number of previous list query
Response::getPreviousRecord() — Method in class Response: Get previous record in record list
Response::getRecord() — Method in class Response: Get Record at given index
Response::getRecords() — Method in class Response: Get all Records
Response::getRecordsCount() — Method in class Response: Get count of rows in this response
Response::getRecordsTotalCount() — Method in class Response: Get total count of records available for the list query
Response::getRecordsLimitation() — Method in class Response: Get limit(ation) setting of the current list query This is the count of requested rows
ResponseTemplateManager::generateTemplate() — Method in class ResponseTemplateManager: Generate API response template string for given status and description
ResponseTemplateManager::getTemplate() — Method in class ResponseTemplateManager: Get response template instance from template container
ResponseTemplateManager::getTemplates() — Method in class ResponseTemplateManager: Return all available response templates
SocketConfig::getPOSTDataParams() — Method in class SocketConfig: Get POST data container of connection data
SocketConfig::getPOSTData() — Method in class SocketConfig: Create POST data string out of connection data
SocketConfig::getLogin() — Method in class SocketConfig: Get current login (including role)
RecordInterface::getData() — Method in class RecordInterface: Get row data
RecordInterface::getDataByKey() — Method in class RecordInterface: Get row data for given column
ResponseInterface::getCode() — Method in class ResponseInterface: Get API response code
ResponseInterface::getDescription() — Method in class ResponseInterface: Get API response description
ResponseInterface::getRequestURL() — Method in class ResponseInterface: Get Request URL
ResponseInterface::getPlain() — Method in class ResponseInterface: Get Plain API response
ResponseInterface::getQueuetime() — Method in class ResponseInterface: Get Queuetime of API response
ResponseInterface::getHash() — Method in class ResponseInterface: Get API response as Hash
ResponseInterface::getRuntime() — Method in class ResponseInterface: Get Runtime of API response
ResponseInterface::getColumn() — Method in class ResponseInterface: Get column by column name
ResponseInterface::getColumnIndex() — Method in class ResponseInterface: Get Data by Column Name and Index
ResponseInterface::getColumnKeys() — Method in class ResponseInterface: Get Column Names
ResponseInterface::getColumns() — Method in class ResponseInterface: Get List of Columns
ResponseInterface::getCommand() — Method in class ResponseInterface: Get Command used in this request
ResponseInterface::getCommandPlain() — Method in class ResponseInterface: Get Command used in this request in plain text format
ResponseInterface::getCurrentPageNumber() — Method in class ResponseInterface: Get Page Number of current List Query
ResponseInterface::getCurrentRecord() — Method in class ResponseInterface: Get Record of current record index
ResponseInterface::getFirstRecordIndex() — Method in class ResponseInterface: Get Index of first row in this response
ResponseInterface::getLastRecordIndex() — Method in class ResponseInterface: Get last record index of the current list query
ResponseInterface::getListHash() — Method in class ResponseInterface: Get Response as List Hash including useful meta data for tables
ResponseInterface::getNextRecord() — Method in class ResponseInterface: Get next record in record list
ResponseInterface::getNextPageNumber() — Method in class ResponseInterface: Get Page Number of next list query
ResponseInterface::getNumberOfPages() — Method in class ResponseInterface: Get the number of pages available for this list query
ResponseInterface::getPagination() — Method in class ResponseInterface: Get object containing all paging data
ResponseInterface::getPreviousPageNumber() — Method in class ResponseInterface: Get Page Number of previous list query
ResponseInterface::getPreviousRecord() — Method in class ResponseInterface: Get previous record in record list
ResponseInterface::getRecord() — Method in class ResponseInterface: Get Record at given index
ResponseInterface::getRecords() — Method in class ResponseInterface: Get all Records
ResponseInterface::getRecordsCount() — Method in class ResponseInterface: Get count of rows in this response
ResponseInterface::getRecordsTotalCount() — Method in class ResponseInterface: Get total count of records available for the list query
ResponseInterface::getRecordsLimitation() — Method in class ResponseInterface: Get limit(ation) setting of the current list query This is the count of requested rows

H

$ Response#hash — Property in class Response: hash representation of plain API response
Response::hasNextPage() — Method in class Response: Check if this list query has a next page
Response::hasPreviousPage() — Method in class Response: Check if this list query has a previous page
ResponseTemplateManager::hasTemplate() — Method in class ResponseTemplateManager: Check if given template exists in template container
Response::hasNextPage() — Method in class Response: Check if this list query has a next page
Response::hasPreviousPage() — Method in class Response: Check if this list query has a previous page
ResponseTemplateManager::hasTemplate() — Method in class ResponseTemplateManager: Check if given template exists in template container
ResponseInterface::hasNextPage() — Method in class ResponseInterface: Check if this list query has a next page
ResponseInterface::hasPreviousPage() — Method in class ResponseInterface: Check if this list query has a previous page

I

$ Client#isOTE — Property in class Client: is connected to OT&E
Client::IDNConvert() — Method in class Client: Convert domain names to idn + punycode if necessary
Response::isError() — Method in class Response: Check if current API response represents an error case API response code is an 5xx code
Response::isSuccess() — Method in class Response: Check if current API response represents a success case API response code is an 2xx code
Response::isTmpError() — Method in class Response: Check if current API response represents a temporary error case API response code is an 4xx code
Response::isPending() — Method in class Response: Check if current operation is returned as pending
ResponseTemplateManager::isTemplateMatchHash() — Method in class ResponseTemplateManager: Check if given API response hash matches a given template by code and description
ResponseTemplateManager::isTemplateMatchPlain() — Method in class ResponseTemplateManager: Check if given API plain response matches a given template by code and description
Response::isError() — Method in class Response: Check if current API response represents an error case API response code is an 5xx code
Response::isSuccess() — Method in class Response: Check if current API response represents a success case API response code is an 2xx code
Response::isTmpError() — Method in class Response: Check if current API response represents a temporary error case
Response::isPending() — Method in class Response: Check if current operation is returned as pending
ResponseTemplateManager::isTemplateMatchHash() — Method in class ResponseTemplateManager: Check if given API response hash matches a given template by code and description
ResponseTemplateManager::isTemplateMatchPlain() — Method in class ResponseTemplateManager: Check if given API plain response matches a given template by code and description
ResponseInterface::isError() — Method in class ResponseInterface: Check if current API response represents an error case API response code is an 5xx code
ResponseInterface::isSuccess() — Method in class ResponseInterface: Check if current API response represents a success case API response code is an 2xx code
ResponseInterface::isTmpError() — Method in class ResponseInterface: Check if current API response represents a temporary error case API response code is an 4xx code
ResponseInterface::isPending() — Method in class ResponseInterface: Check if current operation is returned as pending

L

$ Client#logger — Property in class Client: logger function name for debug mode
$ Column#length — Property in class Column: count of column data entries
Logger — Class in namespace CNIC\CNR: CNR Logger
Logger::log() — Method in class Logger: output/log given data
SessionClient::login() — Method in class SessionClient: Perform API login to start session-based communication
SessionClient::logout() — Method in class SessionClient: Perform API logout to close API session in use
$ SocketConfig#login — Property in class SocketConfig: account name
Logger — Class in namespace CNIC\IBS: IBS Logger
Logger::log() — Method in class Logger: Output/log given data
SessionClient::login() — Method in class SessionClient: Perform API login to start session-based communication
SessionClient::logout() — Method in class SessionClient: Perform API logout to close API session in use
$ SocketConfig#login — Property in class SocketConfig: account name
LoggerInterface — Class in namespace CNIC: Common Logger Interface
LoggerInterface::log() — Method in class LoggerInterface: Output/log given data

P

$ Response#paginationkeys — Property in class Response: Regex for pagination related column keys
ResponseParser::parse() — Method in class ResponseParser: Method to parse plain API response into js object
$ SocketConfig#pw — Property in class SocketConfig: account password
$ SocketConfig#parameters — Property in class SocketConfig: list of http request parameters
$ Response#paginationkeys — Property in class Response: Regex for pagination related column keys
ResponseParser::parse() — Method in class ResponseParser: Method to parse API response into associative array
$ SocketConfig#pw — Property in class SocketConfig: account password
$ SocketConfig#parameters — Property in class SocketConfig: list of http request parameters

R

Client::request() — Method in class Client: Perform API request using the given command
Client::requestNextResponsePage() — Method in class Client: Request the next page of list entries for the current list query Useful for tables
Client::requestAllResponsePages() — Method in class Client: Request all pages/entries for the given query command
Record — Class in namespace CNIC\CNR: CNR Record
Response — Class in namespace CNIC\CNR: CNR Response
$ Response#raw — Property in class Response: plain API response
$ Response#recordIndex — Property in class Response: Record Index we currently point to in record list
$ Response#records — Property in class Response: Record List (List of rows)
$ Response#requestUrl — Property in class Response: API request url
Response::rewindRecordList() — Method in class Response: Reset index in record list back to zero
ResponseParser — Class in namespace CNIC\CNR: CNR ResponseParser
ResponseTemplateManager — Class in namespace CNIC\CNR: CNR ResponseTemplateManager
ResponseTranslator — Class in namespace CNIC\CNR: CNR ResponseTranslator
ResponseTranslator::replacePlaceholders() — Method in class ResponseTranslator: Replace known placeholders in DESCRIPTION while preserving literal brace content.
SessionClient::reuseSession() — Method in class SessionClient: Use existing configuration out of php session object to rebuild and reuse connection settings
$ SocketConfig#remoteaddr — Property in class SocketConfig: remote ip address (ip filter)
Client::request() — Method in class Client: Perform API request using the given command
Record — Class in namespace CNIC\IBS: IBS Record
Response — Class in namespace CNIC\IBS: IBS Response
Response::rewindRecordList() — Method in class Response: Reset index in record list back to zero
ResponseParser — Class in namespace CNIC\IBS: IBS ResponseParser
ResponseTemplateManager — Class in namespace CNIC\IBS: IBS ResponseTemplateManager
ResponseTranslator — Class in namespace CNIC\IBS: IBS ResponseTranslator
ResponseTranslator::replacePlaceholders() — Method in class ResponseTranslator: Replace placeholder vars like {CONNECTION_URL} in a string
SessionClient::reuseSession() — Method in class SessionClient: Use existing configuration out of php session object to rebuild and reuse connection settings
$ SocketConfig#remoteaddr — Property in class SocketConfig: remote ip address (ip filter)
RecordInterface — Class in namespace CNIC: Common Record Interface
ResponseInterface — Class in namespace CNIC: Common Response Interface
ResponseInterface::rewindRecordList() — Method in class ResponseInterface: Reset index in record list back to zero

S

$ Client#settings — Property in class Client: registrar api settings
$ Client#socketURL — Property in class Client: API connection url
$ Client#socketConfig — Property in class Client: Object covering API connection data
Client::setCustomLogger() — Method in class Client: set custom logger to use instead of default one create your own class implementing \CNIC\LoggerInterface
Client::setDefaultLogger() — Method in class Client: set default logger to use
Client::setUserAgent() — Method in class Client: Set a custom user agent (for platforms that use this SDK)
Client::setProxy() — Method in class Client: Set proxy to use for API communication
Client::setReferer() — Method in class Client: Set Referer to use for API communication
Client::setURL() — Method in class Client: Set another connection url to be used for API communication
Client::setSession() — Method in class Client: Set an API session id to be used for API communication
Client::setRemoteIPAddress() — Method in class Client: Set an Remote IP Address to be used for API communication To be used in case you have an active ip filter setting.
Client::setCredentials() — Method in class Client: Set Credentials to be used for API communication
Client::setRoleCredentials() — Method in class Client: Set Credentials to be used for API communication
Client::setUserView() — Method in class Client: Set a data view to a given subuser
Client::setContext() — Method in class Client: Set context data for the client (to be used in a custom logger to access additional data at logging time again) The use of this context data is optional and has no impact on the SDK behaviour itself.
SessionClient — Class in namespace CNIC\CNR: CNR Session API Client
SessionClient::saveSession() — Method in class SessionClient: Apply session data (session id, login) to given php session object
SocketConfig — Class in namespace CNIC\CNR: CNR SocketConfig
$ SocketConfig#session — Property in class SocketConfig: API session id
SocketConfig::setPersistent() — Method in class SocketConfig: Add persistent parameter to request (request API session)
SocketConfig::setLogin() — Method in class SocketConfig: Set account name to use
SocketConfig::setPassword() — Method in class SocketConfig: Set account password to use
SocketConfig::setRemoteAddress() — Method in class SocketConfig: Set Remote IP Address to use
SocketConfig::setSession() — Method in class SocketConfig: Set API Session ID to use
SocketConfig::setUser() — Method in class SocketConfig: Set subuser account name (for subuser data view)
Client::setSession() — Method in class Client: Set an API session id to be used for API communication
Client::setRoleCredentials() — Method in class Client: Set Credentials to be used for API communication Note: not supported.
Client::setUserView() — Method in class Client: Set a data view to a given subuser Note: not supported.
Client::setDefaultLogger() — Method in class Client: Set default logger to use
SessionClient — Class in namespace CNIC\IBS: IBS API Client
SessionClient::saveSession() — Method in class SessionClient: Apply session data (session id, login) to given php session object
SocketConfig — Class in namespace CNIC\IBS: IBS SocketConfig
SocketConfig::setLogin() — Method in class SocketConfig: Set account name to use
SocketConfig::setPassword() — Method in class SocketConfig: Set account password to use
SocketConfig::setRemoteAddress() — Method in class SocketConfig: Set Remote IP Address to use
SessionClient — Class in namespace CNIC\MONIKER: MONIKER API Client

T

$ ResponseTemplateManager#templates — Property in class ResponseTemplateManager: Template container
ResponseTranslator::translate() — Method in class ResponseTranslator: translate a raw api response
$ ResponseTemplateManager#templates — Property in class ResponseTemplateManager: template container
ResponseTranslator::translate() — Method in class ResponseTranslator: translate a raw api response

U

$ Client#ua — Property in class Client: user agent
Client::useHighPerformanceConnectionSetup() — Method in class Client: Activate High Performance Setup
Client::useOTESystem() — Method in class Client: Set OT&E System for API communication
Client::useLIVESystem() — Method in class Client: Set LIVE System for API communication (this is the default setting)
$ SocketConfig#user — Property in class SocketConfig: subuser account name (subuser specific data view)
Client::useHighPerformanceConnectionSetup() — Method in class Client: Activate High Performance Setup Note: not supported.

_

Client::__construct() — Method in class Client: Constructor
Column::__construct() — Method in class Column: Constructor
Record::__construct() — Method in class Record: Constructor e.g.
Response::__construct() — Method in class Response: Constructor
SessionClient::__construct() — Method in class SessionClient: Constructor
SocketConfig::__construct() — Method in class SocketConfig: Constructor
ColumnInterface::__construct() — Method in class ColumnInterface: Constructor
Client::__construct() — Method in class Client: Constructor
Response::__construct() — Method in class Response: Constructor
SessionClient::__construct() — Method in class SessionClient: Constructor
SocketConfig::__construct() — Method in class SocketConfig: Constructor
RecordInterface::__construct() — Method in class RecordInterface: Constructor e.g.
ResponseInterface::__construct() — Method in class ResponseInterface: Constructor