Oihana Php Schema

ParcelDelivery extends Intangible

The delivery of a parcel either via the postal service or a commercial service.

Constants

CONTEXT : string = 'https://schema.org': JSON-LD @context declaration for Schema.org.
JSON_PRIORITY_KEYS : array<string|int, mixed> = [\org\schema\constants\Schema::AT_TYPE, \org\sc...: Defines the priority order of keys when serializing the object to JSON-LD.

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 visibility 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.
$deliveryAddress : null|array<string|int, mixed>|string|PostalAddress: Destination address.
$deliveryStatus : DeliveryEvent|null|array<string|int, mixed>: New entry added as the package passes through each leg of its journey (from shipment to final delivery).
$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.
$expectedArrivalFrom : null|string|int: The earliest date the package may arrive.
$expectedArrivalUntil : null|string|int: The latest date the package may arrive.
$hasDeliveryMethod : null|array<string|int, mixed>|string|DeliveryMethod|DefinedTerm: Method used for delivery or shipping.
$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.
$itemShipped : array<string|int, mixed>|Product|null: Item(s) being shipped.
$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.
$originAddress : null|string|array<string|int, mixed>|PostalAddress: Shipper's address.
$owner : null|string|Thing: The owner of this Thing.
$partOfOrder : null|array<string|int, mixed>|Order: The overall order the items in this delivery were included in.
$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.
$provider : null|array<string|int, mixed>|Organization|Person: The service provider, service operator, or service performer; the goods producer.
$publisher : string|array<string|int, string|Person|Organization>|Person|Organization|null: The publisher of the resource.
$requestedDeliveryDate : null|string|int: The date the customer asks the parcel to be delivered on.
$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.
$trackingNumber : null|string: Shipper tracking number.
$trackingUrl : null|string: Tracking url for the parcel delivery.
$url : int|string|null: URL of the item.
$atContext : string|null: The JSON-LD `@context` value.
$atType : string|null: The JSON-LD `@type` value.
$DEFAULT_JSON_SERIALIZE_OPTIONS : array<string|int, mixed>: The default static jsonSerialize options (class-level configuration).
$schemaTypeCache : array<string, string>: Internal cache for resolved schema types.

Methods

__construct() : mixed: Constructor to hydrate public properties from an array or stdClass.
getJsonSerializeOptions() : array<string|int, mixed>: Returns the default JSON serialization options.
getSchemaType() : string: Returns the fully qualified URI of the schema type.
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`.

CONTEXT

JSON-LD @context declaration for Schema.org.


    public
        string
    CONTEXT
    = 'https://schema.org'

JSON_PRIORITY_KEYS

Defines the priority order of keys when serializing the object to JSON-LD.


    public
        array<string|int, mixed>
    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.

$_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 visibility 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

$deliveryAddress

Destination address.


        public
            null|array<string|int, mixed>|string|PostalAddress
    $deliveryAddress

Accepts a raw associative array so a row read straight from storage can be assigned as-is, exactly like BusinessDocument::$billingAddress.

$deliveryStatus

New entry added as the package passes through each leg of its journey (from shipment to final delivery).


        public
            DeliveryEvent|null|array<string|int, mixed>
    $deliveryStatus

$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

$expectedArrivalFrom

The earliest date the package may arrive.


        public
            null|string|int
    $expectedArrivalFrom

$expectedArrivalUntil

The latest date the package may arrive.


        public
            null|string|int
    $expectedArrivalUntil

$hasDeliveryMethod

Method used for delivery or shipping.


        public
            null|array<string|int, mixed>|string|DeliveryMethod|DefinedTerm
    $hasDeliveryMethod

This property may be expressed as a predefined DeliveryMethod, a DefinedTerm — which covers the house, priced delivery terms a back office maintains in its own thesaurus — a string identifier, or a list of such values. Same union as Site::$deliveryMethod and Company::$deliveryMethod.

$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

$itemShipped

Item(s) being shipped.


        public
            array<string|int, mixed>|Product|null
    $itemShipped

$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

$originAddress

Shipper's address.


        public
            null|string|array<string|int, mixed>|PostalAddress
    $originAddress

$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.

$partOfOrder

The overall order the items in this delivery were included in.


        public
            null|array<string|int, mixed>|Order
    $partOfOrder

$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

$provider

The service provider, service operator, or service performer; the goods producer.


        public
            null|array<string|int, mixed>|Organization|Person
    $provider

Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

The Organization|Person union cannot be resolved from the property type alone — reflection picks the first class member, so a Person payload would come out an Organization. The attribute pins the candidates, which lets a payload carrying a JSON-LD @type discriminator land on the right one. A payload without that discriminator still falls back to Organization : hydrateOrganizationOrPerson() is what a caller reaches for when it needs more than the attribute can give.

#[HydrateWith]: \org\schema\Organization::class; \org\schema\Person::class

$publisher

The publisher of the resource.


        public
            string|array<string|int, string|Person|Organization>|Person|Organization|null
    $publisher

$requestedDeliveryDate

The date the customer asks the parcel to be delivered on.


        public
            null|string|int
    $requestedDeliveryDate

This is an intent, stated when the delivery is ordered — not an estimate : ParcelDelivery::$expectedArrivalFrom and ParcelDelivery::$expectedArrivalUntil say when the parcel may arrive, as bounded by the carrier, and stay free to express that window later on, once the carrier has answered.

$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

$trackingNumber

Shipper tracking number.


        public
            null|string
    $trackingNumber

$trackingUrl

Tracking url for the parcel delivery.


        public
            null|string
    $trackingUrl

$url

URL of the item.


        public
            int|string|null
    $url

$atContext

The JSON-LD `@context` value.


        protected
            string|null
    $atContext
     = null

Default is https://schema.org.

$atType

The JSON-LD `@type` value.


        protected
            string|null
    $atType
     = null

This can be manually set or automatically inferred from the class name.

$DEFAULT_JSON_SERIALIZE_OPTIONS

The default static jsonSerialize options (class-level configuration).


        protected
        static    array<string|int, mixed>
    $DEFAULT_JSON_SERIALIZE_OPTIONS
     = []

$schemaTypeCache

Internal cache for resolved schema types.


        private
        static    array<string, string>
    $schemaTypeCache
     = []

__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.

getJsonSerializeOptions()

Returns the default JSON serialization options.


    public
                    getJsonSerializeOptions() : array<string|int, mixed>

This method determines how the jsonSerialize() output is reduced or compressed, etc. It can be overridden in child classes to customize serialization behavior.

Return values

array<string|int, mixed> —

Returns the reduction/compression options for JSON serialization.

getSchemaType()

Returns the fully qualified URI of the schema type.


    public
            static        getSchemaType() : string

This method combines the class's CONTEXT constant with its short name to produce a globally unique identifier for the entity type.

It uses Late Static Binding to ensure the correct context is retrieved even when called from an inherited class (e.g., Corporation vs. Affiliate).
Performance Optimization: Results are stored in a static cache ($schemaTypeCache) to avoid redundant Reflection calls during the same execution lifecycle.

Return values

string —

The absolute URI of the type (e.g., "https://schema.org/Thing"). ** @example

echo Thing::getSchemaType();      // https://schema.org/Thing
echo Affiliate::getSchemaType();  // https://schema.oihana.xyz/Pagination

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.

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

$this

withAtType()

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

$this

withJSONLDMeta()

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

Return values

$this

ParcelDelivery extends Intangible

Tags

Table of Contents

Constants

Properties

Methods

Constants

CONTEXT

JSON_PRIORITY_KEYS

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalType

$alternateName

$created

$deliveryAddress

$deliveryStatus

$description

$disambiguatingDescription

$expectedArrivalFrom

$expectedArrivalUntil

$hasDeliveryMethod

$hasPart

$id

$identifier

$image

$isPartOf

$itemShipped

$license

$mainEntityOfPage

$modified

$name

$originAddress

$owner

$partOfOrder

$potentialAction

$provider

Attributes

$publisher

$requestedDeliveryDate

Tags

$sameAs

$subjectOf

$trackingNumber

$trackingUrl

$url

$atContext

$atType

$DEFAULT_JSON_SERIALIZE_OPTIONS

$schemaTypeCache

Methods

__construct()

Parameters

Tags

getJsonSerializeOptions()

Return values

getSchemaType()

Return values

jsonSerialize()

Tags

Return values

withAtContext()

Parameters

Return values

withAtType()

Parameters

Return values

withJSONLDMeta()

Parameters

Return values