system/io/FileSystem.php

Show:

inherited

Classes
- \FileSystem

Table of Contents

This is an abstract class for platform specific filesystem implementations you have to implement each method in the platform specific filesystem implementation classes Your local filesytem implementation must extend this class.

You should also use this class as a template to write your local implementation Some native PHP filesystem specific methods are abstracted here as well. Anyway you must always use this methods via a PhingFile object (that by nature uses the *FileSystem drivers to access the real filesystem via this class using natives.

FIXME: - Error handling reduced to min fallthrough runtime exceptions more precise errorhandling is done by the PhingFile class

Author: Charlie Killian
Author: Hans Lellelid
Package: phing.system.io
Version: $Id$

\FileSystem
jump to top

Package: phing\system\io

FIXME: - Error handling reduced to min fallthrough runtime exceptions more precise errorhandling is done by the PhingFile class

Children: \Win32FileSystem; \UnixFileSystem
Author: Charlie Killian
Author: Hans Lellelid
Version: $Id$

Constants

int 
                BA_EXISTS
                = 0x01

: int

int 
                BA_REGULAR
                = 0x02

: int

int 
                BA_DIRECTORY
                = 0x04

: int

int 
                BA_HIDDEN
                = 0x08

: int

Properties

\FileSystem
                 $fs= ''

static

Instance for getFileSystem() method.

Details

Type: \FileSystem

Methods

canDelete(
          \PhingFile $f
          )
        
        :
          boolean

Whether file can be deleted.

Parameters

Name	Type	Description
$f	\PhingFile

Returns

Type	Description
boolean

canonicalize(
          string $strPath
          )
        
        :
          mixed

canonicalize filename by checking on disk

Parameters

Name	Type	Description
$strPath	string

Returns

Type	Description
mixed	Canonical path or false if the file doesn't exist.

checkAccess(
          \PhingFile $f, boolean $write
              =
              false
          )
        
        :
          void

Check whether the file or directory denoted by the given abstract pathname may be accessed by this process. If the second argument is false, then a check for read access is made; if the second argument is true, then a check for write (not read-write) access is made. Return false if access is denied or an I/O error occurs.

Parameters

Name	Type	Description
$f	\PhingFile
$write	boolean

chgrp(
          string $pathname, string $group
          )
        
        :
          void

Change the group on a file or directory.

Parameters

Name	Type	Description
$pathname	string	Path and name of file or directory.
$group	string	The group of the file or directory. See http://us.php.net/chgrp

Throws

Exception	Description
\IOException	if operation failed.

chmod(
          string $pathname, int $mode
          )
        
        :
          void

Change the permissions on a file or directory.

Parameters

Name	Type	Description
$pathname	string	Path and name of file or directory.
$mode	int	The mode (permissions) of the file or directory. If using octal add leading 0. eg. 0777. Mode is affected by the umask system setting.

Throws

Exception	Description
\IOException	if operation failed.

chown(
          string $pathname, string $user
          )
        
        :
          void

Change the ownership on a file or directory.

Parameters

Name	Type	Description
$pathname	string	Path and name of file or directory.
$user	string	The user name or number of the file or directory. See http://us.php.net/chown

Throws

Exception	Description
\Exception	if operation failed.

compare(
          \PhingFile $f1, \PhingFile $f2
          )
        
        :
          void

Compare two abstract pathnames lexicographically.

Parameters

Name	Type	Description
$f1	\PhingFile
$f2	\PhingFile

compareMTimes(
          \file1 $file1, \file2 $file2
          )
        
        :
          \Int.

Compare the modified time of two files.

Parameters

Name	Type	Description
$file1	\file1	String. Path and name of file1.
$file2	\file2	String. Path and name of file2.

Returns

Type	Description
\Int.	1 if file1 is newer. -1 if file2 is newer. 0 if files have the same time. Err object on failure.

Throws

Exception	Description
\Exception	- if cannot get modified time of either file.

copy(
          \PhingFile $src, \PhingFile $dest
          )
        
        :
          void

Copy a file.

Parameters

Name	Type	Description
$src	\PhingFile	Source path and name file to copy.
$dest	\PhingFile	Destination path and name of new file.

Throws

Exception	Description
\IOException	if file cannot be copied.

copyr(
          string $source, string $dest
          )
        
        :
          bool

Copy a file, or recursively copy a folder and its contents

Parameters

Name	Type	Description
$source	string	Source path
$dest	string	Destination path

Returns

Type	Description
bool	Returns TRUE on success, FALSE on failure

Details

Author: Aidan Lister
Link: http://aidanlister.com/repos/v/function.copyr.php
Version: 1.0.1

createDirectory(
          \PhingFile $f, int $mode
              =
              0755
          )
        
        :
          boolean

Create a new directory denoted by the given abstract pathname, returning true if and only if the operation succeeds.

NOTE: umask() is reset to 0 while executing mkdir(), and restored afterwards

Parameters

Name	Type	Description
$f	\PhingFile
$mode	int

Returns

Type	Description
boolean

createNewFile(
          string $strPathname
          )
        
        :
          boolean

Create a new empty file with the given pathname. Return true if the file was created and false if a file or directory with the given pathname already exists. Throw an IOException if an I/O error occurs.

Parameters

Name	Type	Description
$strPathname	string	Path of the file to be created.

Returns

Type	Description
boolean

Throws

Exception	Description
\IOException

delete(
          \PhingFile $f, boolean $recursive
              =
              false
          )
        
        :
          void

Delete the file or directory denoted by the given abstract pathname, returning true if and only if the operation succeeds.

Parameters

Name	Type	Description
$f	\PhingFile
$recursive	boolean

deleteOnExit(
          \PhingFile $f
          )
        
        :
          void

Arrange for the file or directory denoted by the given abstract pathname to be deleted when Phing::shutdown is called, returning true if and only if the operation succeeds.

Parameters

Name	Type	Description
$f	\PhingFile

Throws

Exception	Description
\IOException

fromURIPath(
          string $path
          )
        
        :
          void

abstract

Post-process the given URI path string if necessary. This is used on win32, e.g., to transform "/c:/foo" into "c:/foo". The path string still has slash separators; code in the PhingFile class will translate them after this method returns.

Parameters

Name	Type	Description
$path	string

getBooleanAttributes(
          \PhingFile $f
          )
        
        :
          void

Return the simple boolean attributes for the file or directory denoted by the given abstract pathname, or zero if it does not exist or some other I/O error occurs.

Parameters

Name	Type	Description
$f	\PhingFile

getDefaultParent(
          
          )
        
        :
          void

abstract

Return the parent pathname string to be used when the parent-directory argument in one of the two-argument PhingFile constructors is the empty pathname.

getFileSystem(
          
          )
        
        :
          \FileSystem

static

Static method to return the FileSystem singelton representing this platform's local filesystem driver.

Returns

Type	Description
\FileSystem

Throws

Exception	Description
\IOException

getLastModifiedTime(
          \PhingFile $f
          )
        
        :
          int

Return the time at which the file or directory denoted by the given abstract pathname was last modified, or zero if it does not exist or some other I/O error occurs.

Parameters

Name	Type	Description
$f	\PhingFile

Returns

Type	Description
int

Throws

Exception	Description
\IOException

getLength(
          \PhingFile $f
          )
        
        :
          int

Return the length in bytes of the file denoted by the given abstract pathname, or zero if it does not exist, is a directory, or some other I/O error occurs.

Parameters

Name	Type	Description
$f	\PhingFile

Returns

Type	Description
int

Throws

Exception	Description
\IOException

getPathSeparator(
          
          )
        
        :
          void

abstract

Return the local filesystem's path-separator character.

getSeparator(
          
          )
        
        :
          void

abstract

Return the local filesystem's name-separator character.

isAbsolute(
          \PhingFile $f
          )
        
        :
          void

abstract

Tell whether or not the given abstract pathname is absolute.

Parameters

Name	Type	Description
$f	\PhingFile

listDir(
          \PhingFile $f
          )
        
        :
          void

List the elements of the directory denoted by the given abstract pathname. Return an array of strings naming the elements of the directory if successful; otherwise, return null.

Parameters

Name	Type	Description
$f	\PhingFile

listRoots(
          
          )
        
        :
          void

List the available filesystem roots, return array of PhingFile objects

Throws

Exception	Description
\IOException

lock(
          \PhingFile $f
          )
        
        :
          void

Locks a file and throws an Exception if this is not possible.

Parameters

Name	Type	Description
$f	\PhingFile

Throws

Exception	Description
\Exception

normalize(
          string $strPath
          )
        
        :
          void

abstract

Convert the given pathname string to normal form. If the string is already in normal form then it is simply returned.

Parameters

Name	Type	Description
$strPath	string

prefixLength(
          string $pathname
          )
        
        :
          void

abstract

Compute the length of this pathname string's prefix. The pathname string must be in normal form.

Parameters

Name	Type	Description
$pathname	string

rename(
          \PhingFile $f1, \PhingFile $f2
          )
        
        :
          void

Rename the file or directory denoted by the first abstract pathname to the second abstract pathname, returning true if and only if the operation succeeds.

Parameters

Name	Type	Description
$f1	\PhingFile	abstract source file
$f2	\PhingFile	abstract destination file

Throws

Exception	Description
\IOException	if rename cannot be performed

resolve(
          string $parent, string $child
          )
        
        :
          void

abstract

Resolve the child pathname string against the parent.

Both strings must be in normal form, and the result will be a string in normal form.

Parameters

Name	Type	Description
$parent	string
$child	string

resolveFile(
          \PhingFile $f
          )
        
        :
          void

abstract

Resolve the given abstract pathname into absolute form. Invoked by the getAbsolutePath and getCanonicalPath methods in the PhingFile class.

Parameters

Name	Type	Description
$f	\PhingFile

rmdir(
          \dir $dir, \children $children
              =
              false
          )
        
        :
          void

Delete an empty directory OR a directory and all of its contents.

Parameters

Name	Type	Description
$dir	\dir	String. Path and/or name of directory to delete.
$children	\children	Boolean. False: don't delete directory contents. True: delete directory contents.

setLastModifiedTime(
          \PhingFile $f, int $time
          )
        
        :
          void

Set the last-modified time of the file or directory denoted by the given abstract pathname returning true if and only if the operation succeeds.

Parameters

Name	Type	Description
$f	\PhingFile
$time	int

Throws

Exception	Description
\IOException

setReadOnly(
          \PhingFile $f
          )
        
        :
          void

Mark the file or directory denoted by the given abstract pathname as read-only, returning true if and only if the operation succeeds.

Parameters

Name	Type	Description
$f	\PhingFile

Throws

Exception	Description
\IOException

symlink(
          string $target, string $link
          )
        
        :
          void

Symbolically link a file to another name.

Currently symlink is not implemented on Windows. Don't use if the application is to be portable.

Parameters

Name	Type	Description
$target	string	Path and/or name of file to link.
$link	string	Path and/or name of link to be created.

touch(
          string $file, int $time
              =
              null
          )
        
        :
          void

Set the modification and access time on a file to the present time.

Parameters

Name	Type	Description
$file	string	Path and/or name of file to touch.
$time	int

umask(
          \mode $mode
          )
        
        :
          void

Set the umask for file and directory creation.

Parameters

Name	Type	Description
$mode	\mode	Int. Permissions ususally in ocatal. Use leading 0 for octal. Number between 0 and 0777.

Throws

Exception	Description
\Exception	if there is an error performing operation.

unlink(
          string $file
          )
        
        :
          void

Delete a file.

Parameters

Name	Type	Description
$file	string	Path and/or name of file to delete.

Throws

Exception	Description
\IOException	- if an error is encountered.

unlock(
          \PhingFile $f
          )
        
        :
          void

Unlocks a file and throws an IO Error if this is not possible.

Parameters

Name	Type	Description
$f	\PhingFile

Throws

Exception	Description
\IOException

system/io/FileSystem.php

\FileSystemjump to top

Constants

Properties

Methods

\FileSystem
jump to top