WritableSecretStoreInterface
extends
SecretStoreInterface
in
Table of Contents
Methods
- delete() : void
- Delete a secret value.
- exists() : bool
- Return true if a secret name exists without revealing or decrypting its value.
- get() : SensitiveString|null
- Fetch a secret value.
- list() : array<int, string>
- put() : void
- Store or replace a secret value.
- rotatedAt() : DateTimeImmutable|null
- Return when a secret was last rotated, if known, without revealing the value.
Methods
delete()
Delete a secret value.
public
delete(string $name) : void
Parameters
- $name : string
-
Secret name
exists()
Return true if a secret name exists without revealing or decrypting its value.
public
exists(string $name) : bool
Parameters
- $name : string
Return values
boolget()
Fetch a secret value.
public
get(string $name) : SensitiveString|null
Parameters
- $name : string
-
Secret name
Return values
SensitiveString|nulllist()
public
list([string $prefix = '' ]) : array<int, string>
Parameters
- $prefix : string = ''
Return values
array<int, string> —Secret names only; never values.
put()
Store or replace a secret value.
public
put(string $name, SensitiveString $value) : void
Parameters
- $name : string
-
Secret name
- $value : SensitiveString
-
Secret value
rotatedAt()
Return when a secret was last rotated, if known, without revealing the value.
public
rotatedAt(string $name) : DateTimeImmutable|null
Parameters
- $name : string
-
Secret name