[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

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

Mandatory public API of url module

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

Defines 14 functions

  url_supports()
  url_get_extra_capabilities()
  url_reset_userdata()
  url_get_view_actions()
  url_get_post_actions()
  url_add_instance()
  url_update_instance()
  url_delete_instance()
  url_get_coursemodule_info()
  url_page_type_list()
  url_export_contents()
  url_dndupload_register()
  url_dndupload_handle()
  url_view()

Functions
Functions that are not part of a class:

url_supports($feature)   X-Ref
List of features supported in URL module

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

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

return: array

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

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

url_get_view_actions()   X-Ref
List the actions that correspond to a view of this module.
This is used by the participation report.

Note: This is not used by new logging system. Event with
crud = 'r' and edulevel = LEVEL_PARTICIPATING will
be considered as view action.

return: array

url_get_post_actions()   X-Ref
List the actions that correspond to a post of this module.
This is used by the participation report.

Note: This is not used by new logging system. Event with
crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
will be considered as post action.

return: array

url_add_instance($data, $mform)   X-Ref
Add url instance.

param: object $data
param: object $mform
return: int new url instance id

url_update_instance($data, $mform)   X-Ref
Update url instance.

param: object $data
param: object $mform
return: bool true

url_delete_instance($id)   X-Ref
Delete url instance.

param: int $id
return: bool true

url_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 {@link get_array_of_activities()} in course/lib.php

param: object $coursemodule
return: cached_cm_info info

url_page_type_list($pagetype, $parentcontext, $currentcontext)   X-Ref
Return a list of page types

param: string $pagetype current page type
param: stdClass $parentcontext Block's parent context
param: stdClass $currentcontext Current context of block

url_export_contents($cm, $baseurl)   X-Ref
Export URL resource contents

return: array of file content

url_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

url_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

url_view($url, $course, $cm, $context)   X-Ref
Mark the activity completed (if required) and trigger the course_module_viewed event.

param: stdClass $url        url object
param: stdClass $course     course object
param: stdClass $cm         course module object
param: stdClass $context    context object



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