Block formslib: Difference between revisions
No edit summary |
No edit summary |
||
(6 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
(This is currently a proposal and isn't available for use). | {{obsolete}} | ||
(This is currently a proposal and isn't available for use see [http://tracker.moodle.org/browse/MDL-9641 MDL-9641]). | |||
= Overview = | = Overview = | ||
The block formslib functions are designed to allow developers easily create forms for their blocks. Please read [[lib/formslib.php]] for full details about using formslib. | The block formslib functions are designed to allow developers easily create forms for their blocks. Please read [[lib/formslib.php]] for full details about using formslib. | ||
= Creating a Global Configuration form = | = Creating a Global Configuration form = | ||
Line 25: | Line 11: | ||
In this file a class needs to be created which follows the naming scheme: block_BLOCKNAME_config_global_form and extends block_config_global_form | In this file a class needs to be created which follows the naming scheme: block_BLOCKNAME_config_global_form and extends block_config_global_form | ||
In your form configuration class you need to implement the block_configuration() method | In your form configuration class you need to implement the block_configuration() method. Elements added will automatically saved in $CFG. | ||
<pre> | <pre> | ||
Line 35: | Line 21: | ||
// add a html editor text field named block_BLOCKNAME_text | // add a html editor text field named block_BLOCKNAME_text | ||
$ | $mform->addElement('htmleditor', 'block_BLOCKNAME_text', get_string('text','BLOCKNAME')); | ||
// This will set the default value of the textfield to 'mydefaultstring'. (If $CFG->textfield | |||
// exsts, it will be set to that when the form is loaded) | |||
$mform->setDefault('mydefaultstring'); | |||
$mform->setType('block_BLOCKNAME_text', PARAM_RAW); | |||
$mform->setType(' | $mform->addElement('text', 'block_BLOCKNAME_num', get_string('block_BLOCKNAME_num', 'BLOCKNAME')); | ||
$mform->setDefault('block_online_users_timetosee', '5'); | |||
// Add client side validation which forces the field as numeric | |||
$mform->addRule('block_BLOCKNAME_num', null, 'numeric', null, 'client'); | |||
$mform->setType('block_BLOCKNAME_num', PARAM_INT); | |||
} | } | ||
Line 55: | Line 50: | ||
In this file a class needs to be created which follows the naming scheme: block_BLOCKNAME_config_instance_form and extends block_config_instance_form. | In this file a class needs to be created which follows the naming scheme: block_BLOCKNAME_config_instance_form and extends block_config_instance_form. | ||
In your form configuration class you need to implement the instance_configuration() method | In your form configuration class you need to implement the instance_configuration() method. Elements added will automatically saved in $block->config | ||
<pre> | <pre> | ||
Line 66: | Line 61: | ||
// add a text field named title | // add a text field named title | ||
$ | $mform->addElement('text','title',get_string('configtitle', 'BLOCKNAME')); | ||
// this will set the form field to 'my title' | // this will set the form field to 'my title' | ||
// | // (if a title string is already stored in the block instance | ||
$ | // configuration, it will automatically be set it to that) | ||
$mform->setDefault('title', 'my title string'); | |||
$mform->setType('title', PARAM_NOTAGS); | $mform->setType('title', PARAM_NOTAGS); | ||
Latest revision as of 12:25, 10 November 2013
Warning: This page is no longer in use. The information contained on the page should NOT be seen as relevant or reliable. |
(This is currently a proposal and isn't available for use see [https://tracker.moodle.org/browse/MDL-9641 MDL-9641]).
Overview
The block formslib functions are designed to allow developers easily create forms for their blocks. Please read lib/formslib.php for full details about using formslib.
Creating a Global Configuration form
In order to create a global confuration form using formslib, you must create a file /blocks/BLOCKNAME/config_global_form.php
In this file a class needs to be created which follows the naming scheme: block_BLOCKNAME_config_global_form and extends block_config_global_form
In your form configuration class you need to implement the block_configuration() method. Elements added will automatically saved in $CFG.
require_once $CFG->dirroot .'/blocks/block_config_global_form.php'; class block_BLOCKNAME_config_global_form extends block_config_global_form { function block_configuration(&$mform){ // add a html editor text field named block_BLOCKNAME_text $mform->addElement('htmleditor', 'block_BLOCKNAME_text', get_string('text','BLOCKNAME')); // This will set the default value of the textfield to 'mydefaultstring'. (If $CFG->textfield // exsts, it will be set to that when the form is loaded) $mform->setDefault('mydefaultstring'); $mform->setType('block_BLOCKNAME_text', PARAM_RAW); $mform->addElement('text', 'block_BLOCKNAME_num', get_string('block_BLOCKNAME_num', 'BLOCKNAME')); $mform->setDefault('block_online_users_timetosee', '5'); // Add client side validation which forces the field as numeric $mform->addRule('block_BLOCKNAME_num', null, 'numeric', null, 'client'); $mform->setType('block_BLOCKNAME_num', PARAM_INT); } }
Creating a Instance Configuration form
In order to create a global confuration form using formslib, you must create a file /blocks/BLOCKNAME/config_instance_form.php
In this file a class needs to be created which follows the naming scheme: block_BLOCKNAME_config_instance_form and extends block_config_instance_form.
In your form configuration class you need to implement the instance_configuration() method. Elements added will automatically saved in $block->config
<?php require_once $CFG->dirroot .'/blocks/block_config_instance_form.php'; class block_BLOCKNAME_config_instance_form extends block_config_instance_form { function instance_configuration(&$mform){ // add a text field named title $mform->addElement('text','title',get_string('configtitle', 'BLOCKNAME')); // this will set the form field to 'my title' // (if a title string is already stored in the block instance // configuration, it will automatically be set it to that) $mform->setDefault('title', 'my title string'); $mform->setType('title', PARAM_NOTAGS); } }