imscp_file_info Class Reference

Inheritance diagram for imscp_file_info:

Collaboration diagram for imscp_file_info:

Public Member Functions
	__construct ($browser, $course, $cm, $context, $areas, $filearea)
	get_params ()
	get_visible_name ()
	is_writable ()
	is_directory ()
	get_children ()
	get_parent ()
Protected Attributes
	$course
	$cm
	$areas
	$filearea

---

Detailed Description

File browsing support class

Definition at line 218 of file locallib.php.

---

Constructor & Destructor Documentation

__construct	(	$	browser,
		$	course,
		$	cm,
		$	context,
		$	areas,
		$	filearea
	)

Definition at line 224 of file locallib.php.

---

Member Function Documentation

get_children

(

)

Returns list of children.

Returns:

array of file_info instances

Reimplemented from file_info.

Definition at line 275 of file locallib.php.

get_params

(

)

Returns list of standard virtual file/directory identification. The difference from stored_file parameters is that null values are allowed in all fields

Returns:

array with keys contextid, filearea, itemid, filepath and filename

Reimplemented from file_info.

Definition at line 238 of file locallib.php.

get_parent

(

)

Returns parent file_info instance

Returns:

file_info or null for root

Reimplemented from file_info.

Definition at line 292 of file locallib.php.

get_visible_name

(

)

Returns localised visible name.

Returns:

string

Reimplemented from file_info.

Definition at line 251 of file locallib.php.

is_directory

(

)

Is directory?

Returns:

bool

Reimplemented from file_info.

Definition at line 267 of file locallib.php.

is_writable

(

)

Can I add new files or directories?

Returns:

bool

Reimplemented from file_info.

Definition at line 259 of file locallib.php.

---

Field Documentation

$areas [protected]

Definition at line 221 of file locallib.php.

$cm [protected]

Definition at line 220 of file locallib.php.

$course [protected]

Definition at line 219 of file locallib.php.

$filearea [protected]

Definition at line 222 of file locallib.php.

---

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

• C:/xampp/htdocs/moodle/mod/imscp/locallib.php