interface CallbackInterface in Zircon Profile 8

Hierarchy

• interface \Zend\Feed\PubSubHubbub\CallbackInterface

File

vendor/zendframework/zend-feed/src/PubSubHubbub/CallbackInterface.php, line 12

Namespace

Zend\Feed\PubSubHubbub

interface CallbackInterface {

  /**
   * 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.
   *
   * @param array $httpData GET/POST data if available and not in $_GET/POST
   * @param bool $sendResponseNow Whether to send response now or when asked
   */
  public function handle(array $httpData = null, $sendResponseNow = false);

  /**
   * Send the response, including all headers.
   * If you wish to handle this via Zend\Mvc\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!
   *
   * @return void
   */
  public function sendResponse();

  /**
   * 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\Feed\Pubsubhubbub\AbstractCallback.
   *
   * @param HttpResponse|\Zend\Http\PhpEnvironment\Response $httpResponse
   */
  public function setHttpResponse($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\Feed\Pubsubhubbub\AbstractCallback.
   *
   * @return HttpResponse|\Zend\Http\PhpEnvironment\Response
   */
  public function getHttpResponse();

}

Members

Name	Modifiers	Type	Description	Overrides
CallbackInterface::getHttpResponse	public	function	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\Feed\Pubsubhubbub\AbstractCallback.	1
CallbackInterface::handle	public	function	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.
CallbackInterface::sendResponse	public	function	Send the response, including all headers. If you wish to handle this via Zend\Mvc\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…	1
CallbackInterface::setHttpResponse	public	function	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\Feed\Pubsubhubbub\AbstractCallback.	1