Référence de la classe FieldsPlugin

Graphe d'héritage de FieldsPlugin:

Fonctions membres publiques
	onCustomFieldsGetTypes ()
	onCustomFieldsPrepareField ($context, $item, $field)
	onCustomFieldsPrepareDom ($field, \DOMElement $parent, Form $form)
	onContentPrepareForm (Form $form, $data)
Fonctions membres publiques hérités de CMSPlugin
	__construct (&$subject, $config=array())
	loadLanguage ($extension='', $basePath=JPATH_ADMINISTRATOR)
	setApplication (CMSApplicationInterface $application)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de PluginInterface
	registerListeners ()

Fonctions membres protégées
	getFormPath (Form $form, $data)
	isTypeSupported ($type)
Fonctions membres protégées hérités de CMSPlugin
	registerLegacyListener (string $methodName)
	registerListener (string $methodName)
	getApplication ()

Attributs protégés
	$autoloadLanguage = true
	$app
Attributs protégés hérités de CMSPlugin
	$_name = null
	$_type = null
	$autoloadLanguage = false
	$allowLegacyListeners = true

Membres hérités additionnels
Champs de données hérités de CMSPlugin
	$params = null

Description détaillée

Abstract Fields Plugin

Depuis

3.7.0

Documentation des fonctions membres

getFormPath()

getFormPath ( Form  $form,   $data  )

protected

Returns the path of the XML definition file for the field parameters

Paramètres

Form	$form	The form
\stdClass	$data	The data

Renvoie

string

Depuis

4.0.0

Références $data, $form, $path, $type, JPATH_PLUGINS, et null.

isTypeSupported()

isTypeSupported (   $type )

protected

Returns true if the given type is supported by the plugin.

Paramètres

string

$type

The type

Renvoie

boolean

Depuis

3.7.0

Références $type.

onContentPrepareForm()

onContentPrepareForm	(	Form	$form,
			$data
	)

The form event. Load additional parameters when available into the field form. Only when the type of the form is of interest.

Paramètres

Form	$form	The form
\stdClass	$data	The data

Renvoie

void

Depuis

3.7.0

Références $data, $form, $path, et null.

onCustomFieldsGetTypes()

onCustomFieldsGetTypes

(

)

Returns the custom fields types.

Renvoie

string[][]

Depuis

3.7.0

Références $data, $key, $layout, $path, $root, Folder\files(), JPATH_PLUGINS, et Text\sprintf().

onCustomFieldsPrepareDom()

onCustomFieldsPrepareDom	(		$field,
		\DOMElement	$parent,
		Form	$form
	)

Transforms the field into a DOM XML element and appends it as a child on the given parent.

Paramètres

\stdClass	$field	The field.
\DOMElement	$parent	The field node parent.
Form	$form	The form.

Renvoie

Depuis

3.7.0

Références $field, $key, $layout, $params, FieldsHelper\canEditFieldValue(), FieldsHelper\displayFieldOnForm(), et null.

onCustomFieldsPrepareField()

onCustomFieldsPrepareField	(		$context,
			$item,
			$field
	)

Prepares the field value.

Paramètres

string	$context	The context.
\stdclass	$item	The item.
\stdclass	$field	The field.

Renvoie

string

Depuis

3.7.0

Références $field, $output, $params, $path, et PluginHelper\getLayoutPath().

Documentation des champs

$app

$app

protected

$autoloadLanguage

$autoloadLanguage = true

protected

---

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

• FieldsPlugin.php