Elgg
Version 4.3
|
Manage the contents of the api_users table. More...
Public Member Functions | |
__construct (Database $database, Crypto $crypto) | |
Create a new table handler. More... | |
createApiUser () | |
Generate a new API user for a site, returning a new keypair on success. More... | |
getApiUser (string $public_api_key, bool $only_active=true) | |
Find an API User's details based on the provided public api key. More... | |
removeApiUser (string $public_api_key) | |
Revoke an api user key. More... | |
enableAPIUser (string $public_api_key) | |
Enable an api user key. More... | |
disableAPIUser (string $public_api_key) | |
Disable an api user key. More... | |
Protected Attributes | |
$database | |
$crypto | |
$table = 'api_users' | |
Manage the contents of the api_users table.
Definition at line 14 of file ApiUsersTable.php.
Create a new table handler.
Definition at line 37 of file ApiUsersTable.php.
Elgg\Database\ApiUsersTable::createApiUser | ( | ) |
Generate a new API user for a site, returning a new keypair on success.
Definition at line 47 of file ApiUsersTable.php.
Elgg\Database\ApiUsersTable::disableAPIUser | ( | string | $public_api_key | ) |
Disable an api user key.
string | $public_api_key | The API Key (public) |
Definition at line 131 of file ApiUsersTable.php.
Elgg\Database\ApiUsersTable::enableAPIUser | ( | string | $public_api_key | ) |
Enable an api user key.
string | $public_api_key | The API Key (public) |
Definition at line 116 of file ApiUsersTable.php.
Elgg\Database\ApiUsersTable::getApiUser | ( | string | $public_api_key, |
bool | $only_active = true |
||
) |
Find an API User's details based on the provided public api key.
These users are not users in the traditional sense.
string | $public_api_key | The API Key (public) |
bool | $only_active | Only return if the API key is active (default: true) |
Definition at line 73 of file ApiUsersTable.php.
Elgg\Database\ApiUsersTable::removeApiUser | ( | string | $public_api_key | ) |
Revoke an api user key.
string | $public_api_key | The API Key (public) |
Definition at line 97 of file ApiUsersTable.php.
|
protected |
Definition at line 24 of file ApiUsersTable.php.
|
protected |
Definition at line 19 of file ApiUsersTable.php.
|
protected |
Definition at line 29 of file ApiUsersTable.php.