Template/src/string_tool.php

<?php
/**
 * File containing the ezcTemplateStringTool 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
 */

/**
 * Contains static function for doing common string operations.
 *
 * Processing escaped sequences for single and double quoted strings
 * are possible with processSingleQuotedEscapes() and processDoubleQuotedEscapes().
 *
 * <code>
 * $text = ezcTemplateStringTool::processDoubleQuotedEscapes( 'hi\nthere' );
 * var_dump( $text );
 * </code>
 *
 * @package Template
 * @version //autogen//
 * @access private
 */

class ezcTemplateStringTool
{
    /**
     * This will process escape characters allowed for double quoted strings and return
     * the new string.
     *
     * The allowed escape characters are:
     * - \\n  => 0x0a
     * - \\r  => 0x0c
     * - \\t  => 0x09
     * - \\\\ => \\
     * - \\"  => "
     *
     * @param string $text
     * @return string
     */
    public static function processDoubleQuotedEscapes( $text )
    {

        $text = preg_replace_callback( '#(?:\\\\([nrt"\\\\]))#',
                                       array( __CLASS__, "doubleQuotedEscape" ),
                                       $text );
        return $text;
    }

    /**
     * This will process escape characters allowed for single quoted strings and return
     * the new string.
     *
     * The allowed escape characters are:
     * - \\\\ => \\
     * - \\'  => '
     *
     * @param string $text
     * @return string
     */
    public static function processSingleQuotedEscapes( $text )
    {
        $text = preg_replace_callback( '#(?:\\\\([\'\\\\]))#',
                                       array( __CLASS__, "singleQuotedEscape" ),
                                       $text );
        return $text;
    }

    /**
     * Callback function for the preg_replace_callback() call in processDoubleQuotedEscapes().
     *
     * @param array $matches Array from the preg_replace_callback method.
     * @return string
     */
    public static function doubleQuotedEscape( $matches )
    {
        if ( isset( $matches[1] ) &&
             $matches[1] != "" )
        {
            switch ( $matches[1] )
            {
                case "n":
                    return "\n";
                case "r":
                    return "\r";
                case "t":
                    return "\t";
                case "\"":
                    return "\"";
                case "\\":
                    return "\\";
            }
        }
    }

    /**
     * Callback function for the preg_replace_callback() call in processSingleQuotedEscapes().
     *
     * @param array $matches Array from the preg_replace_callback method.
     * @return string
     */
    public static function singleQuotedEscape( $matches )
    {
        if ( isset( $matches[1] ) &&
             $matches[1] != "" )
        {
            switch ( $matches[1] )
            {
                case "'":
                    return "'";
                case "\\":
                    return "\\";
            }
        }
    }
}

?>