[ Index ]
 

Code source de Symfony 1.0.0

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/lib/vendor/phing/system/io/ -> PhingFile.php (sommaire)

(pas de description)

Poids: 866 lignes (32 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

PhingFile:: (47 méthodes):
  __construct()
  getPrefixLength()
  _constructPathname()
  _constructStringParentStringChild()
  _constructFileParentStringChild()
  getName()
  getParent()
  getParentFile()
  getPath()
  isAbsolute()
  getAbsolutePath()
  getAbsoluteFile()
  getCanonicalPath()
  getCanonicalFile()
  toURL()
  toURI()
  _slashify()
  canRead()
  canWrite()
  exists()
  isDirectory()
  isFile()
  isHidden()
  lastModified()
  length()
  contents()
  createNewFile()
  delete()
  deleteOnExit()
  listDir()
  listFiles()
  mkdirs()
  mkdir()
  renameTo()
  copyTo()
  setLastModified()
  setReadOnly()
  setMode()
  getMode()
  listRoots()
  getTempDir()
  createTempFile()
  removeTempFile()
  compareTo()
  equals()
  toString()
  __toString()


Classe: PhingFile  - X-Ref

An abstract representation of file and directory pathnames.

__construct($arg1 = null, $arg2 = null)   X-Ref
Pas de description

getPrefixLength()   X-Ref
Pas de description

_constructPathname($pathname)   X-Ref
Pas de description

_constructStringParentStringChild($parent, $child = null)   X-Ref
Pas de description

_constructFileParentStringChild($parent, $child = null)   X-Ref
Pas de description

getName()   X-Ref
Returns the name of the file or directory denoted by this abstract
pathname.  This is just the last name in the pathname's name
sequence.  If the pathname's name sequence is empty, then the empty
string is returned.

return: The name of the file or directory denoted by this abstract

getParent()   X-Ref
Returns the pathname string of this abstract pathname's parent, or
null if this pathname does not name a parent directory.

The parent of an abstract pathname consists of the pathname's prefix,
if any, and each name in the pathname's name sequence except for the last.
If the name sequence is empty then the pathname does not name a parent
directory.

return: The pathname string of the parent directory named by this

getParentFile()   X-Ref
Returns the abstract pathname of this abstract pathname's parent,
or null if this pathname does not name a parent directory.

The parent of an abstract pathname consists of the pathname's prefix,
if any, and each name in the pathname's name sequence except for the
last.  If the name sequence is empty then the pathname does not name
a parent directory.

return: The abstract pathname of the parent directory named by this

getPath()   X-Ref
Converts this abstract pathname into a pathname string.  The resulting
string uses the default name-separator character to separate the names
in the name sequence.

return: The string form of this abstract pathname

isAbsolute()   X-Ref
Tests whether this abstract pathname is absolute.  The definition of
absolute pathname is system dependent.  On UNIX systems, a pathname is
absolute if its prefix is "/".  On Win32 systems, a pathname is absolute
if its prefix is a drive specifier followed by "\\", or if its prefix
is "\\".

return: true if this abstract pathname is absolute, false otherwise

getAbsolutePath()   X-Ref
Returns the absolute pathname string of this abstract pathname.

If this abstract pathname is already absolute, then the pathname
string is simply returned as if by the getPath method.
If this abstract pathname is the empty abstract pathname then
the pathname string of the current user directory, which is named by the
system property user.dir, is returned.  Otherwise this
pathname is resolved in a system-dependent way.  On UNIX systems, a
relative pathname is made absolute by resolving it against the current
user directory.  On Win32 systems, a relative pathname is made absolute
by resolving it against the current directory of the drive named by the
pathname, if any; if not, it is resolved against the current user
directory.

return: The absolute pathname string denoting the same file or

getAbsoluteFile()   X-Ref
Returns the absolute form of this abstract pathname.  Equivalent to
getAbsolutePath.

return: The absolute abstract pathname denoting the same file or

getCanonicalPath()   X-Ref
Returns the canonical pathname string of this abstract pathname.

A canonical pathname is both absolute and unique. The precise
definition of canonical form is system-dependent. This method first
converts this pathname to absolute form if necessary, as if by invoking the
getAbsolutePath() method, and then maps it to its unique form in a
system-dependent way.  This typically involves removing redundant names
such as "." and .. from the pathname, resolving symbolic links
(on UNIX platforms), and converting drive letters to a standard case
(on Win32 platforms).

Every pathname that denotes an existing file or directory has a
unique canonical form.  Every pathname that denotes a nonexistent file
or directory also has a unique canonical form.  The canonical form of
the pathname of a nonexistent file or directory may be different from
the canonical form of the same pathname after the file or directory is
created.  Similarly, the canonical form of the pathname of an existing
file or directory may be different from the canonical form of the same
pathname after the file or directory is deleted.

return: The canonical pathname string denoting the same file or

getCanonicalFile()   X-Ref
Returns the canonical form of this abstract pathname.  Equivalent to
getCanonicalPath(.

return: PhingFile The canonical pathname string denoting the same file or

toURL()   X-Ref
Converts this abstract pathname into a file: URL.  The
exact form of the URL is system-dependent.  If it can be determined that
the file denoted by this abstract pathname is a directory, then the
resulting URL will end with a slash.

Usage note: This method does not automatically escape
characters that are illegal in URLs.  It is recommended that new code
convert an abstract pathname into a URL by first converting it into a
URI, via the toURI() method, and then converting the URI
into a URL via the URI::toURL()

return: A URL object representing the equivalent file URL

toURI()   X-Ref
Constructs a file: URI that represents this abstract pathname.
Not implemented yet


_slashify($path, $isDirectory)   X-Ref
Pas de description

canRead()   X-Ref
Tests whether the application can read the file denoted by this
abstract pathname.

return: true if and only if the file specified by this

canWrite()   X-Ref
Tests whether the application can modify to the file denoted by this
abstract pathname.

return: true if and only if the file system actually

exists()   X-Ref
Tests whether the file denoted by this abstract pathname exists.

return: true if and only if the file denoted by this

isDirectory()   X-Ref
Tests whether the file denoted by this abstract pathname is a
directory.

return: true if and only if the file denoted by this

isFile()   X-Ref
Tests whether the file denoted by this abstract pathname is a normal
file.  A file is normal if it is not a directory and, in
addition, satisfies other system-dependent criteria.  Any non-directory
file created by a Java application is guaranteed to be a normal file.

return: true if and only if the file denoted by this

isHidden()   X-Ref
Tests whether the file named by this abstract pathname is a hidden
file.  The exact definition of hidden is system-dependent.  On
UNIX systems, a file is considered to be hidden if its name begins with
a period character ('.').  On Win32 systems, a file is considered to be
hidden if it has been marked as such in the filesystem. Currently there
seems to be no way to dermine isHidden on Win file systems via PHP

return: true if and only if the file denoted by this

lastModified()   X-Ref
Returns the time that the file denoted by this abstract pathname was
last modified.

return: A integer value representing the time the file was

length()   X-Ref
Returns the length of the file denoted by this abstract pathname.
The return value is unspecified if this pathname denotes a directory.

return: The length, in bytes, of the file denoted by this abstract

contents()   X-Ref
Convenience method for returning the contents of this file as a string.
This method uses file_get_contents() to read file in an optimized way.

return: string

createNewFile($parents=true, $mode=0777)   X-Ref
Atomically creates a new, empty file named by this abstract pathname if
and only if a file with this name does not yet exist.  The check for the
existence of the file and the creation of the file if it does not exist
are a single operation that is atomic with respect to all other
filesystem activities that might affect the file.

return: true if the named file does not exist and was

delete()   X-Ref
Deletes the file or directory denoted by this abstract pathname.  If
this pathname denotes a directory, then the directory must be empty in
order to be deleted.

return: true if and only if the file or directory is

deleteOnExit()   X-Ref
Requests that the file or directory denoted by this abstract pathname
be deleted when php terminates.  Deletion will be attempted only for
normal termination of php and if and if only Phing::shutdown() is
called.

Once deletion has been requested, it is not possible to cancel the
request.  This method should therefore be used with care.


listDir($filter = null)   X-Ref
Returns an array of strings naming the files and directories in the
directory denoted by this abstract pathname.

If this abstract pathname does not denote a directory, then this
method returns null  Otherwise an array of strings is
returned, one for each file or directory in the directory.  Names
denoting the directory itself and the directory's parent directory are
not included in the result.  Each string is a file name rather than a
complete path.

There is no guarantee that the name strings in the resulting array
will appear in any specific order; they are not, in particular,
guaranteed to appear in alphabetical order.

return: An array of strings naming the files and directories in the

listFiles($filter = null)   X-Ref
Pas de description

mkdirs()   X-Ref
Creates the directory named by this abstract pathname, including any
necessary but nonexistent parent directories.  Note that if this
operation fails it may have succeeded in creating some of the necessary
parent directories.

return: true if and only if the directory was created,

mkdir()   X-Ref
Creates the directory named by this abstract pathname.

return: true if and only if the directory was created; false otherwise

renameTo(PhingFile $destFile)   X-Ref
Renames the file denoted by this abstract pathname.

param: destFile  The new abstract pathname for the named file
return: true if and only if the renaming succeeded; false otherwise

copyTo(PhingFile $destFile)   X-Ref
Simple-copies file denoted by this abstract pathname into another
PhingFile

param: PhingFile $destFile  The new abstract pathname for the named file
return: true if and only if the renaming succeeded; false otherwise

setLastModified($time)   X-Ref
Sets the last-modified time of the file or directory named by this
abstract pathname.

All platforms support file-modification times to the nearest second,
but some provide more precision.  The argument will be truncated to fit
the supported precision.  If the operation succeeds and no intervening
operations on the file take place, then the next invocation of the
lastModified method will return the (possibly truncated) time argument
that was passed to this method.

param: time  The new last-modified time, measured in milliseconds since
return: true if and only if the operation succeeded; false otherwise

setReadOnly()   X-Ref
Marks the file or directory named by this abstract pathname so that
only read operations are allowed.  After invoking this method the file
or directory is guaranteed not to change until it is either deleted or
marked to allow write access.  Whether or not a read-only file or
directory may be deleted depends upon the underlying system.

return: true if and only if the operation succeeded; false otherwise

setMode($mode)   X-Ref
Sets the mode of the file

param: int $mode Ocatal mode.

getMode()   X-Ref
Retrieve the mode of this file.

return: int

listRoots()   X-Ref
List the available filesystem roots.

A particular platform may support zero or more hierarchically-organized
file systems.  Each file system has a root  directory from which all
other files in that file system can be reached.
Windows platforms, for example, have a root directory for each active
drive; UNIX platforms have a single root directory, namely "/".
The set of available filesystem roots is affected by various system-level
operations such the insertion or ejection of removable media and the
disconnecting or unmounting of physical or virtual disk drives.

This method returns an array of PhingFile objects that
denote the root directories of the available filesystem roots.  It is
guaranteed that the canonical pathname of any file physically present on
the local machine will begin with one of the roots returned by this
method.

The canonical pathname of a file that resides on some other machine
and is accessed via a remote-filesystem protocol such as SMB or NFS may
or may not begin with one of the roots returned by this method.  If the
pathname of a remote file is syntactically indistinguishable from the
pathname of a local file then it will begin with one of the roots
returned by this method.  Thus, for example, PhingFile objects
denoting the root directories of the mapped network drives of a Windows
platform will be returned by this method, while PhingFile
objects containing UNC pathnames will not be returned by this method.

return: An array of PhingFile objects denoting the available

getTempDir()   X-Ref
Returns the path to the temp directory.


createTempFile($prefix, $suffix, PhingFile $directory)   X-Ref
Static method that creates a unique filename whose name begins with
$prefix and ends with $suffix in the directory $directory. $directory
is a reference to a PhingFile Object.
Then, the file is locked for exclusive reading/writing.

author: manuel holtgrewe, grin@gmx.net

removeTempFile()   X-Ref
If necessary, $File the lock on $File is removed and then the file is
deleted


compareTo(PhingFile $file)   X-Ref
Compares two abstract pathnames lexicographically.  The ordering
defined by this method depends upon the underlying system.  On UNIX
systems, alphabetic case is significant in comparing pathnames; on Win32
systems it is not.

param: PhingFile $file Th file whose pathname sould be compared to the pathname of this file.
return: int Zero if the argument is equal to this abstract pathname, a

equals($obj)   X-Ref
Tests this abstract pathname for equality with the given object.
Returns <code>true</code> if and only if the argument is not
<code>null</code> and is an abstract pathname that denotes the same file
or directory as this abstract pathname.  Whether or not two abstract
pathnames are equal depends upon the underlying system.  On UNIX
systems, alphabetic case is significant in comparing pathnames; on Win32
systems it is not.

return: boolean

toString()   X-Ref
Pas de description

__toString()   X-Ref
Pas de description



Généré le : Fri Mar 16 22:42:14 2007 par Balluche grâce à PHPXref 0.7