81 lines
1.5 KiB
PHP
81 lines
1.5 KiB
PHP
<?php
|
|
/**
|
|
* Joomla! Content Management System
|
|
*
|
|
* @copyright (C) 2005 Open Source Matters, Inc. <https://www.joomla.org>
|
|
* @license GNU General Public License version 2 or later; see LICENSE
|
|
*/
|
|
|
|
namespace Joomla\CMS\Application;
|
|
|
|
\defined('JPATH_PLATFORM') or die;
|
|
|
|
use Joomla\CMS\User\User;
|
|
use Joomla\CMS\User\UserFactoryInterface;
|
|
|
|
/**
|
|
* Trait for application classes which are identity (user) aware
|
|
*
|
|
* @since 4.0.0
|
|
*/
|
|
trait IdentityAware
|
|
{
|
|
/**
|
|
* The application identity object.
|
|
*
|
|
* @var User
|
|
* @since 4.0.0
|
|
*/
|
|
protected $identity;
|
|
|
|
/**
|
|
* UserFactoryInterface
|
|
*
|
|
* @var UserFactoryInterface
|
|
* @since 4.0.0
|
|
*/
|
|
private $userFactory;
|
|
|
|
/**
|
|
* Get the application identity.
|
|
*
|
|
* @return User
|
|
*
|
|
* @since 4.0.0
|
|
*/
|
|
public function getIdentity()
|
|
{
|
|
return $this->identity;
|
|
}
|
|
|
|
/**
|
|
* Allows the application to load a custom or default identity.
|
|
*
|
|
* @param User $identity An optional identity object. If omitted, a null user object is created.
|
|
*
|
|
* @return $this
|
|
*
|
|
* @since 4.0.0
|
|
*/
|
|
public function loadIdentity(User $identity = null)
|
|
{
|
|
$this->identity = $identity ?: $this->userFactory->loadUserById(0);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the user factory to use.
|
|
*
|
|
* @param UserFactoryInterface $userFactory The user factory to use
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 4.0.0
|
|
*/
|
|
public function setUserFactory(UserFactoryInterface $userFactory)
|
|
{
|
|
$this->userFactory = $userFactory;
|
|
}
|
|
}
|