API17:JFactory::getStream

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.

JFactory::getStream

Description

Creates a new stream object with appropriate prefix.

public static function getStream (
        $use_prefix=true
        $use_network=true
        $ua=null
        $uamask=false
)

Parameter	Type	Default	Description
$use_prefix	boolean	true	Prefix the connections for writing
$use_network	boolean	true	Use network if available for writing; use false to disable (e.g. FTP, SCP)
$ua	string	null	UA User agent to use
$uamask	boolean	false	User agent masking (prefix Mozilla)

• Returns
• Defined on line 699 of libraries/joomla/factory.php
• Since
• Referenced by
  • JFolder::copy
  • JFile::copy
  • JArchiveTar::extract
  • JArchiveGzip::extract
  • JArchiveBzip2::extract
  • JFolder::move
  • JFile::move
  • JFile::upload
  • JFile::write

See also

• JFactory::getStream source code on BitBucket
• Class JFactory
• Other versions of JFactory::getStream

User contributed notes

<CodeExamplesForm />