Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 39 and 401] [Versions 401 and 403]

Private imscp module utility functions

Copyright: 2009 Petr Skoda {@link http://skodak.org}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 432 lines (15 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

imscp_file_info:: (10 methods):
  __construct()
  get_params()
  get_visible_name()
  is_writable()
  is_directory()
  get_children()
  get_filtered_children()
  get_non_empty_children()
  count_non_empty_children()
  get_parent()

Defines 10 functions


Class: imscp_file_info  - X-Ref

File browsing support class

__construct($browser, $course, $cm, $context, $areas, $filearea)   X-Ref
No description

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

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

get_visible_name()   X-Ref
Returns localised visible name.

return: string

is_writable()   X-Ref
Can I add new files or directories?

return: bool

is_directory()   X-Ref
Is directory?

return: bool

get_children()   X-Ref
Returns list of children.

return: array of file_info instances

get_filtered_children($extensions = '*', $countonly = false, $returnemptyfolders = false)   X-Ref
Help function to return files matching extensions or their count

param: string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
param: bool|int $countonly if false returns the children, if an int returns just the
param: bool $returnemptyfolders if true returns items that don't have matching files inside
return: array|int array of file_info instances or the count

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

param: string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
return: array of file_info instances

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

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

get_parent()   X-Ref
Returns parent file_info instance

return: file_info or null for root

Functions that are not part of a class:

imscp_print_content($imscp, $cm, $course)   X-Ref
Print IMSCP content to page.

param: stdClass $imscp module instance.
param: stdClass $cm course module.
param: stdClass $course record.

imscp_htmllize_item($item, $imscp, $cm)   X-Ref
Internal function - creates htmls structure suitable for YUI tree.


imscp_parse_structure($imscp, $context)   X-Ref
Parse an IMS content package's manifest file to determine its structure

param: object $imscp
param: object $context
return: array

imscp_parse_manifestfile($manifestfilecontents, $imscp, $context)   X-Ref
Parse the contents of a IMS package's manifest file.

param: string $manifestfilecontents the contents of the manifest file
return: array

imscp_recursive_href($manifestfilename, $imscp, $context)   X-Ref
No description

imscp_recursive_item($xmlitem, $level, $resources)   X-Ref
No description

imscp_libxml_disable_entity_loader(bool $value)   X-Ref
Wrapper for function libxml_disable_entity_loader() deprecated in PHP 8

Method was deprecated in PHP 8 and it shows deprecation message. However it is still
required in the previous versions on PHP. While Moodle supports both PHP 7 and 8 we need to keep it.
param: bool $value
return: bool