Référence de la classe ConsentBoxField

Graphe d'héritage de ConsentBoxField:

Fonctions membres publiques
	__set ($name, $value)
	__get ($name)
	setup (\SimpleXMLElement $element, $value, $group=null)
Fonctions membres publiques hérités de CheckboxesField
	__get ($name)
	__set ($name, $value)
	setup (\SimpleXMLElement $element, $value, $group=null)
Fonctions membres publiques hérités de ListField
	addOption ($text, $attributes=array())
	__get ($name)
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)

Fonctions membres protégées
	getLabel ()
	getInput ()
	getLayoutData ()
Fonctions membres protégées hérités de CheckboxesField
	getInput ()
	getLayoutData ()
Fonctions membres protégées hérités de ListField
	getInput ()
	getOptions ()
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
	$type = 'ConsentBox'
	$forceMultiple = false
	$articleid
	$menuItemId
	$privacyType
Attributs protégés hérités de CheckboxesField
	$type = 'Checkboxes'
	$layout = 'joomla.form.field.checkboxes'
	$forceMultiple = true
Attributs protégés hérités de ListField
	$type = 'List'
	$layout = 'joomla.form.field.list'
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()

Fonctions membres privées
	getAssignedArticleUrl ()
	getAssignedMenuItemUrl ()

Membres hérités additionnels
Champs de données hérités de CheckboxesField
	$checkedOptions
Champs de données hérités de FormField
	$repeat = false
Attributs protégés statiques hérités de FormField
static	$count = 0
static	$generated_fieldname = '__field'

Description détaillée

Consentbox Field class for the Confirm Consent Plugin.

Depuis

3.9.1

Documentation des fonctions membres

__get()

__get

(

$name

)

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

Paramètres

string

$name

The property name for which to get the value.

Renvoie

mixed The property value or null.

Depuis

3.9.1

Références $name.

__set()

__set	(		$name,
			$value
	)

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

Paramètres

string	$name	The property name for which to set the value.
mixed	$value	The value of the property.

Renvoie

void

Depuis

3.9.1

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

getAssignedArticleUrl()

getAssignedArticleUrl ( )

private

Return the url of the assigned article based on the current user language

Renvoie

string Returns the link to the article

Depuis

3.9.1

Références $article, $db, $query, Route\_(), RouteHelper\getArticleRoute(), Associations\getAssociations(), Joomla\Database\getDatabase(), Factory\getLanguage(), Associations\isEnabled(), et language.

getAssignedMenuItemUrl()

getAssignedMenuItemUrl ( )

private

Get privacy menu item URL. If the site is a multilingual website and there is associated menu item for the current language, the URL of the associated menu item will be returned.

Renvoie

string

Depuis

4.0.0

Références $db, $itemId, $query, Route\_(), Associations\getAssociations(), Joomla\Database\getDatabase(), Factory\getLanguage(), ParameterType\INTEGER, Multilanguage\isEnabled(), et Associations\isEnabled().

getInput()

getInput ( )

protected

Method to get the field input markup.

Renvoie

string The field input markup.

Depuis

4.0.0

Références HTMLHelper\_(), et Joomla\Application\getInput().

getLabel()

getLabel ( )

protected

Method to get the field label markup.

Renvoie

string The field label markup.

Depuis

3.9.1

Références $attribs, $data, $position, et HTMLHelper\_().

getLayoutData()

getLayoutData ( )

protected

Method to get the data to be passed to the layout for rendering.

Renvoie

array

Depuis

3.9.1

Références $data.

setup()

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

Method to attach a JForm object to the field.

Paramètres

\SimpleXMLElement	$element	The SimpleXMLElement object representing the <field> tag for the form field object.
mixed	$value	The form field value to validate.
string	$group	The field name group control value. This acts as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".

Renvoie

boolean True on success.

Voir également

::setup()

Depuis

3.9.1

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

Documentation des champs

$articleid

$articleid

protected

$forceMultiple

$forceMultiple = false

protected

$menuItemId

$menuItemId

protected

$privacyType

$privacyType

protected

$type

$type = 'ConsentBox'

protected

---

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

• ConsentBoxField.php