Back to Joomla project (class list)

Class ListField - list of methods

Form Field class for the Joomla Platform.
Supports a generic list of options.

Extends

Direct known subclasses

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

Method Summary

protected string
()

Method to get the field input markup for a generic list.
Returns
  • string The field input markup.
Since
  • 3.7.0
Show source code of this method: getInput Source Code

protected array
()

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

public \Joomla\CMS\Form\Field\ListField
(mixed $text, mixed $attributes = array())

Method to add an option to the list field.
Parameters
  • string $text Text/Language variable of the option.
  • array $attributes Array of attributes ('name' => 'value' format)
Returns
  • \Joomla\CMS\Form\Field\ListField For chaining.
Since
  • 3.7.0
Show source code of this method: addOption Source Code

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.7.0
Show source code of this method: __get Source Code

Properties Summary

protected string
$type
The form field type.
Since
  • 1.7.0
protected string
$layout
Name of the layout being used to render the field
Since
  • 4.0.0

Tags Summary

Since
1.7.0