API16:JForm/getFieldset - Revision history

JoomlaWikiBot: /* Examples */removing red link to edit, no existant pages

2013-05-14T02:52:49Z

‎Examples: removing red link to edit, no existant pages

Haroldbr: /* Syntax */

2010-08-27T10:08:19Z

‎Syntax

Haroldbr: /* Examples */

2010-08-27T10:06:25Z

‎Examples

Haroldbr: /* Examples */

2010-08-27T10:04:20Z

‎Examples

Haroldbr: /* Examples */

2010-08-27T10:03:19Z

‎Examples

Haroldbr: /* Examples */

2010-08-27T10:02:24Z

‎Examples

Haroldbr: /* Examples */

2010-08-27T10:02:03Z

‎Examples

Haroldbr: /* Source Body */

2010-08-27T10:01:22Z

‎Source Body

Haroldbr: /* Source Body */

2010-08-27T10:00:13Z

‎Source Body

Haroldbr: /* Importing */

2010-08-27T09:59:54Z

‎Importing

← Older revision		Revision as of 02:52, 14 May 2013
Line 187:		Line 187:
	format= ,,,		format= ,,,
	</dpl>		</dpl>
		+	[[Category:Archived pages API16]]

@@ Line 1: / Line 1: @@
 ===Syntax===
-<source lang="php">getFieldset()</source>
+<source lang="php">getFieldset($fieldset)</source>
 ===Defined in===

@@ Line 109: / Line 109: @@
          public function getForm($data = array(), $loadData = true)
+         {
-                 $form = $this->loadForm('com_mvc.mvc', 'form', array('control' => 'jform', 'load_data' => $loadData);
+                 $form = $this->loadForm(
                  return $form;
+         }

@@ Line 62: / Line 62: @@
 </source>
-We'll assume for this example that we have also have a controller which is instantiating our "mvcview", which is a class that extends JView. The following are the contents of the view.html.php file:
+We'll assume for this example that we have also have a controller which is instantiating our "mvcViewmvc", which is a class that extends JView. The following is the content of the view.html.php file:
 <source lang="php">

@@ Line 47: / Line 47: @@
 ===Examples===
-<CodeExamplesForm />
-<dpl>
- noresultsheader=\n
- category=getFieldsets
- category=JForm
- category=CodeExample
- category=MethodExample
- include=*
- format= ,,,
-</dpl>
 For this example, consider a situation in which we're building an MVC component. The following is a list of the files and directories inside our "com_mvc" folder:
@@ Line 182: / Line 173: @@
 This template will display only the fields which we have defined in our form.xml file that are within the "primary_fieldset." This becomes very handy if you have fieldsets that you want to display from different templates, but they all fall under the purview of a single data model.
 <dpl>
   noresultsheader=\n
-  category=getFieldsets
+  category=getFieldset
   category=JForm
   category=CodeExample

@@ Line 58: / Line 58: @@
 For this example, consider a situation in which we're building an MVC component. The following is a list of the files and directories inside our "com_mvc" folder:
 models/
 models/mvcmodel.php
@@ Line 67: / Line 68: @@
 views/mvc/tmpl/
 views/mvc/tmpl/default.php
 We'll assume for this example that we have also have a controller which is instantiating our "mvcview", which is a class that extends JView. The following are the contents of the view.html.php file:
@@ Line 164: / Line 166: @@
 <source lang="php">
-<div class="first-fieldset>
+<div class="first-fieldset">
      <form name="formname">
          <fieldset class="adminform">

← Older revision		Revision as of 10:01, 27 August 2010
Line 44:		Line 44:
	}		}
	</source>		</source>
		+	===Examples===
		+	===Examples===
		+	<CodeExamplesForm />
		+	<dpl>
		+	noresultsheader=\n
		+	category=getFieldsets
		+	category=JForm
		+	category=CodeExample
		+	category=MethodExample
		+	include=*
		+	format= ,,,
		+	</dpl>
		+	For this example, consider a situation in which we're building an MVC component. The following is a list of the files and directories inside our "com_mvc" folder:
		+
		+	models/
		+	models/mvcmodel.php
		+	models/forms/
		+	models/forms/form.xml
		+	views/
		+	views/mvc/
		+	views/mvc/view.html.php
		+	views/mvc/tmpl/
		+	views/mvc/tmpl/default.php
		+
		+	We'll assume for this example that we have also have a controller which is instantiating our "mvcview", which is a class that extends JView. The following are the contents of the view.html.php file:
		+
		+	<source lang="php">
		+	class mvcViewmvc extends JView
		+	{
		+	/**
		+	* View form
		+	*
		+	* @var form
		+	*/
		+	protected $form = null;
		+	/**
		+	* display method of MVC view
		+	* @return void
		+	*/
		+	public function display($tpl = null)
		+	{
		+	// get the Form
		+	$form = & $this->get('Form');
		+	// get the Data
		+	if (count($errors = $this->get('Errors')))
		+	{
		+	JError::raiseError(500, implode("<br />", $errors));
		+	return;
		+	}
		+	// Assign the form
		+	$this->form = $form;
		+	// Display the template
		+	parent::display();
		+	}
		+	}
		+	</source>
		+
		+	This view uses the mvcmodelmvc data model to get the form data, and the default template to display the form. Looking at the code in our mvcmodel.php file will shed some light on how the form.xml data is loaded:
		+
		+	<source lang="php">
		+	class mvcModelmvc extends JModelAdmin
		+	{
		+
		+	/**
		+	* Method to get the form.
		+	*
		+	* @access public
		+	* @return mixed JForm object on success, false on failure.
		+	*/
		+	public function getForm($data = array(), $loadData = true)
		+	{
		+	$form = $this->loadForm('com_mvc.mvc', 'form', array('control' => 'jform', 'load_data' => $loadData);
		+	return $form;
		+	}
		+	}
		+	</source>
		+
		+	We can see that the getForm method defined in our data model calls the loadForm method, which will load the data from the form.xml file. Let's take a look inside our form.xml file:
		+
		+	<source lang="xml">
		+	<?xml version="1.0" encoding="utf-8"?>
		+	<form>
		+	<fieldset name="primary_fieldset">
		+	<field
		+	id="id"
		+	name="id"
		+	type="hidden"
		+	/>
		+	<field
		+	id="primary"
		+	name="primary"
		+	type="list"
		+	label="Primary Selection"
		+	default="red">
		+	<option value="red">Red</option>
		+	<option value="blue">Blue</option>
		+	</field>
		+	</fieldset>
		+	<fieldset name="secondary_fieldset">
		+	<field
		+	id="id"
		+	name="id"
		+	type="hidden"
		+	/>
		+	<field
		+	id="secondary"
		+	name="secondary"
		+	type="list"
		+	label="Secondary Selection"
		+	default="green">
		+	<option value="green">Green</option>
		+	<option value="yellow">Yellow</option>
		+	</field>
		+	</fieldset>
		+	</form>
		+	</source>
		+
		+	So, as of right now, we've called the default template and passed $this to it. $this has our form contained in the form variable, accessible through $this->form. Since $this->form is a JForm object, we can call getFieldset($fieldset) from it. Consider the default.php template file:
		+
		+	<source lang="php">
		+	<div class="first-fieldset>
		+	<form name="formname">
		+	<fieldset class="adminform">
		+	<legend>Primary Fields</legend>
		+	<?php foreach ($this->form->getFieldset('primary_fieldset') as $field): ?>
		+	<?php echo $field->label; ?>
		+	<?php echo $field->input; ?>
		+	<?php endforeach; ?>
		+	</fieldset>
		+	</form>
		+	</div>
		+	</source>
		+
		+	This template will display only the fields which we have defined in our form.xml file that are within the "primary_fieldset." This becomes very handy if you have fieldsets that you want to display from different templates, but they all fall under the purview of a single data model.
		+
		+	<dpl>
		+	noresultsheader=\n
		+	category=getFieldsets
		+	category=JForm
		+	category=CodeExample
		+	category=MethodExample
		+	include=*
		+	format= ,,,
		+	</dpl>

@@ Line 43: / Line 43: @@
 	return $fields;
+}
-</span>
+</source>

← Older revision		Revision as of 09:59, 27 August 2010
Line 6:		Line 6:
	===Importing===		===Importing===
	<source lang="php">jimport( 'joomla.form.form' );</source>		<source lang="php">jimport( 'joomla.form.form' );</source>
		+	===Source Body===
		+	<source lang="php">
		+	public function getFieldset($set = null)
		+	{
		+	// Initialize variables.
		+	$fields = array();
		+
		+	// Get all of the field elements in the fieldset.
		+	if ($set) {
		+	$elements = $this->findFieldsByFieldset($set);
		+	}
		+	// Get all fields.
		+	else {
		+	$elements = $this->findFieldsByGroup();
		+	}
		+
		+	// If no field elements were found return empty.
		+	if (empty($elements)) {
		+	return $fields;
		+	}
		+
		+	// Build the result array from the found field elements.
		+	foreach ($elements as $element) {
		+
		+	// Get the field groups for the element.
		+	$attrs = $element->xpath('ancestor::fields[@name]/@name');
		+	$groups = array_map('strval', $attrs ? $attrs : array());
		+	$group = implode('.', $groups);
		+
		+	// If the field is successfully loaded add it to the result array.
		+	if ($field = $this->loadField($element, $group)) {
		+	$fields[$field->id] = $field;
		+	}
		+	}
		+
		+	return $fields;
		+	}
		+	</span>