Template/src/syntax_trees/ast/nodes/dynamic_variable.php

<?php
/**
 * File containing the ezcTemplateDynamicVariableAstNode class
 *
 * 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 Template
 * @version //autogen//
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @access private
 */
/**
 * Represents PHP variables.
 *
 * Dynamic variables are code elements with one expression which defines the
 * name of the variable to find. The expression will be evaluated and the
 * return value of it will be used as variable name.
 *
 * Dynamic lookup of variable using other variable $some_var.
 * <code>
 * $var1 = new ezcTemplateVariableAstNode( 'some_var' );
 * $var2 = new ezcTemplateDynamicVariableAstNode( $var1 );
 * </code>
 * The corresponding PHP code will be:
 * <code>
 * ${$some_var}
 * </code>
 *
 * @package Template
 * @version //autogen//
 * @access private
 */
class ezcTemplateDynamicVariableAstNode extends ezcTemplateAstNode
{
    /**
     * The expression which will, when evaluated, return the name of the
     * variable to use.
     * @var ezcTemplateAstNode
     */
    public $nameExpression;

    /**
     * Constructs a new ezcTemplateDynamicVariableAstNode
     *
     * @param ezcTemplateAstNode $nameExpression The code element which will evaluate to the name of the variable.
     */
    public function __construct( ezcTemplateAstNode $nameExpression = null )
    {
        parent::__construct();
        $this->nameExpression = $nameExpression;
    }
}
?>