File Source for Folder.class.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 manage folder in a filesystemtree.
*
* @package filesystem
* @version 0.1.25
* @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 Folder
{
/**
* @access public
* @var string $path
*/
var $path;
/**
* @access public
* @var string $name
*/
var $name;
/**
* @access public
* @var Folder $parentfolder
*/
var $parentfolder;
/**
* @access public
* @var array $folder
*/
var $folder;
/**
* @access public
* @var array $files
*/
var $files;
/**
* Constructor
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $name
* @param object $parent
*/
function Folder( $name, $parent )
{
$this->name = $name;
$this->path = $parent->path."/".$name;
}
/**
* Sets the parent folder of this folder object that there is a back reference
* up to the root of the filesystem tree,
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access protected
* @param Folder $objRef The reference to the folder object that
* contains this folder.
*/
function setParentFolder( &$objRef )
{ $this->parentfolder = &$objRef; }
/**
* Returns the names of folder that this folder contains by an array.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return array
*/
function getFoldernames()
{
for( $i = 0; $i < count( $this->folder ); $i++ )
$outputArr[] = $this->folder[$i]->getName();
return $outputArr;
}
/**
* Returns the names of files that this folder contains by an array.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return array
*/
function getFilenames()
{
for( $i = 0; $i < count( $this->files ); $i++ )
$outputArr[] = $this->files[$i]->getName();
return $outputArr;
}
/**
* Returns the path to the folder of this folder object including
* it selfs name.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function getPath()
{ return $this->path; }
/**
* Returns the foldername of this folder object.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function getName()
{ return $this->name; }
/**
* Returns the file objects of this folder object in pre-order.
*
* @version 1.0
* @since 0.1.25
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return array
*/
function &getFilesArray()
{
$out_arr = array();
foreach ( $this->files as $key => $value )
$out_arr[] =& $this->files[$key];
foreach ( $this->folder as $key => $value )
{
$tmp_arr =& $this->folder[$key]->getFilesArray();
// array_merge doesn't keep references alive!
foreach ( $tmp_arr as $key2 => $value2 )
$out_arr[] =& $tmp_arr[$key2];
unset( $tmp_arr );
}
return $out_arr;
}
/**
* Prints out a dirty formatted list of all folder and files that this
* folder contains. All contents of containing folder will be printed too
* because of recursive invocation.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
*/
function echoNameQueque()
{
echo "<blockquote>\n";
for( $i = 0; $i < count( $this->folder ); $i++ )
{
echo $this->folder[$i]->getName()."<br>\n";
$this->folder[$i]->echoNameQueque();
}
for( $i = 0; $i < count( $this->files ); $i++ )
echo $this->files[$i]->getName()."<br>\n";
echo "</blockquote>\n";
}
} // END of class Folder
?>

Source for file Folder.class.php