API Models BatchCheckItem - evansims/openfga-php GitHub Wiki
Represents a single item in a batch check request. Each batch check item contains a tuple key to check, an optional context, optional contextual tuples, and a correlation ID to map the result back to this specific check.
Table of Contents
OpenFGA\Models
BatchCheckItemInterfaceJsonSerializableModelInterface
- BatchCheckItemInterface (interface)
- BatchCheckItems (collection)
| Name | Value | Description |
|---|---|---|
OPENAPI_MODEL |
BatchCheckItem |
public function getContext(): ?objectGet the context object for this check. This provides additional context data that can be used by conditions in the authorization model during evaluation.
object | null
public function getContextualTuples(): ?OpenFGA\Models\Collections\TupleKeysInterfaceGet the contextual tuples for this check. These are additional tuples that are evaluated only for this specific check and are not persisted in the store.
TupleKeysInterface | null
public function getCorrelationId(): stringGet the correlation ID for this batch check item. This unique identifier maps the result back to this specific check. Must be alphanumeric characters or hyphens, maximum 36 characters.
string — The correlation ID
public function getTupleKey(): OpenFGA\Models\TupleKeyInterfaceGet the tuple key to be checked. This defines the user, relation, and object for the authorization check.
TupleKeyInterface — The tuple key for this check
public function jsonSerialize(): array<string, mixed>array<string, mixed>
Implements Models\BatchCheckItemInterface
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
public function toArray(): array<string, mixed>array<string, mixed>