Difference between revisions of "JStream"
From Joomla! Documentation
m (JoomlaWikiBot moved page JStream/11.1 to API17:JStream without leaving a redirect: Robot: Moved page) |
m (preparing for archive only) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
=={{JVer|11.1}} JStream== | =={{JVer|11.1}} JStream== | ||
===Description=== | ===Description=== | ||
− | + | ||
− | + | ||
− | |||
− | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
Line 14: | Line 12: | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::__construct | + | |[[API17:JStream::__construct|__construct]] |
|Constructor. | |Constructor. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::__destruct | + | |[[API17:JStream::__destruct|__destruct]] |
|Destructor. | |Destructor. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::_buildContext | + | |[[API17:JStream::_buildContext|_buildContext]] |
|Stream contexts Builds the context from the array. | |Stream contexts Builds the context from the array. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::_getFilename | + | |[[API17:JStream::_getFilename|_getFilename]] |
|Determine the appropriate 'filename' of a file. | |Determine the appropriate 'filename' of a file. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::addContextEntry | + | |[[API17:JStream::addContextEntry|addContextEntry]] |
|Adds a particular options to the context. | |Adds a particular options to the context. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::appendFilter | + | |[[API17:JStream::appendFilter|appendFilter]] |
|Stream filters Append a filter to the chain. | |Stream filters Append a filter to the chain. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::applyContextToStream | + | |[[API17:JStream::applyContextToStream|applyContextToStream]] |
|Applies the current context to the stream. | |Applies the current context to the stream. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::chmod | + | |[[API17:JStream::chmod|chmod]] |
|Chmod wrapper. | |Chmod wrapper. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::close | + | |[[API17:JStream::close|close]] |
|Attempt to close a file handle. | |Attempt to close a file handle. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::copy | + | |[[API17:JStream::copy|copy]] |
|Support operations (copy, move). | |Support operations (copy, move). | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::delete | + | |[[API17:JStream::delete|delete]] |
|Delete a file. | |Delete a file. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::deleteContextEntry | + | |[[API17:JStream::deleteContextEntry|deleteContextEntry]] |
|Deletes a particular setting from a context. | |Deletes a particular setting from a context. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::eof | + | |[[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. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::filesize | + | |[[API17:JStream::filesize|filesize]] |
|Retrieve the file size of the path. | |Retrieve the file size of the path. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::get_meta_data | + | |[[API17:JStream::get_meta_data|get_meta_data]] |
|Get the stream metadata. | |Get the stream metadata. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::getFileHandle | + | |[[API17:JStream::getFileHandle|getFileHandle]] |
|Return the internal file handle. | |Return the internal file handle. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::gets | + | |[[API17:JStream::gets|gets]] |
| | | | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::move | + | |[[API17:JStream::move|move]] |
|Moves a file. | |Moves a file. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::open | + | |[[API17:JStream::open|open]] |
|Generic File Operations. | |Generic File Operations. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::prependFilter | + | |[[API17:JStream::prependFilter|prependFilter]] |
|Prepend a filter to the chain. | |Prepend a filter to the chain. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::read | + | |[[API17:JStream::read|read]] |
|Read a file. | |Read a file. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::removeFilter | + | |[[API17:JStream::removeFilter|removeFilter]] |
|Remove a filter, either by resource (handed out from the append or prepend function) or 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 | |public | ||
− | |[[JStream::seek | + | |[[API17:JStream::seek|seek]] |
|Seek the file. | |Seek the file. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::setContextOptions | + | |[[API17:JStream::setContextOptions|setContextOptions]] |
|Updates the context to the array. | |Updates the context to the array. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::tell | + | |[[API17:JStream::tell|tell]] |
| | | | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::upload | + | |[[API17:JStream::upload|upload]] |
|Upload a file. | |Upload a file. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::write | + | |[[API17:JStream::write|write]] |
|File write. | |File write. | ||
|- | |- | ||
|public | |public | ||
− | |[[JStream::writeFile | + | |[[API17:JStream::writeFile|writeFile]] |
|All in one 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 | * '''Defined in''' libraries/joomla/filesystem/stream.php | ||
− | * '''Extends''' [[JObject | + | * '''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=== | ||
* {{JVer|11.1}} '''JStream source code''' on [[jplatform:filesystem/stream.php|BitBucket]] | * {{JVer|11.1}} '''JStream source code''' on [[jplatform:filesystem/stream.php|BitBucket]] | ||
− | * {{JVer|11.1}} Subpackage [[Subpackage Filesystem | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Filesystem|Filesystem]] |
− | * [[JStream|Other versions of JStream]] | + | * [[API17:JStream|Other versions of JStream]] |
− | + | ||
− | + | ||
− | |||
− | |||
===User contributed notes=== | ===User contributed notes=== | ||
− | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JStream | category=JStream | ||
− | + | namespace=CodeExample | |
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
Line 149: | Line 145: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
− | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Latest revision as of 22:43, 24 March 2017
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]
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' );
See also[edit]
- JStream source code on BitBucket
- Subpackage Filesystem
- Other versions of JStream
User contributed notes[edit]
Code Examples[edit]