API17:JStream::open

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

Description

Generic File Operations.

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

See also

• JStream::open source code on BitBucket
• Class JStream
• Subpackage Filesystem
• Other versions of JStream::open

User contributed notes

<CodeExamplesForm />