Référence de la classe FileWrapper

Fonctions membres publiques
	getExt ($file)
	stripExt ($file)
	makeSafe ($file)
	copy ($src, $dest, $path=null, $useStreams=false)
	delete ($file)
	move ($src, $dest, $path='', $useStreams=false)
	read ($filename, $incpath=false, $amount=0, $chunksize=8192, $offset=0)
	write ($file, &$buffer, $useStreams=false)
	upload ($src, $dest, $useStreams=false)
	exists ($file)
	getName ($file)

Description détaillée

Wrapper class for File

Depuis

3.4

Obsolète:

4.0 Use instead

Documentation des fonctions membres

copy()

copy	(		$src,
			$dest,
			$path = null,
			$useStreams = false
	)

Helper wrapper method for copy

Paramètres

string	$src	The path to the source file.
string	$dest	The path to the destination file.
string	$path	An optional base path to prefix to the file names.
boolean	$useStreams	True to use streams.

Renvoie

boolean True on success.

Voir également

File::copy()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $path, et File\copy().

delete()

delete

(

$file

)

Helper wrapper method for delete

Paramètres

mixed

$file

The file name or an array of file names

Renvoie

boolean True on success.

Voir également

File::delete()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $file, et File\delete().

exists()

exists

(

$file

)

Helper wrapper method for exists

Paramètres

string

$file

File path.

Renvoie

boolean True if path is a file.

Voir également

File::exists()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $file, et File\exists().

getExt()

getExt

(

$file

)

Helper wrapper method for getExt

Paramètres

string

$file

The file name.

Renvoie

string The file extension.

Voir également

File::getExt()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $file, et File\getExt().

getName()

getName

(

$file

)

Helper wrapper method for getName

Paramètres

string

$file

File path.

Renvoie

string filename.

Voir également

File::getName()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $file, et File\getName().

makeSafe()

makeSafe

(

$file

)

Helper wrapper method for makeSafe

Paramètres

string

$file

The name of the file [not full path].

Renvoie

string The sanitised string.

Voir également

File::makeSafe()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $file, et File\makeSafe().

move()

move	(		$src,
			$dest,
			$path = '',
			$useStreams = false
	)

Helper wrapper method for move

Paramètres

string	$src	The path to the source file.
string	$dest	The path to the destination file.
string	$path	An optional base path to prefix to the file names.
boolean	$useStreams	True to use streams.

Renvoie

boolean True on success.

Voir également

File::move()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $path, et File\move().

read()

read	(		$filename,
			$incpath = false,
			$amount = 0,
			$chunksize = 8192,
			$offset = 0
	)

Helper wrapper method for read

Paramètres

string	$filename	The full file path.
boolean	$incpath	Use include path.
integer	$amount	Amount of file to read.
integer	$chunksize	Size of chunks to read.
integer	$offset	Offset of the file.

Renvoie

mixed Returns file contents or boolean False if failed.

Voir également

File::read()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $offset, et File\read().

stripExt()

stripExt

(

$file

)

Helper wrapper method for stripExt

Paramètres

string

$file

The file name.

Renvoie

string The file name without the extension.

Voir également

File::stripExt()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $file, et File\stripExt().

upload()

upload	(		$src,
			$dest,
			$useStreams = false
	)

Helper wrapper method for upload

Paramètres

string	$src	The name of the php (temporary) uploaded file.
string	$dest	The path (including filename) to move the uploaded file to.
boolean	$useStreams	True to use streams.

Renvoie

boolean True on success.

Voir également

File::upload()

Depuis

3.4

Obsolète:

4.0 Use instead

Références File\upload().

write()

write	(		$file,
		&	$buffer,
			$useStreams = false
	)

Helper wrapper method for write

Paramètres

string	$file	The full file path.
string	&$buffer	The buffer to write.
boolean	$useStreams	Use streams.

Renvoie

boolean True on success.

Voir également

File::write()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $buffer, $file, et File\write().

---

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

• FileWrapper.php