[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/mod/label/ -> lib.php (summary)

Library of functions and constants for module label

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

Defines 11 functions

  get_label_name()
  label_add_instance()
  label_update_instance()
  label_delete_instance()
  label_get_coursemodule_info()
  label_reset_userdata()
  label_get_extra_capabilities()
  label_supports()
  label_dndupload_register()
  label_dndupload_handle()
  label_generate_resized_image()

Functions
Functions that are not part of a class:

get_label_name($label)   X-Ref

param: object $label
return: string

label_add_instance($label)   X-Ref
Given an object containing all the necessary data,
(defined by the form in mod_form.php) this function
will create a new instance and return the id number
of the new instance.

param: object $label
return: bool|int

label_update_instance($label)   X-Ref
Given an object containing all the necessary data,
(defined by the form in mod_form.php) this function
will update an existing instance with new data.

param: object $label
return: bool

label_delete_instance($id)   X-Ref
Given an ID of an instance of this module,
this function will permanently delete the instance
and any data that depends on it.

param: int $id
return: bool

label_get_coursemodule_info($coursemodule)   X-Ref
Given a course_module object, this function returns any
"extra" information that may be needed when printing
this activity in a course listing.
See get_array_of_activities() in course/lib.php

param: object $coursemodule
return: cached_cm_info|null

label_reset_userdata($data)   X-Ref
This function is used by the reset_course_userdata function in moodlelib.

param: object $data the data submitted from the reset course.
return: array status array

label_get_extra_capabilities()   X-Ref
Returns all other caps used in module

return: array

label_supports($feature)   X-Ref

param: string $feature FEATURE_xx constant for requested feature
return: bool|null True if module supports feature, false if not, null if doesn't know

label_dndupload_register()   X-Ref
Register the ability to handle drag and drop file uploads

return: array containing details of the files / types the mod can handle

label_dndupload_handle($uploadinfo)   X-Ref
Handle a file that has been uploaded

param: object $uploadinfo details of the file / content that has been uploaded
return: int instance id of the newly created mod

label_generate_resized_image(stored_file $file, $maxwidth, $maxheight)   X-Ref
Resize the image, if required, then generate an img tag and, if required, a link to the full-size image

param: stored_file $file the image file to process
param: int $maxwidth the maximum width allowed for the image
param: int $maxheight the maximum height allowed for the image
return: string HTML fragment to add to the label



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