AppserverIo\Stomp\Frame

Complexity

Total Complexity

21

Size/Duplication

Total Lines	250
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	0	Features	1

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getHeaders()	0	4	1
A	setHeaders()	0	12	3
A	getHeaderValueByKey()	0	4	2
A	setHeaderValueByKey()	0	9	2
A	getBody()	0	4	1
A	setBody()	0	9	2
A	__toString()	0	10	1
A	headersToString()	0	13	2
A	encodeHeaderString()	0	14	2
A	getHeaderEncodingRequired()	0	11	2
A	getCommand()	0	4	1
A	setCommand()	0	4	1

<?php

/**
 * \AppserverIo\Stomp\Frame
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Lars Roettig <lr@appserver.io>
 * @copyright 2016 TechDivision GmbH - <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      http://www.appserver.io/
 */

namespace AppserverIo\Stomp;

use AppserverIo\Stomp\Protocol\CommonValues;
use AppserverIo\Stomp\Protocol\Headers;
use AppserverIo\Stomp\Protocol\ServerCommands;
use AppserverIo\Stomp\Interfaces\FrameInterface;

/**
 * This class for stomp frame implementations.
 *
 * @author    Lars Roettig <lr@appserver.io>
 * @copyright 2016 TechDivision GmbH - <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      http://www.appserver.io/
 * @link      https://github.com/stomp/stomp-spec/blob/master/src/stomp-specification-1.1.md
 */
class Frame implements FrameInterface
{
    /**
     * Holds the const for stomp frame colon.
     *
     * @var string
     */
    const COLON = ':';

    /**
     * Holds the const for stomp frame escape.
     *
     * @var string
     */
    const ESCAPE = '\\';

    /**
     * Holds the const for stomp frame newline.
     *
     * @var string
     */
    const NEWLINE = "\n";

    /**
     * Holds the const for stomp frame null.
     *
     * @var string
     */
    const NULL = "\x00";

    /**
     * Holds the message command.
     *
     * @var string
     */
    protected $command;

    /**
     * Holds the message headers.
     *
     * @var array
     */
    protected $headers;

    /**
     * Holds the message body.
     *
     * @var string
     */
    protected $body;

    /**
     * Create new stomp protocol frame.
     *
     * @param string $command The message command.
     * @param array  $headers The message headers.
     * @param string $body    The message body.
     */
    public function __construct($command = null, array $headers = array(), $body = "")
    {
        $this->setCommand($command);
        $this->setHeaders($headers);
        $this->setBody($body);
    }

    /**
     * Returns the message headers.
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Set the headers.
     *
     * @param array $headers The headers to set.
     *
     * @return void
     *
     * @link http://stomp.github.io/stomp-specification-1.1.html#Repeated_Header_Entries
     */
    public function setHeaders(array $headers)
    {
        // prevents override all ready set header key
        if (is_array($this->headers)) {
            foreach ($headers as $key => $value) {
                // set the value for the given header key.
                $this->setHeaderValueByKey($key, $value);
            }
        } else {
            $this->headers = $headers;
        }
    }

    /**
     * Returns the value for the given header key.
     *
     * @param string $key The header to find the value
     *
     * @return string|null
     */
    public function getHeaderValueByKey($key)
    {
        return isset($this->headers[$key]) ? $this->headers[$key] : null;
    }

    /**
     * Set the value for the given header key.
     *
     * @param string $key   The header to find the value
     * @param string $value The value to set
     *
     * @return void
     */
    public function setHeaderValueByKey($key, $value)
    {
        // ignore already set header element
        if (isset($this->headers[$key])) {
            return;
        }

        $this->headers[$key] = $value;
    }

    /**
     * Returns the message body.
     *
     * @return string
     */
    public function getBody()
    {
        return $this->body;
    }

    /**
     * Set the body for the frame.
     *
     * @param string $body The body to set.
     *
     * @return void
     */
    public function setBody($body)
    {
        $this->body = $body;

        if (strlen($body) > 0) {
            $this->setHeaderValueByKey(Headers::CONTENT_TYPE, CommonValues::TEXT_PLAIN);
            $this->setHeaderValueByKey(Headers::CONTENT_LENGTH, strlen($body));
        }
    }

    /**
     * Returns the frame object as string.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->command .
        Frame::NEWLINE .
        $this->headersToString() .
        Frame::NEWLINE .
        $this->body .
        Frame::NULL .
        Frame::NEWLINE;
    }

    /**
     * Convert the frame headers to string.
     *
     * @return string
     */
    protected function headersToString()
    {
        $headerString = "";

        foreach ($this->headers as $key => $value) {
            $name = $this->encodeHeaderString($key);
            $value = $this->encodeHeaderString($value);

            $headerString .= $name . Frame::COLON . $value . Frame::NEWLINE;
        }

        return $headerString;
    }

    /**
     * Encode the header string as stomp header string.
     *
     * @param string $value The value to convert
     *
     * @return string
     */
    protected function encodeHeaderString($value)
    {
        // encode the header if encode header required.
        if ($this->getHeaderEncodingRequired()) {
            // escape "\n , : , \\" in value
            $value = strtr($value, array(
                Frame::NEWLINE => '\n',
                Frame::COLON   => '\c',
                Frame::ESCAPE  => '\\\\'
            ));
        }

        return $value;
    }

    /**
     * Returns is for the current frame encode header required.
     *
     * @return bool
     */
    protected function getHeaderEncodingRequired()
    {
        /*
         * CONNECTED frames do not escape the colon or newline octets
         * in order to remain backward compatible with STOMP 1.0.
         */
        if ($this->getCommand() === ServerCommands::CONNECTED) {
            return false;
        }
        return true;
    }

    /**
     * Returns the message command.
     *
     * @return string
     */
    public function getCommand()
    {
        return $this->command;
    }

    /**
     * Set the command for the frame.
     *
     * @param string $command The Command to set.
     *
     * @return void
     */
    public function setCommand($command)
    {
        $this->command = $command;
    }
}