PEIP\Message\MessageBuilder

Complexity

Total Complexity

13

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	4
Bugs	4	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	copyHeaders()	0	6	1
A	copyHeadersIfAbsent()	0	6	1
A	removeHeader()	0	6	1
A	setHeader()	0	6	1
A	setHeaders()	0	6	1
A	getHeaders()	0	4	1
A	build()	0	7	1
A	setContent()	0	6	1
A	getInstance()	0	4	1
A	getInstanceFromMessage()	0	4	1
A	setMessageClass()	0	4	1
A	getMessageClass()	0	4	1

<?php

namespace PEIP\Message;

/*
 * This file is part of the PEIP package.
 * (c) 2009-2016 Timo Michna <timomichna/yahoo.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
/*
 * MessageBuilder
 * Util class to easily create and copy messages
 *
 * @author Timo Michna <timomichna/yahoo.de>
 * @package PEIP
 * @subpackage message
 * @implements \PEIP\INF\Message\MessageBuilder, \PEIP\INF\Factory\DedicatedFactory
 */

use PEIP\Base\GenericBuilder;
use PEIP\Factory\DedicatedFactory;

class MessageBuilder implements
        \PEIP\INF\Message\MessageBuilder,
        \PEIP\INF\Factory\DedicatedFactory
{
    protected $messageClass,
        $factory,
        $headers = [],
        $payload;

    /**
     * constructor.
     *
     * @param string $messageClass the message-class to build instances for
     */
    public function __construct($messageClass = '\PEIP\Message\GenericMessage')
    {
        $this->messageClass = $messageClass;
        $this->factory = DedicatedFactory::getfromCallable([$messageClass, 'build']);
    }

    /**
     * copies headers to message to build.
     *
     * @param array $headers the headers to set
     *
     * @return MessageBuilder $this
     */
    public function copyHeaders(array $headers)
    {
        $this->headers = array_merge($this->headers, $headers);

        return $this;
    }

    /**
     * copies headers to message to build if not set allerady.
     *
     * @param array $headers the headers to set
     *
     * @return MessageBuilder $this
     */
    public function copyHeadersIfAbsent(array $headers)
    {
        $this->headers = array_merge($headers, $this->headers);

        return $this;
    }

    /**
     * removes a header from message to build.
     *
     * @param string $headerName the name of the header
     *
     * @return MessageBuilder $this
     */
    public function removeHeader($headerName)
    {
        unset($this->headers[$headerName]);

        return $this;
    }

    /**
     * sets a header for the message to build.
     *
     * @param string $headerName  the name of the header
     * @param mixed  $headerValue the value for the header
     *
     * @return MessageBuilder $this
     */
    public function setHeader($headerName, $headerValue)
    {
        $this->headers[$headerName] = $headerValue;

        return $this;
    }

    /**
     * sets all headers for the message to build.
     *
     * @param array $headers the headers to set
     *
     * @return MessageBuilder $this
     */
    public function setHeaders(array $headers)
    {
        $this->headers = $headers;

        return $this;
    }

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

    /**
     * creates a new message instance with given headers.
     *
     * @param $arguments
     *
     * @return
     */
    public function build(array $headers = [])
    {
        $this->copyHeaders($headers);

        return GenericBuilder::getInstance($this->messageClass)
            ->build([$this->payload, new \ArrayObject($this->headers)]);
    }

    /**
     * sets the content/payload for the message to build.
     *
     * @param mixed $payload payload for the message to build
     *
     * @return MessageBuilder $this
     */
    public function setContent($payload)
    {
        $this->payload = $payload;

        return $this;
    }

    /**
     * returns a instance of MessageBuilder for given message-class.
     *
     * @static
     *
     * @param string $messageClass the message class to build from the builder
     *
     * @return MessageBuilder new instance of MessageBuilder
     */
    public static function getInstance($messageClass = '\PEIP\Message\GenericMessage')
    {
        return new  self($messageClass);
    }

    /**
     * returns a instance of MessageBuilder for message-class derived from given message.
     *
     * @static
     *
     * @param \PEIP\INF\Message\Message $message the message to get class to build from the builder
     *
     * @return MessageBuilder new instance of MessageBuilder
     */
    public static function getInstanceFromMessage(\PEIP\INF\Message\Message $message)
    {
        return new self(get_class($message));
    }

    /**
     * sets the message-class to build new instances for.
     *
     * @param string $messageClass the message-class to build new instances for
     */
    public function setMessageClass($messageClass)
    {
        $this->messageClass = $messageClass;
    }

    /**
     * returns the message-class to build new instances for.
     *
     * @return string the message-class to build new instances for
     */
    public function getMessageClass()
    {
        return $this->messageClass;
    }
}