lib/formslib.php setAdvanced - Revision history

Devdocsbot: Protected "lib/formslib.php setAdvanced": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-17T06:41:55Z

Protected "lib/formslib.php setAdvanced": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 06:41, 17 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-17T06:40:00Z

Update migration status and path

← Older revision		Revision as of 06:40, 17 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/subsystems/form/advanced/advanced-elements}}
	{{Formslib}}		{{Formslib}}
	==setAdvanced to specify one form element as an advanced option==		==setAdvanced to specify one form element as an advanced option==

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:28:20Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:28, 14 July 2021
Line 6:		Line 6:
	$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);		$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);
	$mform->setAdvanced('display');		$mform->setAdvanced('display');
	</~~code~~>		</syntaxhighlight>

	If you set any element in a form to be an advanced item then ''''show / hide advanced' buttons are shown automatically''' in the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced controls hidden or shown.		If you set any element in a form to be an advanced item then ''''show / hide advanced' buttons are shown automatically''' in the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced controls hidden or shown.
Line 20:		Line 20:
	$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);		$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);
	$mform->setAdvanced('display');		$mform->setAdvanced('display');
	</~~code~~>		</syntaxhighlight>

	The second param of the addElement('header', ....) should be a unique name for the header.		The second param of the addElement('header', ....) should be a unique name for the header.
Line 30:		Line 30:
	$mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));		$mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));
	$mform->setAdvanced('miscellaneoussettingshdr');		$mform->setAdvanced('miscellaneoussettingshdr');
	</~~code~~>		</syntaxhighlight>

	Will set the header element miscellaneoussettingshdr and '''all''' the elements it contains to advanced.		Will set the header element miscellaneoussettingshdr and '''all''' the elements it contains to advanced.

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:05:00Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:05, 14 July 2021
				
Line 3:
Line 3:
You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option : You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option :



<code> <syntaxhighlight lang="php">
         $mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);          $mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);
         $mform->setAdvanced('display');          $mform->setAdvanced('display');
Line 16:
Line 16:
Ie. this is not good : Ie. this is not good :



<code> <syntaxhighlight lang="php">
         $mform->addElement('header', <nowiki>''</nowiki>, get_string('miscellaneoussettings', 'form'));          $mform->addElement('header', <nowiki>''</nowiki>, get_string('miscellaneoussettings', 'form'));
         $mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);          $mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);
Line 27:
Line 27:



==setAdvanced to specify all form elements in a fieldset are advanced elements== ==setAdvanced to specify all form elements in a fieldset are advanced elements==
<code> <syntaxhighlight lang="php">
         $mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));          $mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));
         $mform->setAdvanced('miscellaneoussettingshdr');          $mform->setAdvanced('miscellaneoussettingshdr');



Jamiesensei: /* Make Sure You Name the Header of a Fieldset Within Which You Include Advanced Elements */  - problem with formatting fixed
2007-03-13T05:51:16Z
Make Sure You Name the Header of a Fieldset Within Which You Include Advanced Elements:   - problem with formatting fixed

				
				
				
				
				
				← Older revision
				Revision as of 05:51, 13 March 2007
				
Line 15:
Line 15:



Ie. this is not good : Ie. this is not good :

<code> <code>
         $mform->addElement('header', '', get_string('miscellaneoussettings', 'form'));          $mform->addElement('header', <nowiki>''</nowiki>, get_string('miscellaneoussettings', 'form'));
         $mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);          $mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);
         $mform->setAdvanced('display');          $mform->setAdvanced('display');
</code> </code>

The second param of the addElement('header', ....) should be a unique name for the header. The second param of the addElement('header', ....) should be a unique name for the header.






Jamiesensei: Make Sure You Name the Header of a Fieldset Within Which You Include Advanced Elements
2007-03-13T05:43:11Z
Make Sure You Name the Header of a Fieldset Within Which You Include Advanced Elements

				
				
				
				
				
				← Older revision
				Revision as of 05:43, 13 March 2007
				
Line 11:
Line 11:



setAdvanced takes a second boolean parameter which defaults to true. True means set this control as an advanced control. False means it is not advanced. setAdvanced takes a second boolean parameter which defaults to true. True means set this control as an advanced control. False means it is not advanced.

===Make Sure You Name the Header of a Fieldset Within Which You Include Advanced Elements===

Ie. this is not good :
<code>
        $mform->addElement('header', '', get_string('miscellaneoussettings', 'form'));
        $mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);
        $mform->setAdvanced('display');
</code>
The second param of the addElement('header', ....) should be a unique name for the header.

If you don't then other sections of the form that also have an unnamed header may also get marked as advanced. This will also happen if header elements have identical names.

==setAdvanced to specify all form elements in a fieldset are advanced elements== ==setAdvanced to specify all form elements in a fieldset are advanced elements==
<code> <code>



Jamiesensei at 07:15, 8 March 2007
2007-03-08T07:15:24Z


				
				
				
				
				
				← Older revision
				Revision as of 07:15, 8 March 2007
				
Line 1:
Line 1:
{{Formslib}} {{Formslib}}
==setAdvanced to specify a form element== ==setAdvanced to specify one form element as an advanced option==
You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option : You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option :






Jamiesensei: clarification
2007-03-08T07:14:29Z
clarification

				
				
				
				
				
				← Older revision
				Revision as of 07:14, 8 March 2007
				
Line 1:
Line 1:
{{Formslib}} {{Formslib}}
==setAdvanced to specify a form element==
You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option : You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option :



Line 6:
Line 7:
         $mform->setAdvanced('display');          $mform->setAdvanced('display');
</code> </code>

If you set any element in a form to be an advanced item then ''''show / hide advanced' buttons are shown automatically''' in the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced controls hidden or shown.



setAdvanced takes a second boolean parameter which defaults to true. True means set this control as an advanced control. False means it is not advanced. setAdvanced takes a second boolean parameter which defaults to true. True means set this control as an advanced control. False means it is not advanced.
  ==setAdvanced to specify all form elements in a fieldset are advanced elements==
<code> <code>
         $mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));          $mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));
Line 14:
Line 17:
</code> </code>



Will set the header element miscellaneoussettingshdr and all the elements it contains to advanced. Will set the header element miscellaneoussettingshdr and '''all''' the elements it contains to advanced.
  
If you set any button in a form to be an advanced item then ''''show / hide advanced' buttons are shown automatically''' in the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced controls hidden or shown. 



===What happens when a form is submitted with form elements hidden?=== ===What happens when a form is submitted with form elements hidden?===



If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by set_data which is called to load database contents into the form. If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by set_data which is called to load database contents into the form.



Jamiesensei: /* What happens when a form is submitted with form elements hidden? */  -- set_defaults changed to set_data
2007-01-21T09:56:20Z
What happens when a form is submitted with form elements hidden?:   -- set_defaults changed to set_data

				
				
				
				
				
				← Older revision
				Revision as of 09:56, 21 January 2007
				
Line 20:
Line 20:
===What happens when a form is submitted with form elements hidden?=== ===What happens when a form is submitted with form elements hidden?===



If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by set_defaults which is called to load database contents into the form. If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by set_data which is called to load database contents into the form.



Jamiesensei at 06:34, 19 December 2006
2006-12-19T06:34:55Z


				
				
				
				
				
				← Older revision
				Revision as of 06:34, 19 December 2006
				
Line 17:
Line 17:



If you set any button in a form to be an advanced item then ''''show / hide advanced' buttons are shown automatically''' in the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced controls hidden or shown. If you set any button in a form to be an advanced item then ''''show / hide advanced' buttons are shown automatically''' in the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced controls hidden or shown.

===What happens when a form is submitted with form elements hidden?===

If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by set_defaults which is called to load database contents into the form.

← Older revision		Revision as of 13:05, 14 July 2021
Line 3:		Line 3:
	You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option :		You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option :

	<~~code~~>		<syntaxhighlight lang="php">
	$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);		$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);
	$mform->setAdvanced('display');		$mform->setAdvanced('display');
Line 16:		Line 16:
	Ie. this is not good :		Ie. this is not good :

	<~~code~~>		<syntaxhighlight lang="php">
	$mform->addElement('header', <nowiki>''</nowiki>, get_string('miscellaneoussettings', 'form'));		$mform->addElement('header', <nowiki>''</nowiki>, get_string('miscellaneoussettings', 'form'));
	$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);		$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);
Line 27:		Line 27:

	==setAdvanced to specify all form elements in a fieldset are advanced elements==		==setAdvanced to specify all form elements in a fieldset are advanced elements==
	<~~code~~>		<syntaxhighlight lang="php">
	$mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));		$mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));
	$mform->setAdvanced('miscellaneoussettingshdr');		$mform->setAdvanced('miscellaneoussettingshdr');

← Older revision		Revision as of 05:51, 13 March 2007
Line 15:		Line 15:

	Ie. this is not good :		Ie. this is not good :

	<code>		<code>
	$mform->addElement('header', '', get_string('miscellaneoussettings', 'form'));		$mform->addElement('header', <nowiki>''</nowiki>, get_string('miscellaneoussettings', 'form'));
	$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);		$mform->addElement('select', 'display', get_string('displaymode', 'choice'), $CHOICE_DISPLAY);
	$mform->setAdvanced('display');		$mform->setAdvanced('display');
	</code>		</code>

	The second param of the addElement('header', ....) should be a unique name for the header.		The second param of the addElement('header', ....) should be a unique name for the header.

← Older revision		Revision as of 07:15, 8 March 2007
Line 1:		Line 1:
	{{Formslib}}		{{Formslib}}
	==setAdvanced to specify a form element==		==setAdvanced to specify one form element as an advanced option==
	You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option :		You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option :

← Older revision		Revision as of 07:14, 8 March 2007
Line 1:		Line 1:
	{{Formslib}}		{{Formslib}}
			==setAdvanced to specify a form element==
	You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option :		You can use MoodleQuickForm's method setAdvanced to specify a form element as an advanced option :

Line 6:		Line 7:
	$mform->setAdvanced('display');		$mform->setAdvanced('display');
	</code>		</code>

			If you set any element in a form to be an advanced item then ''''show / hide advanced' buttons are shown automatically''' in the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced controls hidden or shown.

	setAdvanced takes a second boolean parameter which defaults to true. True means set this control as an advanced control. False means it is not advanced.		setAdvanced takes a second boolean parameter which defaults to true. True means set this control as an advanced control. False means it is not advanced.
			==setAdvanced to specify all form elements in a fieldset are advanced elements==
	<code>		<code>
	$mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));		$mform->addElement('header', 'miscellaneoussettingshdr', get_string('miscellaneoussettings', 'form'));
Line 14:		Line 17:
	</code>		</code>

	Will set the header element miscellaneoussettingshdr and ~~all the elements it contains to advanced.~~		Will set the header element miscellaneoussettingshdr and '''all''' the elements it contains to advanced.

	~~If you set any button in a form to be an advanced item then~~ ''''~~show / hide advanced' buttons are shown automatically~~''~~' in~~ the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced ~~controls hidden or shown~~.

	===What happens when a form is submitted with form elements hidden?===		===What happens when a form is submitted with form elements hidden?===

	If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by set_data which is called to load database contents into the form.		If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by set_data which is called to load database contents into the form.

← Older revision		Revision as of 09:56, 21 January 2007
Line 20:		Line 20:
	===What happens when a form is submitted with form elements hidden?===		===What happens when a form is submitted with form elements hidden?===

	If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by ~~set_defaults~~ which is called to load database contents into the form.		If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by set_data which is called to load database contents into the form.

← Older revision		Revision as of 06:34, 19 December 2006
Line 17:		Line 17:

	If you set any button in a form to be an advanced item then ''''show / hide advanced' buttons are shown automatically''' in the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced controls hidden or shown.		If you set any button in a form to be an advanced item then ''''show / hide advanced' buttons are shown automatically''' in the form. Show / hide buttons are currently displayed at the top right of all fieldsets containing advanced controls. The show / hide button shows or hides advanced controls using javascript or if no javascript is available then the whole page is submitted and redisplayed with advanced controls hidden or shown.

			===What happens when a form is submitted with form elements hidden?===

			If form elements are hidden and the form is submitted then no values are submitted by the form elements. But the 'default values' of the form elements are automatically passed to the processing functions from data_submitted(). Default values are set by setDefault normally called from within definition() function or by set_defaults which is called to load database contents into the form.