BusinessDocumentLine extends StructuredValue uses BusinessDocumentLineTrait, HasColor, HasPhysicalMeasures

A single line of a {@see BusinessDocument} : the item sold, its quantity and price, the taxes and adjustments applying to it, and the resulting line totals.

Tags

author

Marc Alcaraz (eKameleon)

since

1.3.0

Table of Contents

Constants

ADDITIONAL_PROPERTY  : string = 'additionalProperty'

ADJUSTMENTS  : string = 'adjustments'

COLOR  : string = 'color'

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

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

FREE_REASON  : string = 'freeReason'

INCLUDED_IN_TOTAL  : string = 'includedInTotal'

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.

POSITION  : string = 'position'

PRICE  : string = 'price'

QUANTITY  : string = 'quantity'

QUANTITY_ORIGIN  : string = 'quantityOrigin'

SECTION  : string = 'section'

SUBTOTAL  : string = 'subtotal'

TAXES  : string = 'taxes'

TECHNICAL_NOTE  : string = 'technicalNote'

TOTAL  : string = 'total'

UNIT  : string = 'unit'

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.

$additionalProperty  : null|array<string|int, mixed>|PropertyValue

A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.

$additionalType  : array<string|int, mixed>|string|null|object

An additionalType for the item.

$adjustments  : null|array<string|int, mixed>|Adjustment

The adjustments (discounts, surcharges, fees...) applying to this line.

$alternateName  : string|object|array<string|int, mixed>|null

An alias for the item.

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

$freeReason  : DefinedTerm|array<string|int, mixed>|null

Why the goods on this line leave without being invoiced — a gift, a breakage, a sample, goods that were the customer's to begin with.

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

$includedInTotal  : bool|null

Whether this line counts towards the document totals.

$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 sold on this line.

$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  : int|string|null

The position of this line within the document (e.g. 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.

$price  : MonetaryAmount|PriceSpecification|array<string|int, mixed>|null

The unit price of the item.

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

The publisher of the resource.

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

The quantity of the item sold on this line.

$quantityOrigin  : string|QuantityOrigin|null

Where the quantity above comes from — worked out by the system, or typed by someone ({@see QuantityOrigin}).

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

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

$section  : string|null

The heading this line belongs to, when the document is written in chapters — « roof frame », « oak flooring », « laying ».

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

A CreativeWork or Event about this Thing.

$subtotal  : MonetaryAmount|array<string|int, mixed>|null

The line total before tax (quantity × price, adjustments applied).

$taxes  : null|array<string|int, mixed>|TaxDetail

The taxes applying to this line.

$technicalNote  : string|null

A note meant for whoever prepares the goods, never for the customer.

$total  : MonetaryAmount|array<string|int, mixed>|null

The line total including tax.

$unit  : null|string|UnitOfSaleType

The unit of sale the quantity is expressed in.

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

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

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