Source for file Type.php

<?php
 
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
 
/**
 * ScriptReorganizer :: Type
 *
 * PHP version 5
 *
 * LICENSE: This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option) any
 * later version.
 *
 * @category   Tools
 * @package    ScriptReorganizer
 * @author     Stefano F. Rausch <stefano@rausch-e.net>
 * @copyright  2005 Stefano F. Rausch <stefano@rausch-e.net>
 * @license    http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
 * @version    SVN: $Id: Type.php 32 2005-10-30 22:05:19Z stefanorausch $
 * @link       http://pear.php.net/package/ScriptReorganizer
 * @filesource
 */
 
/**
 * Depends on <kbd>ScriptReorganizer_Strategy</kbd>
 */
require_once 'ScriptReorganizer/Strategy.php';
 
/**
 * Throws <kbd>ScriptReorganizer_Type_Exception</kbd>
 */
require_once 'ScriptReorganizer/Type/Exception.php';
 
/**
 * Base class to be extended by (reorganizer) types to use
 *
 * All types must follow the naming convention
 * <kbd>ScriptReorganizer_Type_<Type></kbd>.
 *
 * @category  Tools
 * @package   ScriptReorganizer
 * @author    Stefano F. Rausch <stefano@rausch-e.net>
 * @copyright 2005 Stefano F. Rausch <stefano@rausch-e.net>
 * @license   http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
 * @version   Release: @package_version@
 * @link      http://pear.php.net/package/ScriptReorganizer
 */
abstract class ScriptReorganizer_Type
{
    // {{{ public function __construct( ScriptReorganizer_Strategy $strategy )
    
    /**
     * Constructor
     *
     * @param ScriptReorganizer_Strategy $strategy a
     *         <kbd>ScriptReorganizer_Strategy</kbd> to apply
     */
    public function __construct( ScriptReorganizer_Strategy $strategy )
    {
        $this->strategy = $strategy;
        
        $this->endOfLineIdentifiers = array(
            'win' => "\r\n", 'unix' => "\n", 'mac' => "\r"
        );
    }
    
    // }}}
    // {{{ public function __destruct()
    
    /**
     * Destructor
     */
    public function __destruct()
    {
        unset( $this->strategy );
    }
    
    // }}}
    
    // {{{ public function load( $file )
    
    /**
     * Loads the script's content to be reorganized from disk
     *
     * @param  string $file a string representing the file's name to load
     * @return void 
     * @throws {@link ScriptReorganizer_Type_Exception ScriptReorganizer_Type_Exception}
     */
    public function load( $file )
    {
        $content = @file_get_contents( $file );
        
        if ( false === $content ) {
            throw new ScriptReorganizer_Type_Exception(
                'File ' . $file . ' is not readable'
            );
        }
        
        $eol = $this->getEolIdentifier( $content );
        
        $this->initializeIdentifiers( $eol );
        
        if ( $eol != $this->endOfLine ) {
            $content = str_replace( $eol, $this->endOfLine, $content );
        }
        
        if ( preg_match( $this->hashBangIdentifier, $content, $match ) ) {
            $content = str_replace( $match[0], '', $content );
            
            if ( !$this->hashBang ) {
                $this->hashBang = $match[1];
            }
        }
        
        $result = trim( $content );
        $result = preg_replace( '"^<\?php"', '', $result );
        $result = preg_replace( '"\?>$"', '', $result );
        
        $this->_setContent( $result );
    }
    
    // }}}
    // {{{ public function reformat()
    
    /**
     * Reorganizes the script's content by applying the chosen
     * {@link ScriptReorganizer_Strategy Strategy}
     *
     * @return void 
     */
    public function reformat()
    {
        $content = $this->_getContent();
        
        $this->maskHeredocs( $content );
        $content = trim( $this->strategy->reformat( $content, $this->endOfLine ) );
        $this->unmaskHeredocs( $content );
        
        $this->_setContent( $content );
    }
    
    // }}}
    // {{{ public function save( $file )
    
    /**
     * Saves the reorganized script's content to disk
     *
     * @param  string $file a string representing the file's name to save
     * @return void 
     * @throws {@link ScriptReorganizer_Type_Exception ScriptReorganizer_Type_Exception}
     */
    public function save( $file )
    {
        $content  = $this->hashBang;
        $content .= '<?php' . $this->endOfLine . $this->endOfLine . $this->_getContent()
            . $this->endOfLine . $this->endOfLine . '?>';
        
        if ( false === @file_put_contents( $file, $content ) ) {
            throw new ScriptReorganizer_Type_Exception(
                'File ' . $file . ' is not writable'
            );
        }
        
        $this->endOfLine = '';
    }
    
    // }}}
    
    // {{{ protected function getEolIdentifier( & $content )
    
    /**
     * Detects the currently used end-of-line identifier
     *
     * @param  string &$content a string representing the script's content
     * @return string a string representing the end-of-line identifier found in the
     *          script's content
     * @since  Method available sind Release 0.3.0
     */
    protected function getEolIdentifier( & $content )
    {
        foreach ( $this->endOfLineIdentifiers as $eol ) {
            if ( false !== strpos( $content, $eol ) ) {
                return $eol;
            }
        }
    }
    
    // }}}
    
    // {{{ package function _getContent()
    
    /**
     * Gets the script's content currently being reorganized
     *
     * @visibility package restricted
     * @return     string a string representing the script's content
     */
    public function _getContent()
    {
        return $this->content;
    }
    
    // }}}
    // {{{ package function _setContent( $content )
    
    /**
     * Sets the script's content currently being reorganized
     *
     * @visibility package restricted
     * @param      string $content a string representing the content's replacement
     * @return     void 
     */
    public function _setContent( $content )
    {
        $this->content = $content;
    }
    
    // }}}
    
    // {{{ private function initializeIdentifiers( $eol )
    
    /**
     * Sets the values of internal identifiers for future use
     *
     * @param  string $eol a string representing an end-of-line identifier
     * @return void 
     * @since  Method available sind Release 0.3.0
     */
    private function initializeIdentifiers( $eol )
    {
        if ( !$this->endOfLine ) {
            $this->endOfLine = $eol;
            
            $this->hashBangIdentifier = '"^[ \t' . $eol . ']*(\#\![^' . $eol . ']+'
                 . $eol . ')"';
            
            $heredocs  = '"([<]{3}[ \t]*(\w+)[' . $eol . ']';
            $heredocs .= '(.|[' . $eol . '])+?\2;?)[' . $eol . ']"';
            
            $this->heredocsIdentifier = $heredocs;
        }
    }
    
    // }}}
    // {{{ private function maskHeredocs( & $content )
    
    /**
     * Hides Heredoc strings before the reorganization process
     *
     * @param  string &$content a string representing the script's content
     * @return void 
     * @see    unmaskHeredocs(), reformat()
     * @since  Method available since Release 0.2.1
     */
    private function maskHeredocs( & $content )
    {
        if ( preg_match_all( $this->heredocsIdentifier, $content, $this->heredocs ) ) {
            $i = 0;
            
            foreach ( $this->heredocs[1] as $heredoc ) {
                $content = str_replace(
                    $heredoc, '< Heredoc ' . $i++ . ' >', $content
                );
                
                preg_match( '"^[<]{3}[ \t]*(\w+)"', $heredoc, $identifier );
                $heredocIndent = '"[' . $this->endOfLine . ']([ \t]+)' . $identifier[1] . ';?$"';
                
                if ( preg_match( $heredocIndent, $heredoc, $indent ) ) {
                    $this->heredocs[1][$i-1] = str_replace(
                        $this->endOfLine . $indent[1], $this->endOfLine, $heredoc
                    );
                }
            }
        }
    }
    
    // }}}
    // {{{ private function unmaskHeredocs( & $content )
    
    /**
     * Unhides Heredoc strings after the reorganization process
     *
     * @param  string &$content a string representing the script's content
     * @return void 
     * @see    maskHeredocs(), reformat()
     * @since  Method available since Release 0.2.1
     */
    private function unmaskHeredocs( & $content )
    {
        $i = 0;
        
        foreach ( $this->heredocs[1] as $heredoc ) {
            $hd = '< Heredoc ' . $i++ . ' >';
            $trailingSpace = false !== strpos( $content, $hd . ' ' );
            
            $content = str_replace(
                $hd . ( $trailingSpace ? ' ' : '' ),
                $heredoc . ( $trailingSpace ? $this->endOfLine : '' ), $content
            );
        }
    }
    
    // }}}
    
    // {{{ private properties
    
    /**
     * Holds the script's content currently being reorganized
     *
     * @var string 
     */
    private $content = '';
    
    /**
     * Holds the end-of-line identifier currently being used
     *
     * @var string 
     */
    private $endOfLine = '';
    
    /**
     * Holds the end-of-line identifiers of known OSes
     *
     * @var array 
     */
    private $endOfLineIdentifiers = null;
    
    /**
     * Holds the first found hash-bang directive
     *
     * @var string 
     */
    private $hashBang = '';
    
    /**
     * Holds the regular expression for the unices' has-bang directive
     *
     * @var string 
     */
    private $hashBangIdentifier = '';
    
    /**
     * Holds the list of Heredoc strings to un-/mask
     *
     * @var array 
     */
    private $heredocs = null;
    
    /**
     * Holds the regular expression for Heredoc strings
     *
     * @var string 
     */
    private $heredocsIdentifier = '';
    
    /**
     * Holds the strategy to apply
     *
     * @var ScriptReorganizer_Strategy 
     */
    private $strategy = null;
    
    // }}}
}
 
/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * c-hanging-comment-ender-p: nil
 * End:
 */
 
?>