[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/plugins/content/confirmconsent/src/Field/ -> ConsentBoxField.php (summary)

(no description)

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

Defines 1 class

ConsentBoxField:: (8 methods):
  __set()
  __get()
  setup()
  getLabel()
  getInput()
  getLayoutData()
  getAssignedArticleUrl()
  getAssignedMenuItemUrl()


Class: ConsentBoxField  - X-Ref

Consentbox Field class for the Confirm Consent Plugin.

__set($name, $value)   X-Ref
Method to set certain otherwise inaccessible properties of the form field object.

param: string  $name   The property name for which to set the value.
param: mixed   $value  The value of the property.
return: void

__get($name)   X-Ref
Method to get certain otherwise inaccessible properties from the form field object.

param: string  $name  The property name for which to get the value.
return: mixed  The property value or null.

setup(\SimpleXMLElement $element, $value, $group = null)   X-Ref
Method to attach a JForm object to the field.

param: \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
param: mixed              $value    The form field value to validate.
param: string             $group    The field name group control value. This acts as an array container for the field.
return: boolean  True on success.

getLabel()   X-Ref
Method to get the field label markup.

return: string  The field label markup.

getInput()   X-Ref
Method to get the field input markup.

return: string  The field input markup.

getLayoutData()   X-Ref
Method to get the data to be passed to the layout for rendering.

return: array

getAssignedArticleUrl()   X-Ref
Return the url of the assigned article based on the current user language

return: string  Returns the link to the article

getAssignedMenuItemUrl()   X-Ref
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.

return: string



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