Tariqa SOAP
 All Data Structures Namespaces Files Functions Variables Enumerations
tariqaIDOL Class Reference
Inheritance diagram for tariqaIDOL:
Tariqa

Public Member Functions

 __construct ($config, $soap)
 IDOLSearch ($token, $query)
 IDOLGetDocument ($token, $id, $url, $highlight=null)

Data Fields

 $soap

Protected Member Functions

 IDOLParseResponse ($doc)
 _IDOLSearch ($query)
 _IDOLGetDocument ($id, $url, $highlight=null)
 IDOLTransformDocument ($doc, $matrix, $obj)

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

_IDOLGetDocument ( id,
url,
highlight = null 
) [protected]

Gets an IDOL document without authentication

Parameters:
int$idThe document id
string$urlThe IDOL url
string$highlightThe terms to be highlighted [OPTIONAL] protected
Returns:
IDOLDocument
_IDOLSearch ( query) [protected]

Performs an IDOL search without authentication

Parameters:
IDOLQuery$queryThe query protected
Returns:
IDOLResultSet
IDOLGetDocument ( token,
id,
url,
highlight = null 
)

Gets an IDOL document

Parameters:
string$tokenThe token identifier
int$idThe document id
string$urlThe IDOL url
string$highlightThe terms to be highlighted [OPTIONAL] public
Returns:
IDOLDocument
IDOLParseResponse ( doc) [protected]

Parse the document data from an IDOL response XML

Parameters:
DOMDocument$docThe IDOL document protected
Returns:
IDOLDocument[]
IDOLSearch ( token,
query 
)

Performs an IDOL search

Parameters:
string$tokenThe token identifier
IDOLQuery$queryThe query public
Returns:
IDOLResultSet
IDOLTransformDocument ( doc,
matrix,
obj 
) [protected]

Transfors an IDOL Document into a given class. The result is returned as an associative array which can then be json decoded setting array to false so we will have a new class.

Parameters:
IDOLDocument$docThe document
array$matrixThe transformation matrix (an associative array in which the keys are the new class methods and the values are the IDOL document keys)
object$objThe object in which the document will be transformed protected
Returns:
object

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


The documentation for this class was generated from the following file: