Oihana Php Schema

DeliveryRouteTerm extends ThesaurusTerm uses DeliveryRouteTermTrait

A delivery route : the recurring circuit an own-fleet vehicle runs — leaving a given warehouse, on given days of the week, to serve the addresses assigned to it.

Where DeliveryMethodTerm answers how an order travels (counter pick-up, carrier, own fleet) and what that costs, this term answers on which passage it travels. The two are orthogonal : a dozen routes may all be run under the single "own fleet" method, and a route carries no charge of its own.

A back office maintains this list alongside its other reference data, which is why the class is a ThesaurusTerm first — referenced by its id from sites and business documents, and enriched here with the two values that describe the circuit itself.

The days a route runs

byDay holds the days the vehicle is on the road, as DayOfWeek constants — the vocabulary Schedule::$byDay uses, so a consumer that already reads schedules reads a route with the same code.

An empty list is meaningful and must be kept : a route defined but not yet scheduled runs no day at all, which is not the same thing as null (nothing was said about its days).

Beware of the distinction with DeliveryRouteAssignment::$byDay, which is narrower : this property says when the route runs, the assignment says when it serves one given address. The second is always a subset of the first.

Where the route departs from

assignedPOS names the warehouse the vehicle leaves from — the same word, and the same shape, Customer::$assignedPOS uses for the point of sale a customer is attached to. It holds the raw warehouse reference as read, or the resolved Warehouse once the reference data has been joined.

null means no warehouse is assigned : back offices commonly encode that absence as a zero, which a consumer normalizes away on ingestion rather than letting a route claim to depart from a warehouse that does not exist.

Example

use org\schema\enumerations\DayOfWeek;
use xyz\oihana\schema\thesaurus\DeliveryRouteTerm;

$route = new DeliveryRouteTerm
([
    'id'                             => '01D' ,
    'name'                           => 'West coast, midweek' ,
    DeliveryRouteTerm::ASSIGNED_POS => '1' ,
    DeliveryRouteTerm::BY_DAY       => [ DayOfWeek::WEDNESDAY , DayOfWeek::FRIDAY ] ,
]);

Constants

ASSIGNED_POS : string = 'assignedPOS'
BY_DAY : string = 'byDay'
COLOR : string = 'color': A house color, expressed as a `#RRGGBB` hex string.
CONTEXT : string = \xyz\oihana\schema\constants\Oihana::SCHEMA: The @context of the json-ld representation of the thing.
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.
$assignedPOS : null|int|string|array<string|int, mixed>|Warehouse: The warehouse the route departs from.
$byDay : null|array<string|int, mixed>|string|DayOfWeek: The days of the week the route runs, as {@see DayOfWeek} constants.
$color : string|null: An optional house color, expressed as a `#RRGGBB` hex string.
$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.
$inDefinedTermSet : string|DefinedTermSet|null: A DefinedTermSet that contains this term.
$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.
$termCode : string|null: A code that identifies this DefinedTerm within a DefinedTermSet.
$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`.

ASSIGNED_POS


    public
        string
    ASSIGNED_POS
    = 'assignedPOS'

BY_DAY


    public
        string
    BY_DAY
    = 'byDay'

COLOR

A house color, expressed as a `#RRGGBB` hex string.


    public
        string
    COLOR
    = 'color'

Related model property:

public ?string $color ;

CONTEXT

The @context of the json-ld representation of the thing.


    public
        string
    CONTEXT
    = \xyz\oihana\schema\constants\Oihana::SCHEMA

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

$assignedPOS

The warehouse the route departs from.


        public
            null|int|string|array<string|int, mixed>|Warehouse
    $assignedPOS

Holds the raw warehouse reference as read from the source, or the resolved Warehouse once the reference data has been joined.

null means the route is attached to no warehouse.

$byDay

The days of the week the route runs, as {@see DayOfWeek} constants.


        public
            null|array<string|int, mixed>|string|DayOfWeek
    $byDay

An empty list means the route runs no day — a defined but unscheduled route — whereas null means nothing was said about its days.

$color

An optional house color, expressed as a `#RRGGBB` hex string.


        public
            string|null
    $color

Example:

$term->color = '#7B1E3A' ;

$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

$inDefinedTermSet

A DefinedTermSet that contains this term.


        public
            string|DefinedTermSet|null
    $inDefinedTermSet

$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

$termCode

A code that identifies this DefinedTerm within a DefinedTermSet.


        public
            string|null
    $termCode

$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

DeliveryRouteTerm extends ThesaurusTerm uses DeliveryRouteTermTrait

The days a route runs

Where the route departs from

Example

Tags

Table of Contents

Constants

Properties

Methods

Constants

ASSIGNED_POS

BY_DAY

COLOR

CONTEXT

JSON_PRIORITY_KEYS

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalType

$alternateName

$assignedPOS

$byDay

$color

$created

$description

$disambiguatingDescription

$hasPart

$id

$identifier

$image

$inDefinedTermSet

$isPartOf

$license

$mainEntityOfPage

$modified

$name

$owner

$potentialAction

$publisher

$sameAs

$subjectOf

$termCode

$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