<?php

namespace FunctionParser;

/**
 * Token
 *
 * The Token object is an object-oriented abstraction representing a single item from the results of the get_token_all()
 * function, which is part of PHP tokenizer, or lexical scanner. There are also many convenience methods revolved around
 * the token's identity.
 *
 * @package  FunctionParser
 * @author   Jeremy Lindblom
 * @license  MIT
 * @see      http://us2.php.net/manual/en/tokens.php
 * @property string $name
 * @property string $code
 * @property integer $line
 * @property integer $value
 */
class Token
{
    /**
     * @var string The token name.
     */
    protected $name;

    /**
     * @var integer The token's integer value.
     */
    protected $value;

    /**
     * @var string The parsed code of the token.
     */
    protected $code;

    /**
     * @var integer The line number of the token in the original code.
     */
    protected $line;

    /**
     * Constructs a token object.
     *
     * @param mixed $token Either a literal string token or an array of token data as returned by get_token_all()
     */
    public function __construct($token)
    {
        if (is_string($token))
        {
            $this->name  = null;
            $this->value = null;
            $this->code  = $token;
            $this->line  = null;
        }
        elseif (is_array($token) && in_array(count($token), array(2, 3)))
        {
            $this->name  = token_name($token[0]);
            $this->value = $token[0];
            $this->code  = $token[1];
            $this->line  = isset($token[2]) ? $token[2] : null;
        }
        else
        {
            throw new \InvalidArgumentException('The token was invalid.');
        }
    }

    /**
     * Serializes the token.
     *
     * @return string The serialized token.
     */
    public function __serialize()
    {
        return serialize(array($this->name, $this->value, $this->code, $this->line));
    }

    /**
     * Unserializes the token
     *
     * @param string $serialized The serialized token
     */
    public function __unserialize($serialized)
    {
        list($this->name, $this->value, $this->code, $this->line) = unserialize($serialized);
    }

    /**
     * Get the token name.
     *
     * @return string The token name. Always null for literal tokens.
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Get the token's integer value. Always null for literal tokens.
     *
     * @return integer The token value.
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Get the token's PHP code as a string.
     *
     * @return string The token code
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * Get the line where the token was defined. Always null for literal tokens.
     *
     * @return integer The line number.
     */
    public function getLine()
    {
        return $this->line;
    }

    /**
     * Determines whether the token is an opening brace.
     *
     * @return boolean True if the token is an opening brace.
     */
    public function isOpeningBrace()
    {
        return ($this->code === '{' || $this->name === 'T_CURLY_OPEN' || $this->name === 'T_DOLLAR_OPEN_CURLY_BRACES');
    }

    /**
     * Determines whether the token is an closing brace.
     *
     * @return boolean True if the token is an closing brace.
     */
    public function isClosingBrace()
    {
        return ($this->code === '}');
    }

    /**
     * Determines whether the token is an opening parenthsesis.
     *
     * @return boolean True if the token is an opening parenthsesis.
     */
    public function isOpeningParenthesis()
    {
        return ($this->code === '(');
    }

    /**
     * Determines whether the token is an closing parenthsesis.
     *
     * @return boolean True if the token is an closing parenthsesis.
     */
    public function isClosingParenthesis()
    {
        return ($this->code === ')');
    }

    /**
     * Determines whether the token is a literal token.
     *
     * @return boolean True if the token is a literal token.
     */
    public function isLiteralToken()
    {
        return ($this->name === null && $this->code !== null);
    }

    /**
     * Determines whether the token's integer value or code is equal to the specified value.
     *
     * @param mixed $value The value to check.
     * @return boolean True if the token is equal to the value.
     */
    public function is($value)
    {
        return ($this->code === $value || $this->value === $value);
    }

    /**
     * Typical magic getter.
     *
     * @param string $key The property name.
     * @return mixed The property value.
     * @throws \OutOfBoundsException
     */
    public function __get($key)
    {
        if (property_exists(__CLASS__, $key))
        {
            return $this->{$key};
        }
        else
        {
            throw new \OutOfBoundsException("The property \"{$key}\" does not exist in Token.");
        }
    }

    /**
     * Typical magic setter.
     *
     * @param string $key The property name.
     * @param mixed $value The property's new value.
     * @throws \OutOfBoundsException
     */
    public function __set($key, $value)
    {
        if (property_exists(__CLASS__, $key))
        {
            $this->{$key} = $value;
        }
        else
        {
            throw new \OutOfBoundsException("The property \"{$key}\" does not exist in Token.");
        }
    }

    /**
     * Typical magic isset.
     *
     * @param string $key The property name.
     * @return boolean Whether or not the property is set.
     */
    public function __isset($key)
    {
        return isset($this->{$key});
    }

    /**
     * Serializes the token.
     *
     * @return string The serialized token.
     */
    public function serialize()
    {
        return serialize(array($this->name, $this->value, $this->code, $this->line));
    }

    /**
     * Unserializes the token
     *
     * @param string $serialized The serialized token
     */
    public function unserialize($serialized)
    {
        list($this->name, $this->value, $this->code, $this->line) = unserialize($serialized);
    }

    /**
     * Typical magic tostring.
     *
     * @return string The code.
     */
    public function __toString()
    {
        return $this->code;
    }
}