[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_fields/src/Plugin/ -> FieldsPlugin.php (summary)

(no description)

Copyright: (C) 2017 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 309 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 6 functions

  onCustomFieldsGetTypes()
  onCustomFieldsPrepareField()
  onCustomFieldsPrepareDom()
  onContentPrepareForm()
  getFormPath()
  isTypeSupported()

Functions
Functions that are not part of a class:

onCustomFieldsGetTypes()   X-Ref
Returns the custom fields types.

return: string[][]

onCustomFieldsPrepareField($context, $item, $field)   X-Ref
Prepares the field value.

param: string     $context  The context.
param: \stdclass  $item     The item.
param: \stdclass  $field    The field.
return: string

onCustomFieldsPrepareDom($field, \DOMElement $parent, Form $form)   X-Ref
Transforms the field into a DOM XML element and appends it as a child on the given parent.

param: \stdClass    $field   The field.
param: \DOMElement  $parent  The field node parent.
param: Form         $form    The form.
return: \DOMElement

onContentPrepareForm(Form $form, $data)   X-Ref
The form event. Load additional parameters when available into the field form.
Only when the type of the form is of interest.

param: Form       $form  The form
param: \stdClass  $data  The data
return: void

getFormPath(Form $form, $data)   X-Ref
Returns the path of the XML definition file for the field parameters

param: Form       $form  The form
param: \stdClass  $data  The data
return: string

isTypeSupported($type)   X-Ref
Returns true if the given type is supported by the plugin.

param: string  $type  The type
return: boolean



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer