1. class
  2. Joomla
  3. CMS
  4. Form
  5. Field
  6. OrderingField

OrderingField

class OrderingField extends FormField

Ordering field.

Properties

mixed $repeat Allows extensions to create repeat elements from FormField

Methods

__construct( Form $form = null)

Method to instantiate the form field object.

from FormField
mixed
__get( string $name)

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

void
__set( string $name, mixed $value)

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

FormField
setForm( Form $form)

Method to attach a JForm object to the field.

from FormField
boolean
setup( SimpleXMLElement $element, mixed $value, string $group = null)

Method to attach a JForm object to the field.

void
setValue( mixed $value)

Simple method to set the value

from FormField
mixed
getAttribute( string $name, mixed $default = null)

Method to get an attribute of the field

from FormField
string
getControlGroup()

Method to get a control group with label and input.

from FormField
string
render( string $layoutId, array $data = array())

Render a layout of this field

from FormField
string
renderField( array $options = array())

Method to get a control group with label and input.

from FormField

Details

__construct( Form $form = null)

Method to instantiate the form field object.

Parameters

Form $form The form to attach to the form field object.

mixed __get( string $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.

Return Value

mixed The property value or null.

void __set( string $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.

Return Value

void

FormField setForm( Form $form)

Method to attach a JForm object to the field.

Parameters

Form $form The JForm object to attach to the form field.

Return Value

FormField The form field object so that the method can be used in a chain.

boolean setup( SimpleXMLElement $element, mixed $value, string $group = null)

Method to attach a JForm 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 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 Value

boolean True on success.

See also

FormField::setup()

void setValue( mixed $value)

Simple method to set the value

Parameters

mixed $value Value to set

Return Value

void

mixed getAttribute( string $name, mixed $default = null)

Method to get an attribute of the field

Parameters

string $name Name of the attribute to get
mixed $default Optional value to return if attribute not found

Return Value

mixed Value of the attribute / default

string getControlGroup()

Method to get a control group with label and input.

Return Value

string A string containing the html for the control group

string render( string $layoutId, array $data = array())

Render a layout of this field

Parameters

string $layoutId Layout identifier
array $data Optional data for the layout

Return Value

string

string renderField( array $options = array())

Method to get a control group with label and input.

Parameters

array $options Options to be passed into the rendering of the field

Return Value

string A string containing the html for the control group