Template/src/syntax_trees/tst/nodes/literal_block.php

<?php
/**
 * File containing the ezcTemplateLiteralBlockTstNode 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
 */
/**
 * Element representing a literal block and the literal text.
 *
 * The element consists of four cursors, the $startCursor points to the start of
 * the opening literal block while $endCursor points to the end of the closing
 * literal block. In addition the $textStartCursors points to the end of the
 * opening literal block and marks the start of the actual text, while
 * $textEndCursor points to the start of the closing literal block and marks
 * the end of the text.
 *
 * @package Template
 * @version //autogen//
 * @access private
 */
class ezcTemplateLiteralBlockTstNode extends ezcTemplateTextTstNode
{
    /**
     * The starting point for the text after the initial literal block
     * specified with a cursor.
     *
     * @var ezcTemplateCursor
     */
    public $textStartCursor;

    /**
     * The end point for the text after the inital literal block specified with
     * a cursor. This is also the starting point of the end literal block which
     * goes on until $endCursor.
     *
     * @var ezcTemplateCursor
     */
    public $textEndCursor;

    /**
     * The extracted text from the source code found between start and end cursor.
     * The text will exactly the same as the source code.
     */
    public $text;

    /**
     *
     * @param ezcTemplateSource $source
     * @param ezcTemplateCursor $start
     * @param ezcTemplateCursor $end
     */
    public function __construct( ezcTemplateSourceCode $source, /*ezcTemplateCursor*/ $start, /*ezcTemplateCursor*/ $end )
    {
        parent::__construct( $source, $start, $end );
        $this->textStartCursor = null;
        $this->textEndCursor   = null;
    }

    /**
     * Stores the text from the source code using the $textStartCursor and
     * $textEndCursor and stores the result in the $text property.
     */
    public function storeText()
    {
        $this->text = $this->textStartCursor->subString( $this->textEndCursor->position );
    }
}
?>