JStream::open
From Joomla! Documentation
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::open[edit]
Description[edit]
Open a stream with some lazy loading smarts.
Template:Description:JStream::open [Edit Descripton]
Since[edit]
Synopsis[edit]
public JStream::open ($filename, $mode='r', $use_include_path=false, $context=null, $use_prefix=false, $relative=false, $detectprocessingmode=false)
Parameter | Type | Default | Description |
---|---|---|---|
$filename | string | Filename | |
$mode | string | 'r' | Mode string to use |
$use_include_path | bool | false | Use the PHP include path |
$context | resource | null | Context to use when opening |
$use_prefix | bool | false | Use a prefix to open the file |
$relative | bool | false | Filename is a relative path (if false, strips JPATH_ROOT to make it relative) |
$detectprocessingmode | bool | false | Detect the processing method for the file and use the appropriate function to handle output automatically |
Returns[edit]
boolean
Defined in[edit]
libraries/joomla/filesystem/stream.php (line 129)
- see source code in BitBucket
Referenced by[edit]
See also[edit]
Template:SeeAlso:JStream::open
Examples[edit]
<CodeExamplesForm />