Actions

API17

Difference between revisions of "JFile::read"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JFile::read|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JFile::read|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JFile::read ($filename, $incpath=false, $amount=0, $chunksize=8192, $offset=0)
+
public static function read (
 +
        $filename
 +
        $incpath=false
 +
        $amount=0
 +
        $chunksize=8192
 +
        $offset=0
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 47: Line 50:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' mixed Returns file contents or boolean False if failed
mixed Returns file contents or boolean False if failed
+
* '''Defined''' on line 272 of libraries/joomla/filesystem/file.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/filesystem/file.php (line 260)
+
* '''Referenced by'''
* see source code in [[jplatform:filesystem/file.php#cl-260|BitBucket]]
+
** [[JArchiveZip::_extract/11.1|JArchiveZip::_extract]]
===Referenced by===
+
** [[JRegistry::loadFile/11.1|JRegistry::loadFile]]
* [[JArchiveZip::_extract/11.1|JArchiveZip::_extract]]
+
* [[JRegistry::loadFile/11.1|JRegistry::loadFile]]
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JFile::read source code''' on [[jplatform:filesystem/file.php#cl-264|BitBucket]]
 +
* {{JVer|11.1}} Class [[JFile/11.1|JFile]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]]
 +
* [[JFile::read|Other versions of JFile::read]]
 +
{{SeeAlso:JFile::read}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JFile::read|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JFile::read|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JFile/11.1|JFile]]
+
===User contributed notes===
* [[JFile::read|Other versions of this method]]
+
{{SeeAlso:JFile::read}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 70: Line 73:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JFile]][[Category:JFile::read]]</noinclude>
 
<noinclude>[[Category:JFile]][[Category:JFile::read]]</noinclude>

Revision as of 20:56, 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 JFile::read

Description

Read the contents of a file.

Description:JFile::read [Edit Descripton]

public static 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

See also

SeeAlso:JFile::read [Edit See Also]

User contributed notes

<CodeExamplesForm />