API Documentation

Zend/Feed/Pubsubhubbub/Subscriber/Callback.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Feed_Pubsubhubbub  
Version
$Id: Callback.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Feed_Pubsubhubbub_Subscriber_Callback

Package: Zend\Feed\Pubsubhubbub

Parent(s)
\Zend_Feed_Pubsubhubbub_CallbackAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_currentSubscriptionData= 'null'

After verification, this is set to the verified subscription's data.

Default valuenullDetails
Type
array
Propertyprotectedstring  $_feedUpdate= 'null'

Contains the content of any feeds sent as updates to the Callback URL

Default valuenullDetails
Type
string
Propertyprotectedstring  $_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.

Default valuenullDetails
Type
string

Methods

methodprotected_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).

Parameters
Name Type Description
$httpGetData null|array
Returns
Type Description
false|string
methodprotected_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.

Parameters
Name Type Description
$httpGetData array
$checkValue bool
Returns
Type Description
bool
methodprotected_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.

Returns
Type Description
array|void
methodpublicgetFeedUpdate( ) : string

Gets a newly received feed (Atom/RSS) sent by a Hub as an update to a Topic we've subscribed to.

Returns
Type Description
string
methodpublichandle( 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.

Parameters
Name Type Description
$httpGetData array

GET data if available and not in $_GET

$sendResponseNow bool

Whether to send response now or when asked

methodpublichasFeedUpdate( ) : bool

Check if any newly received feed (Atom/RSS) update was received

Returns
Type Description
bool
methodpublicisValidHubVerification( array $httpGetData ) : bool

Checks validity of the request simply by making a quick pass and confirming the presence of all REQUIRED parameters.

Parameters
Name Type Description
$httpGetData array
Returns
Type Description
bool
methodpublicsetFeedUpdate( 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.

Parameters
Name Type Description
$feed string
Returns
Type Description
\Zend_Feed_Pubsubhubbub_Subscriber_Callback
methodpublicsetSubscriptionKey( 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.

Parameters
Name Type Description
$key string
Returns
Type Description
\Zend_Feed_Pubsubhubbub_Subscriber_Callback
Documentation was generated by DocBlox 0.15.1.