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

Fonctions membres publiques

 __get ($name)
 
 __set ($name, $value)
 
 setup (\SimpleXMLElement $element, $value, $group=null)
 
- Fonctions membres publiques hérités de SubformField
 __get ($name)
 
 __set ($name, $value)
 
 setup (\SimpleXMLElement $element, $value, $group=null)
 
 loadSubForm ()
 
 filter ($value, $group=null, Registry $input=null)
 
- 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)
 

Attributs protégés

 $type = 'Accessiblemedia'
 
 $preview
 
 $directory
 
 $previewWidth
 
 $previewHeight
 
 $layout
 
- Attributs protégés hérités de SubformField
 $type = 'Subform'
 
 $formsource
 
 $min = 0
 
 $max = 1000
 
 $layout = 'joomla.form.field.subform.default'
 
 $groupByFieldset = false
 
 $buttons = array('add' => true, 'remove' => true, 'move' => true)
 
- 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
 
- Fonctions membres protégées hérités de SubformField
 getInput ()
 
 getName ($fieldName)
 
 loadSubFormData (Form $subForm)
 
- 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 statiques hérités de FormField
static $count = 0
 
static $generated_fieldname = '__field'
 

Description détaillée

The Field to load the form inside current form

Depuis
4.0.0

Documentation des fonctions membres

◆ __get()

__get (   $name)

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

Paramètres
string$nameThe property name for which to get the value.
Renvoie
mixed The property value or null.
Depuis
4.0.0

Références $name.

◆ __set()

__set (   $name,
  $value 
)

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

Paramètres
string$nameThe property name for which to set the value.
mixed$valueThe value of the property.
Renvoie
void
Depuis
4.0.0

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

◆ setup()

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

Method to attach a Form object to the field.

Paramètres
\SimpleXMLElement$elementThe SimpleXMLElement object representing the <field> tag for the form field object.
mixed$valueThe form field value to validate.
string$groupThe field name group control value.
Renvoie
boolean True on success.
Depuis
4.0.0

When you have subforms which are not repeatable (i.e. a subform custom field with the repeat attribute set to 0) you get an array here since the data comes from decoding the JSON into an associative array, including the media subfield's data.

However, this method expects an object or a string, not an array. Typecasting the array to an object solves the data format discrepancy.

If the value is not a string, it is most likely within a custom field of type subform and the value is a stdClass with properties imagefile and alt_text. So it is fine.

If the value is not empty and is not a valid JSON string, it is most likely a custom field created in Joomla 3 and the value is a string that contains the file name.

Références $value, $xml, description, elseif, fieldset, JPATH_ROOT, et name.

Documentation des champs

◆ $directory

$directory
protected

◆ $layout

$layout
protected

◆ $preview

$preview
protected

◆ $previewHeight

$previewHeight
protected

◆ $previewWidth

$previewWidth
protected

◆ $type

$type = 'Accessiblemedia'
protected

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