FileWrapper Class Reference
[File]

Class abstracting operations for reading remote files using various protocols. (for when allow_url_fopen is disabled). More...

Inheritance diagram for FileWrapper:

List of all members.

Public Member Functions
	close ()
	contents ()
	eof ()
	FileWrapper ($url, &$info)
	open ($mode= 'r')
	read ($len=8192)
&	wrapper ($url)

---

Detailed Description

Class abstracting operations for reading remote files using various protocols. (for when allow_url_fopen is disabled).

TODO:

• Other protocols?
• Write mode (where possible)

Definition at line 23 of file FileWrapper.inc.php.

---

Member Function Documentation

FileWrapper.close

(

)

Close the file.

Reimplemented in FTPFileWrapper.

Definition at line 75 of file FileWrapper.inc.php.

Referenced by contents(), and HTTPFileWrapper.open().

FileWrapper.contents

(

)

Read and return the contents of the file (like file_get_contents()).

Returns:

string

Definition at line 48 of file FileWrapper.inc.php.

References close(), eof(), open(), and read().

FileWrapper.eof

(

)

Check for end-of-file.

Returns:

boolean

Definition at line 93 of file FileWrapper.inc.php.

Referenced by contents().

FileWrapper.FileWrapper	(	$	url,
		&$	info
	)

Constructor.

Parameters:

	$url	string
	$info	array

Definition at line 39 of file FileWrapper.inc.php.

Referenced by wrapper().

FileWrapper.open

(

$

mode = 'r'

)

Open the file.

Parameters:

$mode

string only 'r' (read-only) is currently supported

Returns:

boolean

Reimplemented in HTTPFileWrapper, and FTPFileWrapper.

Definition at line 66 of file FileWrapper.inc.php.

Referenced by contents().

FileWrapper.read

(

$

len = 8192

)

Read from the file.

Parameters:

$len

int

Returns:

string

Definition at line 85 of file FileWrapper.inc.php.

Referenced by contents().

& FileWrapper.wrapper

(

$

url

)

Return instance of a class for reading the specified URL.

Parameters:

$url

string

Returns:

FileWrapper

Definition at line 107 of file FileWrapper.inc.php.

References FileWrapper(), and Config.getVar().

Referenced by LanguageAction.downloadLocale(), HTTPFileWrapper.open(), XMLParser.parse(), and XMLParser.parseStruct().

---

The documentation for this class was generated from the following file:

• classes/file/FileWrapper.inc.php