Feed/Pubsubhubbub/CallbackInterface.php

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Feed_Pubsubhubbub
0017  * @subpackage Callback
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022
0023 /**
0024  * @category   Zend
0025  * @package    Zend_Feed_Pubsubhubbub
0026  * @subpackage Callback
0027  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0028  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0029  */
0030 interface Zend_Feed_Pubsubhubbub_CallbackInterface
0031 {
0032     /**
0033      * Handle any callback from a Hub Server responding to a subscription or
0034      * unsubscription request. This should be the Hub Server confirming the
0035      * the request prior to taking action on it.
0036      *
0037      * @param array $httpData GET/POST data if available and not in $_GET/POST
0038      * @param bool $sendResponseNow Whether to send response now or when asked
0039      */
0040     public function handle(array $httpData = null, $sendResponseNow = false);
0041
0042     /**
0043      * Send the response, including all headers.
0044      * If you wish to handle this via Zend_Controller, use the getter methods
0045      * to retrieve any data needed to be set on your HTTP Response object, or
0046      * simply give this object the HTTP Response instance to work with for you!
0047      *
0048      * @return void
0049      */
0050     public function sendResponse();
0051
0052     /**
0053      * An instance of a class handling Http Responses. This is implemented in
0054      * Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with
0055      * (i.e. not inherited from) Zend_Controller_Response_Http.
0056      *
0057      * @param Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http $httpResponse
0058      */
0059     public function setHttpResponse($httpResponse);
0060
0061     /**
0062      * An instance of a class handling Http Responses. This is implemented in
0063      * Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with
0064      * (i.e. not inherited from) Zend_Controller_Response_Http.
0065      *
0066      * @return Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http
0067      */
0068     public function getHttpResponse();
0069 }