CallbackInterface.php in Zircon Profile 8

Namespace

Zend\Feed\PubSubHubbub

File

vendor/zendframework/zend-feed/src/PubSubHubbub/CallbackInterface.php

<?php

/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the canonical source repository
 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 */
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();

}

Interfaces

Name	Description
CallbackInterface