page_content_file_info Class Reference

File browsing support class. More...

Inheritance diagram for page_content_file_info:

Public Member Functions
	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_imageinfo ()
	Returns width, height and mimetype of the stored image, or false.
	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 ()
	Whether or not this is a directory.
	is_empty_area ()
	Whether or not this is an empty area.
	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 ()
	Whether or not new files or directories can be added.

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
string	$areaonly
	do not show links to parent context/area
file_browser	$browser
	File browser instance.
context	$context
	File context.
int bool	$itemidused
	it's false if itemid is 0 and not included in URL
stored_file virtual_root_file	$lf
	stored_file or virtual_root_file instance
bool	$readaccess
	allow file reading
string	$topvisiblename
	the human readable name of this area
string	$urlbase
	the serving script
bool	$writeaccess
	allow file write, delee

Detailed Description

File browsing support class.

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_stored::copy_to_pathname ( $pathname )

inherited

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

Parameters

string

$pathname

real local full file name

Return values

bool

success

Reimplemented from file_info.

copy_to_storage()

file_info_stored::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 from file_info.

count_non_empty_children()

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

inherited

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_stored::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|null

new directory's file_info instance or null if failed

Reimplemented from file_info.

create_file_from_pathname()

file_info_stored::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|null

new file's file_info instance or null if failed

Reimplemented from file_info.

create_file_from_storedfile()

file_info_stored::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	file id or stored_file of file
int	$userid	id of author, default $USER->id

Return values

file_info|null

new file's file_info instance or null if failed

Reimplemented from file_info.

create_file_from_string()

file_info_stored::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|null

new file's file_info instance or null if failed

Reimplemented from file_info.

delete()

file_info_stored::delete ( )

inherited

Delete file, make sure file is deletable first.

Return values

bool

success

Reimplemented from file_info.

get_author()

file_info_stored::get_author ( )

inherited

Returns the author name of the file.

Return values

string

author name or null

Reimplemented from file_info.

get_children()

file_info_stored::get_children ( )

inherited

Returns list of children.

Return values

array

of file_info instances

Reimplemented from file_info.

Reimplemented in file_info_area_course_legacy.

get_filesize()

file_info_stored::get_filesize ( )

inherited

Returns file size in bytes, null for directories.

Return values

int	bytes or null if not known

Reimplemented from file_info.

get_imageinfo()

file_info_stored::get_imageinfo ( )

inherited

Returns width, height and mimetype of the stored image, or false.

See also

stored_file\get_imageinfo()

Return values

array|false

get_license()

file_info_stored::get_license ( )

inherited

Returns the license type of the file.

Return values

string

license short name or null

Reimplemented from file_info.

get_mimetype()

file_info_stored::get_mimetype ( )

inherited

Returns mimetype.

Return values

string

mimetype or null if not known

Reimplemented from file_info.

get_non_empty_children()

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

inherited

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.

Reimplemented in file_info_area_course_legacy.

get_params()

file_info_stored::get_params ( )

inherited

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, component, 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()

page_content_file_info::get_parent

(

)

Returns parent file_info instance.

Return values

file_info|null

file_info instance or null for root

Reimplemented from file_info_stored.

get_readable_fullname()

file_info_stored::get_readable_fullname ( )

inherited

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

Return values

string

Reimplemented from file_info.

get_sortorder()

file_info_stored::get_sortorder ( )

inherited

Returns the sort order of the file.

Return values

int

Reimplemented from file_info.

get_source()

file_info_stored::get_source ( )

inherited

Returns the source of the file.

Return values

string

a source url or null

Reimplemented from file_info.

get_status()

file_info_stored::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 from file_info.

get_timecreated()

file_info_stored::get_timecreated ( )

inherited

Returns time created unix timestamp if known.

Return values

int	timestamp or null

Reimplemented from file_info.

get_timemodified()

file_info_stored::get_timemodified ( )

inherited

Returns time modified unix timestamp if known.

Return values

int	timestamp or null

Reimplemented from file_info.

get_url()

file_info_stored::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 from file_info.

Reimplemented in file_info_area_course_legacy.

get_visible_name()

page_content_file_info::get_visible_name

(

)

Returns localised visible name.

Return values

string

Reimplemented from file_info_stored.

is_directory()

file_info_stored::is_directory ( )

inherited

Whether or not this is a directory.

Return values

bool

Reimplemented from file_info.

is_empty_area()

file_info_stored::is_empty_area ( )

inherited

Whether or not this is an empty area.

Return values

bool

Reimplemented from file_info.

is_external_file()

file_info_stored::is_external_file ( )

inherited

Whether or not this is a external resource.

Return values

bool

Reimplemented from file_info.

is_readable()

file_info_stored::is_readable ( )

inherited

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

Return values

bool

Reimplemented from file_info.

is_writable()

file_info_stored::is_writable ( )

inherited

Whether or not new files or directories can be added.

Return values

bool

Reimplemented from file_info.

---

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

• mod/page/locallib.php