dallgoot / yaml

API.php

<?php
namespace Dallgoot\Yaml;

use Dallgoot\Yaml\Types as T;

/**
 * the return Object representing a YAML file content
 *  consider dumping datetime as date strings according to a format provided by user or default
 */
class API
{
    private $_references = [];
    private $_comments   = [];
    // private $_documents  = [];
    private $tags = [];

    public $type = T::MAPPING;
    public $value = null;

    const UNKNOWN_REFERENCE = self::class.": no reference named '%s'";
    const UNAMED_REFERENCE  = self::class.": reference MUST have a name";


    /**
     * Adds a reference.
     *
     * @param   string                    $name   The name
     * @param   mixed                     $value  The value
     * @throws  \UnexpectedValueException  (description)
     */
    public function addReference($name, $value):void
    {
        if (empty($name)) {
            throw new \UnexpectedValueException(self::UNAMED_REFERENCE, 1);
        }
        $this->_references[$name] = $value;
    }

    /**
     *  return the reference saved by $name
     *  @param  string  nameof the reference

The type Dallgoot\Yaml\nameof was not found. Maybe you did not declare it correctly or list all dependencies?

     *  @return mixed   the value of the reference
     *  @throws UnexpectedValueException    if there's no reference by that $name
     */
    public function &getReference($name)
    {
        if (array_key_exists($name, $this->_references)) {
            return $this->_references[$name];
        }
        throw new \UnexpectedValueException(sprintf(self::UNKNOWN_REFERENCE, $name), 1);
    }

    public function getAllReferences():array
    {
        return $this->_references;
    }

    public function addComment($index, $value):void
    {
        $this->_comments[$index] = $value;
    }

    public function getComment($lineNumber = null)
    {
        if (array_key_exists($lineNumber, $this->_comments)) {
            return $this->_comments[$lineNumber];
        }
        return $this->_comments;
    }

    public function setText($value):void
    {
        $this->value .= $value;
    }

    public function addTag($value):void
    {
        $this->tags[] = $value;
    }
}