API Documentation

Zend/Feed/Pubsubhubbub/CallbackInterface.php

Show: inherited
    Table of Contents

    Zend Framework

    LICENSE

    This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_Feed_Pubsubhubbub  
    Subpackage
    Callback  
    Version
    $Id: CallbackInterface.php 24594 2012-01-05 21:27:01Z matthew $  

    \Zend_Feed_Pubsubhubbub_CallbackInterface

    Package: Zend\Feed\Pubsubhubbub\Callback

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

    methodpublicgetHttpResponse( ) : \Zend_Feed_Pubsubhubbub_HttpResponse|\Zend_Controller_Response_Http

    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_Controller_Response_Http.

    methodpublichandle( array $httpData = null, bool $sendResponseNow = false ) : void

    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.

    Parameters
    Name Type Description
    $httpData array

    GET/POST data if available and not in $_GET/POST

    $sendResponseNow bool

    Whether to send response now or when asked

    methodpublicsendResponse( ) : void

    Send the response, including all headers.

    If you wish to handle this via Zend_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!

    methodpublicsetHttpResponse( \Zend_Feed_Pubsubhubbub_HttpResponse|\Zend_Controller_Response_Http $httpResponse ) : void

    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_Controller_Response_Http.

    Parameters
    Name Type Description
    $httpResponse \Zend_Feed_Pubsubhubbub_HttpResponse|\Zend_Controller_Response_Http
    Documentation was generated by DocBlox 0.15.1.