Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
file_info_context_module Class Reference

Represents a module context in the tree navigated by file_browser. More...

Inheritance diagram for file_info_context_module:
file_info

Public Member Functions

 __construct ($browser, $context, $course, $cm, $modname)
 Constructor. More...
 
 copy_to_pathname ($pathname)
 Copy content of this file to local storage, overriding current file if needed. More...
 
 copy_to_storage ($filerecord)
 Copy content of this file to local storage, overriding current file if needed. More...
 
 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. More...
 
 create_directory ($newdirname, $userid=NULL)
 Create new directory, may throw exception - make sure params are valid. More...
 
 create_file_from_pathname ($newfilename, $pathname, $userid=NULL)
 Create new file from pathname - make sure params are valid. More...
 
 create_file_from_storedfile ($newfilename, $fid, $userid=NULL)
 Create new file from stored file - make sure params are valid. More...
 
 create_file_from_string ($newfilename, $content, $userid=NULL)
 Create new file from string - make sure params are valid. More...
 
 delete ()
 Delete file, make sure file is deletable first. More...
 
 get_author ()
 Returns the author name of the file. More...
 
 get_children ()
 Returns list of children. More...
 
 get_file_info ($component, $filearea, $itemid, $filepath, $filename)
 Return information about this specific context level. More...
 
 get_filesize ()
 Returns file size in bytes, null for directories. More...
 
 get_license ()
 Returns the license type of the file. More...
 
 get_mimetype ()
 Returns mimetype. More...
 
 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. More...
 
 get_params ()
 Returns list of standard virtual file/directory identification. More...
 
 get_params_rawencoded ()
 Returns array of url encoded params. More...
 
 get_parent ()
 Returns parent file_info instance. More...
 
 get_readable_fullname ()
 Returns the localised human-readable name of the file together with virtual path. More...
 
 get_sortorder ()
 Returns the sort order of the file. More...
 
 get_source ()
 Returns the source of the file. More...
 
 get_status ()
 Returns file status flag. More...
 
 get_timecreated ()
 Returns time created unix timestamp if known. More...
 
 get_timemodified ()
 Returns time modified unix timestamp if known. More...
 
 get_url ($forcedownload=false, $https=false)
 Returns file download url. More...
 
 get_visible_name ()
 Returns localised visible name. More...
 
 is_directory ()
 Whether or not this is a directory. More...
 
 is_empty_area ()
 Whether or not this is an emtpy area. More...
 
 is_external_file ()
 Whether or not this is a external resource. More...
 
 is_readable ()
 Whether or not I can read content of this file or enter directory. More...
 
 is_writable ()
 Whether or not files or directories can be added. More...
 

Protected Member Functions

 build_search_files_sql ($extensions, $prefix=null)
 Builds SQL sub query (WHERE clause) for selecting files with the specified extensions. More...
 
 get_area_backup ($itemid, $filepath, $filename)
 Get a file from module backup area. More...
 
 get_area_intro ($itemid, $filepath, $filename)
 Get a file from module intro area. More...
 

Protected Attributes

array $areas
 Available file areas.
 
file_browser $browser
 File browser instance.
 
cm_info $cm
 Course module object.
 
stdClass $context
 File context.
 
stdClass $course
 Course object.
 
string $modname
 Module name.
 
array $nonemptychildren
 caches the result of last call to get_non_empty_children()
 

Detailed Description

Represents a module context in the tree navigated by file_browser.

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

Constructor & Destructor Documentation

◆ __construct()

file_info_context_module::__construct (   $browser,
  $context,
  $course,
  $cm,
  $modname 
)

Constructor.

Parameters
file_browser$browserfile browser instance
stdClass$contextcontext object
stdClass$coursecourse object
stdClass$cmcourse module object
string$modnamemodule name

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$prefixprefix for DB table files in the query (empty by default)
Return values
arrayof 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$pathnamereal local full file name
Return values
booleansuccess

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$filerecordcontains contextid, component, filearea, itemid, filepath, filename and optionally other attributes of the new file
Return values
boolsuccess

Reimplemented in file_info_stored.

◆ count_non_empty_children()

file_info_context_module::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$extensionsfor example '*' or array('.gif','.jpg')
int$limitstop 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$newdirnamename of new directory
int$useridid of author, default $USER->id
Return values
file_infonew 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$newfilenamename of new file
string$pathnamelocation of file
int$useridid of author, default $USER->id
Return values
file_infonew 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$newfilenamename of new file
int | stored_file$fidid or stored_file of file
int$useridid of author, default $USER->id
Return values
file_infonew 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$newfilenamename of new file
string$contentof file
int$useridid of author, default $USER->id
Return values
file_infonew file

Reimplemented in file_info_stored.

◆ delete()

file_info::delete ( )
inherited

Delete file, make sure file is deletable first.

Return values
boolsuccess

Reimplemented in file_info_stored.

◆ get_area_backup()

file_info_context_module::get_area_backup (   $itemid,
  $filepath,
  $filename 
)
protected

Get a file from module backup area.

Parameters
int$itemiditem ID
string$filepathfile path
string$filenamefile name
Return values
file_info|null

◆ get_area_intro()

file_info_context_module::get_area_intro (   $itemid,
  $filepath,
  $filename 
)
protected

Get a file from module intro area.

Parameters
int$itemiditem ID
string$filepathfile path
string$filenamefile name
Return values
file_info|null

◆ get_author()

file_info::get_author ( )
inherited

Returns the author name of the file.

Return values
stringauthor name or null

Reimplemented in file_info_stored.

◆ get_children()

file_info_context_module::get_children ( )

Returns list of children.

Return values
arrayof file_info instances

Reimplemented from file_info.

◆ get_file_info()

file_info_context_module::get_file_info (   $component,
  $filearea,
  $itemid,
  $filepath,
  $filename 
)

Return information about this specific context level.

Parameters
string$componentcomponent
string$fileareafile area
int$itemiditem ID
string$filepathfile path
string$filenamefile name
Return values
file_info|null

◆ get_filesize()

file_info::get_filesize ( )
inherited

Returns file size in bytes, null for directories.

Return values
intbytes 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
stringlicense short name or null

Reimplemented in file_info_stored.

◆ get_mimetype()

file_info::get_mimetype ( )
inherited

Returns mimetype.

Return values
stringmimetype or null if not known

Reimplemented in file_info_stored.

◆ get_non_empty_children()

file_info_context_module::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$extensionseither '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
Return values
arrayof file_info instances

Reimplemented from file_info.

◆ get_params()

file_info::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
arraywith keys contextid, component, filearea, itemid, filepath and filename

Reimplemented in file_info_area_course_section, file_info_area_backup_section, file_info_stored, book_file_info, data_file_info_container, forum_file_info_container, glossary_file_info_container, imscp_file_info, mod_lesson_file_info, workshop_file_info_submissions_container, and workshop_file_info_overallfeedback_container.

◆ get_params_rawencoded()

file_info::get_params_rawencoded ( )
inherited

Returns array of url encoded params.

Return values
arraywith numeric keys

◆ get_parent()

file_info_context_module::get_parent ( )

Returns parent file_info instance.

Return values
file_info|nullfile_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
stringa source url or null

Reimplemented in file_info_stored.

◆ get_status()

file_info::get_status ( )
inherited

Returns file status flag.

Return values
int0 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
inttimestamp or null

Reimplemented in file_info_stored.

◆ get_timemodified()

file_info::get_timemodified ( )
inherited

Returns time modified unix timestamp if known.

Return values
inttimestamp or null

Reimplemented in file_info_stored.

◆ get_url()

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

Returns file download url.

Parameters
bool$forcedownloadwhether or not force download
bool$httpswhether or not force https
Return values
stringurl

Reimplemented in file_info_area_course_legacy, and file_info_stored.

◆ get_visible_name()

file_info_context_module::get_visible_name ( )

Returns localised visible name.

Return values
string

Reimplemented from file_info.

◆ is_directory()

file_info_context_module::is_directory ( )

Whether or not this is a directory.

Return values
bool

Reimplemented from file_info.

◆ is_empty_area()

file_info_context_module::is_empty_area ( )

Whether or not this is an emtpy area.

Return values
bool

Reimplemented from file_info.

◆ 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()

file_info_context_module::is_writable ( )

Whether or not files or directories can be added.

Return values
bool

Reimplemented from file_info.


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