API Documentation
\
CallFire
Common
Subscription
Resource
Hydrator
Api
Rest
Request
Client
Response
Http
Soap
Request
Structure
Response

\CallFire\CommonSubscription

Summary

Methods
Properties
Constants
is_event_request()
event()
fromXml()
fromJson()
createXPath()
loadXml()
parseResourceNode()
getSubscriptionId()
setSubscriptionId()
getXPath()
setXPath()
getHydrator()
setHydrator()
getDomHydrator()
setDomHydrator()
getQueryMap()
setQueryMap()
getResource()
setResource()
$eventContentTypes
FORMAT_XML
FORMAT_JSON
getXmlDocument()
cleanup()
$namespaces
$subscriptionId
$xpath
$hydrator
$domHydrator
$queryMap
N/A
loadQueryMap()
No private properties found
N/A

Constants

FORMAT_XML

FORMAT_XML

FORMAT_JSON

FORMAT_JSON

Properties

$eventContentTypes

$eventContentTypes

$namespaces

$namespaces

$subscriptionId

$subscriptionId

$xpath

$xpath

$hydrator

$hydrator

$domHydrator

$domHydrator

$queryMap

$queryMap

Methods

is_event_request()

is_event_request(array $requestData, array $contentTypes) : string

Determines if the request is an event notification, and returns the corresponding format identifier.

Parameters

array $requestData

= null
array $contentTypes

= null

Returns

string

event()

event( $postData,  $format)

Parameters

$postData
$format

fromXml()

fromXml( $document)

Parameters

$document

fromJson()

fromJson( $data)

Parameters

$data

createXPath()

createXPath(\DOMDocument $document)

Parameters

\DOMDocument $document

loadXml()

loadXml(\DOMDocument $document, \DOMNode $contextNode,  $cleanup)

Parameters

\DOMDocument $document
\DOMNode $contextNode
$cleanup

parseResourceNode()

parseResourceNode(\DOMNode $resourceNode)

Parameters

\DOMNode $resourceNode

getSubscriptionId()

getSubscriptionId()

setSubscriptionId()

setSubscriptionId( $subscriptionId)

Parameters

$subscriptionId

getXPath()

getXPath()

setXPath()

setXPath( $xpath)

Parameters

$xpath

getHydrator()

getHydrator()

setHydrator()

setHydrator( $hydrator)

Parameters

$hydrator

getDomHydrator()

getDomHydrator()

setDomHydrator()

setDomHydrator( $domHydrator)

Parameters

$domHydrator

getQueryMap()

getQueryMap()

setQueryMap()

setQueryMap( $queryMap)

Parameters

$queryMap

getResource()

getResource()

setResource()

setResource( $resource)

Parameters

$resource

getXmlDocument()

getXmlDocument( $document)

Parameters

$document

cleanup()

cleanup()

loadQueryMap()

loadQueryMap()