JsonPointer.php

<?php


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

use JsonSchema\Exception\InvalidArgumentException;

/**
 * @package JsonSchema\Entity
 *
 * @author Joost Nijhuis <jnijhuis81@gmail.com>
 */
class JsonPointer {
    
    /** @var string */
    private $filename;
    
    /** @var string[] */
    private $propertyPaths = array();
    
    /**
     * @var bool Whether the value at this path was set from a schema default
     */
    private $fromDefault = false;
    
    /**
     * @param string $value
     *
     * @throws InvalidArgumentException when $value is not a string
     */
    public function __construct($value) {
        if (!is_string($value)) {
            throw new InvalidArgumentException('Ref value must be a string');
        }
        $splitRef = explode('#', $value, 2);
        $this->filename = $splitRef[0];
        if (array_key_exists(1, $splitRef)) {
            $this->propertyPaths = $this->decodePropertyPaths($splitRef[1]);
        }
    }
    
    /**
     * @param string $propertyPathString
     *
     * @return string[]
     */
    private function decodePropertyPaths($propertyPathString) {
        $paths = array();
        foreach (explode('/', trim($propertyPathString, '/')) as $path) {
            $path = $this->decodePath($path);
            if (is_string($path) && '' !== $path) {
                $paths[] = $path;
            }
        }
        return $paths;
    }
    
    /**
     * @return array
     */
    private function encodePropertyPaths() {
        return array_map(array(
            $this,
            'encodePath',
        ), $this->getPropertyPaths());
    }
    
    /**
     * @param string $path
     *
     * @return string
     */
    private function decodePath($path) {
        return strtr($path, array(
            '~1' => '/',
            '~0' => '~',
            '%25' => '%',
        ));
    }
    
    /**
     * @param string $path
     *
     * @return string
     */
    private function encodePath($path) {
        return strtr($path, array(
            '/' => '~1',
            '~' => '~0',
            '%' => '%25',
        ));
    }
    
    /**
     * @return string
     */
    public function getFilename() {
        return $this->filename;
    }
    
    /**
     * @return string[]
     */
    public function getPropertyPaths() {
        return $this->propertyPaths;
    }
    
    /**
     * @param array $propertyPaths
     *
     * @return JsonPointer
     */
    public function withPropertyPaths(array $propertyPaths) {
        $new = clone $this;
        $new->propertyPaths = $propertyPaths;
        return $new;
    }
    
    /**
     * @return string
     */
    public function getPropertyPathAsString() {
        return rtrim('#/' . implode('/', $this->encodePropertyPaths()), '/');
    }
    
    /**
     * @return string
     */
    public function __toString() {
        return $this->getFilename() . $this->getPropertyPathAsString();
    }
    
    /**
     * Mark the value at this path as being set from a schema default
     */
    public function setFromDefault() {
        $this->fromDefault = true;
    }
    
    /**
     * Check whether the value at this path was set from a schema default
     *
     * @return bool
     */
    public function fromDefault() {
        return $this->fromDefault;
    }

}