File browsing support class. More...

Inheritance diagram for book_file_info:

Public Member Functions
	__construct ($browser, $course, $cm, $context, $areas, $filearea)
	Constructor.

	copy_to_pathname ($pathname)
	Copy content of this file to local storage, overriding current file if needed.

	copy_to_storage ($filerecord)
	Copy content of this file to local storage, overriding current file if needed.

	count_non_empty_children ($extensions=' *', $limit=1)
	Returns the number of children which are either files matching the specified extensions or folders containing at least one such file.

	create_directory ($newdirname, $userid=NULL)
	Create new directory, may throw exception - make sure params are valid.

	create_file_from_pathname ($newfilename, $pathname, $userid=NULL)
	Create new file from pathname - make sure params are valid.

	create_file_from_storedfile ($newfilename, $fid, $userid=NULL)
	Create new file from stored file - make sure params are valid.

	create_file_from_string ($newfilename, $content, $userid=NULL)
	Create new file from string - make sure params are valid.

	delete ()
	Delete file, make sure file is deletable first.

	get_author ()
	Returns the author name of the file.

	get_children ()
	Returns list of children.

	get_filesize ()
	Returns file size in bytes, null for directories.

	get_license ()
	Returns the license type of the file.

	get_mimetype ()
	Returns mimetype.

	get_non_empty_children ($extensions=' *')
	Returns list of children which are either files matching the specified extensions or folders that contain at least one such file.

	get_params ()
	Returns list of standard virtual file/directory identification.

	get_params_rawencoded ()
	Returns array of url encoded params.

	get_parent ()
	Returns parent file_info instance.

	get_readable_fullname ()
	Returns the localised human-readable name of the file together with virtual path.

	get_sortorder ()
	Returns the sort order of the file.

	get_source ()
	Returns the source of the file.

	get_status ()
	Returns file status flag.

	get_timecreated ()
	Returns time created unix timestamp if known.

	get_timemodified ()
	Returns time modified unix timestamp if known.

	get_url ($forcedownload=false, $https=false)
	Returns file download url.

	get_visible_name ()
	Returns localised visible name.

	is_directory ()
	Is directory?

	is_empty_area ()
	Is this info area and is it "empty"? Are there any files in subfolders?

	is_external_file ()
	Whether or not this is a external resource.

	is_readable ()
	Whether or not I can read content of this file or enter directory.

	is_writable ()
	Can I add new files or directories?

Protected Member Functions
	build_search_files_sql ($extensions, $prefix=null)
	Builds SQL sub query (WHERE clause) for selecting files with the specified extensions.

Protected Attributes
array	$areas
	Available file areas.

file_browser	$browser
	File browser instance.

stdClass	$cm
	Course module object.

context	$context
	File context.

stdClass	$course
	Course object.

string	$filearea
	File area to browse.

Detailed Description

File browsing support class.

Copyright: 2010-2011 Petr Skoda

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

file_browser	$browser	file_browser instance
stdClass	$course	course object
stdClass	$cm	course module object
stdClass	$context	module context
array	$areas	available file areas
string	$filearea	file area to browse

Member Function Documentation

◆ build_search_files_sql()

file_info::build_search_files_sql	(		$extensions,
			$prefix = null )

protectedinherited

Builds SQL sub query (WHERE clause) for selecting files with the specified extensions.

If $extensions == '*' (any file), the result is array('', array()) otherwise the result is something like array('AND filename ...', array(...))

Parameters

string \| array	$extensions	- either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
string	$prefix	prefix for DB table files in the query (empty by default)

Return values

array of two elements: $sql - sql where clause and $params - array of parameters

◆ copy_to_pathname()

file_info::copy_to_pathname ( $pathname )

inherited

Copy content of this file to local storage, overriding current file if needed.

Todo: MDL-31068 implement move() rename() unzip() zip()

Parameters

string $pathname real local full file name

Return values

boolean success

Reimplemented in file_info_stored.

◆ copy_to_storage()

file_info::copy_to_storage ( $filerecord )

inherited

Copy content of this file to local storage, overriding current file if needed.

Parameters

array | stdClass $filerecord contains contextid, component, filearea, itemid, filepath, filename and optionally other attributes of the new file

Return values

bool success

Reimplemented in file_info_stored.

◆ count_non_empty_children()

book_file_info::count_non_empty_children	(		$extensions = '*',
			$limit = 1 )

Returns the number of children which are either files matching the specified extensions or folders containing at least one such file.

Parameters

string \| array	$extensions,for	example '*' or array('.gif','.jpg')
int	$limit	stop counting after at least $limit non-empty children are found

Return values

int

Reimplemented from file_info.

◆ create_directory()

file_info::create_directory	(		$newdirname,
			$userid = NULL )

inherited

Create new directory, may throw exception - make sure params are valid.

Parameters

string	$newdirname	name of new directory
int	$userid	id of author, default $USER->id

Return values

file_info new directory

Reimplemented in file_info_stored.

◆ create_file_from_pathname()

file_info::create_file_from_pathname	(	$newfilename,
		$pathname,
		$userid = NULL )

inherited

Create new file from pathname - make sure params are valid.

Parameters

string	$newfilename	name of new file
string	$pathname	location of file
int	$userid	id of author, default $USER->id

Return values

file_info new file

Reimplemented in file_info_stored.

◆ create_file_from_storedfile()

file_info::create_file_from_storedfile	(	$newfilename,
		$fid,
		$userid = NULL )

inherited

Create new file from stored file - make sure params are valid.

Parameters

string	$newfilename	name of new file
int \| stored_file	$fid	id or stored_file of file
int	$userid	id of author, default $USER->id

Return values

file_info new file

Reimplemented in file_info_stored.

◆ create_file_from_string()

file_info::create_file_from_string	(	$newfilename,
		$content,
		$userid = NULL )

inherited

Create new file from string - make sure params are valid.

Parameters

string	$newfilename	name of new file
string	$content	of file
int	$userid	id of author, default $USER->id

Return values

file_info new file

Reimplemented in file_info_stored.

◆ delete()

file_info::delete ( )

inherited

Delete file, make sure file is deletable first.

Return values

bool success

Reimplemented in file_info_stored.

◆ get_author()

file_info::get_author ( )

inherited

Returns the author name of the file.

Return values

string author name or null

Reimplemented in file_info_stored.

◆ get_children()

book_file_info::get_children ( )

Returns list of children.

Return values

array of file_info instances

Reimplemented from file_info.

◆ get_filesize()

file_info::get_filesize ( )

inherited

Returns file size in bytes, null for directories.

Return values

int	bytes or null if not known

Reimplemented in file_info_stored.

◆ get_license()

file_info::get_license ( )

inherited

Returns the license type of the file.

Return values

string license short name or null

Reimplemented in file_info_stored.

◆ get_mimetype()

file_info::get_mimetype ( )

inherited

Returns mimetype.

Return values

string mimetype or null if not known

Reimplemented in file_info_stored.

◆ get_non_empty_children()

book_file_info::get_non_empty_children ( $extensions = '*' )

Returns list of children which are either files matching the specified extensions or folders that contain at least one such file.

Parameters

string | array $extensions,either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')

Return values

array of file_info instances

Reimplemented from file_info.

◆ get_params()

book_file_info::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

Return values

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

Reimplemented from file_info.

◆ get_params_rawencoded()

file_info::get_params_rawencoded ( )

inherited

Returns array of url encoded params.

Return values

array with numeric keys

◆ get_parent()

book_file_info::get_parent ( )

Returns parent file_info instance.

Return values

file_info or null for root

Reimplemented from file_info.

◆ get_readable_fullname()

file_info::get_readable_fullname ( )

inherited

Returns the localised human-readable name of the file together with virtual path.

See also: file_info_stored\get_readable_fullname()

Return values

string

Reimplemented in file_info_stored.

◆ get_sortorder()

file_info::get_sortorder ( )

inherited

Returns the sort order of the file.

Return values

int

Reimplemented in file_info_stored.

◆ get_source()

file_info::get_source ( )

inherited

Returns the source of the file.

Return values

string a source url or null

Reimplemented in file_info_stored.

◆ get_status()

file_info::get_status ( )

inherited

Returns file status flag.

Return values

int	0 means file OK, anything else is a problem and file can not be used

Reimplemented in file_info_stored.

◆ get_timecreated()

file_info::get_timecreated ( )

inherited

Returns time created unix timestamp if known.

Return values

int	timestamp or null

Reimplemented in file_info_stored.

◆ get_timemodified()

file_info::get_timemodified ( )

inherited

Returns time modified unix timestamp if known.

Return values

int	timestamp or null

Reimplemented in file_info_stored.

◆ get_url()

file_info::get_url	(		$forcedownload = false,
			$https = false )

inherited

Returns file download url.

Parameters

bool	$forcedownload	whether or not force download
bool	$https	whether or not force https

Return values

string url

Reimplemented in file_info_area_course_legacy, and file_info_stored.

◆ get_visible_name()

book_file_info::get_visible_name ( )

Returns localised visible name.

Return values

string

Reimplemented from file_info.

◆ is_directory()

book_file_info::is_directory ( )

Is directory?

Return values

bool

Reimplemented from file_info.

◆ is_empty_area()

file_info::is_empty_area ( )

inherited

Is this info area and is it "empty"? Are there any files in subfolders?

This is used mostly in repositories to reduce the number of empty folders. This method may be very slow, use with care.

Return values

bool

Reimplemented in file_info_area_backup_section, file_info_area_course_section, file_info_context_module, and file_info_stored.

◆ is_external_file()

file_info::is_external_file ( )

inherited

Whether or not this is a external resource.

Return values

bool

Reimplemented in file_info_stored.

◆ is_readable()

file_info::is_readable ( )

inherited

Whether or not I can read content of this file or enter directory.

Return values

bool

Reimplemented in file_info_stored.

◆ is_writable()

book_file_info::is_writable ( )

Can I add new files or directories?

Return values

bool

Reimplemented from file_info.

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

mod/book/locallib.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ build_search_files_sql()

◆ copy_to_pathname()

◆ copy_to_storage()

◆ count_non_empty_children()

◆ create_directory()

◆ create_file_from_pathname()

◆ create_file_from_storedfile()

◆ create_file_from_string()

◆ delete()

◆ get_author()

◆ get_children()

◆ get_filesize()

◆ get_license()

◆ get_mimetype()

◆ get_non_empty_children()

◆ get_params()

◆ get_params_rawencoded()

◆ get_parent()

◆ get_readable_fullname()

◆ get_sortorder()

◆ get_source()

◆ get_status()

◆ get_timecreated()

◆ get_timemodified()

◆ get_url()

◆ get_visible_name()

◆ is_directory()

◆ is_empty_area()

◆ is_external_file()

◆ is_readable()

◆ is_writable()