[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/mod/data/ -> locallib.php (summary)

(no description)

Copyright: 1999 onwards Martin Dougiamas {@link http://moodle.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 672 lines (25 kb)
Included or required:0 times
Referenced: 4 times
Includes or requires: 0 files

Defines 2 classes

data_portfolio_caller:: (16 methods):
  expected_callbackargs()
  __construct()
  load_data()
  expected_time()
  get_sha1()
  prepare_package()
  check_permissions()
  display_name()
  __wakeup()
  exportentry()
  formats()
  has_files()
  base_supported_formats()
  has_export_config()
  export_config_form()
  get_allowed_export_config()

data_file_info_container:: (11 methods):
  __construct()
  get_params()
  is_writable()
  is_directory()
  get_visible_name()
  get_children()
  get_filtered_children()
  get_non_empty_children()
  count_non_empty_children()
  get_parent()
  data_set_events()


Class: data_portfolio_caller  - X-Ref

The class to handle entry exports of a database module

expected_callbackargs()   X-Ref
the required callback arguments for a single-record export

return: array

__construct($callbackargs)   X-Ref

param: array $callbackargs the arguments passed through

load_data()   X-Ref
load up the data needed for the export


expected_time()   X-Ref
How long we think the export will take
Single entry is probably not too long.
But we check for filesizes
Else base it on the number of records

return: one of PORTFOLIO_TIME_XX constants

get_sha1()   X-Ref
Calculate the shal1 of this export
Dependent on the export format.

return: string

prepare_package()   X-Ref
Prepare the package for export

return: stored_file object

check_permissions()   X-Ref
Verify the user can still export this entry

return: bool

display_name()   X-Ref

return: string

__wakeup()   X-Ref

return: bool|void

exportentry($record)   X-Ref
Prepare a single entry for export, replacing all the content etc

param: stdclass $record the entry to export
return: array with key 0 = the html content, key 1 = array of attachments

formats($fields, $record)   X-Ref
Given the fields being exported, and the single record,
work out which export format(s) we can use

param: array $fields array of field objects
param: object $record The data record object
return: array of PORTFOLIO_XX constants

has_files($data)   X-Ref
No description

base_supported_formats()   X-Ref
base supported formats before we know anything about the export


has_export_config()   X-Ref
No description

export_config_form(&$mform, $instance)   X-Ref
No description

get_allowed_export_config()   X-Ref
No description

Class: data_file_info_container  - X-Ref

Class representing the virtual node with all itemids in the file browser

__construct($browser, $course, $cm, $context, $areas, $filearea)   X-Ref
Constructor (in case you did not realize it ;-)

param: file_browser $browser
param: stdClass $course
param: stdClass $cm
param: stdClass $context
param: array $areas
param: string $filearea

get_params()   X-Ref

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

is_writable()   X-Ref
Can new files or directories be added via the file browser

return: bool

is_directory()   X-Ref
Should this node be considered as a folder in the file browser

return: bool

get_visible_name()   X-Ref
Returns localised visible name of this node

return: string

get_children()   X-Ref
Returns list of children nodes

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

data_set_events($data)   X-Ref
This creates new calendar events given as timeavailablefrom and timeclose by $data.

param: stdClass $data
return: void



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