Référence de la classe MediaField

Graphe d'héritage de MediaField:

Fonctions membres publiques
	__get ($name)
	__set ($name, $value)
	setup (\SimpleXMLElement $element, $value, $group=null)
	getLayoutData ()
Fonctions membres publiques hérités de FormField
	__construct ($form=null)
	__get ($name)
	__set ($name, $value)
	setForm (Form $form)
	setup (\SimpleXMLElement $element, $value, $group=null)
	setValue ($value)
	getAttribute ($name, $default=null)
	getDataAttributes ()
	renderDataAttributes ()
	render ($layoutId, $data=array())
	renderField ($options=array())
	filter ($value, $group=null, Registry $input=null)
	validate ($value, $group=null, Registry $input=null)
	postProcess ($value, $group=null, Registry $input=null)
Fonctions membres publiques hérités de DatabaseAwareInterface
	setDatabase (DatabaseInterface $db)

Fonctions membres protégées
	getInput ()
Fonctions membres protégées hérités de FormField
	getId ($fieldId, $fieldName)
	getInput ()
	getTitle ()
	getLabel ()
	getName ($fieldName)
	getFieldName ($fieldName)
	getLayoutData ()
	getLayoutPaths ()
	getRenderer ($layoutId='default')
	isDebugEnabled ()

Attributs protégés
	$type = 'Media'
	$authorField
	$asset
	$link
	$width
	$height
	$preview
	$directory
	$previewWidth
	$previewHeight
	$types
	$layout = 'joomla.form.field.media'
	$parentclass
Attributs protégés hérités de FormField
	$description
	$hint
	$autocomplete = 'on'
	$spellcheck = true
	$autofocus = false
	$element
	$form
	$formControl
	$hidden = false
	$hiddenLabel = false
	$hiddenDescription = false
	$translateLabel = true
	$translateDescription = true
	$translateHint = true
	$id
	$input
	$label
	$multiple = false
	$pattern
	$validationtext
	$name
	$fieldname
	$group
	$required = false
	$disabled = false
	$readonly = false
	$type
	$validate
	$value
	$default
	$size
	$class
	$labelclass
	$onchange
	$onclick
	$showon
	$parentclass
	$layout
	$renderLayout = 'joomla.form.renderfield'
	$renderLabelLayout = 'joomla.form.renderlabel'
	$dataAttributes = array()

Membres hérités additionnels
Champs de données hérités de FormField
	$repeat = false
Attributs protégés statiques hérités de FormField
static	$count = 0
static	$generated_fieldname = '__field'

Description détaillée

Provides a modal media selector including upload mechanism

Depuis

1.6

Documentation des fonctions membres

__get()

__get

(

$name

)

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

Paramètres

string

$name

The property name for which to get the value.

Renvoie

mixed The property value or null.

Depuis

3.2

Références $name.

__set()

__set	(		$name,
			$value
	)

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

Paramètres

string	$name	The property name for which to set the value.
mixed	$value	The value of the property.

Renvoie

void

Depuis

3.2

Références $name, et $value.

getInput()

getInput ( )

protected

Method to get the field input markup for a media selector. Use attributes to identify specific created_by and asset_id fields

Renvoie

string The field input markup.

Depuis

1.6

Références name.

getLayoutData()

getLayoutData

(

)

Get the data that is going to be passed to the layout

Renvoie

array

Local image, for example images/sampledata/cassiopeia/nasa2-640.jpg . We need to validate and make sure the top level folder is one of the directory configured in filesystem local plugin to avoid error message displayed in manage when users click on Select button to select a new image

This is the case where a folder is configured in directory attribute of the form field. The directory needs to be a relative folder of the folder configured in Path to Images Folder config option of Media component. Same with a already stored local image above, we need to validate and make sure top level folder is one of the directory configured in filesystem local plugin

Directory contains adapter information and path, for example via programming or directly defined in xml via directory attribute

Références $data, $folder, $link, $mediaTypes, $path, $preview, $this, $uri, elseif, Factory\getApplication(), ComponentHelper\getParams(), MediaHelper\isValidLocalDirectory(), JPATH_ROOT, et value.

setup()

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

Method to attach a Form object to the field.

Paramètres

\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 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]".

Renvoie

boolean True on success.

Voir également

FormField::setup()

Depuis

3.2

Références $result, $value, et width.

Documentation des champs

$asset

$asset

protected

$authorField

$authorField

protected

$directory

$directory

protected

$height

$height

protected

$layout

$layout = 'joomla.form.field.media'

protected

$link

$link

protected

$parentclass

$parentclass

protected

$preview

$preview

protected

$previewHeight

$previewHeight

protected

$previewWidth

$previewWidth

protected

$type

$type = 'Media'

protected

$types

$types

protected

$width

$width

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• MediaField.php