Source for file Pack.php

<?php
 
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
 
/**
 * ScriptReorganizer Strategy :: Pack
 *
 * 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
 * @subpackage Strategy
 * @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: Pack.php 33 2005-11-06 22:05:46Z stefanorausch $
 * @link       http://pear.php.net/package/ScriptReorganizer
 * @filesource
 */
 
/**
 * Implements <kbd>ScriptReorganizer_Strategy</kbd>
 */
require_once 'ScriptReorganizer/Strategy.php';
 
/**
 * Uses <kbd>ScriptReorganizer_Strategy_Quiet</kbd>
 */
require_once 'ScriptReorganizer/Strategy/Quiet.php';
 
/**
 * Advanced strategy
 *
 * Reorganizes scripts by applying the {@link ScriptReorganizer_Strategy_Quiet Quiet}
 * strategy as well as by replacing (1) EOLs according to the pack mode - see below
 * (2) two or more consecutive spaces and/or tabs with a single space char.
 *
 * Multiple consecutive EOLs are replaced either as defined (1) in the default mode
 * by a single EOL or (2) in the extreme mode by a single space char.
 *
 * <b>Warning</b>: With ScriptReorganizer optimized source code the tracking of
 * report error messages of the PHP Engine will definitively get cumbersome, when the
 * extreme mode of the Pack strategy is applied. Reason being: all statements are
 * organized on one line only. It is crucial to throughout test again - not only unit
 * test - the code after optimizing it and before building a release to deploy.
 *
 * If the extreme pack mode strategy is used for packaging, a non-ScriptReorganized
 * source code tree should be shipped together with the optimized one, to enable
 * third parties to track down undiscoverd bugs.
 *
 * @category   Tools
 * @package    ScriptReorganizer
 * @subpackage Strategy
 * @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
 */
class ScriptReorganizer_Strategy_Pack implements ScriptReorganizer_Strategy
{
    // {{{ public function __construct( $oneLiner = false )
    
    /**
     * Constructor
     *
     * @param boolean $oneLiner true, if the script's packing should result in only
     *         one line of code - extreme pack mode; otherwise false - default pack
     *         mode
     */
    public function __construct( $oneLiner = false )
    {
        $this->oneLiner = $oneLiner ? true : false;
        $this->quiet = new ScriptReorganizer_Strategy_Quiet;
    }
    
    // }}}
    
    // {{{ public function reformat( & $content, $eol )
    
    /**
     * Performs the main reorganization of the script's content
     *
     * @param  string &$content a string representing the script's content
     * @param  string $eol a string representing the EOL identifier to use
     * @return string a string representing the reorganized content
     */
    public function reformat( & $content, $eol )
    {
        $multiSpacesAndOrTabs = '"[ \t]+"';
        
        $result = $this->quiet->reformat( $content, $eol );
        
        if ( $this->oneLiner ) {
            $result = str_replace( $eol, ' ', $result );
        } else {
            $result = preg_replace( '"[' . $eol . ']+[ \t]+"', $eol , $result );
            $result = str_replace( $eol . $eol, $eol, $result );
        }
        
        $result = preg_replace( $multiSpacesAndOrTabs, ' ', $result );
        
        return $result;
    }
    
    // }}}
    
    // {{{ private properties
    
    /**
     * Holds the indicator for extreme packing
     *
     * @var boolean 
     */
    private $oneLiner = false;
    
    /**
     * Holds the helper strategy
     *
     * @var ScriptReorganizer_Strategy_Quiet 
     */
    private $quiet = null;
    
    // }}}
}
 
/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * c-hanging-comment-ender-p: nil
 * End:
 */
 
?>