Miliooo\Messaging\ValueObjects\ReadStatus

Complexity

Total Complexity

6

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	2
Bugs	1	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	getReadStatus()	0	4	1
A	isValidReadStatus()	0	17	3

<?php

/*
 * This file is part of the MilioooMessageBundle package.
 *
 * (c) Michiel boeckaert <boeckaert@gmail.com>
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Miliooo\Messaging\ValueObjects;

use Miliooo\Messaging\Model\MessageMetaInterface;

/**
 * Read Status value object.
 *
 * This value objects makes sure the read statuses are valid. A read status is valid if it's one of the
 * MessageMetaInterface class constants.
 *
 * @author Michiel Boeckaert <boeckaert@gmail.com>
 */
class ReadStatus
{
    private $readStatus;

    /**
     * Constructor.
     *
     * @param integer $readStatus
     */
    public function __construct($readStatus)
    {
        if ($this->isValidReadStatus($readStatus)) {
            $this->readStatus = $readStatus;
        }
    }

    /**
     * Returns the read status of a message
     *
     * @return integer The read status of a message
     */
    public function getReadStatus()
    {
        return $this->readStatus;
    }

    /**
     * Checks if the given read status is a valid read status.
     *
     * @param mixed $readStatus The read status we check
     *
     * @return true if the read status is valid.

Should the return type not be boolean?

     *
     * @throws \InvalidArgumentException If the read status is invalid.
     */
    protected function isValidReadStatus($readStatus)
    {
        if (!is_integer($readStatus) || !in_array(
            $readStatus,
            [
            MessageMetaInterface::READ_STATUS_NEVER_READ,
            MessageMetaInterface::READ_STATUS_MARKED_UNREAD,
            MessageMetaInterface::READ_STATUS_READ
            ],
            true
            )
        ) {
            throw new \InvalidArgumentException('Read status is not valid');
        }

        return true;
    }
}