Back to Joomla project (class list)

Class SqlField - list of methods

Supports a custom SQL select list

Extends

Package: Joomla\CMS\Form\Field
Copyright: (C) 2010 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Form/Field/SqlField.php
Project: Joomla

Method Summary

public mixed
(mixed $name)

Method to get certain otherwise inaccessible properties from the form field object.
Parameters
  • string $name The property name for which to get the value.
Returns
  • mixed The property value or null.
Since
  • 3.2
Show source code of this method: __get Source Code

public void
(mixed $name, mixed $value)

Method to set certain otherwise inaccessible properties of the form field object.
Parameters
  • string $name The property name for which to set the value.
  • mixed $value The value of the property.
Returns
  • void
Since
  • 3.2
Show source code of this method: __set Source Code

public bool
(\SimpleXMLElement $element, mixed $value, mixed $group = null)

Method to attach a Form object to the field.
Parameters
  • \SimpleXMLElement $element The SimpleXMLElement object representing the `<field>` tag for the form field object.
  • mixed $value The form field value to validate.
  • 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]".
Returns
  • bool True on success.
Since
  • 3.2
-
  • \Joomla\CMS\Form\Field\FormField::setup()
Show source code of this method: setup Source Code

protected \Joomla\Database\DatabaseQuery
(mixed $conditions, mixed $filters, mixed $defaults)

Method to process the query from form.
Parameters
  • array $conditions The conditions from the form.
  • string $filters The columns to filter.
  • array $defaults The defaults value to set if condition is empty.
Returns
  • \Joomla\Database\DatabaseQuery The query object.
Since
  • 3.5
Show source code of this method: processQuery Source Code

protected array
()

Method to get the custom field options.
Returns
  • array The field option objects.
Since
  • 1.7.0
Show source code of this method: getOptions Source Code

Properties Summary

public string
$type
The form field type.
Since
  • 1.7.0
protected string
$keyField
The keyField.
Since
  • 3.2
protected string
$valueField
The valueField.
Since
  • 3.2
protected bool
$translate
The translate.
Since
  • 3.2
protected string
$query
The query.
Since
  • 3.2

Tags Summary

Since
1.7.0