[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/filebrowser/ -> file_info_context_coursecat.php (summary)

Utility class for browsing of curse category files.

Copyright: 2008 Petr Skoda (http://skodak.org)
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 263 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

file_info_context_coursecat:: (9 methods):
  __construct()
  get_file_info()
  get_area_coursecat_description()
  get_visible_name()
  is_writable()
  is_directory()
  get_children()
  count_non_empty_children()
  get_parent()


Class: file_info_context_coursecat  - X-Ref

Represents a course category context in the tree navigated by {@link file_browser}.

__construct($browser, $context, $category)   X-Ref
Constructor

param: file_browser $browser file browser instance
param: stdClass $context context object
param: stdClass $category category object

get_file_info($component, $filearea, $itemid, $filepath, $filename)   X-Ref
Return information about this specific context level

param: string $component component
param: string $filearea file area
param: int $itemid item ID
param: string $filepath file path
param: string $filename file name
return: fileinfo|null

get_area_coursecat_description($itemid, $filepath, $filename)   X-Ref
Return a file from course category description area

param: int $itemid item ID
param: string $filepath file path
param: string $filename file name
return: fileinfo|null

get_visible_name()   X-Ref
Returns localised visible name.

return: string

is_writable()   X-Ref
Whether or not new files or directories can be added

return: bool

is_directory()   X-Ref
Whether or not this is a directory

return: bool

get_children()   X-Ref
Returns list of children.

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|null fileinfo instance or null for root directory



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1