Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
- Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/mod/lesson/classes/ -> file_info.php (source)
File browsing support.
| Copyright: | 2013 Frédéric Massart |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 194 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
mod_lesson_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()
Class: mod_lesson_file_info - X-Ref
File browsing support class.| __construct($browser, $course, $cm, $context, $areas, $filearea) X-Ref |
| Constructor param: file_browser $browser file_browser instance param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context module context param: array $areas available file areas param: string $filearea file area to browse |
| 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 |
