aleph1.co.uk Git - yaffs-website/blob - vendor/zendframework/zend-feed/src/PubSubHubbub/CallbackInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Feed\PubSubHubbub;
  11
  12 interface CallbackInterface
  13 {
  14     /**
  15      * Handle any callback from a Hub Server responding to a subscription or
  16      * unsubscription request. This should be the Hub Server confirming the
  17      * the request prior to taking action on it.
  18      *
  19      * @param array $httpData GET/POST data if available and not in $_GET/POST
  20      * @param bool $sendResponseNow Whether to send response now or when asked
  21      */
  22     public function handle(array $httpData = null, $sendResponseNow = false);
  23
  24     /**
  25      * Send the response, including all headers.
  26      * If you wish to handle this via Zend\Mvc\Controller, use the getter methods
  27      * to retrieve any data needed to be set on your HTTP Response object, or
  28      * simply give this object the HTTP Response instance to work with for you!
  29      *
  30      * @return void
  31      */
  32     public function sendResponse();
  33
  34     /**
  35      * An instance of a class handling Http Responses. This is implemented in
  36      * Zend\Feed\Pubsubhubbub\HttpResponse which shares an unenforced interface with
  37      * (i.e. not inherited from) Zend\Feed\Pubsubhubbub\AbstractCallback.
  38      *
  39      * @param HttpResponse|\Zend\Http\PhpEnvironment\Response $httpResponse
  40      */
  41     public function setHttpResponse($httpResponse);
  42
  43     /**
  44      * An instance of a class handling Http Responses. This is implemented in
  45      * Zend\Feed\Pubsubhubbub\HttpResponse which shares an unenforced interface with
  46      * (i.e. not inherited from) Zend\Feed\Pubsubhubbub\AbstractCallback.
  47      *
  48      * @return HttpResponse|\Zend\Http\PhpEnvironment\Response
  49      */
  50     public function getHttpResponse();
  51 }