Oihana Php Schema

BusinessDocumentLine extends StructuredValue uses BusinessDocumentLineTrait

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.

taxes and adjustments are scoped to this line — a document can mix lines taxed at different rates, or carry a line-specific discount, independently of the document-level DocumentTotals.

Constants

ADDITIONAL_PROPERTY : string = 'additionalProperty'
ADJUSTMENTS : string = 'adjustments'
CONTEXT : string = \xyz\oihana\schema\constants\Oihana::SCHEMA: The @context of the json-ld representation of the thing.
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'
SUBTOTAL : string = 'subtotal'
TAXES : string = 'taxes'
TOTAL : string = 'total'
UNIT : string = 'unit'

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

ADDITIONAL_PROPERTY


    public
        string
    ADDITIONAL_PROPERTY
    = 'additionalProperty'

ADJUSTMENTS


    public
        string
    ADJUSTMENTS
    = 'adjustments'

CONTEXT

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


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

ITEM


    public
        string
    ITEM
    = 'item'

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'

PRICE


    public
        string
    PRICE
    = 'price'

QUANTITY


    public
        string
    QUANTITY
    = 'quantity'

SUBTOTAL


    public
        string
    SUBTOTAL
    = 'subtotal'

TAXES


    public
        string
    TAXES
    = 'taxes'

TOTAL


    public
        string
    TOTAL
    = 'total'

UNIT


    public
        string
    UNIT
    = 'unit'

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

$additionalProperty

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.


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

#[HydrateWith]: \org\schema\PropertyValue::class

$additionalType

An additionalType for the item.


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

$adjustments

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


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

#[HydrateWith]: \xyz\oihana\schema\business\documents\Adjustment::class

$alternateName

An alias for the item.


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

$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

$isPartOf

Indicates an item that this item is part of.


        public
            string|Thing|array<string|int, Thing>|null
    $isPartOf

$item

The product or service sold on this line.


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

The Product|Service union is resolved from the payload's @type : a raw item hydrates into a Service when it says so, and into the commerce-enriched Product (a org\schema\Product) otherwise.

#[HydrateWith]: \xyz\oihana\schema\products\Product::class; \org\schema\Service::class

$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 position of this line within the document (e.g. 1, 2, 3...).


        public
            int|string|null
    $position

$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

$price

The unit price of the item.


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

A raw payload is hydrated into a CompoundPriceSpecification, so a unit price can be broken down into the UnitPriceSpecification components applying in parallel (base price, eco-fee, deposit...).

#[HydrateAs]: \org\schema\CompoundPriceSpecification::class

$publisher

The publisher of the resource.


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

$quantity

The quantity of the item sold on this line.


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

#[HydrateAs]: \org\schema\QuantitativeValue::class

$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

$subtotal

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


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

#[HydrateAs]: \org\schema\MonetaryAmount::class

$taxes

The taxes applying to this line.


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

#[HydrateWith]: \xyz\oihana\schema\business\documents\TaxDetail::class

$total

The line total including tax.


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

#[HydrateAs]: \org\schema\MonetaryAmount::class

$unit

The unit of sale the quantity is expressed in.


        public
            null|string|UnitOfSaleType
    $unit

$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

BusinessDocumentLine extends StructuredValue uses BusinessDocumentLineTrait

Tags

Table of Contents

Constants

Properties

Methods

Constants

ADDITIONAL_PROPERTY

ADJUSTMENTS

CONTEXT

ITEM

JSON_PRIORITY_KEYS

POSITION

PRICE

QUANTITY

SUBTOTAL

TAXES

TOTAL

UNIT

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalProperty

Attributes

$additionalType

$adjustments

Attributes

$alternateName

$created

$description

$disambiguatingDescription

$hasPart

$id

$identifier

$image

$isPartOf

$item

Attributes

$license

$mainEntityOfPage

$modified

$name

$owner

$position

$potentialAction

$price

Attributes

$publisher

$quantity

Attributes

$sameAs

$subjectOf

$subtotal

Attributes

$taxes

Attributes

$total

Attributes

$unit

$url

$atContext

$atType

$DEFAULT_JSON_SERIALIZE_OPTIONS

$schemaTypeCache

Methods

__construct()

Parameters

Tags

getJsonSerializeOptions()

Return values

getSchemaType()

Return values

jsonSerialize()

Tags

Return values

withAtContext()