Fonctions membres publiques statiques
static	getExt ($file)

static	stripExt ($file)

static	makeSafe ($file)

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

static	delete ($file)

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

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

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

static	append ($file, $buffer, $useStreams=false)

static	upload ($src, $dest, $useStreams=false, $allowUnsafe=false, $safeFileOptions=array())

static	exists ($file)

static	getName ($file)

Description détaillée

A File handling class

Depuis: 1.7.0

Documentation des fonctions membres

◆ append()

static append	(	$file,
		$buffer,
		$useStreams = `false`
	)

static

Append contents to a file

Paramètres

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

Renvoie: boolean True on success

Depuis: 3.6.0

Références $buffer, $file, Log\add(), Path\clean(), ClientHelper\getCredentials(), FtpClient\getInstance(), Factory\getStream(), JPATH_ROOT, Text\sprintf(), et Log\WARNING.

◆ copy()

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

static

Copies a file

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

Depuis: 1.7.0

Références $path, Log\add(), PathWrapper\clean(), FolderWrapper\create(), ClientHelper\getCredentials(), FtpClient\getInstance(), Factory\getStream(), JPATH_ROOT, Text\sprintf(), et Log\WARNING.

◆ delete()

static delete ( $file )

static

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

Depuis: 1.7.0

Références $file, $files, Log\add(), elseif, ClientHelper\getCredentials(), FtpClient\getInstance(), JPATH_ROOT, Text\sprintf(), et Log\WARNING.

Référencé par Patcher\apply().

◆ exists()

static exists ( $file )

static

Wrapper for the standard file_exists function

Paramètres

string $file File path

Renvoie: boolean True if path is a file

Depuis: 1.7.0

Références $file.

Référencé par FileWrapper\exists().

◆ getExt()

static getExt ( $file )

static

Gets the extension of a file name

Paramètres

string $file The file name

Renvoie: string The file extension

Depuis: 1.7.0

Références $file, et DIRECTORY_SEPARATOR.

Référencé par FileWrapper\getExt(), et Stream\open().

◆ getName()

static getName ( $file )

static

Returns the name, without any path.

Paramètres

string $file File path

Renvoie: string filename

Depuis: 1.7.0

Obsolète:: 4.0 - Use basename() instead.

Références $file, Log\add(), et Log\WARNING.

Référencé par FileWrapper\getName().

◆ makeSafe()

static makeSafe ( $file )

static

Makes file name safe to use

Paramètres

string $file The name of the file [not full path]

Renvoie: string The sanitised string

Depuis: 1.7.0

Références $file.

◆ move()

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

static

Moves a file

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

Depuis: 1.7.0

Références $path, Text\_(), Log\add(), PathWrapper\clean(), ClientHelper\getCredentials(), FtpClient\getInstance(), Factory\getStream(), JPATH_ROOT, Text\sprintf(), et Log\WARNING.

◆ read()

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

static

Read the contents of a file

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

Depuis: 1.7.0

Obsolète:: 4.0 - Use the native file_get_contents() instead.

Références $data, $offset, Log\add(), null, Text\sprintf(), et Log\WARNING.

Référencé par FileWrapper\read().

◆ stripExt()

static stripExt ( $file )

static

Strips the last extension off of a file name

Paramètres

string $file The file name

Renvoie: string The file name without the extension

Depuis: 1.7.0

Références $file.

◆ upload()

static upload	(	$src,
		$dest,
		$useStreams = `false`,
		$allowUnsafe = `false`,
		$safeFileOptions = `array()`
	)

static

Moves an uploaded file to a destination folder

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
boolean	$allowUnsafe	Allow the upload of unsafe files
boolean	$safeFileOptions	Options to ::isSafeFile

Renvoie: boolean True on success

Depuis: 1.7.0

Références $baseDir, Text\_(), Log\add(), PathWrapper\clean(), FolderWrapper\create(), ClientHelper\getCredentials(), FtpClient\getInstance(), Factory\getStream(), JPATH_ROOT, Text\sprintf(), et Log\WARNING.

◆ write()

static write	(	$file,
		$buffer,
		$useStreams = `false`
	)

static

Write contents to a file

Paramètres

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

Renvoie: boolean True on success

Depuis: 1.7.0

Références $buffer, $file, Log\add(), ClientHelper\getCredentials(), FtpClient\getInstance(), Factory\getStream(), JPATH_ROOT, Text\sprintf(), true, et Log\WARNING.

Référencé par Patcher\apply().

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

src/Filesystem/File.php

Fonctions membres publiques statiques

Description détaillée

Documentation des fonctions membres

◆ append()

◆ copy()

◆ delete()

◆ exists()

◆ getExt()

◆ getName()

◆ makeSafe()

◆ move()

◆ read()

◆ stripExt()

◆ upload()

◆ write()