File Source for Files.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();
}
/**
*
*/
include_once( CLASSPATH."filesystem/FilesystemToolkit.class.php" );
/**
* A class to manage files in a filesystemtree.
*
* @package filesystem
* @version 0.2.26
* @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 Files
{
/**
* @access public
* @var string $path
*/
var $path = "";
/**
* @access private
* @var Folder $parentfolder
*/
var $parentfolder = "";
/**
* @access public
* @var string $filename
*/
var $filename = "";
/**
* @access public
* @var integer $filename
*/
var $filesize = 0;
/**
* @access public
* @var string $content
*/
var $content = "";
/**
* Is set if the function saveTmp() has been invoke.
*
* @access private
* @var string $tmp_fh
*/
var $tmp_fh = "";
/**
* 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 Files()
{
$param = func_get_args();
if( empty( $param[1] ) )
{
$tmpArr = FilesystemToolkit
::separatePathAndFile( $param[0] );
$path = $tmpArr[0];
$file = $tmpArr[1];
}
else
{
$path = $param[0];
$file = $param[1];
}
$this->path = $path;
$this->filename = $file;
}
/**
* Compares the given Files object with this one. If both equal each other it
* will be returned true, otherwise false. The two file objects will be
* accounted as equal, if the the filenames and pathes match each other.
*
* @version 1.0
* @since 0.2.22
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param ImageFiles $img_obj
* @return boolean
*/
function equals( &$img_obj )
{
return $this->filename == $img_obj->filename
&& $this->path == $img_obj->path;
}
/**
* Returns the path to the file of this file 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 filename of this file object.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function getName()
{ return $this->filename; }
/**
* Returns the file extension of the given filename.
*
* @static
* @version 1.0
* @since 0.2.2
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string
* @return string|false
*/
function getExtension( $filename )
{
if( !preg_match( "!\.!", $filename ) )
return false;
else
return preg_replace( "!^.+\.([^.]+)$i!", "$1", $filename );
}
/**
* Returns the content of this file object.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function &getContent()
{
if ( empty( $this->content ) )
$this->load();
return $this->content;
}
/**
* Returns the content of this file object. This function is an alias for
* the function getContent().
*
* @version 1.0
* @since 0.1.4
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function get()
{ return $this->getContent(); }
/**
* Sets the parent folder of this file 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 file.
* @return void
*/
function setParentFolder( &$objRef )
{ $this->parentfolder = &$objRef; }
/**
* Sets the content of this file object.
*
* @version 1.0
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $string The content which should be set to the file.
* @return void
*/
function setContent( $string )
{
if ( !empty( $string ) )
$this->content = $string;
}
/**
* Sets the content of this file object.
*
* @version 1.0
* @since 0.1.2
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param integer $filesize The size of this file to be set.
* @return void
*/
function setFilesize( $filesize )
{
if ( preg_match( "!^\d+$!", $filesize ) )
$this->filesize = $filesize;
}
/**
* Sets the content of this file object.
*
* @version 1.1
* @since 0.1.2
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return integer
*/
function getFilesize()
{
if ( !empty( $this->filesize ) )
return $this->filesize;
else
return sprintf( "%u", filesize( $this->path."/".$this->filename ) );
}
/**
* Loads the content of this file object from the filesystem and sets
* the content to this object.
*
* @version 1.01
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function load()
{
$this->setContent(
FilesystemToolkit
::loadFileContent( $this->path, $this->filename )
);
}
/**
* Saves the file of this object with given name.
* You need to give in the filename at least.
*
* @version 1.12
* @since 0.1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $path Where the file should be stored.
* @param string $file Which name the file should get.
* @return boolean
*/
function saveAs()
{
$param = func_get_args();
if( empty( $param[1] ) )
{
$tmpArr = FilesystemToolkit
::separatePathAndFile( $param[0] );
$path = $tmpArr[0];
$file = $tmpArr[1];
}
else
{
$path = $param[0];
$file = $param[1];
}
if(
empty( $path )
&& empty( $file )
)
{
echo 'You have to give a filename at least.\n<br>';
return false;
}
else
{
$this->path = $path;
$this->filename = $file;
return fwrite(
fopen( $path."/".$file, 'w' ),
$this->get()
);
}
}
/**
* Saves the file of this object.
*
* @version 1.01
* @since 0.1.1
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function save()
{ $this->saveAs( $this->path, $this->filename ); }
/**
* Saves the file of this object in a temporary file.
*
* @access public
* @version 1.02
* @since 0.2.0
*
* @return filehandle
*/
function saveTmp()
{
$this->tmp_fh = tmpfile();
if ( !$this->tmp_fh )
{ $this->tmp_fh = tempnam( getcwd(), "GilliGan_" ); }
if ( ($out = fwrite( $this->tmp_fh, $this->get() )) !== false )
{ fseek( $this->tmp_fh, 0 ); }
return $out;
}
/**
* Deletes the temporary file of this object.
*
* @version 1.0
* @since 0.2.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return boolean
*/
function deleteTmp()
{
fclose( $this->tmp_fh );
clearstatcache();
}
} // End of class Files
?>

Source for file Files.class.php