Merge pull request #5987 from WoltLab/acp-dahsboard-box-hight

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / acp / session / ACPSession.class.php

<?php

namespace wcf\data\acp\session;

use wcf\data\DatabaseObject;
use wcf\system\WCF;

/**
 * Represents an ACP session.
 *
 * @author  Alexander Ebert
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 *
 * @property-read   string $sessionID      unique textual identifier of the acp session
 * @property-read   int|null $userID         id of the user the acp session belongs to or `null` if the acp session belongs to a guest
 * @property-read   string $ipAddress      id of the user whom the acp session belongs to
 * @property-read   string $userAgent      user agent of the user whom the acp session belongs to
 * @property-read   int $lastActivityTime   timestamp at which the latest activity occurred
 * @property-read   string $requestURI     uri of the latest request
 * @property-read   string $requestMethod      used request method of the latest request (`GET`, `POST`)
 * @property-read   string $sessionVariables   serialized array with variables stored on a session-basis
 * @deprecated  5.4 Distinct ACP sessions have been removed. This class is preserved due to its use in legacy sessions.
 */
class ACPSession extends DatabaseObject
{
    /**
     * @inheritDoc
     */
    protected static $databaseTableIndexIsIdentity = false;

    /**
     * Returns true if this session type supports persistent logins.
     *
     * @return  bool
     */
    public static function supportsPersistentLogins()
    {
        return false;
    }

    /**
     * Returns the existing session object for given user id or null if there
     * is no such session.
     *
     * @param int $userID
     * @return  ACPSession
     */
    public static function getSessionByUserID($userID)
    {
        $sql = "SELECT  *
                FROM    " . static::getDatabaseTableName() . "
                WHERE   userID = ?";
        $statement = WCF::getDB()->prepareStatement($sql);
        $statement->execute([$userID]);

        return $statement->fetchObject(static::class);
    }
}