primo commit
This commit is contained in:
444
plugins/user/profile/src/Extension/Profile.php
Normal file
444
plugins/user/profile/src/Extension/Profile.php
Normal file
@ -0,0 +1,444 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @package Joomla.Plugin
|
||||
* @subpackage User.profile
|
||||
*
|
||||
* @copyright (C) 2009 Open Source Matters, Inc. <https://www.joomla.org>
|
||||
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
||||
*/
|
||||
|
||||
namespace Joomla\Plugin\User\Profile\Extension;
|
||||
|
||||
use Joomla\CMS\Date\Date;
|
||||
use Joomla\CMS\Form\Form;
|
||||
use Joomla\CMS\Form\FormHelper;
|
||||
use Joomla\CMS\HTML\HTMLHelper;
|
||||
use Joomla\CMS\Language\Text;
|
||||
use Joomla\CMS\Plugin\CMSPlugin;
|
||||
use Joomla\CMS\String\PunycodeHelper;
|
||||
use Joomla\Database\DatabaseAwareTrait;
|
||||
use Joomla\Database\ParameterType;
|
||||
use Joomla\Utilities\ArrayHelper;
|
||||
|
||||
// phpcs:disable PSR1.Files.SideEffects
|
||||
\defined('_JEXEC') or die;
|
||||
// phpcs:enable PSR1.Files.SideEffects
|
||||
|
||||
/**
|
||||
* An example custom profile plugin.
|
||||
*
|
||||
* @since 1.6
|
||||
*/
|
||||
final class Profile extends CMSPlugin
|
||||
{
|
||||
use DatabaseAwareTrait;
|
||||
|
||||
/**
|
||||
* Date of birth.
|
||||
*
|
||||
* @var string
|
||||
*
|
||||
* @since 3.1
|
||||
*/
|
||||
private $date = '';
|
||||
|
||||
/**
|
||||
* Runs on content preparation
|
||||
*
|
||||
* @param string $context The context for the data
|
||||
* @param object $data An object containing the data for the form.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 1.6
|
||||
*/
|
||||
public function onContentPrepareData($context, $data)
|
||||
{
|
||||
// Check we are manipulating a valid form.
|
||||
if (!\in_array($context, ['com_users.profile', 'com_users.user', 'com_users.registration'])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Load plugin language files
|
||||
$this->loadLanguage();
|
||||
|
||||
if (\is_object($data)) {
|
||||
$userId = $data->id ?? 0;
|
||||
|
||||
if (!isset($data->profile) && $userId > 0) {
|
||||
// Load the profile data from the database.
|
||||
$db = $this->getDatabase();
|
||||
$query = $db->getQuery(true)
|
||||
->select(
|
||||
[
|
||||
$db->quoteName('profile_key'),
|
||||
$db->quoteName('profile_value'),
|
||||
]
|
||||
)
|
||||
->from($db->quoteName('#__user_profiles'))
|
||||
->where($db->quoteName('user_id') . ' = :userid')
|
||||
->where($db->quoteName('profile_key') . ' LIKE ' . $db->quote('profile.%'))
|
||||
->order($db->quoteName('ordering'))
|
||||
->bind(':userid', $userId, ParameterType::INTEGER);
|
||||
|
||||
$db->setQuery($query);
|
||||
$results = $db->loadRowList();
|
||||
|
||||
// Merge the profile data.
|
||||
$data->profile = [];
|
||||
|
||||
foreach ($results as $v) {
|
||||
$k = str_replace('profile.', '', $v[0]);
|
||||
$data->profile[$k] = json_decode($v[1], true);
|
||||
|
||||
if ($data->profile[$k] === null) {
|
||||
$data->profile[$k] = $v[1];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!HTMLHelper::isRegistered('users.url')) {
|
||||
HTMLHelper::register('users.url', [__CLASS__, 'url']);
|
||||
}
|
||||
|
||||
if (!HTMLHelper::isRegistered('users.calendar')) {
|
||||
HTMLHelper::register('users.calendar', [__CLASS__, 'calendar']);
|
||||
}
|
||||
|
||||
if (!HTMLHelper::isRegistered('users.tos')) {
|
||||
HTMLHelper::register('users.tos', [__CLASS__, 'tos']);
|
||||
}
|
||||
|
||||
if (!HTMLHelper::isRegistered('users.dob')) {
|
||||
HTMLHelper::register('users.dob', [__CLASS__, 'dob']);
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an anchor tag generated from a given value
|
||||
*
|
||||
* @param string $value URL to use
|
||||
*
|
||||
* @return mixed|string
|
||||
*/
|
||||
public static function url($value)
|
||||
{
|
||||
if (empty($value)) {
|
||||
return HTMLHelper::_('users.value', $value);
|
||||
}
|
||||
|
||||
// Convert website URL to utf8 for display
|
||||
$value = htmlspecialchars(PunycodeHelper::urlToUTF8($value), ENT_QUOTES, 'UTF-8');
|
||||
|
||||
if (strpos($value, 'http') === 0) {
|
||||
return '<a href="' . $value . '">' . $value . '</a>';
|
||||
}
|
||||
|
||||
return '<a href="http://' . $value . '">' . $value . '</a>';
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns html markup showing a date picker
|
||||
*
|
||||
* @param string $value valid date string
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public static function calendar($value)
|
||||
{
|
||||
if (empty($value)) {
|
||||
return HTMLHelper::_('users.value', $value);
|
||||
}
|
||||
|
||||
return HTMLHelper::_('date', $value, null, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the date of birth formatted and calculated using server timezone.
|
||||
*
|
||||
* @param string $value valid date string
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public static function dob($value)
|
||||
{
|
||||
if (!$value) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return HTMLHelper::_('date', $value, Text::_('DATE_FORMAT_LC1'), false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the translated strings yes or no depending on the value
|
||||
*
|
||||
* @param boolean $value input value
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function tos($value)
|
||||
{
|
||||
if ($value) {
|
||||
return Text::_('JYES');
|
||||
}
|
||||
|
||||
return Text::_('JNO');
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds additional fields to the user editing form
|
||||
*
|
||||
* @param Form $form The form to be altered.
|
||||
* @param mixed $data The associated data for the form.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 1.6
|
||||
*/
|
||||
public function onContentPrepareForm(Form $form, $data)
|
||||
{
|
||||
// Check we are manipulating a valid form.
|
||||
$name = $form->getName();
|
||||
|
||||
if (!\in_array($name, ['com_users.user', 'com_users.profile', 'com_users.registration'])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Load plugin language files
|
||||
$this->loadLanguage();
|
||||
|
||||
// Add the registration fields to the form.
|
||||
FormHelper::addFieldPrefix('Joomla\\Plugin\\User\\Profile\\Field');
|
||||
FormHelper::addFormPath(JPATH_PLUGINS . '/' . $this->_type . '/' . $this->_name . '/forms');
|
||||
$form->loadFile('profile');
|
||||
|
||||
$fields = [
|
||||
'address1',
|
||||
'address2',
|
||||
'city',
|
||||
'region',
|
||||
'country',
|
||||
'postal_code',
|
||||
'phone',
|
||||
'website',
|
||||
'favoritebook',
|
||||
'aboutme',
|
||||
'dob',
|
||||
'tos',
|
||||
];
|
||||
|
||||
$tosArticle = $this->params->get('register_tos_article');
|
||||
$tosEnabled = $this->params->get('register-require_tos', 0);
|
||||
|
||||
// We need to be in the registration form and field needs to be enabled
|
||||
if ($name !== 'com_users.registration' || !$tosEnabled) {
|
||||
// We only want the TOS in the registration form
|
||||
$form->removeField('tos', 'profile');
|
||||
} else {
|
||||
// Push the TOS article ID into the TOS field.
|
||||
$form->setFieldAttribute('tos', 'article', $tosArticle, 'profile');
|
||||
}
|
||||
|
||||
foreach ($fields as $field) {
|
||||
// Case using the users manager in admin
|
||||
if ($name === 'com_users.user') {
|
||||
// Toggle whether the field is required.
|
||||
if ($this->params->get('profile-require_' . $field, 1) > 0) {
|
||||
$form->setFieldAttribute($field, 'required', ($this->params->get('profile-require_' . $field) == 2) ? 'required' : '', 'profile');
|
||||
} elseif (
|
||||
// Remove the field if it is disabled in registration and profile
|
||||
$this->params->get('register-require_' . $field, 1) == 0
|
||||
&& $this->params->get('profile-require_' . $field, 1) == 0
|
||||
) {
|
||||
$form->removeField($field, 'profile');
|
||||
}
|
||||
} elseif ($name === 'com_users.registration') {
|
||||
// Case registration
|
||||
// Toggle whether the field is required.
|
||||
if ($this->params->get('register-require_' . $field, 1) > 0) {
|
||||
$form->setFieldAttribute($field, 'required', ($this->params->get('register-require_' . $field) == 2) ? 'required' : '', 'profile');
|
||||
} else {
|
||||
$form->removeField($field, 'profile');
|
||||
}
|
||||
} elseif ($name === 'com_users.profile') {
|
||||
// Case profile in site or admin
|
||||
// Toggle whether the field is required.
|
||||
if ($this->params->get('profile-require_' . $field, 1) > 0) {
|
||||
$form->setFieldAttribute($field, 'required', ($this->params->get('profile-require_' . $field) == 2) ? 'required' : '', 'profile');
|
||||
} else {
|
||||
$form->removeField($field, 'profile');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Drop the profile form entirely if there aren't any fields to display.
|
||||
$remainingfields = $form->getGroup('profile');
|
||||
|
||||
if (!\count($remainingfields)) {
|
||||
$form->removeGroup('profile');
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method is called before user data is stored in the database
|
||||
*
|
||||
* @param array $user Holds the old user data.
|
||||
* @param boolean $isnew True if a new user is stored.
|
||||
* @param array $data Holds the new user data.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 3.1
|
||||
* @throws \InvalidArgumentException on invalid date.
|
||||
*/
|
||||
public function onUserBeforeSave($user, $isnew, $data)
|
||||
{
|
||||
// Load plugin language files
|
||||
$this->loadLanguage();
|
||||
|
||||
// Check that the date is valid.
|
||||
if (!empty($data['profile']['dob'])) {
|
||||
try {
|
||||
$date = new Date($data['profile']['dob']);
|
||||
$this->date = $date->format('Y-m-d H:i:s');
|
||||
} catch (\Exception $e) {
|
||||
// Throw an exception if date is not valid.
|
||||
throw new \InvalidArgumentException($this->getApplication()->getLanguage()->_('PLG_USER_PROFILE_ERROR_INVALID_DOB'));
|
||||
}
|
||||
|
||||
if (Date::getInstance('now') < $date) {
|
||||
// Throw an exception if dob is greater than now.
|
||||
throw new \InvalidArgumentException($this->getApplication()->getLanguage()->_('PLG_USER_PROFILE_ERROR_INVALID_DOB_FUTURE_DATE'));
|
||||
}
|
||||
}
|
||||
|
||||
// Check that the tos is checked if required ie only in registration from frontend.
|
||||
$task = $this->getApplication()->getInput()->getCmd('task');
|
||||
$option = $this->getApplication()->getInput()->getCmd('option');
|
||||
$tosEnabled = ($this->params->get('register-require_tos', 0) == 2);
|
||||
|
||||
// Check that the tos is checked.
|
||||
if ($task === 'register' && $tosEnabled && $option === 'com_users' && !$data['profile']['tos']) {
|
||||
throw new \InvalidArgumentException($this->getApplication()->getLanguage()->_('PLG_USER_PROFILE_FIELD_TOS_DESC_SITE'));
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves user profile data
|
||||
*
|
||||
* @param array $data entered user data
|
||||
* @param boolean $isNew true if this is a new user
|
||||
* @param boolean $result true if saving the user worked
|
||||
* @param string $error error message
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function onUserAfterSave($data, $isNew, $result, $error): void
|
||||
{
|
||||
$userId = ArrayHelper::getValue($data, 'id', 0, 'int');
|
||||
|
||||
if ($userId && $result && isset($data['profile']) && \count($data['profile'])) {
|
||||
$db = $this->getDatabase();
|
||||
|
||||
// Sanitize the date
|
||||
if (!empty($data['profile']['dob'])) {
|
||||
$data['profile']['dob'] = $this->date;
|
||||
}
|
||||
|
||||
$keys = array_keys($data['profile']);
|
||||
|
||||
foreach ($keys as &$key) {
|
||||
$key = 'profile.' . $key;
|
||||
}
|
||||
|
||||
$query = $db->getQuery(true)
|
||||
->delete($db->quoteName('#__user_profiles'))
|
||||
->where($db->quoteName('user_id') . ' = :userid')
|
||||
->whereIn($db->quoteName('profile_key'), $keys, ParameterType::STRING)
|
||||
->bind(':userid', $userId, ParameterType::INTEGER);
|
||||
$db->setQuery($query);
|
||||
$db->execute();
|
||||
|
||||
$query->clear()
|
||||
->select($db->quoteName('ordering'))
|
||||
->from($db->quoteName('#__user_profiles'))
|
||||
->where($db->quoteName('user_id') . ' = :userid')
|
||||
->bind(':userid', $userId, ParameterType::INTEGER);
|
||||
$db->setQuery($query);
|
||||
$usedOrdering = $db->loadColumn();
|
||||
|
||||
$order = 1;
|
||||
$query->clear()
|
||||
->insert($db->quoteName('#__user_profiles'));
|
||||
|
||||
foreach ($data['profile'] as $k => $v) {
|
||||
while (\in_array($order, $usedOrdering)) {
|
||||
$order++;
|
||||
}
|
||||
|
||||
$query->values(
|
||||
implode(
|
||||
',',
|
||||
$query->bindArray(
|
||||
[
|
||||
$userId,
|
||||
'profile.' . $k,
|
||||
json_encode($v),
|
||||
$order++,
|
||||
],
|
||||
[
|
||||
ParameterType::INTEGER,
|
||||
ParameterType::STRING,
|
||||
ParameterType::STRING,
|
||||
ParameterType::INTEGER,
|
||||
]
|
||||
)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$db->setQuery($query);
|
||||
$db->execute();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove all user profile information for the given user ID
|
||||
*
|
||||
* Method is called after user data is deleted from the database
|
||||
*
|
||||
* @param array $user Holds the user data
|
||||
* @param boolean $success True if user was successfully stored in the database
|
||||
* @param string $msg Message
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function onUserAfterDelete($user, $success, $msg): void
|
||||
{
|
||||
if (!$success) {
|
||||
return;
|
||||
}
|
||||
|
||||
$userId = ArrayHelper::getValue($user, 'id', 0, 'int');
|
||||
|
||||
if ($userId) {
|
||||
$db = $this->getDatabase();
|
||||
$query = $db->getQuery(true)
|
||||
->delete($db->quoteName('#__user_profiles'))
|
||||
->where($db->quoteName('user_id') . ' = :userid')
|
||||
->where($db->quoteName('profile_key') . ' LIKE ' . $db->quote('profile.%'))
|
||||
->bind(':userid', $userId, ParameterType::INTEGER);
|
||||
|
||||
$db->setQuery($query);
|
||||
$db->execute();
|
||||
}
|
||||
}
|
||||
}
|
||||
144
plugins/user/profile/src/Field/TosField.php
Normal file
144
plugins/user/profile/src/Field/TosField.php
Normal file
@ -0,0 +1,144 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @package Joomla.Plugin
|
||||
* @subpackage User.profile
|
||||
*
|
||||
* @copyright (C) 2012 Open Source Matters, Inc. <https://www.joomla.org>
|
||||
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
||||
*/
|
||||
|
||||
namespace Joomla\Plugin\User\Profile\Field;
|
||||
|
||||
use Joomla\CMS\Factory;
|
||||
use Joomla\CMS\Form\Field\RadioField;
|
||||
use Joomla\CMS\HTML\HTMLHelper;
|
||||
use Joomla\CMS\Language\Associations;
|
||||
use Joomla\CMS\Language\Text;
|
||||
use Joomla\CMS\Router\Route;
|
||||
use Joomla\Component\Content\Site\Helper\RouteHelper;
|
||||
use Joomla\Database\ParameterType;
|
||||
|
||||
// phpcs:disable PSR1.Files.SideEffects
|
||||
\defined('_JEXEC') or die;
|
||||
// phpcs:enable PSR1.Files.SideEffects
|
||||
|
||||
/**
|
||||
* Provides input for TOS
|
||||
*
|
||||
* @since 2.5.5
|
||||
*/
|
||||
class TosField extends RadioField
|
||||
{
|
||||
/**
|
||||
* The form field type.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.5.5
|
||||
*/
|
||||
protected $type = 'Tos';
|
||||
|
||||
/**
|
||||
* Method to get the field label markup.
|
||||
*
|
||||
* @return string The field label markup.
|
||||
*
|
||||
* @since 2.5.5
|
||||
*/
|
||||
protected function getLabel()
|
||||
{
|
||||
$label = '';
|
||||
|
||||
if ($this->hidden) {
|
||||
return $label;
|
||||
}
|
||||
|
||||
// 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;
|
||||
|
||||
// Build the class for the label.
|
||||
$class = !empty($this->description) ? 'hasPopover' : '';
|
||||
$class .= ' required';
|
||||
$class = !empty($this->labelClass) ? $class . ' ' . $this->labelClass : $class;
|
||||
|
||||
// Add the opening label tag and main attributes 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)) {
|
||||
HTMLHelper::_('bootstrap.popover', '.hasPopover');
|
||||
$label .= ' data-bs-content="' . htmlspecialchars(
|
||||
$this->translateDescription ? Text::_($this->description) : $this->description,
|
||||
ENT_COMPAT,
|
||||
'UTF-8'
|
||||
) . '"';
|
||||
|
||||
if (Factory::getLanguage()->isRtl()) {
|
||||
$label .= ' data-bs-placement="left"';
|
||||
}
|
||||
}
|
||||
|
||||
$tosArticle = $this->element['article'] > 0 ? (int) $this->element['article'] : 0;
|
||||
|
||||
if ($tosArticle) {
|
||||
$attribs = [];
|
||||
$attribs['data-bs-toggle'] = 'modal';
|
||||
$attribs['data-bs-target'] = '#tosModal';
|
||||
|
||||
$db = $this->getDatabase();
|
||||
$query = $db->getQuery(true);
|
||||
|
||||
$query->select($db->quoteName(['id', 'alias', 'catid', 'language']))
|
||||
->from($db->quoteName('#__content'))
|
||||
->where($db->quoteName('id') . ' = :id')
|
||||
->bind(':id', $tosArticle, ParameterType::INTEGER);
|
||||
$db->setQuery($query);
|
||||
$article = $db->loadObject();
|
||||
|
||||
if (Associations::isEnabled()) {
|
||||
$tosAssociated = Associations::getAssociations('com_content', '#__content', 'com_content.item', $tosArticle);
|
||||
}
|
||||
|
||||
$currentLang = Factory::getLanguage()->getTag();
|
||||
|
||||
if (isset($tosAssociated) && $currentLang !== $article->language && \array_key_exists($currentLang, $tosAssociated)) {
|
||||
$url = RouteHelper::getArticleRoute(
|
||||
$tosAssociated[$currentLang]->id,
|
||||
$tosAssociated[$currentLang]->catid,
|
||||
$tosAssociated[$currentLang]->language
|
||||
);
|
||||
$link = HTMLHelper::_('link', Route::_($url . '&tmpl=component'), $text, $attribs);
|
||||
} else {
|
||||
$slug = $article->alias ? ($article->id . ':' . $article->alias) : $article->id;
|
||||
$url = RouteHelper::getArticleRoute($slug, $article->catid, $article->language);
|
||||
$link = HTMLHelper::_('link', Route::_($url . '&tmpl=component'), $text, $attribs);
|
||||
}
|
||||
|
||||
echo HTMLHelper::_(
|
||||
'bootstrap.renderModal',
|
||||
'tosModal',
|
||||
[
|
||||
'url' => Route::_($url . '&tmpl=component'),
|
||||
'title' => $text,
|
||||
'height' => '100%',
|
||||
'width' => '100%',
|
||||
'modalWidth' => '800',
|
||||
'bodyHeight' => '500',
|
||||
'footer' => '<button type="button" class="btn btn-secondary" data-bs-dismiss="modal" aria-hidden="true">'
|
||||
. Text::_('JLIB_HTML_BEHAVIOR_CLOSE') . '</button>',
|
||||
]
|
||||
);
|
||||
} else {
|
||||
$link = $text;
|
||||
}
|
||||
|
||||
// Add the label text and closing tag.
|
||||
$label .= '>' . $link . '<span class="star" aria-hidden="true"> *</span></label>';
|
||||
|
||||
return $label;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user