<?php
/**
 * File containing the ezcDocumentBBCodeNode struct
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 * @package Document
 * @version //autogen//
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 */

/**
 * Struct for BBCode document document abstract syntax tree nodes
 *
 * @package Document
 * @version //autogen//
 */
abstract class ezcDocumentBBCodeNode extends ezcBaseStruct
{
    /**
     * Line of node in source file.
     *
     * @var int
     */
    public $line;

    /**
     * Character position of node in source file.
     *
     * @var int
     */
    public $position;

    /**
     * Child nodes
     *
     * @var mixed
     */
    public $nodes = array();

    /**
     * Optional reference to token, not available for all nodes.
     *
     * @var ezcDocumentBBCodeToken
     */
    public $token = null;

    /**
     * Construct BBCode node
     *
     * @param ezcDocumentBBCodeToken $token
     * @param int $type
     * @return void
     */
    public function __construct( ezcDocumentBBCodeToken $token )
    {
        $this->line     = $token->line;
        $this->position = $token->position;
        $this->token    = $token;
    }

    /**
     * Set state after var_export
     *
     * @param array $properties
     * @return void
     * @ignore
     */
    public static function __set_state( $properties )
    {
        return null;
    }
}

?>
