Class: AlphaFileUtils

Source Location: /util/AlphaFileUtils.inc

Class AlphaFileUtils

Class Overview

A utility class for carrying out various file system tasks

Located in /util/AlphaFileUtils.inc [line 47]

Author(s):

John Collins <dev@alphaframework.org>

Information Tags:

Version:	$Id: AlphaFileUtils.inc 1454 2011-12-04 15:14:05Z johnc $
Copyright:	Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved. 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.
Since:	1.0
License:	The BSD License

Methods

[ Top ]

Method Summary

static void	copy()	Recursively copies the indicated folder, or single file, to the desintation location
static void	deleteDirectoryContents()	Recursively deletes the contents of the directory indicated.
static string	getMIMETypeByExtension()	Method that allows you to determine a MIME type for a file which you provide the extension for.
static integer	listDirectoryContents()	Renders the contents of the directory as a HTML list.
static void	zip()	Recursively compresses the contens of the source directory indicated to the desintation zip archive

[ Top ]

Methods

static method copy [line 595]

static void copy(
string
$source, string
$dest 
)

Recursively copies the indicated folder, or single file, to the desintation location

Parameters:

string	$source:	The path to the source directory or file.
string	$dest:	The destination source directory or file.

API Tags:

Access:

public

Information Tags:

Since:	1.1
Throws:	AlphaException

[ Top ]

static method deleteDirectoryContents [line 567]

static void deleteDirectoryContents(
string
$sourceDir 
)

Recursively deletes the contents of the directory indicated.

Parameters:

string

$sourceDir:

The path to the source directory.

API Tags:

Access:

public

Information Tags:

Since:	1.0
Throws:	AlphaException

[ Top ]

static method getMIMETypeByExtension [line 517]

static string getMIMETypeByExtension(
string
$ext 
)

Method that allows you to determine a MIME type for a file which you provide the extension for.

Parameters:

string

$ext:

The file extension.

API Tags:

Access:

public

Information Tags:

Since:	1.0
Throws:	IllegalArguementException

[ Top ]

static method listDirectoryContents [line 535]

static integer listDirectoryContents(
string
$sourceDir, [integer
$fileCount = 0] 
)

Renders the contents of the directory as a HTML list.

Parameters:

string	$sourceDir:	The path to the source directory.
integer	$fileCount:	The current file count (used in recursive calls).

API Tags:

Return:	The current filecount for the directory.
Access:	public

Information Tags:

Since:	1.0
Throws:	AlphaException

[ Top ]

static method zip [line 631]

static void zip(
string
$source, string
$dest 
)

Recursively compresses the contens of the source directory indicated to the desintation zip archive

Parameters:

string	$source:	The path to the source directory or file.
string	$dest:	The destination zip file file.

API Tags:

Access:

public

Information Tags:

Since:	1.1
Throws:	AlphaException

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:26:05 +0000 by phpDocumentor 1.4.3

	alpha--util

[ class tree: alpha--util ] [ index: alpha--util ] [ all elements ]