|
1 <?php |
|
2 /** |
|
3 * Zend Framework |
|
4 * |
|
5 * LICENSE |
|
6 * |
|
7 * This source file is subject to the new BSD license that is bundled |
|
8 * with this package in the file LICENSE.txt. |
|
9 * It is also available through the world-wide-web at this URL: |
|
10 * http://framework.zend.com/license/new-bsd |
|
11 * If you did not receive a copy of the license and are unable to |
|
12 * obtain it through the world-wide-web, please send an email |
|
13 * to license@zend.com so we can send you a copy immediately. |
|
14 * |
|
15 * @category Zend |
|
16 * @package Zend_Feed_Pubsubhubbub |
|
17 * @subpackage Callback |
|
18 * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
|
19 * @license http://framework.zend.com/license/new-bsd New BSD License |
|
20 * @version $Id: CallbackInterface.php 20785 2010-01-31 09:43:03Z mikaelkael $ |
|
21 */ |
|
22 |
|
23 /** |
|
24 * @category Zend |
|
25 * @package Zend_Feed_Pubsubhubbub |
|
26 * @subpackage Callback |
|
27 * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
|
28 * @license http://framework.zend.com/license/new-bsd New BSD License |
|
29 */ |
|
30 interface Zend_Feed_Pubsubhubbub_CallbackInterface |
|
31 { |
|
32 /** |
|
33 * Handle any callback from a Hub Server responding to a subscription or |
|
34 * unsubscription request. This should be the Hub Server confirming the |
|
35 * the request prior to taking action on it. |
|
36 * |
|
37 * @param array $httpData GET/POST data if available and not in $_GET/POST |
|
38 * @param bool $sendResponseNow Whether to send response now or when asked |
|
39 */ |
|
40 public function handle(array $httpData = null, $sendResponseNow = false); |
|
41 |
|
42 /** |
|
43 * Send the response, including all headers. |
|
44 * If you wish to handle this via Zend_Controller, use the getter methods |
|
45 * to retrieve any data needed to be set on your HTTP Response object, or |
|
46 * simply give this object the HTTP Response instance to work with for you! |
|
47 * |
|
48 * @return void |
|
49 */ |
|
50 public function sendResponse(); |
|
51 |
|
52 /** |
|
53 * An instance of a class handling Http Responses. This is implemented in |
|
54 * Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with |
|
55 * (i.e. not inherited from) Zend_Controller_Response_Http. |
|
56 * |
|
57 * @param Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http $httpResponse |
|
58 */ |
|
59 public function setHttpResponse($httpResponse); |
|
60 |
|
61 /** |
|
62 * An instance of a class handling Http Responses. This is implemented in |
|
63 * Zend_Feed_Pubsubhubbub_HttpResponse which shares an unenforced interface with |
|
64 * (i.e. not inherited from) Zend_Controller_Response_Http. |
|
65 * |
|
66 * @return Zend_Feed_Pubsubhubbub_HttpResponse|Zend_Controller_Response_Http |
|
67 */ |
|
68 public function getHttpResponse(); |
|
69 } |