Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

array
$_currentSubscriptionData= 'null'
After verification, this is set to the verified subscription's data.
null
Details
string
$_feedUpdate= 'null'
Contains the content of any feeds sent as updates to the Callback URL
null
Details
string
$_subscriptionKey= 'null'
Holds a manually set subscription key (i.e. identifies a unique subscription) which is typical when it is not passed in the query string but is part of the Callback URL path, requiring manual retrieval e.g.
using a route and the Zend_Controller_Action::_getParam() method.
null
Details
_detectVerifyTokenKey(
null|array $httpGetData
=
null
)
:
false|string
Attempt to detect the verification token key. This would be passed in the Callback URL (which we are handling with this class!) as a URI path part (the last part by convention).
Name | Type | Description |
---|---|---|
$httpGetData | null|array |
Type | Description |
---|---|
false|string |

_hasValidVerifyToken(
array $httpGetData
=
null, bool $checkValue
=
true
)
:
bool
Check for a valid verify_token. By default attempts to compare values with that sent from Hub, otherwise merely ascertains its existence.
Name | Type | Description |
---|---|---|
$httpGetData | array | |
$checkValue | bool |
Type | Description |
---|---|
bool |

_parseQueryString(
)
:
array|void
Build an array of Query String parameters.
This bypasses $_GET which munges parameter names and cannot accept multiple parameters with the same key.
Type | Description |
---|---|
array|void |

getFeedUpdate(
)
:
string
Gets a newly received feed (Atom/RSS) sent by a Hub as an update to a Topic we've subscribed to.
Type | Description |
---|---|
string |

handle(
array $httpGetData
=
null, bool $sendResponseNow
=
false
)
:
void
Handle any callback from a Hub Server responding to a subscription or unsubscription request. This should be the Hub Server confirming the the request prior to taking action on it.
Name | Type | Description |
---|---|---|
$httpGetData | array | GET data if available and not in $_GET |
$sendResponseNow | bool | Whether to send response now or when asked |

hasFeedUpdate(
)
:
bool
Check if any newly received feed (Atom/RSS) update was received
Type | Description |
---|---|
bool |

isValidHubVerification(
array $httpGetData
)
:
bool
Checks validity of the request simply by making a quick pass and confirming the presence of all REQUIRED parameters.
Name | Type | Description |
---|---|---|
$httpGetData | array |
Type | Description |
---|---|
bool |

setFeedUpdate(
string $feed
)
:
\Zend_Feed_Pubsubhubbub_Subscriber_Callback
Sets a newly received feed (Atom/RSS) sent by a Hub as an update to a Topic we've subscribed to.
Name | Type | Description |
---|---|---|
$feed | string |
Type | Description |
---|---|
\Zend_Feed_Pubsubhubbub_Subscriber_Callback |

setSubscriptionKey(
string $key
)
:
\Zend_Feed_Pubsubhubbub_Subscriber_Callback
Set a subscription key to use for the current callback request manually.
Required if usePathParameter is enabled for the Subscriber.
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
\Zend_Feed_Pubsubhubbub_Subscriber_Callback |