API17:JStream::open
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
(Layout updates) |
||
| Line 12: | Line 12: | ||
===Synopsis=== | ===Synopsis=== | ||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public JStream::open ($filename, $mode='r', $use_include_path=false, $context=null, $use_prefix=false, $relative=false, $detectprocessingmode=false) |
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 60: | Line 60: | ||
boolean | boolean | ||
===Defined in=== | ===Defined in=== | ||
| − | libraries/joomla/filesystem/stream.php | + | libraries/joomla/filesystem/stream.php (line 129) |
| + | * see source code in [[jplatform:filesystem/stream.php#cl-129|BitBucket]] | ||
===Referenced by=== | ===Referenced by=== | ||
===See also=== | ===See also=== | ||
Revision as of 21:18, 23 April 2011
JStream::open
Description
Open a stream with some lazy loading smarts.
Description:JStream::open [Edit Descripton]
Since
Synopsis
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
boolean
Defined in
libraries/joomla/filesystem/stream.php (line 129)
- see source code in BitBucket
Referenced by
See also
Examples
<CodeExamplesForm />
