Class FileUtils

A utility class for carrying out various file system tasks.

Namespace: Alpha\Util\File
Copyright:

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at Util/File/FileUtils.php

Methods summary

`public static string`	# `getMIMETypeByExtension( string $ext )` Method that allows you to determine a MIME type for a file which you provide the extension for. Method that allows you to determine a MIME type for a file which you provide the extension for. Parameters `$ext` The file extension. Returns string Throws `Alpha\Exception\IllegalArguementException` Since 1.0
`public static integer`	# `listDirectoryContents( string $sourceDir, string & $fileList, integer $fileCount = 0, string[] $excludeFiles = array() )` Renders the contents of the directory as a HTML list. Renders the contents of the directory as a HTML list. Parameters `$sourceDir` The path to the source directory. `$fileList` The HTML list of files generated (pass by reference). `$fileCount` The current file count (used in recursive calls). `$excludeFiles` An array of file names to exclude from the list rendered. Returns integer The current filecount for the directory. Throws `Alpha\Exception\AlphaException` Since 1.0
`public static array`	# `getDirectoryContents( string $sourceDir, array & $fileList = array() )` Gets the contents of the directory recursively as a nested hash array (dirname => file1, file2, file3...). Gets the contents of the directory recursively as a nested hash array (dirname => file1, file2, file3...). Parameters `$sourceDir` The path to the source directory. `$fileList` The list of files generated (pass by reference). Returns array Throws `Alpha\Exception\AlphaException` Since 3.0
`public static`	# `deleteDirectoryContents( string $sourceDir, string[] $excludeFiles = array() )` Recursively deletes the contents of the directory indicated (the directory itself is not deleted). Recursively deletes the contents of the directory indicated (the directory itself is not deleted). Parameters `$sourceDir` The path to the source directory. `$excludeFiles` An array of file names to exclude from the deletion. Throws `Alpha\Exception\AlphaException` Since 1.0
`public static`	# `copy( string $source, string $dest )` Recursively copies the indicated folder, or single file, to the destination location. Recursively copies the indicated folder, or single file, to the destination location. Parameters `$source` The path to the source directory or file. `$dest` The destination source directory or file. Throws `Alpha\Exception\AlphaException` Since 1.1
`public static`	# `zip( string $source, string $dest )` Recursively compresses the contents of the source directory indicated to the destintation zip archive. Recursively compresses the contents of the source directory indicated to the destintation zip archive. Parameters `$source` The path to the source directory or file. `$dest` The destination zip file file. Throws `Alpha\Exception\AlphaException` Since 1.1

Namespaces

Classes

Class FileUtils

Methods summary

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Throws

Since

Parameters

Throws

Since

Parameters

Throws

Since