JVal\Context

Complexity

Total Complexity

13

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	addViolation()	0	7	1
A	getViolations()	0	4	1
A	countViolations()	0	4	1
A	enterNode()	0	4	1
A	enterSibling()	0	4	1
A	leaveNode()	0	8	2
A	getCurrentPath()	0	5	2
A	duplicate()	0	11	2
A	mergeViolations()	0	4	1
A	purgeViolations()	0	4	1

<?php

/*
 * This file is part of the JVal package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace JVal;

/**
 * Stores data related to a particular validation task (default schema version,
 * accumulated violations, current path, etc.).
 */
class Context
{
    /**
     * @var array
     */
    private $violations = [];

    /**
     * @var array
     */
    private $pathSegments = [];

    /**
     * @var int
     */
    private $pathLength = 0;

    /**
     * Pushes a path segment onto the context stack, making it the current
     * visited node.
     *
     * @param string $pathSegment
     */
    public function enterNode($pathSegment)
    {
        $this->pathSegments[$this->pathLength++] = $pathSegment;
    }


    /**
     * Leaves the current node and enters another node located at the same
     * depth in the hierarchy.
     *
     * @param string $pathSegment
     */
    public function enterSibling($pathSegment)
    {
        $this->pathSegments[$this->pathLength - 1] = $pathSegment;
    }

    /**
     * Removes the current node from the context stack, thus returning to the
     * previous (parent) node.
     */
    public function leaveNode()
    {
        if ($this->pathLength === 0) {
            throw new \LogicException('Cannot leave node');
        }

        $this->pathLength--;
    }

    /**
     * Returns the path of the current node.
     *
     * @return string
     */
    public function getCurrentPath()
    {
        $this->pathSegments = array_slice($this->pathSegments, 0, $this->pathLength);
        return $this->pathLength ? '/'.implode('/', $this->pathSegments) : '';
    }

    /**
     * Adds a violation message for the current node.
     *
     * @param string $message
     * @param array  $parameters
     */
    public function addViolation($message, array $parameters = [])
    {
        $this->violations[] = [
            'path' => $this->getCurrentPath(),
            'message' => vsprintf($message, $parameters),
        ];
    }

    /**
     * Returns the list of accumulated violations.
     *
     * @return array
     */
    public function getViolations()
    {
        return $this->violations;
    }

    /**
     * Returns the number of accumulated violations.
     *
     * @return int
     */
    public function countViolations()
    {
        return count($this->violations);
    }

    /**
     * Returns a copy of the context, optionally purged of its
     * accumulated violations.
     *
     * @param bool $withViolations
     * @return Context
     */
    public function duplicate($withViolations = true)
    {
        // cloning as long as the context doesn't hold object references
        $clone = clone $this;

        if (!$withViolations) {
            $clone->purgeViolations();
        }

        return $clone;
    }

    /**
     * Merges the current violations with the violations stored in
     * another context.
     *
     * @param Context $context
     */
    public function mergeViolations(Context $context)
    {
        $this->violations = array_merge($this->violations, $context->getViolations());
    }

    /**
     * Deletes the list of accumulated violations.
     */
    public function purgeViolations()
    {
        $this->violations = [];
    }
}