PhraseanetSDK\Entity\Basket

Complexity

Total Complexity

28

Size/Duplication

Total Lines	229
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

77.55%

Importance

Changes	10
Bugs	0	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	fromList()	0	10	2
A	fromValue()	0	4	1
A	__construct()	0	4	1
A	getRawData()	0	4	1
A	getId()	0	4	1
A	getName()	0	4	1
A	getDescription()	0	4	1
A	getPusher()	0	4	2
A	isUnread()	0	4	1
A	getCreatedOn()	0	4	2
A	getUpdatedOn()	0	4	2
A	isValidationBasket()	0	4	1
A	getValidationUsers()	0	10	3
A	getExpiresOn()	0	4	2
A	getValidationInfo()	0	4	1
A	isValidationConfirmed()	0	4	1
A	isValidationInitiator()	0	4	1
A	getValidationInitiatorUser()	0	6	2
A	getOwner()	0	4	2

<?php

/*
 * This file is part of Phraseanet SDK.
 *
 * (c) Alchemy <info@alchemy.fr>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace PhraseanetSDK\Entity;

use Doctrine\Common\Collections\ArrayCollection;

class Basket
{

    public static function fromList(array $values)
    {
        $baskets = array();

        foreach ($values as $value) {
            $baskets[$value->basket_id] = self::fromValue($value);
        }

        return $baskets;
    }

    public static function fromValue(\stdClass $value)
    {
        return new self($value);
    }

    /**
     * @var \stdClass
     */
    protected $source;

    /**
     * @var User|null
     */
    protected $owner;

    /**
     * @var User|null
     */
    protected $pusher;

    /**
     * @var \DateTime
     */
    protected $createdOn;

    /**
     * @var \DateTime
     */
    protected $updatedOn;

    /**
     * ArrayCollection|User[]
     */
    protected $validationUsers;

    /**
     * @var \DateTime
     */
    protected $expiresOn;

    /**
     * @var User|null
     */
    protected $validationInitiatorUser;

    public function __construct(\stdClass $source)
    {
        $this->source = $source;
    }

    /**
     * @return \stdClass
     */
    public function getRawData()
    {
        return $this->source;
    }

    /**
     * The basket id
     *
     * @return integer
     */
    public function getId()
    {
        return $this->source->basket_id;
    }

    /**
     * The basket name
     *
     * @return string
     */
    public function getName()
    {
        return $this->source->name;
    }

    /**
     * The basket description
     *
     * @return string
     */
    public function getDescription()
    {
        return $this->source->description;
    }

    /**
     * The user who created the basket when the current basket
     * is a validation basket
     *
     * @return integer|null
     */
    public function getPusher()
    {
        return $this->pusher ?: $this->pusher = User::fromValue($this->source->pusher);
    }

    /**
     * Tell whether the basket has been read or not
     *
     * @return Boolean
     */
    public function isUnread()
    {
        return $this->source->unread;
    }

    /**
     * Creation date
     *
     * @return \DateTime
     */
    public function getCreatedOn()
    {
        return $this->createdOn ?: $this->createdOn = new \DateTime($this->source->created_on);
    }

    /**
     * Last update date
     *
     * @return \DateTime
     */
    public function getUpdatedOn()
    {
        return $this->updatedOn ?: $this->updatedOn = new \DateTime($this->source->updated_on);
    }

    /**
     * Tell whether the basket is a validation basket
     *
     * @return Boolean
     */
    public function isValidationBasket()
    {
        return $this->source->validation_basket;
    }

    /**
     * Return a collection of PhraseanetSDK\entity\BasketValidationParticipant object
     * if the basket is a validation basket otherwise it returns null
     *
     * @return ArrayCollection|null
     */
    public function getValidationUsers()
    {
        if (! $this->isValidationBasket()) {
            return null;
        }

        return $this->validationUsers ?: $this->validationUsers = new ArrayCollection(
            BasketValidationParticipant::fromList($this->source->validation_users)
        );
    }

    /**
     * The expiration validation date, if the basket is a validation basket
     *
     * @return \DateTime|null
     */
    public function getExpiresOn()
    {
        return $this->expiresOn ?: $this->expiresOn = new \DateTime($this->source->expires_on);
    }

    /**
     * Get some information about the validation, if the basket is a validation
     * basket
     *
     * @return string|null
     */
    public function getValidationInfo()
    {
        return $this->source->validation_infos;
    }

    /**
     * Tell whether the validation is confirmed
     *
     * @return bool
     */
    public function isValidationConfirmed()
    {
        return (bool) $this->source->validation_confirmed;
    }

    /**
     * Tell whether the current authenticated user initiates the validation process
     *
     * @return bool
     */
    public function isValidationInitiator()
    {
        return (bool) $this->source->validation_initiator;
    }

    /**
     * @return User|null
     */
    public function getValidationInitiatorUser()
    {
        return $this->validationInitiatorUser ?: $this->validationInitiatorUser = User::fromValue(
            $this->source->validation_initiator_user
        );
    }

    /**
     * @return User
     */
    public function getOwner()
    {
        return $this->owner ?: $this->owner = User::fromValue($this->source->owner);
    }
}