Class JFormFieldMedia

Provides a modal media selector including upload mechanism

JFormField

JFormFieldMedia

Direct known subclasses

FOFFormFieldMedia

Indirect known subclasses

FOFFormFieldImage

Package: Joomla\Libraries\Form
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.6
Located at cms/form/field/media.php

Methods summary

`public mixed`	# `__get( string $name )` Method to get certain otherwise inaccessible properties from the form field object. Method to get certain otherwise inaccessible properties from the form field object. Parameters `$name` `string` - $name The property name for which to the the value. Returns `mixed` - The property value or null. Since 3.2 Overrides `JFormField::__get`
`public`	# `__set( string $name, mixed $value )` Method to set certain otherwise inaccessible properties of the form field object. Method to set certain otherwise inaccessible properties of the form field object. Parameters `$name` `string` - $name The property name for which to the the value. `$value` `mixed` - $value The value of the property. Since 3.2 Overrides `JFormField::__set`
`public boolean`	# `setup( SimpleXMLElement $element, mixed $value, string $group = null )` Method to attach a JForm object to the field. Method to attach a JForm object to the field. Parameters `$element` `SimpleXMLElement` - $element The SimpleXMLElement object representing the `<field>` tag for the form field object. `$value` `mixed` - $value The form field value to validate. `$group` `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 `boolean` - True on success. Since 3.2 See `JFormField::setup()` Overrides `JFormField::setup`
`protected string`	# `getInput( )` Method to get the field input markup for a media selector. Use attributes to identify specific created_by and asset_id fields Method to get the field input markup for a media selector. Use attributes to identify specific created_by and asset_id fields Returns `string` - The field input markup. Since 1.6 Overrides `JFormField::getInput`
`public array`	# `getLayoutData( )` Get the data that is going to be passed to the layout Get the data that is going to be passed to the layout Returns `array` Overrides `JFormField::getLayoutData`

Methods inherited from JFormField

__construct(), getAttribute(), getControlGroup(), getFieldName(), getId(), getLabel(), getLayoutPaths(), getName(), getRenderer(), getTitle(), isDebugEnabled(), render(), renderField(), setForm(), setValue()

Magic methods summary

Properties summary

`protected string`	`$type`	# The form field type. The form field type. Since 1.6
`protected string`	`$authorField`	# The authorField. The authorField. Since 3.2
`protected string`	`$asset`	# The asset. The asset. Since 3.2
`protected string`	`$link`	# The link. The link. Since 3.2
`protected integer`	`$width`	# Modal width. Modal width. Since 3.4.5
`protected integer`	`$height`	# Modal height. Modal height. Since 3.4.5
`protected string`	`$preview`	# The authorField. The authorField. Since 3.2
`protected string`	`$directory`	# The preview. The preview. Since 3.2
`protected integer`	`$previewWidth`	# The previewWidth. The previewWidth. Since 3.2
`protected integer`	`$previewHeight`	# The previewHeight. The previewHeight. Since 3.2
`protected string`	`$layout`	# Layout to render Layout to render Since 3.5

Properties inherited from JFormField

$autocomplete, $autofocus, $class, $count, $default, $description, $disabled, $element, $fieldname, $form, $formControl, $generated_fieldname, $group, $hidden, $hint, $id, $input, $label, $labelclass, $multiple, $name, $onchange, $onclick, $pattern, $readonly, $renderLabelLayout, $renderLayout, $repeat, $required, $showon, $size, $spellcheck, $translateDescription, $translateHint, $translateLabel, $validate, $value

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFormFieldMedia

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Returns

Since

Overrides

Parameters

Since

Overrides

Parameters

Returns

Since

See

Overrides

Returns

Since

Overrides

Returns

Overrides

Methods inherited from JFormField

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Properties inherited from JFormField