Any_Of_Schema
extends Schema
in package
Represents a schema that allows a value to match any of the given schemas.
See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#oneof-and-anyof
Table of Contents
- $schema : array<string|int, array<string|int, mixed>>
- Schema definition.
- __construct() : mixed
- Any_Of_Schema constructor.
- default() : static
- Set the default value.
- description() : static
- Set the description of the schema.
- field() : static
- Set the field name and value.
- non_nullable() : static
- Returns the schema as an array.
- nullable() : static
- Returns the schema as an array.
- optional() : static
- Unsets the required property.
- required() : static
- Sets the schema as required.
- title() : static
- Set the title of the schema.
- to_array() : array<string|int, mixed>
- Returns the schema as an array.
- to_string() : string
- Returns the schema as a JSON string.
- get_reserved_keywords() : array<string|int, string>
- Returns reserved keywords.
- unset_schema_property() : static
- Unsets the schema property.
- update_schema_property() : static
- Updates the schema property.
- validate_pattern() : void
- Validates the regular expression pattern.
Properties
$schema
Schema definition.
protected
array<string|int, array<string|int, mixed>>
$schema
= array('anyOf' => array())
Methods
__construct()
Any_Of_Schema constructor.
public
__construct(array<string|int, Schema> $schemas) : mixed
Parameters
- $schemas : array<string|int, Schema>
-
List of schemas.
Return values
mixed —default()
Set the default value.
public
default(mixed $default_value) : static
Parameters
- $default_value : mixed
-
Default value.
Return values
static —description()
Set the description of the schema.
public
description(string $description) : static
Parameters
- $description : string
-
Description.
Return values
static —field()
Set the field name and value.
public
field(string $name, mixed $value) : static
Parameters
- $name : string
-
Name of the field.
- $value : mixed
-
Value of the field.
Tags
Return values
static —non_nullable()
Returns the schema as an array.
public
non_nullable() : static
Return values
static —nullable()
Returns the schema as an array.
public
nullable() : static
Return values
static —optional()
Unsets the required property.
public
optional() : static
Return values
static —required()
Sets the schema as required.
public
required() : static
Return values
static —title()
Set the title of the schema.
public
title(string $title) : static
Parameters
- $title : string
-
Title.
Return values
static —to_array()
Returns the schema as an array.
public
to_array() : array<string|int, mixed>
Return values
array<string|int, mixed> —to_string()
Returns the schema as a JSON string.
public
to_string() : string
Tags
Return values
string —get_reserved_keywords()
Returns reserved keywords.
protected
get_reserved_keywords() : array<string|int, string>
Return values
array<string|int, string> —unset_schema_property()
Unsets the schema property.
protected
unset_schema_property(string $name) : static
Parameters
- $name : string
-
Property name.
Return values
static —update_schema_property()
Updates the schema property.
protected
update_schema_property(string $name, mixed $value) : static
Parameters
- $name : string
-
Property name.
- $value : mixed
-
Property value.
Return values
static —validate_pattern()
Validates the regular expression pattern.
protected
validate_pattern(string $pattern) : void
Parameters
- $pattern : string
-
Regular expression pattern.