Zend Framework  3.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AbstractCallback Class Reference

Public Member Functions

 __construct ($options=null)
 Constructor; accepts an array or Traversable object to preset options for the Subscriber without calling all supported setter methods in turn.
 
 setOptions ($options)
 Process any injected configuration options.
 
 sendResponse ()
 Send the response, including all headers.
 
 setStorage (Model\SubscriptionPersistenceInterface $storage)
 Sets an instance of Zend used to background save any verification tokens associated with a subscription or other.
 
 getStorage ()
 Gets an instance of Zend used to background save any verification tokens associated with a subscription or other.
 
 setHttpResponse ($httpResponse)
 An instance of a class handling Http Responses.
 
 getHttpResponse ()
 An instance of a class handling Http Responses.
 
 setSubscriberCount ($count)
 Sets the number of Subscribers for which any updates are on behalf of.
 
 getSubscriberCount ()
 Gets the number of Subscribers for which any updates are on behalf of.
 
- Public Member Functions inherited from CallbackInterface
 handle (array $httpData=null, $sendResponseNow=false)
 Handle any callback from a Hub Server responding to a subscription or unsubscription request.
 

Protected Member Functions

 _detectCallbackUrl ()
 Attempt to detect the callback URL (specifically the path forward)
 
 _getHttpHost ()
 Get the HTTP host.
 
 _getHeader ($header)
 Retrieve a Header value from either $_SERVER or Apache.
 
 _getRawBody ()
 Return the raw body of the request.
 

Protected Attributes

 $storage = null
 
 $httpResponse = null
 
 $subscriberCount = 1
 

Constructor & Destructor Documentation

__construct (   $options = null)

Constructor; accepts an array or Traversable object to preset options for the Subscriber without calling all supported setter methods in turn.

Parameters
array | Traversable$optionsOptions array or Traversable object

Member Function Documentation

_detectCallbackUrl ( )
protected

Attempt to detect the callback URL (specifically the path forward)

Returns
string
_getHeader (   $header)
protected

Retrieve a Header value from either $_SERVER or Apache.

Parameters
string$header
Returns
bool|string
_getHttpHost ( )
protected

Get the HTTP host.

Returns
string
_getRawBody ( )
protected

Return the raw body of the request.

Returns
string|false Raw body, or false if not present
getHttpResponse ( )

An instance of a class handling Http Responses.

This is implemented in Zend which shares an unenforced interface with (i.e. not inherited from) Zend.

Returns
HttpResponse|PhpResponse

Implements CallbackInterface.

getStorage ( )

Gets an instance of Zend used to background save any verification tokens associated with a subscription or other.

Returns
Model
Exceptions
Exception\RuntimeException
getSubscriberCount ( )

Gets the number of Subscribers for which any updates are on behalf of.

In other words, is this class serving one or more subscribers? How many?

Returns
int
sendResponse ( )

Send the response, including all headers.

If you wish to handle this via Zend, use the getter methods to retrieve any data needed to be set on your HTTP Response object, or simply give this object the HTTP Response instance to work with for you!

Returns
void

Implements CallbackInterface.

setHttpResponse (   $httpResponse)

An instance of a class handling Http Responses.

This is implemented in Zend which shares an unenforced interface with (i.e. not inherited from) Zend.

Parameters
HttpResponse | PhpResponse$httpResponse
Returns
AbstractCallback
Exceptions
Exception\InvalidArgumentException

Implements CallbackInterface.

setOptions (   $options)

Process any injected configuration options.

Parameters
array | Traversable$optionsOptions array or Traversable object
Returns
AbstractCallback
Exceptions
Exception\InvalidArgumentException
setStorage ( Model\SubscriptionPersistenceInterface  $storage)

Sets an instance of Zend used to background save any verification tokens associated with a subscription or other.

Parameters
Model\SubscriptionPersistenceInterface$storage
Returns
AbstractCallback
setSubscriberCount (   $count)

Sets the number of Subscribers for which any updates are on behalf of.

In other words, is this class serving one or more subscribers? How many? Defaults to 1 if left unchanged.

Parameters
string | int$count
Returns
AbstractCallback
Exceptions
Exception\InvalidArgumentException

Member Data Documentation

$httpResponse = null
protected
$storage = null
protected
$subscriberCount = 1
protected