UsersApiSessionsTable.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Database;
 
use Elgg\Database;
use Elgg\Security\Crypto;
use Elgg\Traits\TimeUsing;
 
class UsersApiSessionsTable {
    
    use TimeUsing;
    
    public const TABLE_NAME = 'users_apisessions';
    
    public function __construct(protected Database $database, protected Crypto $crypto) {
    }
    
    public function createToken(int $user_guid, int $expires = 60): string|false {
        $token = $this->crypto->getRandomString(32, Crypto::CHARS_HEX);
        $expires = $this->getCurrentTime("+{$expires} minutes");
        
        $insert = Insert::intoTable(self::TABLE_NAME);
        $insert->values([
            'user_guid' => $insert->param($user_guid, ELGG_VALUE_GUID),
            'token' => $insert->param($token, ELGG_VALUE_STRING),
            'expires' => $insert->param($expires->getTimestamp(), ELGG_VALUE_TIMESTAMP),
        ]);
        
        return $this->database->insertData($insert) ? $token : false;
    }
    
    public function getUserTokens(int $user_guid) {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('*')
            ->where($select->compare('user_guid', '=', $user_guid, ELGG_VALUE_GUID));
        
        return $this->database->getData($select);
    }
    
    public function validateToken(string $token): int|false {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('*')
            ->where($select->compare('token', '=', $token, ELGG_VALUE_STRING))
            ->andWhere($select->compare('expires', '>', $this->getCurrentTime()->getTimestamp(), ELGG_VALUE_TIMESTAMP));
        
        $row = $this->database->getDataRow($select);
        
        return $row ? (int) $row->user_guid : false;
    }
    
    public function removeToken(string $token) {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('token', '=', $token, ELGG_VALUE_STRING));
        
        return (bool) $this->database->deleteData($delete);
    }
    
    public function removeExpiresTokens() {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('expires', '<', $this->getCurrentTime()->getTimestamp(), ELGG_VALUE_TIMESTAMP));
        
        return $this->database->deleteData($delete);
    }
}