- md5
- a854bc2111c2210cca3690d4fbb4648e
- sha1
- 1dbcdd1132344e38e36c7110db8ed68cd71e87de
- sha256
- 23156c226a0e6fc405abbe0da56532e912c140dc7b9148a307e0073389fb0991
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
<?php
/**
* @package Joomla.Plugin
* @subpackage User.terms
*
* @copyright (C) 2018 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Plugin\User\Terms\Extension;
use Joomla\CMS\Event\Model\PrepareFormEvent;
use Joomla\CMS\Event\User\AfterSaveEvent;
use Joomla\CMS\Event\User\BeforeSaveEvent;
use Joomla\CMS\Form\FormHelper;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\Component\Actionlogs\Administrator\Model\ActionlogModel;
use Joomla\Event\SubscriberInterface;
use Joomla\Utilities\ArrayHelper;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* An example custom terms and conditions plugin.
*
* @since 3.9.0
*/
final class Terms extends CMSPlugin implements SubscriberInterface
{
/**
* Returns an array of events this subscriber will listen to.
*
* @return array
*
* @since 5.3.0
*/
public static function getSubscribedEvents(): array
{
return [
'onContentPrepareForm' => 'onContentPrepareForm',
'onUserBeforeSave' => 'onUserBeforeSave',
'onUserAfterSave' => 'onUserAfterSave',
];
}
/**
* Adds additional fields to the user registration form
*
* @param PrepareFormEvent $event The event instance.
*
* @return void
*
* @since 3.9.0
*/
public function onContentPrepareForm(PrepareFormEvent $event)
{
$form = $event->getForm();
// Check we are manipulating a valid form - we only display this on user registration form.
$name = $form->getName();
if (!\in_array($name, ['com_users.registration'])) {
return;
}
// Load plugin language files
$this->loadLanguage();
// Add the terms and conditions fields to the form.
FormHelper::addFieldPrefix('Joomla\\Plugin\\User\\Terms\\Field');
FormHelper::addFormPath(JPATH_PLUGINS . '/' . $this->_type . '/' . $this->_name . '/forms');
$form->loadFile('terms');
$termsarticle = $this->params->get('terms_article');
$termsnote = $this->params->get('terms_note');
// Push the terms and conditions article ID into the terms field.
$form->setFieldAttribute('terms', 'article', $termsarticle, 'terms');
$form->setFieldAttribute('terms', 'note', $termsnote, 'terms');
}
/**
* Method is called before user data is stored in the database
*
* @param BeforeSaveEvent $event The event instance.
*
* @return void
*
* @since 3.9.0
* @throws \InvalidArgumentException on missing required data.
*/
public function onUserBeforeSave(BeforeSaveEvent $event)
{
$user = $event->getUser();
// // Only check for front-end user registration
if ($this->getApplication()->isClient('administrator')) {
return;
}
$userId = ArrayHelper::getValue($user, 'id', 0, 'int');
// User already registered, no need to check it further
if ($userId > 0) {
return;
}
// Load plugin language files
$this->loadLanguage();
// Check that the terms is checked if required ie only in registration from frontend.
$input = $this->getApplication()->getInput();
$option = $input->get('option');
$task = $input->post->get('task');
$form = $input->post->get('jform', [], 'array');
if ($option == 'com_users' && \in_array($task, ['registration.register']) && empty($form['terms']['terms'])) {
throw new \InvalidArgumentException($this->getApplication()->getLanguage()->_('PLG_USER_TERMS_FIELD_ERROR'));
}
}
/**
* Saves user profile data
*
* @param AfterSaveEvent $event The event instance.
*
* @return void
*
* @since 3.9.0
*/
public function onUserAfterSave(AfterSaveEvent $event): void
{
$data = $event->getUser();
$isNew = $event->getIsNew();
$result = $event->getSavingResult();
if (!$isNew || !$result) {
return;
}
$userId = ArrayHelper::getValue($data, 'id', 0, 'int');
$message = [
'action' => 'consent',
'id' => $userId,
'title' => $data['name'],
'itemlink' => 'index.php?option=com_users&task=user.edit&id=' . $userId,
'userid' => $userId,
'username' => $data['username'],
'accountlink' => 'index.php?option=com_users&task=user.edit&id=' . $userId,
];
/** @var ActionlogModel $model */
$model = $this->getApplication()
->bootComponent('com_actionlogs')
->getMVCFactory()
->createModel('Actionlog', 'Administrator');
$model->addLog([$message], 'PLG_USER_TERMS_LOGGING_CONSENT_TO_TERMS', 'plg_user_terms', $userId);
}
}
The same content is in 94 releases, Joomla 5.3.0-beta1 to 6.2.1-rc1. See them all, or every version of this file.