API17:JStream::open

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.

JStream::open

Description

Open a stream with some lazy loading smarts.

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

See also

• JStream
• Other versions of this method

Examples

<CodeExamplesForm />