Référence de la classe JStream

Graphe d'héritage de JStream:

Graphe de collaboration de JStream:

Liste de tous les membres

Fonctions membres publiques
	__construct ($writeprefix= '', $readprefix= '', $context=array())
	__destruct ()
	open ($filename, $mode= 'r', $use_include_path=false, $context=null, $use_prefix=false, $relative=false, $detectprocessingmode=false)
	close ()
	eof ()
	filesize ()
	gets ($length=0)
	read ($length=0)
	seek ($offset, $whence=SEEK_SET)
	tell ()
	write (&$string, $length=0, $chunk=0)
	chmod ($filename= '', $mode=0)
	get_meta_data ()
	_buildContext ()
	setContextOptions ($context)
	addContextEntry ($wrapper, $name, $value)
	deleteContextEntry ($wrapper, $name)
	applyContextToStream ()
	appendFilter ($filtername, $read_write=STREAM_FILTER_READ, $params=array())
	prependFilter ($filtername, $read_write=STREAM_FILTER_READ, $params=array())
	removeFilter (&$resource, $byindex=false)
	copy ($src, $dest, $context=null, $use_prefix=true, $relative=false)
	move ($src, $dest, $context=null, $use_prefix=true, $relative=false)
	delete ($filename, $context=null, $use_prefix=true, $relative=false)
	upload ($src, $dest, $context=null, $use_prefix=true, $relative=false)
	writeFile ($filename, &$buffer)
	_getFilename ($filename, $mode, $use_prefix, $relative)
	getFileHandle ()
Fonctions membres publiques inherited from JObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Attributs protégés
	$filemode = 0644
	$dirmode = 0755
	$chunksize = 8192
	$filename
	$writeprefix
	$readprefix
	$processingmethod = 'f'
	$filters = array()
	$_fh
	$_filesize
	$_context = null
	$_contextOptions
	$_openmode
Attributs protégés inherited from JObject
	$_errors = array()

---

Documentation des constructeurs et destructeur

JStream::__construct	(		$writeprefix = '',
			$readprefix = '',
			$context = array()
	)

Constructor

Paramètres:

string	$writeprefix	Prefix of the stream (optional). Unlike the JPATH_*, this has a final path separator!
string	$readprefix	The read prefix (optional).
array	$context	The context options (optional).

Depuis:

11.1

JStream::__destruct

(

)

Destructor

Depuis:

11.1

---

Documentation des fonctions membres

JStream::_buildContext

(

)

Stream contexts Builds the context from the array

Renvoie:

mixed

Depuis:

11.1

Références null.

JStream::_getFilename	(		$filename,
			$mode,
			$use_prefix,
			$relative
	)

Determine the appropriate 'filename' of a file

Paramètres:

string	$filename	Original filename of the file
string	$mode	Mode string to retrieve the filename
boolean	$use_prefix	Controls the use of a prefix
boolean	$relative	Determines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Renvoie:

string

Depuis:

11.1

Références $mode, JFilesystemHelper\getWriteModes(), et JPATH_ROOT.

Voici le graphe d'appel pour cette fonction :

JStream::addContextEntry	(		$wrapper,
			$name,
			$value
	)

Adds a particular options to the context

Paramètres:

string	$wrapper	The wrapper to use
string	$name	The option to set
string	$value	The value of the option

Renvoie:

void

Voir également:

http://php.net/stream_context_create Stream Context Creation

http://php.net/manual/en/context.php Context Options for various streams

Depuis:

11.1

Références $name.

JStream::appendFilter	(		$filtername,
			$read_write = STREAM_FILTER_READ,
			$params = array()
	)

Stream filters Append a filter to the chain

Paramètres:

string	$filtername	The key name of the filter.
integer	$read_write	Optional. Defaults to STREAM_FILTER_READ.
array	$params	An array of params for the stream_filter_append call.

Renvoie:

mixed

Voir également:

http://php.net/manual/en/function.stream-filter-append.php

Depuis:

11.1

Références $params.

JStream::applyContextToStream

(

)

Applies the current context to the stream

Use this to change the values of the context after you've opened a stream

Renvoie:

mixed

Depuis:

11.1

JStream::chmod	(		$filename = '',
			$mode = 0
	)

Chmod wrapper

Paramètres:

string	$filename	File name.
mixed	$mode	Mode to use.

Renvoie:

boolean

Depuis:

11.1

Références $mode, JText\_(), et JFilesystemHelper\ftpChmod().

Voici le graphe d'appel pour cette fonction :

JStream::close

(

)

Attempt to close a file handle

Will return false if it failed and true on success If the file is not open the system will return true, this function destroys the file handle as well

Renvoie:

boolean

Depuis:

11.1

Références JText\_(), et null.

Voici le graphe d'appel pour cette fonction :

JStream::copy	(		$src,
			$dest,
			$context = null,
			$use_prefix = true,
			$relative = false
	)

Copy a file from src to dest

Paramètres:

string	$src	The file path to copy from.
string	$dest	The file path to copy to.
resource	$context	A valid context resource (optional) created with stream_context_create.
boolean	$use_prefix	Controls the use of a prefix (optional).
boolean	$relative	Determines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Renvoie:

mixed

Depuis:

11.1

Références elseif, et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JStream::delete	(		$filename,
			$context = null,
			$use_prefix = true,
			$relative = false
	)

Delete a file

Paramètres:

string	$filename	The file path to delete.
resource	$context	A valid context resource (optional) created with stream_context_create.
boolean	$use_prefix	Controls the use of a prefix (optional).
boolean	$relative	Determines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Renvoie:

mixed

Depuis:

11.1

Références elseif.

JStream::deleteContextEntry	(		$wrapper,
			$name
	)

Deletes a particular setting from a context

Paramètres:

string	$wrapper	The wrapper to use
string	$name	The option to unset

Renvoie:

void

Voir également:

http://php.net/stream_context_create

Depuis:

11.1

Références $name.

JStream::eof

(

)

Work out if we're at the end of the file for a stream

Renvoie:

boolean

Depuis:

11.1

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JStream::filesize

(

)

Retrieve the file size of the path

Renvoie:

mixed

Depuis:

11.1

Références JText\_(), et JFilesystemHelper\remotefsize().

Voici le graphe d'appel pour cette fonction :

JStream::get_meta_data

(

)

Get the stream metadata

Renvoie:

array header/metadata

Voir également:

http://php.net/manual/en/function.stream-get-meta-data.php

Depuis:

11.1

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JStream::getFileHandle

(

)

Return the internal file handle

Renvoie:

File handler

Depuis:

11.1

JStream::gets

(

$length = 0

)

Get a line from the stream source.

Paramètres:

integer

$length

The number of bytes (optional) to read.

Renvoie:

mixed

Depuis:

11.1

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JStream::move	(		$src,
			$dest,
			$context = null,
			$use_prefix = true,
			$relative = false
	)

Moves a file

Paramètres:

string	$src	The file path to move from.
string	$dest	The file path to move to.
resource	$context	A valid context resource (optional) created with stream_context_create.
boolean	$use_prefix	Controls the use of a prefix (optional).
boolean	$relative	Determines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Renvoie:

mixed

Depuis:

11.1

Références elseif.

JStream::open	(		$filename,
			$mode = 'r',
			$use_include_path = false,
			$context = null,
			$use_prefix = false,
			$relative = false,
			$detectprocessingmode = false
	)

Generic File Operations

Open a stream with some lazy loading smarts

Paramètres:

string	$filename	Filename
string	$mode	Mode string to use
boolean	$use_include_path	Use the PHP include path
resource	$context	Context to use when opening
boolean	$use_prefix	Use a prefix to open the file
boolean	$relative	Filename is a relative path (if false, strips JPATH_ROOT to make it relative)
boolean	$detectprocessingmode	Detect the processing method for the file and use the appropriate function to handle output automatically

Renvoie:

boolean

Depuis:

11.1

Références $mode, $url, JText\_(), elseif, JFile\getExt(), et JFilesystemHelper\isJoomlaStream().

Référencé par JLanguage\parse().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JStream::prependFilter	(		$filtername,
			$read_write = STREAM_FILTER_READ,
			$params = array()
	)

Prepend a filter to the chain

Paramètres:

string	$filtername	The key name of the filter.
integer	$read_write	Optional. Defaults to STREAM_FILTER_READ.
array	$params	An array of params for the stream_filter_prepend call.

Renvoie:

mixed

Voir également:

http://php.net/manual/en/function.stream-filter-prepend.php

Depuis:

11.1

Références $params.

JStream::read

(

$length = 0

)

Read a file

Handles user space streams appropriately otherwise any read will return 8192

Paramètres:

integer

$length

Length of data to read

Renvoie:

mixed

Voir également:

http://php.net/manual/en/function.fread.php

Depuis:

11.1

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JStream::removeFilter	(	&	$resource,
			$byindex = false
	)

Remove a filter, either by resource (handed out from the append or prepend function) or via getting the filter list)

Paramètres:

resource	&$resource	The resource.
boolean	$byindex	The index of the filter.

Renvoie:

boolean Result of operation

Depuis:

11.1

JStream::seek	(		$offset,
			$whence = SEEK_SET
	)

Seek the file

Note: the return value is different to that of fseek

Paramètres:

integer	$offset	Offset to use when seeking.
integer	$whence	Seek mode to use.

Renvoie:

boolean True on success, false on failure

Voir également:

http://php.net/manual/en/function.fseek.php

Depuis:

11.1

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JStream::setContextOptions

(

$context

)

Updates the context to the array

Format is the same as the options for stream_context_create

Paramètres:

array

$context

Options to create the context with

Renvoie:

void

Voir également:

http://php.net/stream_context_create

Depuis:

11.1

JStream::tell

(

)

Returns the current position of the file read/write pointer.

Renvoie:

mixed

Depuis:

11.1

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JStream::upload	(		$src,
			$dest,
			$context = null,
			$use_prefix = true,
			$relative = false
	)

Upload a file

Paramètres:

string	$src	The file path to copy from (usually a temp folder).
string	$dest	The file path to copy to.
resource	$context	A valid context resource (optional) created with stream_context_create.
boolean	$use_prefix	Controls the use of a prefix (optional).
boolean	$relative	Determines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Renvoie:

mixed

Depuis:

11.1

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JStream::write	(	&	$string,
			$length = 0,
			$chunk = 0
	)

File write

Whilst this function accepts a reference, the underlying fwrite will do a copy! This will roughly double the memory allocation for any write you do. Specifying chunked will get around this by only writing in specific chunk sizes. This defaults to 8192 which is a sane number to use most of the time (change the default with JStream::set('chunksize', newsize);) Note: This doesn't support gzip/bzip2 writing like reading does

Paramètres:

string	&$string	Reference to the string to write.
integer	$length	Length of the string to write.
integer	$chunk	Size of chunks to write in.

Renvoie:

boolean

Voir également:

http://php.net/manual/en/function.fwrite.php

Depuis:

11.1

Références JText\_(), et elseif.

Voici le graphe d'appel pour cette fonction :

JStream::writeFile	(		$filename,
		&	$buffer
	)

Writes a chunk of data to a file.

Paramètres:

string	$filename	The file name.
string	&$buffer	The data to write to the file.

Renvoie:

boolean

Depuis:

11.1

---

Documentation des données membres

JStream::$_context = null

protected

JStream::$_contextOptions

protected

JStream::$_fh

protected

JStream::$_filesize

protected

JStream::$_openmode

protected

JStream::$chunksize = 8192

protected

JStream::$dirmode = 0755

protected

JStream::$filemode = 0644

protected

JStream::$filename

protected

JStream::$filters = array()

protected

JStream::$processingmethod = 'f'

protected

JStream::$readprefix

protected

JStream::$writeprefix

protected

---

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

• filesystem/stream.php