PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of SqlField.php

Joomla! Content Management System

Copyright:	(C) 2010 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	301 lines (9 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

SqlField:: (5 methods):
  __get()
  __set()
  setup()
  processQuery()
  getOptions()

Class: SqlField - X-Ref

Supports a custom SQL select list

__get($name) X-Ref

Method to get certain otherwise inaccessible properties from the form field object.

param: string $name The property name for which to get the value.
return: mixed The property value or null.

__set($name, $value) X-Ref

Method to set certain otherwise inaccessible properties of the form field object.

param: string $name The property name for which to set the value.
param: mixed $value The value of the property.
return: void

setup(\SimpleXMLElement $element, $value, $group = null) X-Ref

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.
return: boolean  True on success.

processQuery($conditions, $filters, $defaults) X-Ref

Method to process the query from form.

param: array   $conditions  The conditions from the form.
param: string  $filters     The columns to filter.
param: array   $defaults    The defaults value to set if condition is empty.
return: DatabaseQuery  The query object.

getOptions() X-Ref

Method to get the custom field options.
Use the query attribute to supply a query to generate the list.

return: array The field option objects.

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Form/Field/ -> SqlField.php (summary)

Defines 1 class