BackendUser.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
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;
 
class ‪BackendUser extends ‪AbstractEntity
{
    protected ‪$userName = '';
 
    protected ‪$backendUserGroups;
 
    protected ‪$allowedLanguages = '';
 
    protected ‪$dbMountPoints = '';
 
    protected ‪$description = '';
 
    protected ‪$fileMountPoints = '';
 
    protected ‪$isAdministrator = false;
 
    protected ‪$isDisabled = false;
 
    protected ‪$startDateAndTime;
 
    protected ‪$endDateAndTime;
 
    protected ‪$email = '';
 
    protected ‪$realName = '';
 
    protected ‪$lastLoginDateAndTime;
 
    public function ‪setAllowedLanguages(‪$allowedLanguages)
    {
        $this->allowedLanguages = ‪$allowedLanguages;
    }
 
    public function ‪getAllowedLanguages()
    {
        return ‪$this->allowedLanguages;
    }
 
    public function ‪setDbMountPoints(‪$dbMountPoints)
    {
        $this->dbMountPoints = ‪$dbMountPoints;
    }
 
    public function ‪getDbMountPoints()
    {
        return ‪$this->dbMountPoints;
    }
 
    public function ‪setFileMountPoints(‪$fileMountPoints)
    {
        $this->fileMountPoints = ‪$fileMountPoints;
    }
 
    public function ‪getFileMountPoints()
    {
        return ‪$this->fileMountPoints;
    }
 
    public function ‪isActive()
    {
        if ($this->‪getIsDisabled()) {
            return false;
        }
        $now = new \DateTime('now');
        return !$this->‪getStartDateAndTime() && !$this->‪getEndDateAndTime() || $this->‪getStartDateAndTime() <= $now && (!$this->‪getEndDateAndTime() || $this->‪getEndDateAndTime() > $now);
    }
 
    public function ‪setBackendUserGroups(‪$backendUserGroups)
    {
        $this->backendUserGroups = ‪$backendUserGroups;
    }
 
    public function ‪getBackendUserGroups()
    {
        return ‪$this->backendUserGroups;
    }
 
    public function ‪isCurrentlyLoggedIn()
    {
        return $this->‪getUid() === (int)($this->‪getBackendUser()->user['uid'] ?? 0);
    }
 
    public function ‪isPasswordResetEnabled(): bool
    {
        return !$this->‪isCurrentlyLoggedIn()
            && GeneralUtility::makeInstance(PasswordReset::class)->isEnabledForUser((int)$this->‪getUid())
            && ($this->‪getBackendUser()->getTSConfig()['options.']['passwordReset'] ?? true);
    }
 
    public function ‪getUserName()
    {
        return ‪$this->userName;
    }
 
    public function ‪setUserName(‪$userName)
    {
        $this->userName = ‪$userName;
    }
 
    public function ‪getDescription()
    {
        return ‪$this->description;
    }
 
    public function ‪setDescription(‪$description)
    {
        $this->description = ‪$description;
    }
 
    public function ‪getIsAdministrator()
    {
        return ‪$this->isAdministrator;
    }
 
    public function ‪setIsAdministrator(‪$isAdministrator)
    {
        $this->isAdministrator = ‪$isAdministrator;
    }
 
    public function ‪getIsDisabled()
    {
        return ‪$this->isDisabled;
    }
 
    public function ‪setIsDisabled(‪$isDisabled)
    {
        $this->isDisabled = ‪$isDisabled;
    }
 
    public function ‪getStartDateAndTime()
    {
        return ‪$this->startDateAndTime;
    }
 
    public function ‪setStartDateAndTime(\DateTime $dateAndTime = null)
    {
        $this->startDateAndTime = $dateAndTime;
    }
 
    public function ‪getEndDateAndTime()
    {
        return ‪$this->endDateAndTime;
    }
 
    public function ‪setEndDateAndTime(\DateTime $dateAndTime = null)
    {
        $this->endDateAndTime = $dateAndTime;
    }
 
    public function ‪getEmail()
    {
        return ‪$this->email;
    }
 
    public function ‪setEmail(‪$email)
    {
        $this->email = ‪$email;
    }
 
    public function ‪getRealName()
    {
        return ‪$this->realName;
    }
 
    public function ‪setRealName($name)
    {
        $this->realName = $name;
    }
 
    public function ‪isActivated()
    {
        return !$this->‪getIsDisabled() && $this->‪isActivatedViaStartDateAndTime() && $this->‪isActivatedViaEndDateAndTime();
    }
 
    protected function ‪isActivatedViaStartDateAndTime()
    {
        if ($this->‪getStartDateAndTime() === null) {
            return true;
        }
        $now = new \DateTime('now');
        return $this->‪getStartDateAndTime() <= $now;
    }
 
    protected function ‪isActivatedViaEndDateAndTime()
    {
        if ($this->‪getEndDateAndTime() === null) {
            return true;
        }
        $now = new \DateTime('now');
        return $now <= $this->‪getEndDateAndTime();
    }
 
    public function ‪getLastLoginDateAndTime()
    {
        return ‪$this->lastLoginDateAndTime;
    }
 
    public function ‪setLastLoginDateAndTime(\DateTime $dateAndTime = null)
    {
        $this->lastLoginDateAndTime = $dateAndTime;
    }
 
    public function ‪getBackendUser(): BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}