point-tools/src/Skobkin/Bundle/PointToolsBundle/DTO/Api/WebSocket/Message.php

<?php

namespace Skobkin\Bundle\PointToolsBundle\DTO\Api\WebSocket;

use Skobkin\Bundle\PointToolsBundle\DTO\Api\ValidableInterface;
use Skobkin\Bundle\PointToolsBundle\Exception\WebSocket\UnsupportedTypeException;

/**
 * WebSocket update message
 */
class Message implements ValidableInterface
{
    public const TYPE_COMMENT = 'comment';
    public const TYPE_COMMENT_EDITED = 'comment_edited';
    public const TYPE_POST = 'post';
    public const TYPE_POST_EDITED = 'post_edited';
    public const TYPE_POST_COMMENT_RECOMMENDATION = 'rec';
    public const TYPE_RECOMMENDATION_WITH_COMMENT = 'ok';

    /**
     * Event type. @see Message::TYPE_* constants
     *
     * @var string
     */
    private $a;

    /**
     * Login of the user
     *
     * @var string
     */
    private $author;

    /**
     * @var int
     */
    private $authorId;

    /** @var string|null */
    private $authorName;

    /**
     * Number of the comment in the thread
     *
     * @var int|null
     */
    private $commentId;

    /**
     * ???
     *
     * @var bool|null
     */
    private $cut;

    /**
     * Array of file paths
     *
     * @var string[]|null
     */
    private $files;

    /** @var string|null */
    private $html;

    /**
     * @deprecated Link in the Post::type=feed posts
     *
     * @var string|null
     */
    private $link;

    /**
     * @var int|null
     */
    private $postAuthorId;

    /** @var string */
    private $postId;

    /** @var bool|null */
    private $private;

    /**
     * Number of the comment in the thread for recommendation with text
     *
     * @var int|null
     */
    private $rcid;

    /**
     * Array of tags
     *
     * @var string[]|null
     */
    private $tags;

    /** @var string */
    private $text;

    /**
     * @deprecated ???
     *
     * @var string|null
     */
    private $title;

    /**
     * Number of the comment to which this comment is answering
     *
     * @var string|null
     */
    private $toCommentId;

    /**
     * Text quotation of the comment to which this comment is answering
     *
     * @var string|null
     */
    private $toText;

    /**
     * Array of logins of users to which post is addressed
     *
     * @var string[]|null
     */
    private $toUsers;

    public function isPost(): bool
    {
        return self::TYPE_POST === $this->a;
    }

    public function isComment(): bool
    {
        return self::TYPE_COMMENT === $this->a;
    }

    public function isCommentRecommendation(): bool
    {
        return self::TYPE_RECOMMENDATION_WITH_COMMENT === $this->a;
    }

    public function isPostRecommendation(): bool
    {
        return self::TYPE_POST_COMMENT_RECOMMENDATION === $this->a;
    }

    /**
     * @throws \RuntimeException
     * @throws UnsupportedTypeException
     */
    public function isValid(): bool
    {
        switch ($this->a) {
            case self::TYPE_POST:
                return $this->isValidPost();
                break;

            case self::TYPE_POST_EDITED:
                return $this->isValidPostEdited();
                break;

            case self::TYPE_COMMENT;
                return $this->isValidComment();
                break;

            case self::TYPE_COMMENT_EDITED;
                return $this->isValidCommentEdited();
                break;

            case self::TYPE_RECOMMENDATION_WITH_COMMENT;
                return $this->isValidRecommendationWithComment();
                break;

            case self::TYPE_POST_COMMENT_RECOMMENDATION;
                return $this->isValidPostCommentRecommendation();
                break;

            case null:
                throw new \RuntimeException('Message has NULL type.');
                break;

            default:
                throw new UnsupportedTypeException(sprintf('Type \'%s\' is not supported.', $this->a));
        }
    }

    public function getA(): string
    {
        return $this->a;
    }

    public function getAuthor(): string
    {
        return $this->author;
    }

    public function getAuthorId(): int
    {
        return $this->authorId;
    }

    public function getAuthorName(): ?string
    {
        return $this->authorName;
    }

    public function getCommentId(): ?int
    {
        return $this->commentId;
    }

    public function getCut(): ?bool
    {
        return $this->cut;
    }

    public function getFiles(): ?array
    {
        return $this->files;
    }

    public function getHtml(): ?string
    {
        return $this->html;
    }

    public function getLink(): ?string
    {
        return $this->link;
    }

    public function getPostId(): string
    {
        return $this->postId;
    }

    public function getPostAuthorId(): ?int
    {
        return $this->postAuthorId;
    }

    public function getPrivate(): ?bool
    {
        return $this->private;
    }

    public function getRcid(): ?int
    {
        return $this->rcid;
    }

    public function getTags(): ?array
    {
        return $this->tags;
    }

    public function getText(): string
    {
        return $this->text;
    }

    public function getTitle(): ?string
    {
        return $this->title;
    }

    public function getToCommentId(): ?string
    {
        return $this->toCommentId;
    }

    public function getToText(): ?string
    {
        return $this->toText;
    }

    public function getToUsers(): ?array
    {
        return $this->toUsers;
    }

    private function hasCommonMandatoryData(): bool
    {
        return (
            null !== $this->author &&
            null !== $this->authorId &&
            null !== $this->postId
        );
    }

    private function isValidPost(): bool
    {
        return $this->hasCommonMandatoryData() && (
                // Text can be empty ("") though
                null !== $this->text &&
                null !== $this->tags
            );
    }

    private function isValidPostEdited(): bool
    {
        return $this->isValidPost();
    }

    private function isValidComment(): bool
    {
        return $this->hasCommonMandatoryData() && (
                null !== $this->commentId &&
                null !== $this->html &&
                null !== $this->text
            );
    }

    private function isValidCommentEdited(): bool
    {
        return $this->hasCommonMandatoryData() && (null !== $this->commentId);
    }

    private function isValidRecommendationWithComment(): bool
    {
        return $this->hasCommonMandatoryData();
    }

    private function isValidPostCommentRecommendation(): bool
    {
        return $this->hasCommonMandatoryData() && (null !== $this->postAuthorId);
    }
}