| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | (C) 2018 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 683 lines (23 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
FieldsHelper:: (11 methods):
extract()
getFields()
render()
prepareForm()
canEditFieldValue()
displayFieldOnForm()
getAssignedCategoriesIds()
getAssignedCategoriesTitles()
getFieldsPluginId()
getFieldTypes()
clearFieldsCache()
Class: FieldsHelper - X-Ref
FieldsHelper| extract($contextString, $item = null) X-Ref |
| Extracts the component and section from the context string which has to be in the format component.context. param: string $contextString contextString param: object $item optional item object return: array|null |
| getFields($context,$item = null,$prepareValue = false,array $valuesToOverride = null,bool $includeSubformFields = false) X-Ref |
| Returns the fields for the given context. If the item is an object the returned fields do have an additional field "value" which represents the value for the given item. If the item has an assigned_cat_ids field, then additionally fields which belong to that category will be returned. Should the value being prepared to be shown in an HTML context then prepareValue must be set to true. No further escaping needs to be done. The values of the fields can be overridden by an associative array where the keys have to be a name and its corresponding value. param: string $context The context of the content passed to the helper param: null $item The item being edited in the form param: int|bool $prepareValue (if int is display event): 1 - AfterTitle, 2 - BeforeDisplay, 3 - AfterDisplay, 0 - OFF param: array|null $valuesToOverride The values to override param: bool $includeSubformFields Should I include fields marked as Only Use In Subform? return: array |
| render($context, $layoutFile, $displayData) X-Ref |
| No description |
| prepareForm($context, Form $form, $data) X-Ref |
| PrepareForm param: string $context The context of the content passed to the helper param: Form $form form param: object $data data. return: boolean |
| canEditFieldValue($field) X-Ref |
| Return a boolean if the actual logged in user can edit the given field value. param: \stdClass $field The field return: boolean |
| displayFieldOnForm($field) X-Ref |
| Return a boolean based on field (and field group) display / show_on settings param: \stdClass $field The field return: boolean |
| getAssignedCategoriesIds($fieldId) X-Ref |
| Gets assigned categories ids for a field param: \stdClass[] $fieldId The field ID return: array Array with the assigned category ids |
| getAssignedCategoriesTitles($fieldId) X-Ref |
| Gets assigned categories titles for a field param: \stdClass[] $fieldId The field ID return: array Array with the assigned categories |
| getFieldsPluginId() X-Ref |
| Gets the fields system plugin extension id. return: integer The fields system plugin extension id. |
| getFieldTypes() X-Ref |
| Loads the fields plugins and returns an array of field types from the plugins. The returned array contains arrays with the following keys: - label: The label of the field - type: The type of the field - path: The path of the folder where the field can be found return: array |
| clearFieldsCache() X-Ref |
| Clears the internal cache for the custom fields. return: void |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |