unreal4u\MQTT\DataTypes\TopicName

Complexity

Total Complexity

5

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	3	1
A	setTopicName()	0	11	2
A	getTopicName()	0	3	1
A	__construct()	0	3	1

<?php

declare(strict_types=1);

namespace unreal4u\MQTT\DataTypes;

use unreal4u\MQTT\Internals\GeneralTopicRules;

/**
 * When the client wants to send a message to a topic, this is done by adding a topic NAME.
 */
final class TopicName extends GeneralTopicRules
{
    /**
     * The TopicName identifies the information channel to which payload data is published.
     *
     * @see http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106
     * @var string
     */
    private $topicName;

    /**
     * TopicName constructor.
     * @param string $topicName
     * @throws \OutOfBoundsException
     * @throws \unreal4u\MQTT\Exceptions\InvalidQoSLevel
     * @throws \InvalidArgumentException
     */
    public function __construct(string $topicName)
    {
        $this->setTopicName($topicName);
    }

    /**
     * Contains the name of the TopicFilter Filter
     *
     * @param string $topicName
     * @return TopicFilter
     * @throws \OutOfBoundsException
     * @throws \InvalidArgumentException
     */
    private function setTopicName(string $topicName): self
    {
        $this->generalRulesCheck($topicName);

        // A topic name has some additional checks, as no wildcard characters are allowed
        if (strpbrk($topicName, '#+') !== false) {
            throw new \InvalidArgumentException('Topic names can not contain wildcard characters');
        }

        $this->topicName = $topicName;
        return $this;

The expression return $this returns the type unreal4u\MQTT\DataTypes\TopicName which is incompatible with the documented return type unreal4u\MQTT\DataTypes\TopicFilter.

    }

    /**
     * @return string
     */
    public function getTopicName(): string
    {
        return $this->topicName;
    }

    public function __toString()
    {
        return $this->getTopicName();
    }
}