Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe PlgFieldsSubform
+ Graphe d'héritage de PlgFieldsSubform:

Fonctions membres publiques

 onCustomFieldsBeforePrepareField ($context, $item, $field)
 
 onCustomFieldsPrepareField ($context, $item, $field)
 
 onCustomFieldsPrepareDom ($field, DOMElement $parent, Form $form)
 
- Fonctions membres publiques hérités de FieldsPlugin
 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

 getOptionsFromField (\stdClass $field)
 
 getParamsFromField (\stdClass $field)
 
 getSubfieldsFromField (\stdClass $field)
 
- Fonctions membres protégées hérités de FieldsPlugin
 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

 $renderCache = array()
 
- Attributs protégés hérités de FieldsPlugin
 $autoloadLanguage = true
 
 $app
 
- Attributs protégés hérités de CMSPlugin
 $_name = null
 
 $_type = null
 
 $autoloadLanguage = false
 
 $allowLegacyListeners = true
 

Attributs protégés statiques

static $customFieldsCache = null
 

Membres hérités additionnels

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

Description détaillée

Fields subform Plugin

Depuis
4.0.0

Documentation des fonctions membres

◆ getOptionsFromField()

getOptionsFromField ( \stdClass  $field)
protected

Returns an array of all options configured for this field.

Paramètres
\stdClass$fieldThe field
Renvoie
[]
Depuis
4.0.0

Références $field, $option, $params, et $result.

◆ getParamsFromField()

getParamsFromField ( \stdClass  $field)
protected

Returns the configured params for a given field.

Paramètres
\stdClass$fieldThe field
Renvoie
Depuis
4.0.0

Références $field, et $params.

◆ getSubfieldsFromField()

getSubfieldsFromField ( \stdClass  $field)
protected

Returns an array of all subfields for a given field. This will always return a bare clone of a sub field, so manipulating it is safe.

Paramètres
\stdClass$fieldThe field
Renvoie
[]
Depuis
4.0.0

Set the name of the sub field to its id so that the values in the database are being saved based on the id of the sub fields, not on their name. Actually we do not need the name of the sub fields to render them, but just to make sure we have the name when we need it, we store it as fieldname.

Références $customFields, $field, $option, $result, FieldsHelper\getFields(), et null.

◆ onCustomFieldsBeforePrepareField()

onCustomFieldsBeforePrepareField (   $context,
  $item,
  $field 
)

Manipulates the $field->value before the field is being passed to onCustomFieldsPrepareField.

Paramètres
string$contextThe context
object$itemThe item
\stdClass$fieldThe field
Renvoie
void
Depuis
4.0.0

Références $field.

◆ onCustomFieldsPrepareDom()

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

Returns a DOMElement which is the child of $parent and represents the form XML definition for this field.

Paramètres
\stdClass$fieldThe field
DOMElement$parentThe original parent element
Form$formThe form
Renvoie
Depuis
4.0.0

Références $field, $form, et Factory\getApplication().

◆ onCustomFieldsPrepareField()

onCustomFieldsPrepareField (   $context,
  $item,
  $field 
)

Renders this fields value by rendering all sub fields and joining all those rendered sub fields together.

Paramètres
string$contextThe context
object$itemThe item
\stdClass$fieldThe field
Renvoie
string
Depuis
4.0.0

Placeholder to hold all rows (if this field is repeatable). Each array entry is another array representing a row, containing all of the sub fields that are valid for this row and their raw and rendered values.

Construct the cache-key for our renderCache. It is important that the cache key is as unique as possible to avoid false duplicates (e.g. type and rawvalue is not enough for the cache key, because type 'list' and value '1' can have different rendered values, depending on the list items), but it also must be as general as possible to not cause too many unneeded rendering processes (e.g. the type 'text' will always be rendered the same when it has the same rawvalue).

Références $context, $field, $item, $rows, et Factory\getApplication().

Documentation des champs

◆ $customFieldsCache

$customFieldsCache = null
staticprotected

◆ $renderCache

$renderCache = array()
protected

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