API Models ConditionMetadata - evansims/openfga-php GitHub Wiki
Contains metadata information about conditions in your authorization model. ConditionMetadata provides context about ABAC (Attribute-Based Access Control) conditions, including module organization and source information for debugging. This helps you understand where conditions are defined and how they're structured within your authorization model. Use this when working with conditional authorization rules that depend on runtime attributes and context data.
Table of Contents
OpenFGA\Models
ConditionMetadataInterfaceJsonSerializableModelInterface
- ConditionMetadataInterface (interface)
| Name | Value | Description |
|---|---|---|
OPENAPI_MODEL |
ConditionMetadata |
public function getModule(): stringGet the module name where the condition is defined. This provides organizational information about which module or namespace contains the condition definition, helping with debugging and understanding the model structure.
string — The module name containing the condition
public function getSourceInfo(): OpenFGA\Models\SourceInfoInterfaceGet source file information for debugging and tooling. This provides information about the source file where the condition was originally defined, which is useful for development tools, debugging, and error reporting.
SourceInfoInterface — The source file information
public function jsonSerialize(): arrayarray
Implements Models\ConditionMetadataInterface
public function schema(): SchemaInterfaceGet the schema definition for this model. This method returns the schema that defines the structure, validation rules, and serialization behavior for this model class. The schema is used for data validation, transformation, and ensuring consistency across API operations with the OpenFGA service. Each model's schema defines: - Required and optional properties - Data types and format constraints - Nested object relationships - Validation rules and business logic constraints The schema system enables the SDK to automatically validate incoming data, transform between different representations, and ensure compliance with the OpenFGA API specification.
SchemaInterface — The schema definition containing validation rules and property specifications for this model