JFile::read/1.5

JFile::read

Description

Read the contents of a file.

public function read (
        $filename
        $incpath=false
        $amount=0
        $chunksize=8192
        $offset=0
)

Parameter	Type	Default	Description
$filename	string		The full file path
$incpath	boolean	false	Use include path
$amount	int	0	Amount of file to read
$chunksize	int	8192	Size of chunks to read
$offset	int	0	Offset of the file

• Returns mixed Returns file contents or boolean False if failed
• Defined on line 242 of libraries/joomla/filesystem/file.php
• Since
• Referenced by
  • JArchiveZip::_extract
  • JArchiveTar::extract
  • JArchiveGzip::extract
  • JArchiveBzip2::extract
  • JRegistry::loadFile

See also

• JFile::read on api.joomla.org
• JFile source code on JoomlaCode
• Class JFile
• Subpackage Filesystem
• Other versions of JFile::read

User contributed notes

<CodeExamplesForm />