FileSystem

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 charlie@tizac.com
author	Hans Lellelid hans@xmpl.org
version	$Id: bc979767c07b19eafeb3fc6f6efa938dd73bde18 $
package	phing.system.io

Methods

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

getFileSystem() : \FileSystem

static

throws

Response

\FileSystem

Return the local filesystem's name-separator character.

getSeparator()

abstract

Return the local filesystem's path-separator character.

getPathSeparator()

abstract

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

normalize(string $strPath)

abstract

Arguments

$strPath

string

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

prefixLength(string $pathname)

abstract

Arguments

$pathname

string

Resolve the child pathname string against the parent.

resolve(string $parent, string $child)

abstract

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

Arguments

$parent

string

$child

string

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

resolveFile(\PhingFile $f)

abstract

Arguments

$f

\PhingFile

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.

getDefaultParent()

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.

fromURIPath(string $path)

abstract

Arguments

$path

string

Tell whether or not the given abstract pathname is absolute.

isAbsolute(\PhingFile $f)

abstract

Arguments

$f

\PhingFile

canonicalize filename by checking on disk

canonicalize(string $strPath) : mixed

Arguments

$strPath

string

Response

mixed

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

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.

getBooleanAttributes(\PhingFile $f)

Arguments

$f

\PhingFile

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.

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

Arguments

$f

\PhingFile

$write

boolean

Whether file can be deleted.

canDelete(\PhingFile $f) : boolean

Arguments

$f

\PhingFile

Response

boolean

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.

getLastModifiedTime(\PhingFile $f) : int

throws

Arguments

$f

\PhingFile

Response

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.

getLength(\PhingFile $f) : int

throws

Arguments

$f

\PhingFile

Response

int

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.

createNewFile(string $strPathname) : boolean

throws

Arguments

$strPathname

string

Path of the file to be created.

Response

boolean

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

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

Arguments

$f

\PhingFile

$recursive

boolean

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.

deleteOnExit(\PhingFile $f)

throws

Arguments

$f

\PhingFile

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 <code>null</code>.

listDir(\PhingFile $f)

Arguments

$f

\PhingFile

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

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

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

Arguments

$f

\PhingFile

$mode

int

Response

boolean

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.

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

throws	if rename cannot be performed

Arguments

$f1

\PhingFile

abstract source file

$f2

\PhingFile

abstract destination file

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.

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

throws

Arguments

$f

\PhingFile

$time

int

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

setReadOnly(\PhingFile $f)

throws

Arguments

$f

\PhingFile

List the available filesystem roots, return array of PhingFile objects

listRoots()

throws

Compare two abstract pathnames lexicographically.

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

Arguments

$f1

\PhingFile

$f2

\PhingFile

Copy a file.

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

throws	if file cannot be copied.

Arguments

$src

\PhingFile

Source path and name file to copy.

$dest

\PhingFile

Destination path and name of new file.

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

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

author	Aidan Lister aidan@php.net
version
link	http://aidanlister.com/repos/v/function.copyr.php

Arguments

$source

string

Source path

$dest

string

Destination path

Response

bool

Returns TRUE on success, FALSE on failure

Change the ownership on a file or directory.

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

throws	if operation failed.

Arguments

$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

Change the group on a file or directory.

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

throws	if operation failed.

Arguments

$pathname

string

Path and name of file or directory.

$group

string

The group of the file or directory. See http://us.php.net/chgrp

Change the permissions on a file or directory.

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

throws	if operation failed.

Arguments

$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.

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

lock(\PhingFile $f) : void

throws

Arguments

$f

\PhingFile

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

unlock(\PhingFile $f) : void

throws

Arguments

$f

\PhingFile

Delete a file.

unlink(string $file) : void

throws	if an error is encountered.

Arguments

$file

string

Path and/or name of file to delete.

Symbolically link a file to another name.

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

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

Arguments

$target

string

Path and/or name of file to link.

$link

string

Path and/or name of link to be created.

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

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

Arguments

$file

string

Path and/or name of file to touch.

$time

int

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

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

Arguments

$dir

$children

Set the umask for file and directory creation.

umask($mode) : void

throws	if there is an error performing operation.

Arguments

$mode

Compare the modified time of two files.

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

throws	if cannot get modified time of either file.

Arguments

$file1

$file2

Response

\Int.

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

Constants

BA_EXISTS

BA_EXISTS

var

BA_REGULAR

BA_REGULAR

var

BA_DIRECTORY

BA_DIRECTORY

var

BA_HIDDEN

BA_HIDDEN

var

Properties

Instance for getFileSystem() method.

fs : \FileSystem

static

var

Type(s)

\FileSystem