API Documentation

Feed/Pubsubhubbub/CallbackInterface.php

Interfaces
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Pubsubhubbub
subpackage
Callback
Interfaces
Zend_Feed_Pubsubhubbub_CallbackInterface

Description

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.

Zend_Feed_Pubsubhubbub_CallbackInterface

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Pubsubhubbub
subpackage
Callback
Methods
handle
sendResponse
setHttpResponse
getHttpResponse

Description

Methods

getHttpResponse

getHttpResponse( ) : Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http

An instance of a class handling Http Responses. This is implemented in Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with (i.e. not inherited from) Zend_Controller_Response_Http.

Details
visibility
public
final
false
static
false

handle

handle( array $httpData = null, bool $sendResponseNow = false ) :

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.

Arguments
$httpData
array
GET/POST data if available and not in $_GET/POST
$sendResponseNow
bool
Whether to send response now or when asked
Details
visibility
public
final
false
static
false

sendResponse

sendResponse( ) : void

Send the response, including all headers.

If you wish to handle this via Zend_Controller, 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!

Details
visibility
public
final
false
static
false

setHttpResponse

setHttpResponse( Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http $httpResponse ) :

An instance of a class handling Http Responses. This is implemented in Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with (i.e. not inherited from) Zend_Controller_Response_Http.

Arguments
$httpResponse
Zend_Feed_Pubsubhubbub_HttpResponseZend_Controller_Response_Http
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.