Oihana Php Schema

DeliveryMethodTerm extends ThesaurusTerm uses DeliveryMethodTermTrait

A delivery method : the shipping arrangement an order is fulfilled under — counter pick-up, carrier delivery, free carriage above a threshold, flat-rate carriage, and so on — together with what that arrangement costs.

Where the Schema.org DeliveryMethod enumeration names a handful of universal modes (DeliveryModePickUp, DeliveryModeFreight…), a back-office keeps its own, longer list, each entry priced by its own commercial terms. This class is that list : a ThesaurusTerm first — referenced by its id from organizations, sites and business documents — enriched with the four values needed to charge carriage.

The inherited identifier is available to carry the reference of the catalogue item carriage is invoiced through, when the back-office models the charge as a line rather than as a document-level total.

The carriage rule

Carriage is due when the term names a rate and the order does not reach the free-carriage threshold :

$due = $term->shippingRate !== null
    && ( $term->freeShippingThreshold === null || $total < $term->freeShippingThreshold ) ;

A null threshold therefore reads as never free — carriage always applies. That is the same convention Company::$freeShippingThreshold follows for the per-organization override, so the two can be composed with a plain coalesce, the organization winning over the method.

When the charge is fixed

The rule above says whether carriage is due ; ShippingChargeTiming says when the figure it resolves to is locked in — at order time, or recomputed at delivery time. null leaves the timing unspecified, which a consumer is free to read as whichever of the two its own process defaults to.

Scalars rather than value objects

shippingRate and freeShippingThreshold are plain numbers, not MonetaryAmount instances, so a term hydrates straight from a flat table row : a database driver assigns the raw column value to the property before any conversion can take place, and an object type would reject it. The currency is the ledger's own ; a caller building an Adjustment wraps the number at that point — which is also where the amount actually applied is known, since a reached threshold produces no adjustment at all.

vat follows the Company::$vat shape for the same reason : it holds the raw tax code as read, then the resolved TaxRate once the reference data has been joined.

Example

use xyz\oihana\schema\thesaurus\DeliveryMethodTerm;

$term = new DeliveryMethodTerm
([
    'id'                                        => 'F11' ,
    'name'                                      => 'Free above 1000, otherwise 39' ,
    'identifier'                                => '59483' ,
    DeliveryMethodTerm::SHIPPING_RATE           => 39 ,
    DeliveryMethodTerm::FREE_SHIPPING_THRESHOLD => 1000 ,
]);

Constants

CHARGE_TIMING : string = 'chargeTiming'
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.
FREE_SHIPPING_THRESHOLD : string = 'freeShippingThreshold'
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.
SHIPPING_RATE : string = 'shippingRate'
VAT : string = 'vat'

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.
$chargeTiming : null|string|ShippingChargeTiming: When the carriage amount is settled. Reuses {@see ShippingChargeTiming} (at order time, or recomputed at delivery time) or a plain free-text label.
$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.
$freeShippingThreshold : null|float|int: A minimum order value at (or above) which carriage becomes free.
$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.
$shippingRate : null|float|int: The flat carriage charged by this delivery method, expressed in the ledger currency.
$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.
$vat : array<string|int, mixed>|TaxRate|string|int|null: The tax rate applied to the carriage charge.
$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`.

CHARGE_TIMING


    public
        string
    CHARGE_TIMING
    = 'chargeTiming'

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

FREE_SHIPPING_THRESHOLD


    public
        string
    FREE_SHIPPING_THRESHOLD
    = 'freeShippingThreshold'

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.

SHIPPING_RATE


    public
        string
    SHIPPING_RATE
    = 'shippingRate'

VAT


    public
        string
    VAT
    = 'vat'

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

$chargeTiming

When the carriage amount is settled. Reuses {@see ShippingChargeTiming} (at order time, or recomputed at delivery time) or a plain free-text label.


        public
            null|string|ShippingChargeTiming
    $chargeTiming

null means the timing is unspecified.

$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

$freeShippingThreshold

A minimum order value at (or above) which carriage becomes free.


        public
            null|float|int
    $freeShippingThreshold

null means the method has no free-carriage threshold, so DeliveryMethodTerm::$shippingRate always applies.

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

$shippingRate

The flat carriage charged by this delivery method, expressed in the ledger currency.


        public
            null|float|int
    $shippingRate

null means the method carries no charge of its own — either it is free by nature (counter pick-up, carriage offered), or the amount is settled outside this term.

$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

$vat

The tax rate applied to the carriage charge.


        public
            array<string|int, mixed>|TaxRate|string|int|null
    $vat

Holds the raw tax code as read from the source, or the resolved TaxRate once the reference data has been joined.

$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

DeliveryMethodTerm extends ThesaurusTerm uses DeliveryMethodTermTrait

The carriage rule

When the charge is fixed

Scalars rather than value objects

Example

Tags

Table of Contents

Constants

Properties

Methods

Constants

CHARGE_TIMING

COLOR

CONTEXT

FREE_SHIPPING_THRESHOLD

JSON_PRIORITY_KEYS

SHIPPING_RATE

VAT

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalType

$alternateName

$chargeTiming

$color

$created

$description

$disambiguatingDescription

$freeShippingThreshold

$hasPart

$id

$identifier

$image

$inDefinedTermSet

$isPartOf

$license

$mainEntityOfPage

$modified

$name

$owner

$potentialAction

$publisher

$sameAs

$shippingRate

$subjectOf

$termCode

$url

$vat

$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