API Models ConditionParameter - evansims/openfga-php GitHub Wiki
Represents a parameter type definition for ABAC conditions. ConditionParameter defines the type structure for parameters used in attribute-based access control conditions. It specifies the data type (string, int, list, map, etc.) and any generic type parameters for complex types like collections. Use this when defining the expected parameter types for conditions in your authorization model.
Table of Contents
OpenFGA\Models
ConditionParameterInterfaceJsonSerializableModelInterface
- ConditionParameterInterface (interface)
- ConditionParameters (collection)
| Name | Value | Description |
|---|---|---|
OPENAPI_MODEL |
ConditionParamTypeRef |
public function getGenericTypes(): ?OpenFGA\Models\Collections\ConditionParametersInterfaceGet the generic type parameters for complex types like maps and lists. This provides the nested type information for complex parameter types. For example, a map parameter would have generic types defining the key and value types, while a list parameter would define the element type.
ConditionParametersInterface | null
public function getTypeName(): OpenFGA\Models\Enums\TypeNameGet the primary type name of the parameter. This returns the fundamental type of the condition parameter, such as string, int, bool, list, map, etc. This type information is used during condition evaluation to ensure type safety.
TypeName — The type name enum value for this parameter
public function jsonSerialize(): arrayarray
Implements Models\ConditionParameterInterface
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