Class JFormFieldFolderList

Description

Supports an HTML select list of folder

  • since: 11.1

Located in /libraries/joomla/form/fields/folderlist.php (line 22)

JFormField
   |
   --JFormFieldList
      |
      --JFormFieldFolderList
Variable Summary
 string $directory
 string $exclude
 string $filter
 boolean $hideDefault
 boolean $hideNone
 string $type
Method Summary
 array getOptions ()
 boolean setup (SimpleXMLElement $element, mixed $value, [string $group = null])
 mixed __get (string $name)
 void __set (string $name, mixed $value)
Variables
string $directory (line 70)

The directory.

  • since: 3.2
  • access: protected
string $exclude (line 46)

The exclude.

  • since: 3.2
  • access: protected
string $filter (line 38)

The filter.

  • since: 3.2
  • access: protected
boolean $hideDefault = false (line 62)

The hideDefault.

  • since: 3.2
  • access: protected
boolean $hideNone = false (line 54)

The hideNone.

  • since: 3.2
  • access: protected
string $type = 'FolderList' (line 30)

The form field type.

  • since: 11.1
  • access: protected

Redefinition of:
JFormFieldList::$type
The form field type.

Inherited Variables

Inherited from JFormField

JFormField::$autocomplete
JFormField::$autofocus
JFormField::$class
JFormField::$count
JFormField::$default
JFormField::$description
JFormField::$disabled
JFormField::$element
JFormField::$fieldname
JFormField::$form
JFormField::$formControl
JFormField::$generated_fieldname
JFormField::$group
JFormField::$hidden
JFormField::$hint
JFormField::$id
JFormField::$input
JFormField::$label
JFormField::$labelClass
JFormField::$multiple
JFormField::$name
JFormField::$onchange
JFormField::$onclick
JFormField::$pattern
JFormField::$readonly
JFormField::$repeat
JFormField::$required
JFormField::$size
JFormField::$spellcheck
JFormField::$translateDescription
JFormField::$translateHint
JFormField::$translateLabel
JFormField::$validate
JFormField::$value
Methods
getOptions (line 170)

Method to get the field options.

  • return: The field option objects.
  • since: 11.1
  • access: protected
array getOptions ()

Redefinition of:
JFormFieldList::getOptions()
Method to get the field options.
setup (line 141)

Method to attach a JForm object to the field.

boolean setup (SimpleXMLElement $element, mixed $value, [string $group = null])
  • 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 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]".

Redefinition of:
JFormField::setup()
Method to attach a JForm object to the field.
__get (line 81)

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

  • return: The property value or null.
  • since: 3.2
  • access: public
mixed __get (string $name)
  • string $name: The property name for which to the the value.

Redefinition of:
JFormField::__get()
Method to get certain otherwise inaccessible properties from the form field object.
__set (line 106)

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

  • since: 3.2
  • access: public
void __set (string $name, mixed $value)
  • string $name: The property name for which to the the value.
  • mixed $value: The value of the property.

Redefinition of:
JFormField::__set()
Method to set certain otherwise inaccessible properties of the form field object.

Inherited Methods

Inherited From JFormFieldList

 JFormFieldList::getInput()
 JFormFieldList::getOptions()

Inherited From JFormField

 JFormField::__construct()
 JFormField::getAttribute()
 JFormField::getControlGroup()
 JFormField::getFieldName()
 JFormField::getId()
 JFormField::getInput()
 JFormField::getLabel()
 JFormField::getName()
 JFormField::getTitle()
 JFormField::setForm()
 JFormField::setup()
 JFormField::setValue()
 JFormField::__get()
 JFormField::__set()

Documentation generated on Tue, 19 Nov 2013 15:03:28 +0100 by phpDocumentor 1.4.3