Fhp\Message\AbstractMessage

Complexity

Total Complexity

11

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	addSegment()	0	4	1
A	getSegments()	0	4	1
A	setDialogId()	0	4	1
A	getDialogId()	0	4	1
A	setMessageNumber()	0	4	1
A	getMessageNumber()	0	4	1
A	toString()	0	10	2
A	__toString()	0	4	1
A	buildMessageHeader()	0	9	2

<?php

namespace Fhp\Message;

use Fhp\Segment\HNHBK;
use Fhp\Segment\SegmentInterface;

/**
 * Class AbstractMessage
 * @package Fhp\Message
 */
class AbstractMessage
{
    const MSG_HEADER_SEGMENT = 'HNHBK';
    const MSG_HEADER_VERSION = 3;
    const MSG_HEADER_SEG_NUMBER = 1;
    const MSG_HBCI_VERSION = '300';

    const OPT_PINTAN_MECH = 'pintan_mechanism';

    /**
     * @var array
     */
    protected $segments = array();

    /**
     * @var int
     */
    protected $dialogId = 0;

    /**
     * @var int
     */
    protected $messageNumber = 1;

    /**
     * Adds a segment to the message.
     *
     * @param SegmentInterface $segment
     */
    protected function addSegment(SegmentInterface $segment)
    {
        $this->segments[] = $segment;
    }

    /**
     * Gets all segments of a message.
     *
     * @return array
     */
    public function getSegments()
    {
        return $this->segments;
    }

    /**
     * Sets the dialog ID.
     *
     * @param $dialogId
     */
    public function setDialogId($dialogId)
    {
        $this->dialogId = $dialogId;
    }

    /**
     * Gets the dialog ID.
     *
     * @return int
     */
    public function getDialogId()
    {
        return $this->dialogId;
    }

    /**
     * Sets the message number.
     *
     * @param int $number
     */
    public function setMessageNumber($number)
    {
        $this->messageNumber = (int) $number;
    }

    /**
     * Gets the message number.
     *
     * @return int
     */
    public function getMessageNumber()
    {
        return $this->messageNumber;
    }

    /**
     * Transform message to HBCI string.
     *
     * @return string
     */
    public function toString()
    {
        $string = (string) $this->buildMessageHeader();

        foreach ($this->segments as $segment) {
            $string .= (string) $segment;
        }

        return $string;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->toString();
    }

    /**
     * Builds the message header.
     *
     * @return HNHBK
     */
    protected function buildMessageHeader()
    {
        $len = 0;
        foreach ($this->segments as $segment) {
            $len += strlen($segment);
        }

        return new HNHBK($len, $this->dialogId, $this->messageNumber);
    }
}