KumiSystems/moodle-mod_htmlcert
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Corrected PHPDocs

Browse source
This commit is contained in:
Mark Nelson 2013-05-28 16:33:46 +08:00
parent 8350c4afbf
commit 516506e8f1
2 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
elements/element.class.php
View file

@ -218,9 +218,10 @@ class customcert_element_base {
* Can be overridden if more functionality is needed. * Can be overridden if more functionality is needed.
* *
* @param stdClass $data the form data. * @param stdClass $data the form data.
* @return string the unique data to save
*/ */
public function save_unique_data($data) { public function save_unique_data($data) {
return null; return '';
} }
/** /**
@ -228,7 +229,8 @@ class customcert_element_base {
* to a template to be loaded later. * to a template to be loaded later.
* Can be overridden if more functionality is needed. * Can be overridden if more functionality is needed.
* *
* @param stdClass $data the form data. * @param stdClass $data the form data
* @return bool returns true if the data was saved to the template, false otherwise
*/ */
public function save_data_to_template($data) { public function save_data_to_template($data) {
return true; return true;
@ -239,7 +241,8 @@ class customcert_element_base {
* from a template to an existing customcert. * from a template to an existing customcert.
* Can be overridden if more functionality is needed. * Can be overridden if more functionality is needed.
* *
* @param stdClass $data the form data. * @param stdClass $data the form data
* @return bool returns true if the data was loaded from the template, false otherwise
*/ */
public function load_data_from_template($data) { public function load_data_from_template($data) {
return true; return true;
@ -254,7 +257,6 @@ class customcert_element_base {
*/ */
public function render($pdf, $userid) { public function render($pdf, $userid) {
// Must be overridden. // Must be overridden.
return false;
} }
/** /**
@ -319,8 +321,8 @@ class customcert_element_base {
/** /**
* Validates the colour selected. * Validates the colour selected.
* *
* @param string $data * @param string $colour
* @return string|false * @return bool returns true if the colour is valid, false otherwise
*/ */
protected function validate_colour($colour) { protected function validate_colour($colour) {
/** /**

9
lib.php
View file

@ -54,7 +54,7 @@ define('CUSTOMCERT_MAX_PER_PAGE', 300);
/** /**
* Add customcert instance. * Add customcert instance.
* *
* @param stdClass $customcert * @param stdClass $data
* @param stdClass $mform * @param stdClass $mform
* @return int new customcert instance id * @return int new customcert instance id
*/ */
@ -254,7 +254,7 @@ function customcert_user_outline($course, $user, $mod, $customcert) {
* @param stdClass $course * @param stdClass $course
* @param stdClass $user * @param stdClass $user
* @param stdClass $mod * @param stdClass $mod
* @param stdClass $page * @param stdClass $customcert
* @return string the user complete information * @return string the user complete information
*/ */
function customcert_user_complete($course, $user, $mod, $customcert) { function customcert_user_complete($course, $user, $mod, $customcert) {
@ -377,7 +377,7 @@ function customcert_get_images() {
/** /**
* Handles uploading an image for the customcert module. * Handles uploading an image for the customcert module.
* *
* @param stdClass $draftiemtid the draft area containing the files * @param int $draftitemid the draft area containing the files
*/ */
function customcert_upload_imagefiles($draftitemid) { function customcert_upload_imagefiles($draftitemid) {
// Get the filestorage object. // Get the filestorage object.
@ -649,8 +649,7 @@ function customcert_delete_page($pageid) {
/** /**
* Returns a list of all the templates. * Returns a list of all the templates.
* *
* @param stdClass $element the element * @return bool returns true if success, false otherwise
* @param bool returns true if success, false otherwise
*/ */
function customcert_get_templates() { function customcert_get_templates() {
global $DB; global $DB;