[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/admin/tool/assignmentupgrade/ -> locallib.php (summary)

Assignment upgrade tool library functions

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

Defines 2 classes

tool_assignmentupgrade_batchoperationconfirm:: (1 method):
  __construct()

tool_assignmentupgrade_action:: (6 methods):
  __construct()
  make()
  tool_assignmentupgrade_any_upgradable_assignments()
  tool_assignmentupgrade_load_all_upgradable_assignmentids()
  tool_assignmentupgrade_upgrade_assignment()
  tool_assignmentupgrade_get_assignment()

Defines 6 functions

  tool_assignmentupgrade_url()

Class: tool_assignmentupgrade_batchoperationconfirm  - X-Ref

Class to encapsulate the continue / cancel for batch operations

__construct($data)   X-Ref
Constructor for this class

param: stdClass $data - The data from the previous batch form

Class: tool_assignmentupgrade_action  - X-Ref

Class to encapsulate one of the functionalities that this plugin offers.

__construct($name, moodle_url $url, $description)   X-Ref
Constructor to set the fields.

In order to create a new tool_assignmentupgrade_action instance you must use
the tool_assignmentupgrade_action::make
method.

param: string $name the name of this action.
param: moodle_url $url the URL to launch this action.
param: string $description a description of this aciton.

make($shortname, $params = array()   X-Ref
Make an action with standard values.

param: string $shortname internal name of the action. Used to get strings and build a URL.
param: array $params any URL params required.
return: tool_assignmentupgrade_action

tool_assignmentupgrade_any_upgradable_assignments()   X-Ref
Determine if there are any assignments that can be upgraded

return: boolean - Are there any assignments that can be upgraded

tool_assignmentupgrade_load_all_upgradable_assignmentids()   X-Ref
Load a list of all the assignmentids that can be upgraded

return: array of assignment ids

tool_assignmentupgrade_upgrade_assignment($assignmentid)   X-Ref
Upgrade a single assignment. This is used by both upgrade single and upgrade batch

param: int $assignmentid - The assignment id to upgrade
return: array(string, boolean, string) -

tool_assignmentupgrade_get_assignment($assignmentid)   X-Ref
Get the information about a assignment to be upgraded.

param: int $assignmentid the assignment id.
return: stdClass the information about that assignment.

Functions
Functions that are not part of a class:

tool_assignmentupgrade_url($script, $params = array()   X-Ref
Get the URL of a script within this plugin.

param: string $script the script name, without .php. E.g. 'index'
param: array $params URL parameters (optional)
return: moodle_url



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