CoreFiles by mySites.guru
HtmlView.php226 lines, 5,527 bytes, from Joomla_4.2.0-beta1-Beta-Full_Package.zip
Raw History Compare with 4.1.0-beta3
md5
804f0eeee20acb41a0d570a1f0f9f979
sha1
10aa30992c98271a790752fe0405712259ca3137
sha256
017ce74c0bbe10a2231b7b0839a829cc8d12f6ade634dae3ad2b1cc3b3ba8d5b
<?php
/**
 * @package     Joomla.Administrator
 * @subpackage  com_users
 *
 * @copyright   (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\Component\Users\Administrator\View\Method;

use Joomla\CMS\Factory;
use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Toolbar\Button\BasicButton;
use Joomla\CMS\Toolbar\Button\LinkButton;
use Joomla\CMS\Toolbar\Toolbar;
use Joomla\CMS\Toolbar\ToolbarHelper;
use Joomla\CMS\User\User;
use Joomla\CMS\User\UserFactoryInterface;
use Joomla\Component\Users\Administrator\Model\MethodModel;

/**
 * View for Multi-factor Authentication method add/edit page
 *
 * @since 4.2.0
 */
class HtmlView extends BaseHtmlView
{
	/**
	 * Is this an administrator page?
	 *
	 * @var   boolean
	 * @since 4.2.0
	 */
	public $isAdmin = false;

	/**
	 * The editor page render options
	 *
	 * @var   array
	 * @since 4.2.0
	 */
	public $renderOptions = [];

	/**
	 * The MFA Method record being edited
	 *
	 * @var   object
	 * @since 4.2.0
	 */
	public $record = null;

	/**
	 * The title text for this page
	 *
	 * @var  string
	 * @since 4.2.0
	 */
	public $title = '';

	/**
	 * The return URL to use for all links and forms
	 *
	 * @var   string
	 * @since 4.2.0
	 */
	public $returnURL = null;

	/**
	 * The user object used to display this page
	 *
	 * @var   User
	 * @since 4.2.0
	 */
	public $user = null;

	/**
	 * The backup codes for the current user. Only applies when the backup codes record is being "edited"
	 *
	 * @var   array
	 * @since 4.2.0
	 */
	public $backupCodes = [];

	/**
	 * Am I editing an existing Method? If it's false then I'm adding a new Method.
	 *
	 * @var   boolean
	 * @since 4.2.0
	 */
	public $isEditExisting = false;

	/**
	 * Execute and display a template script.
	 *
	 * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
	 *
	 * @return  void
	 *
	 * @throws  \Exception
	 * @see     \JViewLegacy::loadTemplate()
	 * @since   4.2.0
	 */
	public function display($tpl = null): void
	{
		$app = Factory::getApplication();

		if (empty($this->user))
		{
			$this->user = Factory::getApplication()->getIdentity()
				?: Factory::getContainer()->get(UserFactoryInterface::class)->loadUserById(0);
		}

		/** @var MethodModel $model */
		$model = $this->getModel();
		$this->setLayout('edit');
		$this->renderOptions = $model->getRenderOptions($this->user);
		$this->record        = $model->getRecord($this->user);
		$this->title         = $model->getPageTitle();
		$this->isAdmin       = $app->isClient('administrator');

		// Backup codes are a special case, rendered with a special layout
		if ($this->record->method == 'backupcodes')
		{
			$this->setLayout('backupcodes');

			$backupCodes = $this->record->options;

			if (!is_array($backupCodes))
			{
				$backupCodes = [];
			}

			$backupCodes = array_filter(
				$backupCodes,
				function ($x) {
					return !empty($x);
				}
			);

			if (count($backupCodes) % 2 != 0)
			{
				$backupCodes[] = '';
			}

			/**
			 * The call to array_merge resets the array indices. This is necessary since array_filter kept the indices,
			 * meaning our elements are completely out of order.
			 */
			$this->backupCodes = array_merge($backupCodes);
		}

		// Set up the isEditExisting property.
		$this->isEditExisting = !empty($this->record->id);

		// Back-end: always show a title in the 'title' module position, not in the page body
		if ($this->isAdmin)
		{
			ToolbarHelper::title($this->title, 'users user-lock');

			$helpUrl = $this->renderOptions['help_url'];

			if (!empty($helpUrl))
			{
				ToolbarHelper::help('', false, $helpUrl);
			}

			$this->title = '';
		}

		$returnUrl = empty($this->returnURL) ? '' : base64_decode($this->returnURL);
		$returnUrl = $returnUrl ?: Route::_('index.php?option=com_users&task=methods.display&user_id=' . $this->user->id);

		if ($this->isAdmin && $this->getLayout() === 'edit')
		{
			$bar = Toolbar::getInstance();
			$button = (new BasicButton('user-mfa-edit-save'))
				->text($this->renderOptions['submit_text'])
				->icon($this->renderOptions['submit_icon'])
				->onclick('document.getElementById(\'user-mfa-edit-save\').click()');

			if ($this->renderOptions['show_submit'] || $this->isEditExisting)
			{
				$bar->appendButton($button);
			}

			$button = (new LinkButton('user-mfa-edit-cancel'))
				->text('JCANCEL')
				->buttonClass('btn btn-danger')
				->icon('icon-cancel-2')
				->url($returnUrl);
			$bar->appendButton($button);
		}
		elseif ($this->isAdmin && $this->getLayout() === 'backupcodes')
		{
			$bar = Toolbar::getInstance();

			$arrow  = Factory::getApplication()->getLanguage()->isRtl() ? 'arrow-right' : 'arrow-left';
			$button = (new LinkButton('user-mfa-edit-cancel'))
				->text('JTOOLBAR_BACK')
				->icon('icon-' . $arrow)
				->url($returnUrl);
			$bar->appendButton($button);

			$button = (new LinkButton('user-mfa-edit-cancel'))
				->text('COM_USERS_MFA_BACKUPCODES_RESET')
				->buttonClass('btn btn-danger')
				->icon('icon-refresh')
				->url(
					Route::_(
						sprintf(
							"index.php?option=com_users&task=method.regenerateBackupCodes&user_id=%s&%s=1&returnurl=%s",
							$this->user->id,
							Factory::getApplication()->getFormToken(),
							base64_encode($returnUrl)
						)
					)
				);
			$bar->appendButton($button);
		}

		// Display the view
		parent::display($tpl);
	}
}

The same content is in 2 releases, Joomla 4.2.0-beta1 to 4.2.0-beta2. See them all, or every version of this file.