API Responses GetStoreResponse - evansims/openfga-php GitHub Wiki
Response containing detailed information about a specific store. This response provides comprehensive store metadata including its unique identifier, name, and timestamps for creation, updates, and deletion (if applicable). Use this to retrieve information about an authorization store.
Table of Contents
OpenFGA\Responses
- GetStoreResponseInterface (interface)
- GetStoreRequest (request)
Implements Responses\GetStoreResponseInterface
public function fromResponse(
HttpResponseInterface $response,
HttpRequestInterface $request,
SchemaValidatorInterface $validator,
): staticCreate a response instance from an HTTP response. This method transforms a raw HTTP response from the OpenFGA API into a structured response object, validating and parsing the response data according to the expected schema. It handles both successful responses by parsing and validating the data, and error responses by throwing appropriate exceptions.
| Name | Type | Description |
|---|---|---|
$response |
HttpResponseInterface |
The raw HTTP response from the OpenFGA API |
$request |
HttpRequestInterface |
The original HTTP request that generated this response |
$validator |
SchemaValidatorInterface |
Schema validator for parsing and validating response data |
static — The parsed and validated response instance containing the API response data
public function getCreatedAt(): DateTimeImmutableGet the timestamp when the store was created. Returns the exact moment when the store was successfully created in the OpenFGA system. This timestamp is immutable and set by the server upon store creation.
DateTimeImmutable — The creation timestamp of the store
public function getDeletedAt(): ?DateTimeImmutableGet the timestamp when the store was deleted, if applicable. Returns the deletion timestamp for soft-deleted stores, or null if the store is active. This is used for stores that have been marked for deletion but may still be accessible for a grace period.
DateTimeImmutable | null — The deletion timestamp, or null if the store is not deleted
public function getId(): stringGet the unique identifier of the store. Returns the system-generated unique identifier for the store. This ID is used in all API operations to reference this specific store.
string — The unique store identifier
public function getName(): stringGet the human-readable name of the store. Returns the descriptive name that was assigned to the store during creation or last update. This name is used for identification and administrative purposes.
string — The descriptive name of the store
public function getStore(): OpenFGA\Models\StoreInterfaceGet the complete store object. Returns the full store object containing all store metadata and configuration. This provides access to the complete store data structure including any additional properties beyond the individual accessor methods.
StoreInterface — The complete store object
public function getUpdatedAt(): DateTimeImmutableGet the timestamp when the store was last updated. Returns the timestamp of the most recent modification to the store's metadata or configuration. This is updated whenever store properties are changed.
DateTimeImmutable — The last update timestamp of the store
Implements Responses\GetStoreResponseInterface
public function schema(): SchemaInterfaceGet the schema definition for this response. Returns the schema that defines the structure and validation rules for store retrieval response data, ensuring consistent parsing and validation of API responses.
SchemaInterface — The schema definition for response validation