API Models RelationMetadataInterface - evansims/openfga-php GitHub Wiki

Represents metadata associated with a relation in OpenFGA authorization models. Relation metadata provides additional context and constraints for relations defined in type definitions. This metadata helps with: - Type safety by defining which user types can be directly related - Development tooling by providing source file information - Model organization through module names - Validation and error reporting The metadata is particularly important for: - Ensuring that only appropriate user types can be assigned to relations - Providing helpful error messages when model validation fails - Supporting development tools that work with authorization models - Organizing complex models across multiple modules or files

OpenFGA\Models

View source code

• ModelInterface
• JsonSerializable

• RelationMetadata (implementation)

public function getDirectlyRelatedUserTypes(): RelationReferencesInterface|null

Get the user types that can be directly related through this relation. This defines which types of users can have this relation to objects, providing type safety and helping with authorization model validation. For example, a "member" relation might allow "user" and "group" types.

View source

RelationReferencesInterface | null — The directly related user types, or null if not specified

public function getModule(): string|null

Get the optional module name for organization. This provides organizational information about which module or namespace contains the relation definition, helping with model organization and debugging.

View source

string | null — The module name, or null if not specified

public function getSourceInfo(): SourceInfoInterface|null

Get optional source file information for debugging and tooling. This provides information about the source file where the relation was originally defined, which is useful for development tools, debugging, and error reporting.

View source

SourceInfoInterface | null — The source file information, or null if not available

public function jsonSerialize(): array

View source

array