Oihana Php Schema

DeliveryRouteAssignment extends StructuredValue uses DeliveryRouteAssignment

The assignment of a delivery route to one address : which route serves it, on which of its days, in which order, and within which hours.

A DeliveryRouteTerm describes a circuit in the abstract — the days it runs, the warehouse it leaves from. This class is the other half : it says that this address is one of the stops, and adds what only the pairing knows. A site therefore carries a list of assignments (Site::$deliveryRoute), one per route serving it, since a same address is commonly visited by more than one circuit.

Only the reference is stored

route holds the route reference as read — its bare code — or the resolved DeliveryRouteTerm once the reference data has been joined. That is the shape Site::$deliveryMethod already follows, and it is what keeps a renamed route from having to be rewritten everywhere it is assigned : the label lives in the thesaurus, never in a copy.

A business document is the deliberate exception — it freezes the identity of the route it names, so a quote keeps saying what was chosen even after the thesaurus has moved on.

The days, and the narrower ones

byDay uses the DayOfWeek vocabulary of Schedule::$byDay, like the route itself, but says something narrower : the days the route serves this address. It is always a subset of DeliveryRouteTerm::$byDay — a circuit running Monday, Wednesday and Friday may only stop here on Friday.

Times and weeks

startTime and endTime bound the hours the address can be served, as HH:MM strings. Both are optional and independent : an address open from eight in the morning with no closing constraint states a start and no end.

weekFrom and weekThrough bound the assignment in the year, as ISO week numbers (1 to 53), for a stop that only exists part of the year — a seasonal site, a construction site with an end date. Both null means all year round.

Example

use org\schema\enumerations\DayOfWeek;
use xyz\oihana\schema\shipping\DeliveryRouteAssignment;

$assignment = new DeliveryRouteAssignment
([
    DeliveryRouteAssignment::ROUTE      => '01D' ,
    DeliveryRouteAssignment::BY_DAY     => [ DayOfWeek::FRIDAY ] ,
    DeliveryRouteAssignment::POSITION   => 12 ,
    DeliveryRouteAssignment::START_TIME => '08:00' ,
]);

Constants

BY_DAY : string = 'byDay'
CONTEXT : string = \xyz\oihana\schema\constants\Oihana::SCHEMA: The @context of the json-ld representation of the thing.
END_TIME : string = 'endTime'
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.
POSITION : string = 'position'
ROUTE : string = 'route'
START_TIME : string = 'startTime'
WEEK_FROM : string = 'weekFrom'
WEEK_THROUGH : string = 'weekThrough'

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.
$byDay : null|array<string|int, mixed>|string|DayOfWeek: The days of the week the route serves this address, as {@see DayOfWeek} constants.
$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.
$endTime : null|string|int: The latest time of day the address can be served, as an `HH:MM` string.
$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.
$position : null|int|string: The rank of this address in the order the route visits its stops.
$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.
$route : null|array<string|int, mixed>|string|DefinedTerm: The route serving this address.
$sameAs : string|array<string|int, mixed>|null: URL of a reference Web page that unambiguously indicates the item's identity.
$startTime : null|string|int: The earliest time of day the address can be served, as an `HH:MM` string.
$subjectOf : null|string|array<string|int, mixed>|CreativeWork|Event: A CreativeWork or Event about this Thing.
$url : int|string|null: URL of the item.
$weekFrom : int|null: The ISO week number (1 to 53) the assignment starts on.
$weekThrough : int|null: The ISO week number (1 to 53) the assignment ends on, inclusive.
$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`.

BY_DAY


    public
        string
    BY_DAY
    = 'byDay'

CONTEXT

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


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

END_TIME


    public
        string
    END_TIME
    = 'endTime'

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.

POSITION


    public
        string
    POSITION
    = 'position'

ROUTE


    public
        string
    ROUTE
    = 'route'

START_TIME


    public
        string
    START_TIME
    = 'startTime'

WEEK_FROM


    public
        string
    WEEK_FROM
    = 'weekFrom'

WEEK_THROUGH


    public
        string
    WEEK_THROUGH
    = 'weekThrough'

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

$byDay

The days of the week the route serves this address, as {@see DayOfWeek} constants.


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

Always a subset of the days the route runs — see DeliveryRouteTerm::$byDay.

$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

$endTime

The latest time of day the address can be served, as an `HH:MM` string.


        public
            null|string|int
    $endTime

null means no closing constraint.

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

$position

The rank of this address in the order the route visits its stops.


        public
            null|int|string
    $position

null means the order is not specified.

$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

$route

The route serving this address.


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

Holds the raw route reference as read from the source — its bare code — or the resolved DeliveryRouteTerm once the reference data has been joined. Same shape as Site::$deliveryMethod.

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

$startTime

The earliest time of day the address can be served, as an `HH:MM` string.


        public
            null|string|int
    $startTime

null means no opening constraint.

$subjectOf

A CreativeWork or Event about this Thing.


        public
            null|string|array<string|int, mixed>|CreativeWork|Event
    $subjectOf

$url

URL of the item.


        public
            int|string|null
    $url

$weekFrom

The ISO week number (1 to 53) the assignment starts on.


        public
            int|null
    $weekFrom

null means it holds from the start of the year.

$weekThrough

The ISO week number (1 to 53) the assignment ends on, inclusive.


        public
            int|null
    $weekThrough

null means it holds to the end of the year.

$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

DeliveryRouteAssignment extends StructuredValue uses DeliveryRouteAssignment

Only the reference is stored

The days, and the narrower ones

Times and weeks

Example

Tags

Table of Contents

Constants

Properties

Methods

Constants

BY_DAY

CONTEXT

END_TIME

JSON_PRIORITY_KEYS

POSITION

ROUTE

START_TIME

WEEK_FROM

WEEK_THROUGH

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalType

$alternateName

$byDay

$created

$description

$disambiguatingDescription

$endTime

$hasPart

$id

$identifier

$image

$isPartOf

$license

$mainEntityOfPage

$modified

$name

$owner

$position

$potentialAction

$publisher

$route

$sameAs

$startTime

$subjectOf

$url

$weekFrom

$weekThrough

$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