Skip to content

Commit

Permalink
Add layouts to plg_system_privacyconsent
Browse files Browse the repository at this point in the history
  • Loading branch information
Ruud68 committed Jan 24, 2019
1 parent f1c00cc commit 02ca132
Show file tree
Hide file tree
Showing 3 changed files with 189 additions and 65 deletions.
114 changes: 114 additions & 0 deletions layouts/plugins/system/privacyconsent/label.php
@@ -0,0 +1,114 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage System.privacyconsent
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

defined('JPATH_BASE') or die;

use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;

extract($displayData);

/**
* Layout variables
* -----------------
* @var string $autocomplete Autocomplete attribute for the field.
* @var boolean $autofocus Is autofocus enabled?
* @var string $class Classes for the input.
* @var string $description Description of the field.
* @var boolean $disabled Is this field disabled?
* @var string $group Group the field belongs to. <fields> section in form XML.
* @var boolean $hidden Is this field hidden in the form?
* @var string $hint Placeholder for the field.
* @var string $id DOM id of the field.
* @var string $label Label of the field.
* @var string $labelclass Classes to apply to the label.
* @var boolean $multiple Does this field support multiple values?
* @var string $name Name of the input field.
* @var string $onchange Onchange attribute for the field.
* @var string $onclick Onclick attribute for the field.
* @var string $pattern Pattern (Reg Ex) of value of the form field.
* @var boolean $readonly Is this field read only?
* @var boolean $repeat Allows extensions to duplicate elements.
* @var boolean $required Is this field required?
* @var integer $size Size attribute of the input.
* @var boolean $spellcheck Spellcheck state for the form field.
* @var string $validate Validation rules to apply.
* @var string $value Value attribute of the field.
* @var array $options Options available for this field.
* @var array $privacynote The privacy note that needs to be displayed
* @var array $translateLabel Should the label be translated?
* @var array $translateDescription Should the description be translated?
* @var array $translateHint Should the hint be translated?
* @var array $privacyArticle The Article ID holding the Privancy Article
*/

// Get the label text from the XML element, defaulting to the element name.
$text = $label ? (string) $label : (string) $name;
$text = $translateLabel ? Text::_($text) : $text;

// Set required to true as this field is not displayed at all if not required.
$required = true;

JHtml::_('behavior.modal');

// Build the class for the label.
$class = !empty($description) ? 'hasPopover' : '';
$class = $class . ' required';
$class = !empty($labelclass) ? $class . ' ' . $labelclass : $class;

// Add the opening label tag and main attributes.
$label = '<label id="' . $id . '-lbl" for="' . $id . '" class="' . $class . '"';

// If a description is specified, use it to build a tooltip.
if (!empty($description))
{
$label .= ' title="' . htmlspecialchars(trim($text, ':'), ENT_COMPAT, 'UTF-8') . '"';
$label .= ' data-content="' . htmlspecialchars(
$translateDescription ? Text::_($description) : $description,
ENT_COMPAT,
'UTF-8'
) . '"';
}

if (Factory::getLanguage()->isRtl())
{
$label .= ' data-placement="left"';
}

//~ $privacyArticle = $this->element['article'] > 0 ? (int) $this->element['article'] : 0;

if ($privacyArticle && Factory::getApplication()->isClient('site'))
{
JLoader::register('ContentHelperRoute', JPATH_BASE . '/components/com_content/helpers/route.php');

$attribs = array();
$attribs['class'] = 'modal';
$attribs['rel'] = '{handler: \'iframe\', size: {x:800, y:500}}';

$db = Factory::getDbo();
$query = $db->getQuery(true)
->select($db->quoteName(array('id', 'alias', 'catid', 'language')))
->from($db->quoteName('#__content'))
->where($db->quoteName('id') . ' = ' . (int) $privacyArticle);
$db->setQuery($query);
$article = $db->loadObject();

$slug = $article->alias ? ($article->id . ':' . $article->alias) : $article->id;
$url = ContentHelperRoute::getArticleRoute($slug, $article->catid, $article->language);
$link = JHtml::_('link', JRoute::_($url . '&tmpl=component'), $text, $attribs);
}
else
{
$link = $text;
}

// Add the label text and closing tag.
$label .= '>' . $link . '<span class="star">&#160;*</span></label>';

echo $label;
49 changes: 49 additions & 0 deletions layouts/plugins/system/privacyconsent/message.php
@@ -0,0 +1,49 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage System.privacyconsent
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

defined('JPATH_BASE') or die;

extract($displayData);

/**
* Layout variables
* -----------------
* @var string $autocomplete Autocomplete attribute for the field.
* @var boolean $autofocus Is autofocus enabled?
* @var string $class Classes for the input.
* @var string $description Description of the field.
* @var boolean $disabled Is this field disabled?
* @var string $group Group the field belongs to. <fields> section in form XML.
* @var boolean $hidden Is this field hidden in the form?
* @var string $hint Placeholder for the field.
* @var string $id DOM id of the field.
* @var string $label Label of the field.
* @var string $labelclass Classes to apply to the label.
* @var boolean $multiple Does this field support multiple values?
* @var string $name Name of the input field.
* @var string $onchange Onchange attribute for the field.
* @var string $onclick Onclick attribute for the field.
* @var string $pattern Pattern (Reg Ex) of value of the form field.
* @var boolean $readonly Is this field read only?
* @var boolean $repeat Allows extensions to duplicate elements.
* @var boolean $required Is this field required?
* @var integer $size Size attribute of the input.
* @var boolean $spellcheck Spellcheck state for the form field.
* @var string $validate Validation rules to apply.
* @var string $value Value attribute of the field.
* @var array $options Options available for this field.
* @var array $privacynote The privacy note that needs to be displayed
* @var array $translateLabel Should the label be translated?
* @var array $translateDescription Should the description be translated?
* @var array $translateHint Should the hint be translated?
* @var array $privacyArticle The Article ID holding the Privancy Article
*/

echo '<div class="alert alert-info">' . $privacynote . '</div>';

91 changes: 26 additions & 65 deletions plugins/system/privacyconsent/field/privacy.php 100644 → 100755
Expand Up @@ -38,9 +38,8 @@ class JFormFieldprivacy extends JFormFieldRadio
*/
protected function getInput()
{
$privacynote = !empty($this->element['note']) ? $this->element['note'] : Text::_('PLG_SYSTEM_PRIVACYCONSENT_NOTE_FIELD_DEFAULT');

echo '<div class="alert alert-info">' . $privacynote . '</div>';
// Display the message before the field
echo $this->getRenderer('plugins.system.privacyconsent.message')->render($this->getLayoutData());

return parent::getInput();
}
Expand All @@ -59,69 +58,31 @@ protected function getLabel()
return '';
}

// Get the label text from the XML element, defaulting to the element name.
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];
$text = $this->translateLabel ? Text::_($text) : $text;

// Set required to true as this field is not displayed at all if not required.
$this->required = true;

JHtml::_('behavior.modal');

// Build the class for the label.
$class = !empty($this->description) ? 'hasPopover' : '';
$class = $class . ' required';
$class = !empty($this->labelClass) ? $class . ' ' . $this->labelClass : $class;

// Add the opening label tag and main attributes.
$label = '<label id="' . $this->id . '-lbl" for="' . $this->id . '" class="' . $class . '"';

// If a description is specified, use it to build a tooltip.
if (!empty($this->description))
{
$label .= ' title="' . htmlspecialchars(trim($text, ':'), ENT_COMPAT, 'UTF-8') . '"';
$label .= ' data-content="' . htmlspecialchars(
$this->translateDescription ? Text::_($this->description) : $this->description,
ENT_COMPAT,
'UTF-8'
) . '"';
}

if (Factory::getLanguage()->isRtl())
{
$label .= ' data-placement="left"';
}

$privacyArticle = $this->element['article'] > 0 ? (int) $this->element['article'] : 0;

if ($privacyArticle && Factory::getApplication()->isClient('site'))
{
JLoader::register('ContentHelperRoute', JPATH_BASE . '/components/com_content/helpers/route.php');

$attribs = array();
$attribs['class'] = 'modal';
$attribs['rel'] = '{handler: \'iframe\', size: {x:800, y:500}}';

$db = Factory::getDbo();
$query = $db->getQuery(true)
->select($db->quoteName(array('id', 'alias', 'catid', 'language')))
->from($db->quoteName('#__content'))
->where($db->quoteName('id') . ' = ' . (int) $privacyArticle);
$db->setQuery($query);
$article = $db->loadObject();

$slug = $article->alias ? ($article->id . ':' . $article->alias) : $article->id;
$url = ContentHelperRoute::getArticleRoute($slug, $article->catid, $article->language);
$link = JHtml::_('link', JRoute::_($url . '&tmpl=component'), $text, $attribs);
}
else
{
$link = $text;
}
return $this->getRenderer('plugins.system.privacyconsent.label')->render($this->getLayoutData());

// Add the label text and closing tag.
$label .= '>' . $link . '<span class="star">&#160;*</span></label>';
}

return $label;
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since ___VERSION___
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();

$extraData = array(
'privacynote' => !empty($this->element['note']) ? $this->element['note'] : Text::_('PLG_SYSTEM_PRIVACYCONSENT_NOTE_FIELD_DEFAULT'),
'options' => $this->getOptions(),
'value' => (string) $this->value,
'translateLabel' => $this->translateLabel,
'translateDescription' => $this->translateDescription,
'translateHint' => $this->translateHint,
'privacyArticle' => $this->element['article'] > 0 ? (int) $this->element['article'] : 0,
);

return array_merge($data, $extraData);
}
}

0 comments on commit 02ca132

Please sign in to comment.