Vanderlee\Comprehend\Match\Output\ResultTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getResults()	0	8	2
A	getResult()	0	6	1
A	hasResult()	0	3	1
A	processResultCallbacks()	0	9	3
A	addResultCallback()	0	5	1

<?php

namespace Vanderlee\Comprehend\Match\Output;

trait ResultTrait
{
    /**
     * Map of resolved result callbacks.
     *
     * @var array|null
     */
    private $resultCache = null;

    /**
     * List of partial-resolvable result callbacks.
     *
     * @var callable[]
     */
    private $resultCallbacks = [];

    /**
     * Add a callback to this match, to be called after parsing is finished and
     * only if this match was part of the matched rules.
     *
     * @param callable $callback
     *
     * @return $this
     */
    public function addResultCallback(callable $callback)
    {
        $this->resultCallbacks[] = $callback;

        return $this;
    }

    /**
     * Handle all registered result callbacks for this match and any matches
     * at deeper levels of this match.
     *
     * @param array $results map of result-key => value
     */
    private function processResultCallbacks(&$results)
    {
        /** @var self $success */
        foreach ($this->successes as $success) {
            $success->processResultCallbacks($results);
        }

        foreach ($this->resultCallbacks as $callback) {
            $callback($results);
        }
    }

    /**
     * Pre-calculate results.
     *
     * @return array
     */
    public function getResults()
    {
        if ($this->resultCache === null) {
            $this->resultCache = [];
            $this->processResultCallbacks($this->resultCache);
        }

        return $this->resultCache;
    }

    //@todo deprecate? Saves no time and is part of collection
    public function getResult(string $name = null, $default = null)
    {
        $results = $this->getResults();

        return $results[$name]
            ?? $default;
    }

    //@todo deprecate? Saves no time and is part of collection
    public function hasResult(string $name = null): bool
    {
        return isset($this->getResults()[$name]);
    }
}