Actions

API17

Difference between revisions of "JStream::open"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 2: Line 2:
 
=={{JVer|11.1}} JStream::open==
 
=={{JVer|11.1}} JStream::open==
 
===Description===
 
===Description===
Open a stream with some lazy loading smarts.  
+
Generic File Operations.  
  
 
{{Description:JStream::open}}
 
{{Description:JStream::open}}
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JStream::open|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JStream::open|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JStream::open ($filename, $mode='r', $use_include_path=false, $context=null, $use_prefix=false, $relative=false, $detectprocessingmode=false)
+
public function open (
 +
        $filename
 +
        $mode='r'
 +
        $use_include_path=false
 +
        $context=null
 +
        $use_prefix=false
 +
        $relative=false
 +
        $detectprocessingmode=false
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 57: Line 62:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' boolean
boolean
+
* '''Defined''' on line 150 of libraries/joomla/filesystem/stream.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/filesystem/stream.php (line 129)
+
* see source code in [[jplatform:filesystem/stream.php#cl-129|BitBucket]]
+
===Referenced by===
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JStream::open source code''' on [[jplatform:filesystem/stream.php#cl-142|BitBucket]]
 +
* {{JVer|11.1}} Class [[JStream/11.1|JStream]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]]
 +
* [[JStream::open|Other versions of JStream::open]]
 +
{{SeeAlso:JStream::open}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JStream::open|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JStream::open|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JStream/11.1|JStream]]
+
===User contributed notes===
* [[JStream::open|Other versions of this method]]
+
{{SeeAlso:JStream::open}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 78: Line 82:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JStream]][[Category:JStream::open]]</noinclude>
 
<noinclude>[[Category:JStream]][[Category:JStream::open]]</noinclude>

Revision as of 21:42, 27 April 2011

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::open

Description

Generic File Operations.

Description:JStream::open [Edit Descripton]

public function 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 on line 150 of libraries/joomla/filesystem/stream.php
  • Since Joomla 11.1

See also

SeeAlso:JStream::open [Edit See Also]

User contributed notes

<CodeExamplesForm />