API Exceptions DefaultMessages - evansims/openfga-php GitHub Wiki

Maps exception error enums to their default message keys. This class provides the concrete implementation for mapping various error enum types to their corresponding translation message keys. It maintains comprehensive mappings for all error categories in the OpenFGA SDK, enabling consistent and translatable error messages. The class uses static arrays to maintain mappings between error enum values and message keys, providing fast lookup performance while keeping the mappings centralized and maintainable. Each error category has its own mapping array and corresponding method for type-safe access. Error categories supported: - Authentication errors: Token expiration, invalid credentials - Client errors: General validation and usage failures - Configuration errors: Missing PSR components, setup issues - Network errors: HTTP failures, timeouts, connectivity issues - Serialization errors: JSON parsing, schema validation failures

OpenFGA\Exceptions

View source code

• DefaultMessagesInterface

• DefaultMessagesInterface (interface)

Implements Exceptions\DefaultMessagesInterface

public function forAuthenticationError(AuthenticationError $error): Messages

Get the default message key for an authentication error. Maps authentication-related error types (such as expired tokens or invalid credentials) to their corresponding message keys. These messages typically guide users on how to resolve authentication issues with the OpenFGA service.

View source

Messages — The corresponding message enum case for translation

Implements Exceptions\DefaultMessagesInterface

public function forClientError(ClientError $error): Messages

Get the default message key for a general client error. Maps high-level client error categories to their corresponding message keys. These are broad error classifications that encompass various types of SDK usage and operational failures.

View source

Messages — The corresponding message enum case for translation

Implements Exceptions\DefaultMessagesInterface

public function forConfigurationError(ConfigurationError $error): Messages

Get the default message key for a configuration error. Maps configuration-related error types (such as missing PSR components or invalid setup) to their corresponding message keys. These messages typically provide guidance on proper SDK configuration and setup.

View source

Messages — The corresponding message enum case for translation

Implements Exceptions\DefaultMessagesInterface

public function forError(
    AuthenticationError|ClientError|ConfigurationError|NetworkError|SerializationError $error,
): Messages

Get the default message key for any supported error type. Generic method that accepts any error enum type and routes it to the appropriate specific method. This provides a unified interface for error message lookup when the specific error type is not known at compile time.

View source

Messages — The corresponding message enum case for translation

Implements Exceptions\DefaultMessagesInterface

public function forNetworkError(NetworkError $error): Messages

Get the default message key for a network error. Maps network and HTTP-related error types (such as timeouts, HTTP status codes, or connectivity issues) to their corresponding message keys. These messages often include information about retry strategies and network troubleshooting.

View source

Messages — The corresponding message enum case for translation

Implements Exceptions\DefaultMessagesInterface

public function forSerializationError(SerializationError $error): Messages

Get the default message key for a serialization error. Maps data serialization and validation error types (such as JSON parsing failures or schema validation errors) to their corresponding message keys. These messages typically provide details about data format issues and validation failures.

View source

Messages — The corresponding message enum case for translation