ApiUsersTable.php

Go to the documentation of this file.

<?php

namespace Elgg\Database;

use Elgg\Database;
use Elgg\Security\Crypto;

class ApiUsersTable {
    
    public const TABLE_NAME = 'api_users';
    
    public function __construct(protected Database $database, protected Crypto $crypto) {
    }
    
    public function createApiUser() {
        $public = $this->crypto->getRandomString(40, Crypto::CHARS_HEX);
        $secret = $this->crypto->getRandomString(40, Crypto::CHARS_HEX);
        
        $insert = Insert::intoTable(self::TABLE_NAME);
        $insert->values([
            'api_key' => $insert->param($public, ELGG_VALUE_STRING),
            'secret' => $insert->param($secret, ELGG_VALUE_STRING),
        ]);
        
        if ($this->database->insertData($insert) === false) {
            return false;
        }
        
        return $this->getApiUser($public);
    }
    
    public function getApiUser(string $public_api_key, bool $only_active = true) {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('*')
            ->where($select->compare('api_key', '=', $public_api_key, ELGG_VALUE_STRING));
        
        if ($only_active) {
            $select->andWhere($select->compare('active', '=', 1, ELGG_VALUE_INTEGER));
        }
        
        return $this->database->getDataRow($select) ?: false;
    }
    
    public function removeApiUser(string $public_api_key): bool {
        $row = $this->getApiUser($public_api_key);
        if (empty($row)) {
            return false;
        }
        
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('id', '=', $row->id, ELGG_VALUE_ID));
        
        return (bool) $this->database->deleteData($delete);
    }
    
    public function enableAPIUser(string $public_api_key): bool {
        $update = Update::table(self::TABLE_NAME);
        $update->set('active', $update->param(1, ELGG_VALUE_INTEGER))
            ->where($update->compare('api_key', '=', $public_api_key, ELGG_VALUE_STRING));
        
        return (bool) $this->database->updateData($update);
    }
    
    public function disableAPIUser(string $public_api_key): bool {
        $update = Update::table(self::TABLE_NAME);
        $update->set('active', $update->param(0, ELGG_VALUE_INTEGER))
            ->where($update->compare('api_key', '=', $public_api_key, ELGG_VALUE_STRING));
        
        return (bool) $this->database->updateData($update);
    }
}