Queue/Stomp/FrameInterface.php

Show: PublicProtectedPrivateinherited
    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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_Queue  
    Subpackage
    Stomp  
    Version
    $Id$  

    \Zend_Queue_Stomp_FrameInterface
    jump to top

    Package: Zend_Queue\Stomp
    This class represents a Stomp Frame Interface
    Category
    Zend  
    Copyright
    Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

    methodpublic__toString() : void

    Details
    See
     
    methodpublicfromFrame(string $frame) : \Zend_Queue_Stomp_FrameInterface

    Accepts a frame and deconstructs the frame into its' component parts

    Parameters
    NameTypeDescription
    $framestring
    • a stomp frame
    Returns
    TypeDescription
    \Zend_Queue_Stomp_FrameInterface
    Details
    Fluent
    This method is part of a fluent interface and will return the same instance  
    methodpublicgetAutoContentLength() : boolean

    Get the status of the auto content length

    If AutoContentLength is true this code will automatically put the content-length header in, even if it is already set by the user. This is done to make the message sending more reliable.
    Returns
    TypeDescription
    boolean
    methodpublicgetBody() : \Zend_Queue_Stomp_FrameInterface

    Return the body for this frame returns false if the body does not exist

    Returns
    TypeDescription
    \Zend_Queue_Stomp_FrameInterface
    Details
    Fluent
    This method is part of a fluent interface and will return the same instance  
    methodpublicgetCommand() : \Zend_Queue_Stomp_FrameInterface

    Return the command for this frame return false if the command does not exist

    Returns
    TypeDescription
    \Zend_Queue_Stomp_FrameInterface
    Details
    Fluent
    This method is part of a fluent interface and will return the same instance  
    methodpublicgetHeader(string $header) : \$string

    Returns a value for a header returns false if the header does not exist

    Parameters
    NameTypeDescription
    $headerstring
    Returns
    TypeDescription
    \$string
    Throws
    ExceptionDescription
    \Zend_Queue_Exception
    methodpublicgetHeaders() : array

    Get the headers

    Returns
    TypeDescription
    array
    methodpublicsetAutoContentLength(boolean $auto) : \$this;

    setAutoContentLength()

    Set the value on or off.
    Parameters
    NameTypeDescription
    $autoboolean
    Returns
    TypeDescription
    \$this;
    Throws
    ExceptionDescription
    \Zend_Queue_Exception
    methodpublicsetBody(string | null $body) : \Zend_Queue_Stomp_FrameInterface

    Set the body for this frame returns false if the body does not exist

    Set to null for no body.
    Parameters
    NameTypeDescription
    $bodystring | null
    Returns
    TypeDescription
    \Zend_Queue_Stomp_FrameInterface
    Throws
    ExceptionDescription
    \Zend_Queue_Exception
    Details
    Fluent
    This method is part of a fluent interface and will return the same instance  
    methodpublicsetCommand( $command) : \Zend_Queue_Stomp_FrameInterface

    Set the body for this frame returns false if the body does not exist

    Parameters
    NameTypeDescription
    $command
    Returns
    TypeDescription
    \Zend_Queue_Stomp_FrameInterface
    Throws
    ExceptionDescription
    \Zend_Queue_Exception
    Details
    Fluent
    This method is part of a fluent interface and will return the same instance  
    methodpublicsetHeader(string $header, string $value) : \Zend_Queue_Stomp_FrameInterface

    Returns a value for a header returns false if the header does not exist

    Parameters
    NameTypeDescription
    $headerstring
    $valuestring
    Returns
    TypeDescription
    \Zend_Queue_Stomp_FrameInterface
    Throws
    ExceptionDescription
    \Zend_Queue_Exception
    Details
    Fluent
    This method is part of a fluent interface and will return the same instance  
    methodpublicsetHeaders(array $headers) : \Zend_Queue_Stomp_FrameInterface

    Set the headers

    Throws an exception if the array values are not strings.
    Parameters
    NameTypeDescription
    $headersarray
    Returns
    TypeDescription
    \Zend_Queue_Stomp_FrameInterface
    Throws
    ExceptionDescription
    \Zend_Queue_Exception
    Details
    Fluent
    This method is part of a fluent interface and will return the same instance  
    methodpublictoFrame() : string

    Takes the current parameters and returns a Stomp Frame

    Returns
    TypeDescription
    string
    Throws
    ExceptionDescription
    \Zend_Queue_Exception
    Documentation was generated by phpDocumentor 2.2.0 .