ItemAvailability extends Enumeration
A list of possible product availability options.
Members:
- BackOrder
- Discontinued
- InStock
- InStoreOnly
- LimitedAvailability
- MadeToOrder
- OnlineOnly
- OutOfStock
- PreOrder
- PreSale
- Reserved
- SoldOut
Tags
Table of Contents
Constants
- BACK_ORDER = 'https://schema.org/BackOrder'
- Indicates that the item is available on back order.
- CONTEXT = 'https://schema.org'
- JSON-LD @context declaration for Schema.org.
- DISCONTINUED = 'https://schema.org/Discontinued'
- Indicates that the item has been discontinued.
- IN_STOCK = 'https://schema.org/InStock'
- Indicates that the item is in stock.
- IN_STORE_ONLY = 'https://schema.org/InStoreOnly'
- Indicates that the item is available only at physical locations.
- JSON_PRIORITY_KEYS = [\org\schema\constants\Schema::AT_TYPE, \org\schema\constants\Schema::AT_CONTEXT, \org\schema\constants\Schema::_KEY, \org\schema\constants\Schema::_FROM, \org\schema\constants\Schema::_TO, \org\schema\constants\Schema::ID, \org\schema\constants\Schema::NAME, \org\schema\constants\Schema::URL, \org\schema\constants\Schema::CREATED, \org\schema\constants\Schema::MODIFIED]
- Defines the priority order of keys when serializing the object to JSON-LD.
- LIMITED_AVAILABILITY = 'https://schema.org/LimitedAvailability'
- Indicates that the item has limited availability.
- MADE_TO_ORDER = 'https://schema.org/MadeToOrder'
- Indicates that the item is made to order (custom made).
- ONLINE_ONLY = 'https://schema.org/OnlineOnly'
- Indicates that the item is available only online.
- OUT_OF_STOCK = 'https://schema.org/OutOfStock'
- Indicates that the item is out of stock.
- PRE_ORDER = 'https://schema.org/PreOrder'
- Indicates that the item is available for pre-order.
- PRE_SALE = 'https://schema.org/PreSale'
- Indicates that the item is available for ordering and delivery before general availability.
- RESERVED = 'https://schema.org/Reserved'
- Indicates that the item is reserved and therefore not available.
- SOLD_OUT = 'https://schema.org/SoldOut'
- Indicates that the item has sold out.
Properties
- $_from : string|null
- The metadata to indicates the edge 'from' identifier.
- $_id : null|string
- The metadata identifier of the item.
- $_key : null|string
- The metadata unique key identifier of the thing.
- $_rev : null|string
- The metadata revision value of the thing.
- $_to : string|null
- The metadata to indicates the edge 'to' identifier.
- $active : bool|null
- The active flag.
- $additionalType : array<string|int, mixed>|string|null|object
- An additionalType for the item.
- $alternateName : string|object|array<string|int, mixed>|null
- An alias for the item.
- $created : null|string
- Date of creation of the resource.
- $description : string|object|array<string|int, mixed>|null
- A short description of the item.
- $disambiguatingDescription : string|null
- A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
- $hasPart : string|Thing|array<string|int, Thing>|null
- Indicates an item that this part of this item.
- $id : null|int|string
- The unique identifier of the item.
- $identifier : string|null
- The identifier of the item.
- $image : string|ImageObject|array<string|int, ImageObject|string>|null
- The image reference of this resource.
- $isPartOf : string|Thing|array<string|int, Thing>|null
- Indicates an item that this item is part of.
- $license : string|object|null
- A legal document giving official permission to do something with the resource.
- $mainEntityOfPage : string|null
- Indicates a page (or other CreativeWork) for which this thing is the main entity being described.
- $modified : null|string
- Date on which the resource was changed.
- $name : int|string|null
- The name of the item.
- $owner : null|string|Thing
- The owner of this Thing.
- $potentialAction : array<string|int, mixed>|Action|null
- Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
- $publisher : string|array<string|int, string|Person|Organization>|Person|Organization|null
- The publisher of the resource.
- $sameAs : string|array<string|int, mixed>|null
- URL of a reference Web page that unambiguously indicates the item's identity.
- $subjectOf : null|string|array<string|int, mixed>|CreativeWork|Event
- A CreativeWork or Event about this Thing.
- $supersededBy : null|Type|Enumeration|Property
- $url : int|string|null
- URL of the item.
- $atContext : string|null
- The JSON-LD `@context` value.
- $atType : string|null
- The JSON-LD `@type` value.
Methods
- __construct() : mixed
- Constructor to hydrate public properties from an array or stdClass.
- jsonSerialize() : array<string|int, mixed>
- Serializes the current object into a JSON-LD array.
- withAtContext() : $this
- Sets the internal JSON-LD `@context` attribute.
- withAtType() : $this
- Sets the internal JSON-LD `@type` attribute.
- withJSONLDMeta() : $this
- Initializes both JSON-LD metadata: `@type` and `@context`.
Constants
BACK_ORDER
Indicates that the item is available on back order.
public
mixed
BACK_ORDER
= 'https://schema.org/BackOrder'
CONTEXT
JSON-LD @context declaration for Schema.org.
public
mixed
CONTEXT
= 'https://schema.org'
DISCONTINUED
Indicates that the item has been discontinued.
public
mixed
DISCONTINUED
= 'https://schema.org/Discontinued'
IN_STOCK
Indicates that the item is in stock.
public
mixed
IN_STOCK
= 'https://schema.org/InStock'
IN_STORE_ONLY
Indicates that the item is available only at physical locations.
public
mixed
IN_STORE_ONLY
= 'https://schema.org/InStoreOnly'
JSON_PRIORITY_KEYS
Defines the priority order of keys when serializing the object to JSON-LD.
public
array<string|int, string>
JSON_PRIORITY_KEYS
= [\org\schema\constants\Schema::AT_TYPE, \org\schema\constants\Schema::AT_CONTEXT, \org\schema\constants\Schema::_KEY, \org\schema\constants\Schema::_FROM, \org\schema\constants\Schema::_TO, \org\schema\constants\Schema::ID, \org\schema\constants\Schema::NAME, \org\schema\constants\Schema::URL, \org\schema\constants\Schema::CREATED, \org\schema\constants\Schema::MODIFIED]
Keys listed here will always appear first in the serialized array, in the order specified. All remaining public properties will be sorted alphabetically after these priority keys.
This ensures that important JSON-LD metadata and system fields
(like @type, @context, _key, id, url, created, modified, etc.)
appear at the top of the output for consistency and readability.
Usage:
$orderedKeys = self::JSON_PRIORITY_KEYS;
Notes:
- Can be overridden in a subclass by redefining the constant.
- Late static binding (
static::JSON_PRIORITY_KEYS) allows child classes to modify the serialization order.
List of JSON-LD keys in priority order.
LIMITED_AVAILABILITY
Indicates that the item has limited availability.
public
mixed
LIMITED_AVAILABILITY
= 'https://schema.org/LimitedAvailability'
MADE_TO_ORDER
Indicates that the item is made to order (custom made).
public
mixed
MADE_TO_ORDER
= 'https://schema.org/MadeToOrder'
ONLINE_ONLY
Indicates that the item is available only online.
public
mixed
ONLINE_ONLY
= 'https://schema.org/OnlineOnly'
OUT_OF_STOCK
Indicates that the item is out of stock.
public
mixed
OUT_OF_STOCK
= 'https://schema.org/OutOfStock'
PRE_ORDER
Indicates that the item is available for pre-order.
public
mixed
PRE_ORDER
= 'https://schema.org/PreOrder'
PRE_SALE
Indicates that the item is available for ordering and delivery before general availability.
public
mixed
PRE_SALE
= 'https://schema.org/PreSale'
RESERVED
Indicates that the item is reserved and therefore not available.
public
mixed
RESERVED
= 'https://schema.org/Reserved'
SOLD_OUT
Indicates that the item has sold out.
public
mixed
SOLD_OUT
= 'https://schema.org/SoldOut'
Properties
$_from
The metadata to indicates the edge 'from' identifier.
public
string|null
$_from
$_id
The metadata identifier of the item.
public
null|string
$_id
$_key
The metadata unique key identifier of the thing.
public
null|string
$_key
$_rev
The metadata revision value of the thing.
public
null|string
$_rev
$_to
The metadata to indicates the edge 'to' identifier.
public
string|null
$_to
$active
The active flag.
public
bool|null
$active
$additionalType
An additionalType for the item.
public
array<string|int, mixed>|string|null|object
$additionalType
$alternateName
An alias for the item.
public
string|object|array<string|int, mixed>|null
$alternateName
$created
Date of creation of the resource.
public
null|string
$created
$description
A short description of the item.
public
string|object|array<string|int, mixed>|null
$description
$disambiguatingDescription
A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
public
string|null
$disambiguatingDescription
$hasPart
Indicates an item that this part of this item.
public
string|Thing|array<string|int, Thing>|null
$hasPart
$id
The unique identifier of the item.
public
null|int|string
$id
$identifier
The identifier of the item.
public
string|null
$identifier
$image
The image reference of this resource.
public
string|ImageObject|array<string|int, ImageObject|string>|null
$image
$isPartOf
Indicates an item that this item is part of.
public
string|Thing|array<string|int, Thing>|null
$isPartOf
$license
A legal document giving official permission to do something with the resource.
public
string|object|null
$license
$mainEntityOfPage
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.
public
string|null
$mainEntityOfPage
$modified
Date on which the resource was changed.
public
null|string
$modified
$name
The name of the item.
public
int|string|null
$name
$owner
The owner of this Thing.
public
null|string|Thing
$owner
Represents any entity (person, organization, system, or other object) that can be considered the possessor of this Thing.
$potentialAction
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
public
array<string|int, mixed>|Action|null
$potentialAction
$publisher
The publisher of the resource.
public
string|array<string|int, string|Person|Organization>|Person|Organization|null
$publisher
$sameAs
URL of a reference Web page that unambiguously indicates the item's identity.
public
string|array<string|int, mixed>|null
$sameAs
E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
$subjectOf
A CreativeWork or Event about this Thing.
public
null|string|array<string|int, mixed>|CreativeWork|Event
$subjectOf
$supersededBy
public
null|Type|Enumeration|Property
$supersededBy
$url
URL of the item.
public
int|string|null
$url
$atContext
The JSON-LD `@context` value.
private
string|null
$atContext
= null
Default is https://schema.org.
$atType
The JSON-LD `@type` value.
private
string|null
$atType
= null
This can be manually set or automatically inferred from the class name.
Methods
__construct()
Constructor to hydrate public properties from an array or stdClass.
public
__construct([array<string|int, mixed>|object|null $init = null ]) : mixed
This allows objects to be quickly populated with associative data without manually setting each property.
Parameters
- $init : array<string|int, mixed>|object|null = null
-
A data array or object used to initialize the instance. Keys must match public property names.
Tags
jsonSerialize()
Serializes the current object into a JSON-LD array.
public
jsonSerialize() : array<string|int, mixed>
Includes public properties, the JSON-LD @context and @type.
Null values are automatically removed.
Tags
Return values
array<string|int, mixed> —JSON-LD representation of the object.
withAtContext()
Sets the internal JSON-LD `@context` attribute.
public
withAtContext(string $context) : $this
Useful if you need a custom JSON-LD context.
Parameters
- $context : string
-
Optional JSON-LD context.
Return values
$thiswithAtType()
Sets the internal JSON-LD `@type` attribute.
public
withAtType(string $type) : $this
Allows overriding the default type inferred from the class.
Parameters
- $type : string
-
Optional JSON-LD type
Return values
$thiswithJSONLDMeta()
Initializes both JSON-LD metadata: `@type` and `@context`.
public
withJSONLDMeta([string|null $atType = null ][, string|null $atContext = null ]) : $this
Can be called from constructor or later to override default values.
Parameters
- $atType : string|null = null
-
Optional JSON-LD type
- $atContext : string|null = null
-
Optional JSON-LD context