File Source for FilesystemTree.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>\r\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\r\n";
exit();
}
/**
*
*/
require_once( CLASSPATH."filesystem/FilesystemToolkit.class.php" );
/**
*
*/
require_once( CLASSPATH."filesystem/Folder.class.php" );
/**
*
*/
include_once( CLASSPATH."filesystem/ImageFiles.class.php" );
/**
* Class to generate Vector object.
*/
include_once CLASSPATH."data_structures/Vector.class.php";
/**
* A class to managing a filesystemtree.
*
* @package filesystem
* @version 0.1.65
* @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 FilesystemTree
{
/**
* @var string
* @access private
*/
var $path;
/**
* @access public
* @var string $name
*/
var $name;
/**
* @var array
* @access private
*/
var $folder;
/**
* @var array
* @access private
*/
var $files;
/**
* Constructor
*
* @version 1.03
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $path
* @param string $regExpMatchFiles
* @param string $regExpMatchFolder
* @param boolean $filesize
* @param boolean $handle_known_filetypes For example, images will then put
* into a ImageFiles object, instead
* of Files object.
*/
function FilesystemTree(
$path,
$regExpMatchFiles = "",
$regExpMatchFolder = "",
$filesize = false,
$handle_known_filetypes = false
)
{
$this->path = FilesystemToolkit::getCleanPath( $path );
$this->name = basename( $this->path );
$this->setTree(
$path,
$this,
$regExpMatchFiles,
$regExpMatchFolder,
$filesize,
$handle_known_filetypes
);
}
/**
* Returns the names of folder that this->path 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->path 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 filesystem object.
*
* @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 filsystem tree object.
*
* @version 1.0
* @since 0.1.5
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function getName()
{ return $this->name; }
/**
* Returns the file objects of this filesystem tree object in pre-order.
*
* @version 1.0
* @since 0.1.65
* @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;
}
/**
* Builds a tree of the filesystem beginning at $dir.
*
* @version 1.65
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access private
* @static
* @param string $dir The base directory from which the filesystem
* should be build.
* @param object $objRef The root object of the tree. It will be this
* object in most cases.
*
* @param string $regExpMatchFiles
* @param string $regExpMatchFolder
*
* @param boolean $filesize With this flag you were able to assign whether
* the filesizes should also stored in the tree.
*
* @param boolean $handle_known_filetypes For example, images will then put
* into a ImageFiles object, instead
* of Files object.
* @return string
*/
function setTree(
$dir,
&$objRef,
$regExpMatchFiles = "",
$regExpMatchFolder = "",
$filesize = false,
$handle_known_filetypes = false
)
{
$dir = FilesystemToolkit::getCleanPath( $dir );
$resArr = FilesystemToolkit::loadFolderContent(
$dir,
$regExpMatchFiles,
$regExpMatchFolder,
$filesize
);
if ( is_array( $resArr ) )
{
for ( $i = 0; $i < count( $resArr ); $i++ )
if ( $resArr[$i]["is_dir"] )
{
$objRef->folder[] =& new Folder(
$resArr[$i]["name"],
$objRef
);
$tmp_curr = count( $objRef->folder ) - 1;
$objRef->folder[$tmp_curr]->setParentFolder( $objRef );
$this->setTree(
$dir."/".$resArr[$i]["name"],
$objRef->folder[$tmp_curr],
$regExpMatchFiles,
$regExpMatchFolder,
$filesize,
$handle_known_filetypes
);
}
else
{
if ( !$handle_known_filetypes )
$objRef->files[] =& new Files( $dir, $resArr[$i]["name"] );
else
{
switch (
strtolower(
FilesystemToolkit::getFileSuffix(
$resArr[$i]["name"]
)
)
)
{
case "jpg":
case "jpeg":
case "gif":
case "png":
$objRef->files[] =& new ImageFiles(
$dir."/".$resArr[$i]["name"]
);
break;
default:
$objRef->files[] =& new Files(
$dir,
$resArr[$i]["name"]
);
break;
}
}
$tmp_curr = count( $objRef->files ) - 1;
if ( $filesize )
$objRef->files[$tmp_curr]->setFilesize( $resArr[$i]["size"] );
$objRef->files[$tmp_curr]->setParentFolder( $objRef );
}
}
}
/**
* Search an Files object in the tree that is equal to the given one. The
* two File objects will be accounted as equal, if the the filenames and
* pathes match each other.
*
* @version 1.0
* @since 0.1.47
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $f_obj The object to find.
* @param string $folder_obj The reference used to dig in the filesystem
* tree. This variable has to be initialized
* with $this object.
* @return null|Files
*/
function &findFile( &$f_obj, &$folder_obj /* = $this */ )
{
for ( $i = 0; $i < count( $folder_obj->files ); $i++ )
if ( $f_obj->equals( $folder_obj->files[$i] ) )
# ImageFiles object found!
return $folder_obj->files[$i];
for ( $i = 0; $i < count( $folder_obj->folder ); $i++ )
{
$return_obj =& $this->findFile( $f_obj, $folder_obj->folder[$i] );
# ImageFiles object found in depth!
if ( is_object( $return_obj ) )
return $return_obj;
}
return null;
}
/**
* Builds and returns a Vector from the filesystem trees. That means that
* all files will be in a list, so for example you can operate with next()-
* and prev()-function to navigate in that list.
*
* @version 1.0
* @since 0.1.17
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $folder_obj The reference used to dig in the filesystem
* tree. This variable has to be initialized
* with $this object.
* @return Vector
*/
function getVectorFromTree( &$folder_obj )
{
$vec_obj =& new Vector();
for ( $i = 0; $i < count( $folder_obj->files ); $i++ )
$vec_obj->add( $folder_obj->files[$i] );
for ( $i = 0; $i < count( $folder_obj->folder ); $i++ )
{
$return_obj =& $this->getVectorFromTree( $folder_obj->folder[$i] );
$vec_obj->mixed = array_merge(
$vec_obj->mixed,
$return_obj->mixed
);
}
return $vec_obj;
}
/**
* Sends a dirty formatted list of this filesystem to the browser.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function echoTree()
{
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";
}
} // END of class FilesystemTree
?>

Source for file FilesystemTree.class.php