Commit 129452ff authored by Christian Kuhn's avatar Christian Kuhn
Browse files

[TASK] ext:beuser BackendUser model does not extend extbase model

To further clean up ext:beuser and allow more refactoring
of the extension, the BackendUser model no longer extends
the ext:extbase base BackendUser model.
The patch is a straight merge of the lower class for now
and further patches will follow.

Resolves: #94614
Releases: master
Change-Id: I79978cdae8538ce04b15bc703ad0eefc415f6d27
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/70025

Tested-by: core-ci's avatarcore-ci <typo3@b13.com>
Tested-by: Benni Mack's avatarBenni Mack <benni@typo3.org>
Tested-by: Jochen's avatarJochen <rothjochen@gmail.com>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Benni Mack's avatarBenni Mack <benni@typo3.org>
Reviewed-by: Jochen's avatarJochen <rothjochen@gmail.com>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
parent e5bf0c14
......@@ -16,15 +16,29 @@
namespace TYPO3\CMS\Beuser\Domain\Model;
use TYPO3\CMS\Backend\Authentication\PasswordReset;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Annotation as Extbase;
use TYPO3\CMS\Extbase\DomainObject\AbstractEntity;
use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
/**
* Model for backend user
* @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
*/
class BackendUser extends \TYPO3\CMS\Extbase\Domain\Model\BackendUser
class BackendUser extends AbstractEntity
{
/**
* @var string
* @Extbase\Validate("NotEmpty")
*/
protected $userName = '';
/**
* @var ObjectStorage<BackendUserGroup>
*/
protected $backendUserGroups;
/**
* Comma separated list of uids in multi-select
* Might retrieve the labels from TCA/DataMapper
......@@ -41,7 +55,7 @@ class BackendUser extends \TYPO3\CMS\Extbase\Domain\Model\BackendUser
/**
* @var string
*/
protected $description;
protected $description = '';
/**
* @var string
......@@ -49,9 +63,39 @@ class BackendUser extends \TYPO3\CMS\Extbase\Domain\Model\BackendUser
protected $fileMountPoints = '';
/**
* @var ObjectStorage<BackendUserGroup>
* @var bool
*/
protected $backendUserGroups;
protected $isAdministrator = false;
/**
* @var bool
*/
protected $isDisabled = false;
/**
* @var \DateTime|null
*/
protected $startDateAndTime;
/**
* @var \DateTime|null
*/
protected $endDateAndTime;
/**
* @var string
*/
protected $email = '';
/**
* @var string
*/
protected $realName = '';
/**
* @var \DateTime|null
*/
protected $lastLoginDateAndTime;
/**
* @param string $allowedLanguages
......@@ -159,11 +203,225 @@ class BackendUser extends \TYPO3\CMS\Extbase\Domain\Model\BackendUser
}
/**
* Gets the currently logged in backend user
* Gets the user name.
*
* @return string the user name, will not be empty
*/
public function getUserName()
{
return $this->userName;
}
/**
* Sets the user name.
*
* @param string $userName the user name to set, must not be empty
*/
public function setUserName($userName)
{
$this->userName = $userName;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* Checks whether this user is an administrator.
*
* @return bool whether this user is an administrator
*/
public function getIsAdministrator()
{
return $this->isAdministrator;
}
/**
* Sets whether this user should be an administrator.
*
* @param bool $isAdministrator whether this user should be an administrator
*/
public function setIsAdministrator($isAdministrator)
{
$this->isAdministrator = $isAdministrator;
}
/**
* Checks whether this user is disabled.
*
* @return bool whether this user is disabled
*/
public function getIsDisabled()
{
return $this->isDisabled;
}
/**
* Sets whether this user is disabled.
*
* @param bool $isDisabled whether this user is disabled
*/
public function setIsDisabled($isDisabled)
{
$this->isDisabled = $isDisabled;
}
/**
* Returns the point in time from which this user is enabled.
*
* @return \DateTime|null the start date and time
*/
public function getStartDateAndTime()
{
return $this->startDateAndTime;
}
/**
* Sets the point in time from which this user is enabled.
*
* @return \TYPO3\CMS\Core\Authentication\BackendUserAuthentication
* @param \DateTime|null $dateAndTime the start date and time
*/
public function setStartDateAndTime(\DateTime $dateAndTime = null)
{
$this->startDateAndTime = $dateAndTime;
}
/**
* Returns the point in time before which this user is enabled.
*
* @return \DateTime|null the end date and time
*/
public function getEndDateAndTime()
{
return $this->endDateAndTime;
}
/**
* Sets the point in time before which this user is enabled.
*
* @param \DateTime|null $dateAndTime the end date and time
*/
public function setEndDateAndTime(\DateTime $dateAndTime = null)
{
$this->endDateAndTime = $dateAndTime;
}
/**
* Gets the e-mail address of this user.
*
* @return string the e-mail address, might be empty
*/
public function getEmail()
{
return $this->email;
}
/**
* Sets the e-mail address of this user.
*
* @param string $email the e-mail address, may be empty
*/
public function setEmail($email)
{
$this->email = $email;
}
/**
* Returns this user's real name.
*
* @return string the real name. might be empty
*/
public function getRealName()
{
return $this->realName;
}
/**
* Sets this user's real name.
*
* @param string $name the user's real name, may be empty.
*/
public function setRealName($name)
{
$this->realName = $name;
}
/**
* Checks whether this user is currently activated.
*
* This function takes the "disabled" flag, the start date/time and the end date/time into account.
*
* @return bool whether this user is currently activated
*/
public function isActivated()
{
return !$this->getIsDisabled() && $this->isActivatedViaStartDateAndTime() && $this->isActivatedViaEndDateAndTime();
}
/**
* Checks whether this user is activated as far as the start date and time is concerned.
*
* @return bool whether this user is activated as far as the start date and time is concerned
*/
protected function isActivatedViaStartDateAndTime()
{
if ($this->getStartDateAndTime() === null) {
return true;
}
$now = new \DateTime('now');
return $this->getStartDateAndTime() <= $now;
}
/**
* Checks whether this user is activated as far as the end date and time is concerned.
*
* @return bool whether this user is activated as far as the end date and time is concerned
*/
protected function isActivatedViaEndDateAndTime()
{
if ($this->getEndDateAndTime() === null) {
return true;
}
$now = new \DateTime('now');
return $now <= $this->getEndDateAndTime();
}
/**
* Gets this user's last login date and time.
*
* @return \DateTime|null this user's last login date and time, will be NULL if this user has never logged in before
*/
public function getLastLoginDateAndTime()
{
return $this->lastLoginDateAndTime;
}
/**
* Sets this user's last login date and time.
*
* @param \DateTime|null $dateAndTime this user's last login date and time
*/
public function setLastLoginDateAndTime(\DateTime $dateAndTime = null)
{
$this->lastLoginDateAndTime = $dateAndTime;
}
/**
* Gets the currently logged in backend user
*/
public function getBackendUser()
public function getBackendUser(): BackendUserAuthentication
{
return $GLOBALS['BE_USER'];
}
......
......@@ -6,6 +6,27 @@ return [
\TYPO3\CMS\Beuser\Domain\Model\BackendUser::class => [
'tableName' => 'be_users',
'properties' => [
'userName' => [
'fieldName' => 'username'
],
'isAdministrator' => [
'fieldName' => 'admin'
],
'isDisabled' => [
'fieldName' => 'disable'
],
'realName' => [
'fieldName' => 'realName'
],
'startDateAndTime' => [
'fieldName' => 'starttime'
],
'endDateAndTime' => [
'fieldName' => 'endtime'
],
'lastLoginDateAndTime' => [
'fieldName' => 'lastlogin'
],
'allowedLanguages' => [
'fieldName' => 'allowed_languages'
],
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment