Graphe d'héritage de FieldsHelper:

Fonctions membres publiques statiques
static	extract ($contextString, $item=null)

static	getFields ( $context, $item=null, $prepareValue=false, array $valuesToOverride=null, bool $includeSubformFields=false)

static	render ($context, $layoutFile, $displayData)

static	canEditFieldValue ($field)

static	displayFieldOnForm ($field)

static	getAssignedCategoriesIds ($fieldId)

static	getAssignedCategoriesTitles ($fieldId)

static	getFieldsPluginId ()

static	getFieldTypes ()

static	clearFieldsCache ()

Attributs privés statiques
static	$fieldsCache = null

static	$fieldCache = null

Description détaillée

FieldsHelper

Depuis: 3.7.0

Documentation des fonctions membres

◆ canEditFieldValue()

static canEditFieldValue ( $field )

static

Return a boolean if the actual logged in user can edit the given field value.

Paramètres

\stdClass $field The field

Renvoie: boolean

Depuis: 3.7.0

Références $field, $parts, et Factory\getUser().

Référencé par FieldsPlugin\onCustomFieldsPrepareDom(), et FieldModel\setFieldValue().

◆ clearFieldsCache()

static clearFieldsCache ( )

static

Clears the internal cache for the custom fields.

Renvoie: void

Depuis: 3.8.0

Références null.

Référencé par FieldModel\save(), et FieldModel\setFieldValue().

◆ displayFieldOnForm()

static displayFieldOnForm ( $field )

static

Return a boolean based on field (and field group) display / show_on settings

Paramètres

\stdClass $field The field

Renvoie: boolean

Depuis: 3.8.7

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

Référencé par FieldsPlugin\onCustomFieldsPrepareDom().

◆ extract()

static extract	(	$contextString,
		$item = `null`
	)

static

Extracts the component and section from the context string which has to be in the format component.context.

Paramètres

string	$contextString	contextString
object	$item	optional item object

Renvoie: array|null

Depuis: 3.7.0

Références $component, $item, $parts, Factory\getApplication(), et null.

Référencé par GroupController\__construct(), FieldController\__construct(), HtmlView\addToolbar(), FieldModel\canDelete(), FieldModel\canEditState(), Dispatcher\checkAccess(), PrivacyPlugin\createCustomFieldsDomain(), HtmlView\display(), PlgSystemFields\display(), FieldModel\getForm(), FieldsModel\getListQuery(), PlgSystemFields\onContentNormaliseRequestData(), PlgSystemFields\onContentPrepare(), PlgSystemFields\onContentPrepareForm(), FieldsModel\populateState(), FieldModel\populateState(), PlgContentFields\prepare(), et GroupModel\preprocessForm().

◆ getAssignedCategoriesIds()

static getAssignedCategoriesIds ( $fieldId )

static

Gets assigned categories ids for a field

Paramètres

Références $db, $query, et Factory\getDbo().

◆ getAssignedCategoriesTitles()

static getAssignedCategoriesTitles ( $fieldId )

static

Gets assigned categories titles for a field

Paramètres

Références $db, $query, Factory\getDbo(), et ParameterType\INTEGER.

◆ getFields()

static getFields	(		$context,
			$item = `null`,
			$prepareValue = `false`,
		array	$valuesToOverride = `null`,
		bool	$includeSubformFields = `false`
	)

static

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ètres

string	$context	The context of the content passed to the helper
null	$item	The item being edited in the form
int \| bool	$prepareValue	(if int is display event): 1 - AfterTitle, 2 - BeforeDisplay, 3 - AfterDisplay, 0 - OFF
array \| null	$valuesToOverride	The values to override
bool	$includeSubformFields	Should I include fields marked as Only Use In Subform?