Difference between revisions of "JStream"

Revision as of 18:09, 27 April 2011

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JStream[edit]

Description[edit]

Template:Description:JStream [Edit Descripton]

Methods[edit]

Visibility	Method name	Description
public	__construct	Constructor.
public	__destruct	Destructor.
public	_buildContext	Stream contexts Builds the context from the array.
public	_getFilename	Determine the appropriate 'filename' of a file.
public	addContextEntry	Adds a particular options to the context.
public	appendFilter	Stream filters Append a filter to the chain.
public	applyContextToStream	Applies the current context to the stream.
public	chmod	Chmod wrapper.
public	close	Attempt to close a file handle.
public	copy	Support operations (copy, move).
public	delete	Delete a file.
public	deleteContextEntry	Deletes a particular setting from a context.
public	eof	Work out if we're at the end of the file for a stream.
public	filesize	Retrieve the file size of the path.
public	get_meta_data	Get the stream metadata.
public	getFileHandle	Return the internal file handle.
public	gets
public	move	Moves a file.
public	open	Generic File Operations.
public	prependFilter	Prepend a filter to the chain.
public	read	Read a file.
public	removeFilter	Remove a filter, either by resource (handed out from the append or prepend function) or via getting the filter list).
public	seek	Seek the file.
public	setContextOptions	Updates the context to the array.
public	tell
public	upload	Upload a file.
public	write	File write.
public	writeFile	All in one Writes a chunk of data to a file.

Defined in libraries/joomla/filesystem/stream.php
Extends JObject

Importing[edit]

jimport( 'joomla.filesystem.stream' );

User contributed notes[edit]

@@ Line 1: / Line 1: @@
 __NOTOC__
+=={{JVer|11.1}} JStream==
+===Description===
+{{Description:JStream}}
 <span class="editsection" style="font-size:76%;">
 <nowiki>[</nowiki>[[Description:JStream|Edit Descripton]]<nowiki>]</nowiki>
 </span>
-{{Description:JStream}}
-===Defined in===
-libraries/joomla/filesystem/stream.php
-* see source code in [[jplatform:filesystem/stream.php|BitBucket]]
-===Subpackage===
-[[Subpackage Filesystem/11.1|Filesystem]]
-===Extends===
-[[JObject/11.1|JObject]]
-===Extended by===
 ===Methods===
 {| class="wikitable sortable"
 |-
+!Visibility
 !Method name
 !Description
 |-
+|public
 |[[JStream::__construct/11.1|__construct]]
 |Constructor.
 |-
+|public
 |[[JStream::__destruct/11.1|__destruct]]
 |Destructor.
 |-
+|public
 |[[JStream::_buildContext/11.1|_buildContext]]
-|Builds the context from the array.
+|Stream contexts Builds the context from the array.
 |-
+|public
 |[[JStream::_getFilename/11.1|_getFilename]]
 |Determine the appropriate 'filename' of a file.
 |-
+|public
 |[[JStream::addContextEntry/11.1|addContextEntry]]
 |Adds a particular options to the context.
 |-
+|public
 |[[JStream::appendFilter/11.1|appendFilter]]
-|Append a filter to the chain.
+|Stream filters Append a filter to the chain.
 |-
+|public
 |[[JStream::applyContextToStream/11.1|applyContextToStream]]
 |Applies the current context to the stream.
 |-
+|public
 |[[JStream::chmod/11.1|chmod]]
 |Chmod wrapper.
 |-
+|public
 |[[JStream::close/11.1|close]]
 |Attempt to close a file handle.
 |-
+|public
 |[[JStream::copy/11.1|copy]]
-|Copy a file from src to dest.
+|Support operations (copy, move).
 |-
+|public
 |[[JStream::delete/11.1|delete]]
 |Delete a file.
 |-
+|public
 |[[JStream::deleteContextEntry/11.1|deleteContextEntry]]
 |Deletes a particular setting from a context.
 |-
+|public
 |[[JStream::eof/11.1|eof]]
 |Work out if we're at the end of the file for a stream.
 |-
+|public
 |[[JStream::filesize/11.1|filesize]]
 |Retrieve the file size of the path.
 |-
+|public
 |[[JStream::get_meta_data/11.1|get_meta_data]]
 |Get the stream metadata.
 |-
+|public
 |[[JStream::getFileHandle/11.1|getFileHandle]]
 |Return the internal file handle.
 |-
+|public
 |[[JStream::gets/11.1|gets]]
 |
 |-
+|public
 |[[JStream::move/11.1|move]]
 |Moves a file.
 |-
+|public
 |[[JStream::open/11.1|open]]
-|Open a stream with some lazy loading smarts.
+|Generic File Operations.
 |-
+|public
 |[[JStream::prependFilter/11.1|prependFilter]]
 |Prepend a filter to the chain.
 |-
+|public
 |[[JStream::read/11.1|read]]
 |Read a file.
 |-
+|public
 |[[JStream::removeFilter/11.1|removeFilter]]
-|Remove a filter, either by resource (handed out from the append or prepend function alternatively via getting the filter list).
+|Remove a filter, either by resource (handed out from the append or prepend function) or via getting the filter list).
 |-
+|public
 |[[JStream::seek/11.1|seek]]
 |Seek the file.
 |-
+|public
 |[[JStream::setContextOptions/11.1|setContextOptions]]
 |Updates the context to the array.
 |-
+|public
 |[[JStream::tell/11.1|tell]]
 |
 |-
+|public
 |[[JStream::upload/11.1|upload]]
 |Upload a file.
 |-
+|public
 |[[JStream::write/11.1|write]]
 |File write.
 |-
+|public
 |[[JStream::writeFile/11.1|writeFile]]
-|Writes a chunk of data to a file.
+|All in one Writes a chunk of data to a file.
 |-
 |}
+* '''Defined in''' libraries/joomla/filesystem/stream.php
+* '''Extends''' [[JObject/11.1|JObject]]
 ===Importing===
 <source lang="php">jimport( 'joomla.filesystem.stream' );</source>
 ===See also===
-* JStream source code in [[jplatform:filesystem/stream.php|BitBucket]]
+* {{JVer|11.1}} '''JStream source code''' on [[jplatform:filesystem/stream.php|BitBucket]]
-* [[JStream|Other versions of this class]]
+* {{JVer|11.1}} Subpackage [[Subpackage Filesystem/11.1|Filesystem]]
+* [[JStream|Other versions of JStream]]
 {{SeeAlso:JStream}}
 <span class="editsection" style="font-size:76%;">
 <nowiki>[</nowiki>[[SeeAlso:JStream|Edit See Also]]<nowiki>]</nowiki>
 </span>
-===Examples===
+===User contributed notes===
 <CodeExamplesForm />
 <dpl>
@@ Line 120: / Line 146: @@
 category=ClassExample
 include=*
+namespace=CodeExample
 format= ,,,
 </dpl>
 <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JStream]]</noinclude>

API17