Charcoal\Ui\PrioritizableTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	setPriority()	0	11	2
A	priority()	0	4	1

<?php

namespace Charcoal\Ui;

use InvalidArgumentException;

/**
 * Provides an entity with a priority level or sorting index.
 *
 * Implementation of {@see \Charcoal\Ui\PrioritizableInterface}.
 */
trait PrioritizableTrait
{
    /**
     * Priority level of the entity.
     *
     * @var integer
     */
    private $priority = 0;

    /**
     * Set the entity's priority index.
     *
     * @param  integer $priority An index, for sorting.
     * @throws InvalidArgumentException If the priority is not an integer.
     * @return self
     */
    public function setPriority($priority)
    {
        if (!is_numeric($priority)) {
            throw new InvalidArgumentException(
                'Priority must be an integer'
            );
        }

        $this->priority = intval($priority);
        return $this;
    }

    /**
     * Retrieve the entity's priority index.
     *
     * @return integer
     */
    public function priority()
    {
        return $this->priority;
    }
}