cakephp2-php8/cake/libs/file.php
2007-05-27 16:06:49 +00:00

405 lines
No EOL
8.1 KiB
PHP

<?php
/* SVN FILE: $Id$ */
/**
* Convenience class for reading, writing and appending to files.
*
* PHP versions 4 and 5
*
* CakePHP(tm) : Rapid Development Framework <http://www.cakephp.org/>
* Copyright 2005-2007, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2005-2007, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
* @package cake
* @subpackage cake.cake.libs
* @since CakePHP(tm) v 0.2.9
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Included libraries.
*
*/
if (!class_exists('Object')) {
uses ('object');
}
if (!class_exists('Folder')) {
uses ('folder');
}
/**
* Convenience class for reading, writing and appending to files.
*
* @package cake
* @subpackage cake.cake.libs
*/
class File extends Object{
/**
* Folder object of the File
*
* @var object
* @access public
*/
var $Folder = null;
/**
* Filename
*
* @var string
* @access public
*/
var $name = null;
/**
* Constructor
*
* @param string $path Path to file
* @param boolean $create Create file if it does not exist (if true)
* @param int $mode Mode to apply to the folder holding the file
*/
function __construct($path, $create = false, $mode = 0755) {
parent::__construct();
$this->Folder =& new Folder(dirname($path), $create, $mode);
$this->name = basename($path);
if (!$this->exists()) {
if ($create === true) {
$this->safe();
if (!$this->create()) {
return false;
}
} else {
return false;
}
}
}
/**
* Return the contents of this File as a string.
*
* @return string Contents
* @access public
*/
function read() {
$contents = file_get_contents($this->pwd());
return $contents;
}
/**
* Append given data string to this File.
*
* @param string $data Data to write
* @return boolean Success
* @access public
*/
function append($data) {
return $this->write($data, 'a');
}
/**
* Write given data to this File.
*
* @param string $data Data to write to this File.
* @param string $mode Mode of writing. {@link http://php.net/fwrite See fwrite()}.
* @return boolean Success
* @access public
*/
function write($data, $mode = 'w') {
$file = $this->pwd();
if (!($handle = fopen($file, $mode))) {
trigger_error(sprintf(__("[File] Could not open %s with mode %s!", true), $file, $mode), E_USER_WARNING);
return false;
}
if (false === fwrite($handle, $data)) {
return false;
}
if (!fclose($handle)) {
return false;
}
return true;
}
/**
* makes filename safe for saving
*
* @param string $name the name of the file to make safe if different from $this->name
* @return string $ext the extension of the file
* @access public
*/
function safe($name = null, $ext = null) {
if(!$name) {
$name = $this->name;
}
if(!$ext) {
$ext = $this->ext();
}
return preg_replace( "/[^\w\.-]+/", "_", basename($name, $ext));
}
/**
* Get md5 Checksum of file with previous check of Filesize
*
* @param string $force Data to write to this File.
* @return string md5 Checksum {@link http://php.net/md5_file See md5_file()}
* @access public
*/
function md5($force = false) {
$md5 = '';
if ($force == true || $this->size(false) < MAX_MD5SIZE) {
$md5 = md5_file($this->pwd());
}
return $md5;
}
/**
* Returns the Filesize, either in bytes or in human-readable format.
*
* @param boolean $humanReadeble Data to write to this File.
* @return string|int filesize as int or as a human-readable string
* @access public
*/
function size() {
$size = filesize($this->pwd());
return $size;
}
/**
* Returns the File extension.
*
* @return string The File extension
* @access public
*/
function info() {
return pathinfo($this->pwd());
}
/**
* Returns the File extension.
*
* @return string The File extension
* @access public
*/
function ext() {
$info = $this->info();
if(isset($info['extension'])) {
return $info['extension'];
}
return false;
}
/**
* Returns the File name without extension.
*
* @return string The File name without extension.
* @access public
*/
function filename() {
$info = $this->info();
if(isset($info['filename'])) {
return $info['filename'];
}
return false;
}
/**
* Returns the File's owner.
*
* @return int the Fileowner
*/
function owner() {
$fileowner = fileowner($this->pwd());
return $fileowner;
}
/**
* Returns the File group.
*
* @return int the Filegroup
* @access public
*/
function group() {
$filegroup = filegroup($this->pwd());
return $filegroup;
}
/**
* Creates the File.
*
* @return boolean Success
* @access public
*/
function create() {
$dir = $this->Folder->pwd();
if (file_exists($dir) && is_dir($dir) && is_writable($dir) && !$this->exists()) {
if (!touch($this->pwd())) {
print (sprintf(__('[File] Could not create %s', true), $this->name));
return false;
} else {
return true;
}
} else {
print (sprintf(__('[File] Could not create %s', true), $this->name));
return false;
}
}
/**
* Returns true if the File exists.
*
* @return boolean true if it exists, false otherwise
* @access public
*/
function exists() {
$exists = (file_exists($this->pwd()) && is_file($this->pwd()));
return $exists;
}
/**
* Deletes the File.
*
* @return boolean Success
* @access public
*/
function delete() {
$unlink = unlink($this->pwd());
return $unlink;
}
/**
* Returns true if the File is writable.
*
* @return boolean true if its writable, false otherwise
* @access public
*/
function writable() {
$writable = is_writable($this->pwd());
return $writable;
}
/**
* Returns true if the File is executable.
*
* @return boolean true if its executable, false otherwise
* @access public
*/
function executable() {
$executable = is_executable($this->pwd());
return $executable;
}
/**
* Returns true if the File is readable.
*
* @return boolean true if file is readable, false otherwise
* @access public
*/
function readable() {
$readable = is_readable($this->pwd());
return $readable;
}
/**
* Returns last access time.
*
* @return int timestamp Timestamp of last access time
* @access public
*/
function lastAccess() {
$fileatime = fileatime($this->pwd());
return $fileatime;
}
/**
* Returns last modified time.
*
* @return int timestamp Timestamp of last modification
* @access public
*/
function lastChange() {
$filemtime = filemtime($this->pwd());
return $filemtime;
}
/**
* Returns the current folder.
*
* @return Folder Current folder
* @access public
*/
function &Folder() {
return $this->Folder;
}
/**
* Returns the "chmod" (permissions) of the File.
*
* @return string Permissions for the file
* @access public
*/
function perms() {
$substr = substr(sprintf('%o', fileperms($this->pwd())), -4);
return $substr;
}
/**
* Returns the full path of the File.
*
* @return string Full path to file
* @access public
*/
function pwd() {
return $this->Folder->slashTerm($this->Folder->pwd()) . $this->name;
}
/* Deprecated methods */
/**
* @deprecated
* @see File::pwd
*/
function getFullPath() {
return $this->pwd();
}
/**
* @deprecated
* @see File::name
*/
function getName() {
return $this->name;
}
/**
* @deprecated
* @see File::ext()
*/
function getExt() {
return $this->ext();
}
/**
* @deprecated
* @see File::group()
*/
function getMd5() {
return $this->md5();
}
/**
* @deprecated
* @see File::size()
*/
function getSize() {
return $this->size();
}
/**
* @deprecated
* @see File::owner()
*/
function getOwner() {
return $this->owner();
}
/**
* @deprecated
* @see File::group()
*/
function getGroup() {
return $this->group();
}
/**
* @deprecated
* @see File::perms()
*/
function getChmod() {
return $this->perms();
}
/**
* @deprecated
* @see File::Folder()
*/
function getFolder() {
return $this->Folder();
}
}
?>