2023-04-15 15:08:07 +00:00
|
|
|
```
|
|
|
|
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
|
|
|
|
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
|
|
|
|
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
|
|
|
|
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
|
|
|
|
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
|
|
|
|
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
|
|
|
|
```
|
|
|
|
# class Gpg (Details)
|
|
|
|
> namespace: **VDM\Joomla\Gitea\User**
|
2023-10-10 09:39:23 +00:00
|
|
|
> extends: **Api**
|
2023-04-15 15:08:07 +00:00
|
|
|
```uml
|
|
|
|
@startuml
|
|
|
|
class Gpg #Gold {
|
|
|
|
+ createGPGKey(string $armoredPublicKey, ?string $armoredSignature = null) : ?object
|
|
|
|
+ get(int $id) : ?object
|
|
|
|
+ token() : ?string
|
|
|
|
+ verify(string $armoredPublicKey) : ?object
|
|
|
|
+ list(int $page = 1, int $limit = 10) : ?array
|
|
|
|
+ remove(int $id) : string
|
|
|
|
}
|
|
|
|
|
|
|
|
note right of Gpg::createGPGKey
|
|
|
|
Create a GPG key for the authenticated user.
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?object
|
|
|
|
end note
|
|
|
|
|
|
|
|
note right of Gpg::get
|
|
|
|
Get a GPG key for the authenticated user.
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?object
|
|
|
|
end note
|
|
|
|
|
|
|
|
note right of Gpg::token
|
|
|
|
Get a token to verify.
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?string
|
|
|
|
end note
|
|
|
|
|
|
|
|
note right of Gpg::verify
|
|
|
|
Verify a GPG key.
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?object
|
|
|
|
end note
|
|
|
|
|
|
|
|
note right of Gpg::list
|
|
|
|
List the authenticated user's GPG keys.
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?array
|
|
|
|
end note
|
|
|
|
|
|
|
|
note right of Gpg::remove
|
|
|
|
Remove a GPG key for the authenticated user.
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: string
|
|
|
|
end note
|
|
|
|
|
|
|
|
@enduml
|
|
|
|
```
|
|
|
|
|
|
|
|
---
|
|
|
|
```
|
|
|
|
██╗ ██████╗██████╗
|
|
|
|
██║██╔════╝██╔══██╗
|
|
|
|
██║██║ ██████╔╝
|
|
|
|
██ ██║██║ ██╔══██╗
|
|
|
|
╚█████╔╝╚██████╗██████╔╝
|
|
|
|
╚════╝ ╚═════╝╚═════╝
|
|
|
|
```
|
|
|
|
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)
|
|
|
|
|