Actions

API17

Difference between revisions of "JStream"

From Joomla! Documentation

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

Latest revision as of 21:34, 11 May 2013

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JStream

Description

Description:JStream [Edit Descripton]

Methods

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

jimport( 'joomla.filesystem.stream' );

See also

SeeAlso:JStream [Edit See Also]

User contributed notes

<CodeExamplesForm />