allejo\stakx\FrontMatter\ExpandedValue

Complexity

Total Complexity

6

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

86.67%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	__toString()	0	4	1
A	getEvaluated()	0	4	1
A	setEvaluated()	0	4	1
A	getIterators()	0	4	1
A	setIterator()	0	4	1

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\FrontMatter;

/**
 * Class ExpandedValue.
 *
 * An instance of this object is created to store the values and information related to the "value expansion" feature of
 * the FrontMatter parser
 */
class ExpandedValue
{
    /**
     * Store the original value with variables and this value will be updated in-place as it's evaluated.
     *
     * @var string
     */
    private $evaluated;

    /**
     * The definition of variable replacements that occurred for this specific string.
     *
     * The $key for the array would be the variable name without the % and the $value would be literal value that
     * replaced the variable in the string
     *
     * @var string[]
     */
    private $iterators;

    /**
     * ExpandedValue constructor.
     *
     * @param string $string
     */
    public function __construct($string)
    {
        $this->evaluated = $string;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->getEvaluated();
    }

    /**
     * Get the current evaluated string.
     *
     * If the evaluation in FrontMatterParser hasn't been completed, this will return the partially evaluated string
     * variables still in place.
     *
     * @return string
     */
    public function getEvaluated()
    {
        return $this->evaluated;
    }

    /**
     * Update the currently evaluated string.
     *
     * As the string is being evaluated in the FrontMatterParser, this value will be updated as variables are iterated
     * through.
     *
     * @param string $string
     */
    public function setEvaluated($string)
    {
        $this->evaluated = $string;
    }

    /**
     * Get all of the variable replacements that were used in this evaluated string.
     *
     * @return string[]
     */
    public function getIterators()
    {
        return $this->iterators;
    }

    /**
     * Record the value of a variable replacement.
     *
     * The variable name should NOT contain the % and the value should be as-is
     *
     * @param string     $variableName
     * @param string|int $variableValue
     */
    public function setIterator($variableName, $variableValue)
    {
        $this->iterators[$variableName] = $variableValue;
    }
}