This repository was archived by the owner on Nov 7, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
API README
Evan Sims edited this page Jun 17, 2025
·
10 revisions
Total Components: 6
| Directory | Description |
|---|---|
Authentication |
Authentication providers and token management for OpenFGA API access. |
Context |
|
Events |
Event system for cross-cutting concerns like logging and metrics collection. |
Exceptions |
Exception hierarchy for type-safe error handling throughout the SDK. |
Integration |
Framework integration helpers and service providers. |
Models |
Domain models representing OpenFGA entities like stores, tuples, and authorization models. |
Network |
HTTP client abstractions, retry strategies, and low-level networking components. |
Observability |
Telemetry providers and monitoring integrations for operational visibility. |
Repositories |
Data access interfaces and implementations for managing OpenFGA resources. |
Requests |
Request objects for all OpenFGA API operations. |
Responses |
Response objects containing API results and metadata. |
Results |
Result pattern implementation for functional error handling without exceptions. |
Schemas |
JSON schema validation for ensuring data integrity and type safety. |
Services |
Business logic services that orchestrate between repositories and external systems. |
Translation |
Internationalization support and message translation utilities. |
| Name | Description |
|---|---|
ClientInterface |
OpenFGA Client Interface for relationship-based access control operations. This interface defines... |
TransformerInterface |
OpenFGA DSL Transformer Interface for authorization model conversions. This interface defines met... |
| Name | Description |
|---|---|
Client |
OpenFGA Client implementation for relationship-based access control operations. This client provi... |
Transformer |
OpenFGA DSL Transformer implementation for authorization model conversions. This class provides c... |
| Name | Description |
|---|---|
Language |
Supported languages for OpenFGA SDK internationalization. This enum represents all available lang... |
Messages |
Centralized message keys for all exception messages in the OpenFGA PHP SDK. This enum provides ty... |
Getting Started: Introduction • Installation • Authentication
Essentials: Stores • Authorization Models • Relationship Tuples • Permissions Queries
Features: Helper Functions • Concurrency • Results • Exceptions • Observability • Integration
- API Reference - Full class and method documentation
- Quickstart - Get up and running in minutes
- Helpers - Convenient shortcuts for common operations
- Testing Guide - Unit testing with the SDK
- Performance Guide - Optimize for high-scale applications
- Report Issues - Bug reports and feature requests
- Discussions - Community support and questions
- Contributing - Help improve the SDK
- Changelog - Latest updates and releases
- OpenFGA Documentation - Official OpenFGA documentation
- OpenFGA Playground - Interactive modeling environment
- Authorization Concepts - Learn relationship-based access control
- Other SDKs - JavaScript, Go, Python, .NET, and more
OpenFGA PHP SDK • Apache 2.0 License
- Authorization Stores
- Authorization Models
- Relationship Tuples
- Permission Queries
- Testing with Assertions
- Helper Functions
- Concurrency
- Error Handling
- Framework Integration
- OpenTelemetry Observability
- Result Pattern
- Event Dispatcher
- HTTP Request Sent Event
- HTTP Response Received Event
- Operation Started Event
- Operation Completed Event
- More Events …
- Authentication Exception
- Client Exception
- Configuration Exception
- Network Exception
- Serialization Exception
- More Exceptions …
- Request Manager
- Request Context
- Circuit Breaker
- Parallel Task Executor
- Fiber Concurrent Executor
- Simple Concurrent Executor
- Retry Handler
- Exponential Backoff Retry Strategy
- More Networking …