GetSky\ParserExpressions\Rules\AbstractRule

Complexity

Total Complexity

6

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
	scan()	0	1	?
A	getName()	0	4	1
A	toRule()	0	10	3
A	action()	0	7	2

<?php
namespace GetSky\ParserExpressions\Rules;

use GetSky\ParserExpressions\Context;
use GetSky\ParserExpressions\Result;
use GetSky\ParserExpressions\RuleInterface;

/**
 * Abstract class that contains the method of reduction to the rule.
 *
 * @package GetSky\ParserExpressions\Rules
 * @author  Alexander Getmanskii <alexander.get87@gmail.com>
 */
abstract class AbstractRule implements RuleInterface
{
    /**
     * @var string The label for the rule.
     */
    protected $name;

    /**
     * @var callable The function which is performed after scanning.
     */
    protected $action;

    /**
     * Returns the value of the label.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Launches action.
     *
     * @param Result $result
     * @return void
     */
    public function action(Result $result = null)
    {
        if ($this->action !== null) {
            $action = $this->action;
            $action($result);
        }
    }

    /**
     * {@inheritdoc}
     */
    abstract public function scan(Context $context);

    /**
     * This method converts the input value to an object that implements an interface Rule.
     *
     * @param $rule
     * @return RuleInterface
     */
    public function toRule($rule)
    {
        if ($rule instanceof RuleInterface) {
            return $rule;
        }
        if (is_array($rule)) {
            return new Sequence($rule);
        }
        return new Row($rule);
    }
}