Peridot\Leo\Matcher\CountableMatcher

Complexity

Total Complexity

9

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	5
Bugs	0	Features	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setCountable()	0	5	1
A	getCountable()	0	4	1
A	getCount()	0	8	2
A	getTemplate()	0	8	2
A	doMatch()	0	12	3
	getDefaultCountableTemplate()	0	1	?
	matchNumeric()	0	1	?

<?php
namespace Peridot\Leo\Matcher;

use Peridot\Leo\Matcher\Template\TemplateInterface;

/**
 * CountableMatcher a matcher is a matcher that matches numeric values,
 * or reduces a countable value - like array, string, or Countable - to a single
 * numeric value.
 *
 * @package Peridot\Leo\Matcher
 */
abstract class CountableMatcher extends AbstractMatcher
{
    /**
     * @var mixed
     */
    protected $countable;

    /**
     * Set the countable value used by the CountableMatcher.
     *
     * @param mixed $countable
     * @return $this
     */
    public function setCountable($countable)
    {
        $this->countable = $countable;
        return $this;
    }

    /**
     * Return the countable used by the CountableMatcher.
     *
     * @return mixed
     */
    public function getCountable()
    {
        return $this->countable;
    }

    /**
     * Get the count of the countable value.
     * @return int
     */
    public function getCount()
    {
        if (is_string($this->countable)) {
            return strlen($this->countable);
        }

        return count($this->countable);
    }

    /**
     * {@inheritdoc}
     *
     * Returns a default countable interface if the countable is set.
     *
     * @return TemplateInterface
     */
    public function getTemplate()
    {
        if (isset($this->countable)) {
            return $this->getDefaultCountableTemplate();
        }

        return parent::getTemplate();
    }

    /**
     * {@inheritdoc}
     *
     * @param $actual
     * @return mixed
     */
    protected function doMatch($actual = null)
    {
        if (isset($this->countable)) {
            $actual = $this->getCount();
        }

        if (!is_numeric($actual)) {
            throw new \InvalidArgumentException(get_class($this) . " requires a numeric value");
        }

        return $this->matchNumeric($actual);
    }

    /**
     * Return a default template for when a countable has been set.
     *
     * @return TemplateInterface
     */
    abstract public function getDefaultCountableTemplate();

    /**
     * Determine if a number matches a specified condition
     *
     * @param $number
     * @return bool
     */
    abstract protected function matchNumeric($number);
}