mixed upload (string $sFormItem, string $sDestination, string $sFileName, [bool $bModifyFileName = true], [int $iPerm = 0644], [bool $buildDir = true], [bool $bCdn = true])

bool write (string $sFile, string $sData, [string $sMode = 'w'])

object Returns writeToCache (string $sFile, string $sData)

mixed _buildDir (string $sDestination)

void _buildFile (string $sFormItem)

void _getFileType ()

bool _passLimit ()

bool _verify (string $sFileName)

Variables

array $_aFile = array() (line 44)

Holds meta information about a file that was uploaded. Information includes $_FORM

access: private

array $_aFileCheck = array(
// 'mp3' =>
) (line 74)

Foruce a special file check on meta data. This feature is not being used at the moment as it was designed for MP3s

access: private

array $_aSupported = array() (line 58)

Holds an ARRAY of all the supported file types identified by the routine

access: private

int $_iMaxSize = null (line 66)

Holds the max size of what is allowed by the routine in bytes. Note that this is also checked by the system to make sure it can handle such a size.

access: private

string $_sDestination (line 37)

Holds the final path of a file that was uploaded

access: private

string $_sExt (line 51)

Holds the file extension of the file that was uploaded.

access: private

Methods

static filesize (line 334)

Gets the filesize of a file and returns the best human readable output.

return: Returns a human readable output on the file size of a file
access: public

string filesize (int $iSize, [int $iPrecision = 2])

int $iSize: Size of the file
int $iPrecision: Precision on the output

Constructor __construct (line 82)

Class constructor

access: public

Phpfox_File __construct ()

copy (line 517)

Copy a file from one location to another.

return: If copy was successful we return TRUE, otherwise we return FALSE
see: Phpfox_File::copy()
access: public

bool copy (string $sSrc, string $sDest)

string $sSrc: Full path to the orginal file
string $sDest: Full path to where the orignal file will be copied to

delete_directory (line 754)

Deletes a directory and all the files and folders in it (recursive)

access: public

void delete_directory ( $dir, string $sPath)

string $sPath: Absolute path to the folder
$dir

forceDownload (line 433)

Forces a file to be downloaded by the end-user and at the same time try to hide the location of the file.

access: public

void forceDownload (string $sFile, string $sName, [string $sMimeType = ''], [string $sFileSize = ''], [string $iServerId = 0])

string $sFile: Full path to a file
string $sName: Name of the file when the user trys to download it
string $sMimeType: MIME type of the file in case we can't find it.
string $sFileSize: File size of the file in case we can't find it.
string $iServerId: Optional if the site has more then one server you need to specify the original location of the file with the servers ID#

getAllFiles (line 294)

Gets all files/folders in a give directory recursively.

return: List of all the files/folders in a folder.
access: public

array getAllFiles (string $sDir, [bool $bRecurse = false])

string $sDir: Full path to the directory
bool $bRecurse: TRUE if we are in a recursive check or FALSE if we are not.

getBuiltDir (line 742)

Gets the directory we just built to place an uploaded file.

return: Returns the new full path of where the file will be placed.
access: public

string getBuiltDir (string $sDestination)

string $sDestination: Full path to where we should place the uploaded file.

getFiles (line 268)

Gets all the files/folders in a specified directory.

return: Returns an ARRAY of files if we found any or FALSE if we were not able to open the directory.
access: public

mixed getFiles (string $sDir)

string $sDir: Full path to the directory.

getLimit (line 718)

Gets the servers limit on uploading files.

return: Returns the actual limit the server has and if your limit passes the test it will just return your limit.
access: public

string getLimit (int $iMaxSize)

int $iMaxSize: You can define what you want as a limit.

getMeta (line 97)

Get meta information about a file using the getID3 library.

Library is located at: include/library/getid3/

Example:

$aMeta = Phpfox::getLib('file')->getMeta('/var/www/sample.jpg');

return: Returns an ARRAY of meta information about the file
access: public

array getMeta (string $sFileName)

string $sFileName: Full path to the file we need to check

getTempDir (line 673)

Get the temporary directory of the server based on the servers enviroment variables.

Note: Use with caution some servers can be tricky.

return: Returns the best temporary directory we can find.
access: public

string getTempDir ()

isWritable (line 569)

Checks if path is writable

return: If file/folder is writable we return TRUE otherwise we return FALSE
access: public

boolean isWritable (string $sPath, [bool $bForce = false])

string $sPath: Path to file or directory
bool $bForce: If set to TRUE we will disable error reporting and force a check on the file/folder

load (line 125)

Loads an uploaded file and performs checks to make sure it was allowed

to be uploaded bassed on the supported file extensions passed by the 2nd argument. As well as check if the filesize is allowed bassed on the 3rd argument that is passed plus to also make sure the server can handle uploading such a size on the file.

return: If a file was not allowed to be uploaded we return a FALSE, however if it is allowed we return an ARRAY with meta information about the uploaded file.
access: public

mixed load (string $sFormItem, [array $aSupported = array()], [int $iMaxSize = null])

string $sFormItem: Name of the <input> used when submitting the form.
array $aSupported: An ARRAY of allowed file extensions
int $iMaxSize: Max filesize in bytes for the file being uploaded

mkdir (line 787)

Creates a directory. Unlike mkdir() it can also create recursive directories based on the full path that is being passed.

access: public

void mkdir (string $sDir, [bool $bRecurse = false])

string $sDir: Full path of the directory to create
bool $bRecurse: FALSE by default, however if set to TRUE we will create a recursive run on mkdir.

rename (line 535)

Renames a file

return: If rename was successful we return TRUE, otherwise we return FALSE
see: Phpfox_File::rename()
access: public

bool rename (string $sSrc, string $sDest)

string $sSrc: Full path to the orginal file
string $sDest: Full path to where the new file will be located with its new name

unlink (line 552)

Delete a file from the server.

return: If we were able to delete the file we return TRUE otherwise we return FALSE
see: Phpfox_File::unlink()
access: public

bool unlink (string $sSrc)

string $sSrc: Full path to the file

upload (line 198)

Method is named "upload", however due to how PHP works the file has already been uploaded and this simply moves the uploaded file to the final location since it passed all the tests done by the load() method.

return: Returns a FALSE if we cannot move the file or a STRING on the full path of where the file is located as well as the files new name and extension.
access: public

mixed upload (string $sFormItem, string $sDestination, string $sFileName, [bool $bModifyFileName = true], [int $iPerm = 0644], [bool $buildDir = true], [bool $bCdn = true])

string $sFormItem: Name of the <input> used when submitting the form.
string $sDestination: Full path to where the final location of the file will be
string $sFileName: File name of the uploaded file once we have moved it to its final destination
bool $bModifyFileName: By default we modify the actual file name with a unique MD5 hash to make it harder to find, however setting this to FALSE will keep the original name of the file.
int $iPerm: UNIX file permissions on the file. Default is 0644 (read only).
bool $buildDir: We place files in folders based on the current month/year by default. Set this to FALSE to not create such directories and place it in the specificed destination folder.
bool $bCdn: If CDN support is enabled we will copy the file to the CDN server. Set this to FALSE to force the script to not copy the file to CDN even if support is enabled for CDN.

write (line 405)

Writes to a file on the server. Always removes files if it exists.

return: Returns TRUE if we were able to write to the file and FALSE if not.
see: fopen()
see: fwrite()
access: public

bool write (string $sFile, string $sData, [string $sMode = 'w'])

string $sFile: Full path to the file
string $sData: Data to put in the file
string $sMode: Mode to take when opening the file. Default is "w"

writeToCache (line 384)

Writes to a cache file. Overwrites old files and if it does not exist it creates a new one.

return: the classes own object.
access: public

object Returns writeToCache (string $sFile, string $sData)

string $sFile: Fill name of the file to write to.
string $sData: Data to add into the file.

_buildDir (line 852)

Builds a directory structure for items being uploaded based on

by deafult the month/year we are in. This is a setting in the AdminCP where admins can control how the structure is to be built. Note that if SAFE_MODE is enabled this feature will do nothing as we are not allowed to create folders in such an enviroment.

return: Returns TRUE if we were able to create directories and returns NULL if we did nothing
access: private

mixed _buildDir (string $sDestination)

string $sDestination: Destination of the folder we are to create new folders in.

_buildFile (line 899)

We build an ARRAY of information about the file based on information passed by $_FORM or $_FORM['FOO'][] with the latter being a multiple uploade routine.

access: private

void _buildFile (string $sFormItem)

string $sFormItem: The ID to connect with the $_FORM variable

_getFileType (line 884)

We find out a files extension based on information passed along with $_FILE

see: self::_buildFile()
access: private

void _getFileType ()

_passLimit (line 816)

Runs a check to make sure the item being uploaded is allowed to be uploaded based on the server requirements.

return: Returns TRUE if item is allowed to be uploaded and FALSE if not
access: private

bool _passLimit ()

_verify (line 932)

If this feature is enabled we use getID3 to try to find the mime type by trying to extract meta information. Note that since this is based off a 3rd party library this method has been known to have it share of problems. We are not using this by default until it is fully stable.

return: TRUE if mime type checked out and FALSE if there is no mime type
access: private

bool _verify (string $sFileName)

string $sFileName: Path to the file we are going to check

Documentation generated on Tue, 28 Sep 2010 10:36:39 +0200 by phpDocumentor 1.4.0a2