PHPXRef 0.7.1 : Unnamed Project : Detail view of grading.php

Advance grading form element Element-container for advanced grading custom input

Copyright:	2011 Marina Glancy
License:	http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size:	161 lines (6 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

MoodleQuickForm_grading:: (8 methods):
  __construct()
  MoodleQuickForm_grading()
  get_gradinginstance()
  toHtml()
  getHelpButton()
  getElementTemplateType()
  onQuickFormEvent()
  _validate()

Class: MoodleQuickForm_grading - X-Ref

Advance grading form element

HTML class for a grading element. This is a wrapper for advanced grading plugins.
When adding the 'grading' element to the form, developer must pass an object of
class gradingform_instance as $attributes['gradinginstance']. Otherwise an exception will be
thrown.
This object is responsible for implementing functions to render element html and validate it

__construct($elementName=null, $elementLabel=null, $attributes=null) X-Ref

Class constructor

param: string $elementName Input field name attribute
param: mixed $elementLabel Label(s) for the input field
param: mixed $attributes Either a typical HTML attribute string or an associative array

MoodleQuickForm_grading($elementName=null, $elementLabel=null, $attributes=null) X-Ref

Old syntax of class constructor. Deprecated in PHP7.

get_gradinginstance() X-Ref

Helper function to retrieve gradingform_instance passed in element attributes

return: gradingform_instance

toHtml() X-Ref

Returns the input field in HTML

return: string

getHelpButton() X-Ref

get html for help button

return: string html for help button

getElementTemplateType() X-Ref

The renderer of gradingform_instance will take care itself about different display
in normal and frozen states

return: string

onQuickFormEvent($event, $arg, &$caller) X-Ref

Called by HTML_QuickForm whenever form event is made on this element.
Adds necessary rules to the element and checks that coorenct instance of gradingform_instance
is passed in attributes

param: string $event Name of event
param: mixed $arg event arguments
param: object $caller calling object
return: bool

_validate($elementvalue, $attributes = null) X-Ref

Function registered as rule for this element and is called when this element is being validated.
This is a wrapper to pass the validation to the method gradingform_instance::validate_grading_element

param: mixed $elementvalue value of element to be validated
param: array $attributes element attributes
return: MoodleQuickForm_grading

PHP Cross Reference of Unnamed Project

/lib/form/ -> grading.php (summary)

Defines 1 class