Référence de l'interface FOFPlatformFilesystemInterface

Graphe d'héritage de FOFPlatformFilesystemInterface:

Fonctions membres publiques
	fileExists ($path)
	fileDelete ($file)
	fileCopy ($src, $dest)
	fileWrite ($file, &$buffer)
	pathCheck ($path)
	pathClean ($path, $ds=DIRECTORY_SEPARATOR)
	pathFind ($paths, $file)
	folderExists ($path)
	folderFiles ($path, $filter='.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*', '.*~'))
	folderFolders ($path, $filter='.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*'))
	folderCreate ($path='', $mode=0755)

Documentation des fonctions membres

fileCopy()

fileCopy	(		$src,
			$dest
	)

Copies a file

Paramètres

string	$src	The path to the source file
string	$dest	The path to the destination file

Renvoie

boolean True on success

fileDelete()

fileDelete

(

$file

)

Delete a file or array of files

Paramètres

mixed

$file

The file name or an array of file names

Renvoie

boolean True on success

Implémenté dans FOFIntegrationJoomlaFilesystem.

fileExists()

fileExists

(

$path

)

Does the file exists?

Paramètres

$path

string Path to the file to test

Renvoie

bool

Implémenté dans FOFIntegrationJoomlaFilesystem.

fileWrite()

fileWrite	(		$file,
		&	$buffer
	)

Write contents to a file

Paramètres

string	$file	The full file path
string	&$buffer	The buffer to write

Renvoie

boolean True on success

folderCreate()

folderCreate	(		$path = '',
			$mode = 0755
	)

Create a folder – and all necessary parent folders.

Paramètres

string	$path	A path to create from the base path.
integer	$mode	Directory permissions to set for folders created. 0755 by default.

Renvoie

boolean True if successful.

Implémenté dans FOFIntegrationJoomlaFilesystem.

folderExists()

folderExists

(

$path

)

Wrapper for the standard file_exists function

Paramètres

string

$path

Folder name relative to installation dir

Renvoie

boolean True if path is a folder

Implémenté dans FOFIntegrationJoomlaFilesystem.

folderFiles()

folderFiles	(		$path,
			$filter = '.',
			$recurse = false,
			$full = false,
			$exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'),
			$excludefilter = array('^\..*', '.*~')
	)

Utility function to read the files in a folder.

Paramètres

string	$path	The path of the folder to read.
string	$filter	A filter for file names.
mixed	$recurse	True to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean	$full	True to return the full path to the file.
array	$exclude	Array with names of files which should not be shown in the result.
array	$excludefilter	Array of filter to exclude

Renvoie

array Files in the given folder.

folderFolders()

folderFolders	(		$path,
			$filter = '.',
			$recurse = false,
			$full = false,
			$exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'),
			$excludefilter = array('^\..*')
	)

Utility function to read the folders in a folder.

Paramètres

string	$path	The path of the folder to read.
string	$filter	A filter for folder names.
mixed	$recurse	True to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean	$full	True to return the full path to the folders.
array	$exclude	Array with names of folders which should not be shown in the result.
array	$excludefilter	Array with regular expressions matching folders which should not be shown in the result.

Renvoie

array Folders in the given folder.

Implémenté dans FOFIntegrationJoomlaFilesystem.

pathCheck()

pathCheck

(

$path

)

Checks for snooping outside of the file system root.

Paramètres

string

$path

A file system path to check.

Renvoie

string A cleaned version of the path or exit on error.

Exceptions

Exception

Implémenté dans FOFIntegrationJoomlaFilesystem.

pathClean()

pathClean	(		$path,
			$ds = DIRECTORY_SEPARATOR
	)

Function to strip additional / or \ in a path name.

Paramètres

string	$path	The path to clean.
string	$ds	Directory separator (optional).

Renvoie

string The cleaned path.

Exceptions

UnexpectedValueException

Implémenté dans FOFIntegrationJoomlaFilesystem.

pathFind()

pathFind	(		$paths,
			$file
	)

Searches the directory paths for a given file.

Paramètres

mixed	$paths	An path string or array of path strings to search in
string	$file	The file name to look for.

Renvoie

mixed The full path and file name for the target file, or boolean false if the file is not found in any of the paths.

Implémenté dans FOFIntegrationJoomlaFilesystem.

---

La documentation de cette interface a été générée à partir du fichier suivant :

• fof/platform/filesystem/interface.php