File Source for PHPFile.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package filesystem
*/
if( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
exit();
}
/**
*
*/
require_once( CLASSPATH."filesystem/Files.class.php" );
/**
* A class to create php-files who using this class-library.
*
* @package filesystem
* @version 0.1.3
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (c) 2003 Daniel Plücken <daniel@debakel.net>
*
* 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.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class PHPFile extends Files
{
/**
* @access public
* @var string $pathtoclasses
*/
var $pathtoclasses;
/**
* @access public
* @var array $includes
*/
var $includes = array( "html/HTMLDocument.inc.php" );
/**
* @access public
* @var HTMLDocument
*/
var $htmldoc;
/**
* Constructor
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $path_and_filename
* @or
* @param string $path
* @param string $filename
*/
function PHPFile()
{
$param = func_get_args();
$this->Files( $param[0], $param[1] );
}
/**
* Sets pathtoclasses, the variable of this object, that should contain the
* path to the class library relatively from the location of this file.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string the path to the class-library relativly from the
* location of this file.
*/
function setPathToClasses( $string )
{ $this->pathtoclasses = $string; }
/**
* Sets htmldoc, the variable of this object, that should contain the
* object's reference of the html-document whose sourcecode will be
* written if this object will be printed.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param HTMLDocument $doc_ref The path to the class-library relativly
* from the location of this file.
*/
function setDocument( &$doc_ref )
{ $this->htmldoc =& $doc_ref; }
/**
* Adds a sourcepath to the array "includes" of this object.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string The path to a script in the class-library.
*/
function addInclude( $string )
{
$doinc = true;
for( $i = 0; $i < count( $this->includes ); $i++ )
if( $this->includes[$i] == $string )
{
$doinc = false;
break;
}
if( $doinc )
$this->includes[] = $string;
}
/**
* Adds items to the object that is referenced in the object's variable
* "htmldoc".
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param HTMLDocument $item_ref
* @return string
*/
function addItem( &$item_ref )
{ $this->htmldoc->addItem( $item_ref ); }
/**
* Returns the source of the generated php-file.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function get()
{
$outputstr = "<?php\n";
$outputstr .= "\x24classpath = \""
.( !empty( $this->pathtoclasses )
? $this->pathtoclasses
: "./"
)
."\";\n\n";
for( $i = 0; $i < count( $this->includes ); $i++ )
$outputstr .= "include( \x24classpath.\"".$this->includes[$i]."\" );\n";
$outputstr .= "\n";
$outputstr .= $this->htmldoc->getPHPSource();
$outputstr .= "?>\n";
return $outputstr;
}
} // END of class PHPFile
?>

Source for file PHPFile.class.php