DeliveryLine extends StructuredValue uses DeliveryLineTrait, HasPhysicalMeasures

A single line of a {@see DeliveryNote} : how much of a given {@see BusinessDocumentLine} (identified by `position`) was actually delivered, as opposed to ordered or left in backorder.

Tags

author

Marc Alcaraz (eKameleon)

since

1.3.0

Table of Contents

Constants

BACKORDER_QUANTITY  : string = 'backorderQuantity'

BACKORDER_REASON  : string = 'backorderReason'

BATCH_NUMBER  : string = 'batchNumber'

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

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

DELIVERED_QUANTITY  : string = 'deliveredQuantity'

ITEM  : string = 'item'

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.

ORDERED_QUANTITY  : string = 'orderedQuantity'

POSITION  : string = 'position'

REFERENCES_INVOICE  : string = 'referencesInvoice'

REFERENCES_ORDER  : string = 'referencesOrder'

SERIAL_NUMBERS  : string = 'serialNumbers'

VOLUME  : string = 'volume'

WEIGHT  : string = 'weight'

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.

$backorderQuantity  : int|float|QuantitativeValue|array<string|int, mixed>|null

The quantity of this line still in backorder (ordered but not yet delivered).

$backorderReason  : string|null

Why the backorder quantity could not be delivered (e.g. "out of stock").

$batchNumber  : string|null

The batch/lot number of the delivered goods, when traceability applies.

$created  : null|string

Date of creation of the resource.

$deliveredQuantity  : int|float|QuantitativeValue|array<string|int, mixed>|null

The quantity actually delivered on this line.

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

$item  : null|array<string|int, mixed>|Product|Service

The product or service this line concerns.

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

$orderedQuantity  : int|float|QuantitativeValue|array<string|int, mixed>|null

The quantity originally ordered on this line.

$owner  : null|string|Thing

The owner of this Thing.

$position  : int|string|null

The position of the originating {@see BusinessDocumentLine} this delivery line reconciles against (e.g. the purchase order's line 1, 2, 3...).

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

$referencesInvoice  : null|array<string|int, mixed>|string|Invoice

The invoice that bills this line.

$referencesOrder  : null|array<string|int, mixed>|string|PurchaseOrder

The purchase order this line comes from.

$sameAs  : string|array<string|int, mixed>|null

URL of a reference Web page that unambiguously indicates the item's identity.

$serialNumbers  : null|array<string|int, mixed>|string

The serial numbers of the delivered items, when the goods are serialized.

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

A CreativeWork or Event about this Thing.

$url  : int|string|null

URL of the item.

$volume  : null|array<string|int, mixed>|int|float|QuantitativeValue

The space this entry takes up.

$weight  : null|array<string|int, mixed>|int|float|QuantitativeValue|Mass

What this entry weighs.

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

$orderedKeys = self::JSON_PRIORITY_KEYS;

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