[4.0] Fix namespaced form fields Part 2 (#17664)

* Fix namespaced form fields * Fix tests and improve doc blocks
joomla · Aug 22, 2017 · 99fa8be · 99fa8be
1 parent ade0230
commit 99fa8be
Show file tree

Hide file tree

Showing 32 changed files with 98 additions and 69 deletions.
diff --git a/libraries/src/CMS/Form/Field/CalendarField.php b/libraries/src/CMS/Form/Field/CalendarField.php
@@ -145,7 +145,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed             $value    The form field value to validate.
@@ -155,7 +155,7 @@ public function __set($name, $value)
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)

diff --git a/libraries/src/CMS/Form/Field/CaptchaField.php b/libraries/src/CMS/Form/Field/CaptchaField.php
@@ -75,7 +75,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/CheckboxField.php b/libraries/src/CMS/Form/Field/CheckboxField.php
@@ -85,7 +85,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed             $value    The form field value to validate.
@@ -95,7 +95,7 @@ public function __set($name, $value)
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)

diff --git a/libraries/src/CMS/Form/Field/CheckboxesField.php b/libraries/src/CMS/Form/Field/CheckboxesField.php
@@ -118,7 +118,7 @@ protected function getInput()
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed             $value    The form field value to validate.
@@ -128,7 +128,7 @@ protected function getInput()
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)

diff --git a/libraries/src/CMS/Form/Field/ChromeStyleField.php b/libraries/src/CMS/Form/Field/ChromeStyleField.php
@@ -82,7 +82,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.
@@ -92,7 +92,7 @@ public function __set($name, $value)
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)

diff --git a/libraries/src/CMS/Form/Field/ColorField.php b/libraries/src/CMS/Form/Field/ColorField.php
@@ -145,7 +145,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed             $value    The form field value to validate.
@@ -155,7 +155,7 @@ public function __set($name, $value)
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)

diff --git a/libraries/src/CMS/Form/Field/EditorField.php b/libraries/src/CMS/Form/Field/EditorField.php
@@ -186,7 +186,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/FileField.php b/libraries/src/CMS/Form/Field/FileField.php
@@ -89,7 +89,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed             $value    The form field value to validate.
@@ -99,7 +99,7 @@ public function __set($name, $value)
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)

diff --git a/libraries/src/CMS/Form/Field/FilelistField.php b/libraries/src/CMS/Form/Field/FilelistField.php
@@ -138,17 +138,17 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
-	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
-	 * @param   mixed             $value    The form field value to validate.
-	 * @param   string            $group    The field name group control value. This acts as an array container for the field.
-	 *                                      For example if the field has name="foo" and the group value is set to "bar" then the
-	 *                                      full field name would end up being "bar[foo]".
+	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+	 * @param   mixed              $value    The form field value to validate.
+	 * @param   string             $group    The field name group control value. This acts as an array container for the field.
+	 *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+	 *                                       full field name would end up being "bar[foo]".
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)
@@ -202,12 +202,12 @@ protected function getOptions()
 		// Prepend some default options based on field attributes.
 		if (!$this->hideNone)
 		{
-			$options[] = \JHtml::_('select.option', '-1', JText::alt('JOPTION_DO_NOT_USE', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
+			$options[] = \JHtml::_('select.option', '-1', \JText::alt('JOPTION_DO_NOT_USE', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
 		}
 
 		if (!$this->hideDefault)
 		{
-			$options[] = \JHtml::_('select.option', '', JText::alt('JOPTION_USE_DEFAULT', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
+			$options[] = \JHtml::_('select.option', '', \JText::alt('JOPTION_USE_DEFAULT', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
 		}
 
 		// Get a list of files in the search path with the given filter.

diff --git a/libraries/src/CMS/Form/Field/FolderlistField.php b/libraries/src/CMS/Form/Field/FolderlistField.php
@@ -137,17 +137,17 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
-	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
-	 * @param   mixed             $value    The form field value to validate.
-	 * @param   string            $group    The field name group control value. This acts as an array container for the field.
-	 *                                      For example if the field has name="foo" and the group value is set to "bar" then the
-	 *                                      full field name would end up being "bar[foo]".
+	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+	 * @param   mixed              $value    The form field value to validate.
+	 * @param   string             $group    The field name group control value. This acts as an array container for the field.
+	 *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+	 *                                       full field name would end up being "bar[foo]".
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)
@@ -198,12 +198,12 @@ protected function getOptions()
 		// Prepend some default options based on field attributes.
 		if (!$this->hideNone)
 		{
-			$options[] = \JHtml::_('select.option', '-1', JText::alt('JOPTION_DO_NOT_USE', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
+			$options[] = \JHtml::_('select.option', '-1', \JText::alt('JOPTION_DO_NOT_USE', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
 		}
 
 		if (!$this->hideDefault)
 		{
-			$options[] = \JHtml::_('select.option', '', JText::alt('JOPTION_USE_DEFAULT', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
+			$options[] = \JHtml::_('select.option', '', \JText::alt('JOPTION_USE_DEFAULT', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
 		}
 
 		// Get a list of folders in the search path with the given filter.

diff --git a/libraries/src/CMS/Form/Field/MediaField.php b/libraries/src/CMS/Form/Field/MediaField.php
@@ -171,7 +171,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/MenuitemField.php b/libraries/src/CMS/Form/Field/MenuitemField.php
@@ -132,7 +132,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/MeterField.php b/libraries/src/CMS/Form/Field/MeterField.php
@@ -125,7 +125,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed             $value    The form field value to validate.
@@ -135,7 +135,7 @@ public function __set($name, $value)
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)

diff --git a/libraries/src/CMS/Form/Field/ModuleOrderField.php b/libraries/src/CMS/Form/Field/ModuleOrderField.php
@@ -80,7 +80,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/ModulePositionField.php b/libraries/src/CMS/Form/Field/ModulePositionField.php
@@ -84,7 +84,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/NumberField.php b/libraries/src/CMS/Form/Field/NumberField.php
@@ -109,7 +109,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/OrderingField.php b/libraries/src/CMS/Form/Field/OrderingField.php
@@ -82,7 +82,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/PasswordField.php b/libraries/src/CMS/Form/Field/PasswordField.php
@@ -127,7 +127,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/PluginsField.php b/libraries/src/CMS/Form/Field/PluginsField.php
@@ -80,7 +80,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.
@@ -90,7 +90,7 @@ public function __set($name, $value)
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)

diff --git a/libraries/src/CMS/Form/Field/RulesField.php b/libraries/src/CMS/Form/Field/RulesField.php
@@ -105,7 +105,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/SqlField.php b/libraries/src/CMS/Form/Field/SqlField.php
@@ -10,6 +10,7 @@
 
 defined('JPATH_PLATFORM') or die;
 
+use Joomla\CMS\Factory;
 use Joomla\CMS\Form\FormHelper;
 
 FormHelper::loadFieldClass('list');
@@ -111,17 +112,17 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
-	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
-	 * @param   mixed             $value    The form field value to validate.
-	 * @param   string            $group    The field name group control value. This acts as an array container for the field.
-	 *                                      For example if the field has name="foo" and the group value is set to "bar" then the
-	 *                                      full field name would end up being "bar[foo]".
+	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+	 * @param   mixed              $value    The form field value to validate.
+	 * @param   string             $group    The field name group control value. This acts as an array container for the field.
+	 *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+	 *                                       full field name would end up being "bar[foo]".
 	 *
 	 * @return  boolean  True on success.
 	 *
-	 * @see     JFormField::setup()
+	 * @see     FormField::setup()
 	 * @since   3.2
 	 */
 	public function setup(\SimpleXMLElement $element, $value, $group = null)
@@ -190,7 +191,7 @@ public function setup(\SimpleXMLElement $element, $value, $group = null)
 	 * @param   string  $filters     The columns to filter.
 	 * @param   array   $defaults    The defaults value to set if condition is empty.
 	 *
-	 * @return  JDatabaseQuery  The query object.
+	 * @return  \JDatabaseQuery  The query object.
 	 *
 	 * @since   3.5
 	 */
@@ -306,7 +307,7 @@ protected function getOptions()
 			{
 				if ($this->translate == true)
 				{
-					$options[] = \JHtml::_('select.option', $item->$key, JText::_($item->$value));
+					$options[] = \JHtml::_('select.option', $item->$key, \JText::_($item->$value));
 				}
 				else
 				{

diff --git a/libraries/src/CMS/Form/Field/SubformField.php b/libraries/src/CMS/Form/Field/SubformField.php
@@ -178,7 +178,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the <field /> tag for the form field object.
 	 * @param   mixed             $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/TemplatestyleField.php b/libraries/src/CMS/Form/Field/TemplatestyleField.php
@@ -93,7 +93,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.

diff --git a/libraries/src/CMS/Form/Field/TextField.php b/libraries/src/CMS/Form/Field/TextField.php
@@ -142,7 +142,7 @@ public function __set($name, $value)
 	}
 
 	/**
-	 * Method to attach a JForm object to the field.
+	 * Method to attach a Form object to the field.
 	 *
 	 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 	 * @param   mixed              $value    The form field value to validate.