Oihana Php Schema

Quote extends BusinessDocument uses QuoteTrait

A quote (estimate) offered to a customer ahead of an order.

Not to be confused with Quotation, which is a literary citation — an unrelated, pre-existing schema.org mirror type sharing only the English word "quote".

Reuses Schema.org's validThrough (already used by PriceSpecification/Offer for "the end of the validity of offer, price specification...") rather than introducing a new validUntil name for the same concept.

Constants

ADJUSTMENTS : string = 'adjustments'
ATTACHMENTS : string = 'attachments'
AUTHOR : string = 'author'
BILLING_ADDRESS : string = 'billingAddress'
CONTACT : string = 'contact'
CONTEXT : string = \xyz\oihana\schema\constants\Oihana::SCHEMA: The @context of the json-ld representation of the thing.
CURRENCY : string = 'currency'
CUSTOMER : string = 'customer'
DIRECTION : string = 'direction'
DOCUMENT_LINES : string = 'documentLines'
ISSUE_DATE : string = 'issueDate'
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.
ORDER_DELIVERY : string = 'orderDelivery'
PAYMENT_TERMS : string = 'paymentTerms'
POINT_OF_SALE : string = 'pointOfSale'
REFERENCES : string = 'references'
SELLER : string = 'seller'
STATUS : string = 'status'
TAXES : string = 'taxes'
TOTALS : string = 'totals'
VALID_THROUGH : string = 'validThrough'

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.
$adjustments : null|array<string|int, mixed>|Adjustment: The document-level adjustments (discounts, surcharges, shipping fees, packaging...) applying to the whole document, as opposed to a specific line's {@see BusinessDocumentLine::$adjustments}.
$alternateName : string|object|array<string|int, mixed>|null: An alias for the item.
$attachments : null|array<string|int, mixed>|string|MediaObject: Files attached to the document (e.g. a signed PDF, supporting documents).
$author : null|Organization|Person|array<string|int, mixed>: The author of the document — the party (organization or person) who authored it. Reuses the Schema.org `author` name.
$billingAddress : null|array<string|int, mixed>|PostalAddress: The address the document is billed to — stored as a frozen copy so the document stays self-contained even if the party's address book changes later. Reuses the Schema.org `billingAddress` name from `Order`.
$contact : null|array<string|int, mixed>|Person: The individual to deal with about the document (the interlocutor on the customer's side) — distinct from the {@see BusinessDocument::$customer} party the document is addressed to. Absent from Schema.org's commercial documents, hence added here.
$created : null|string: Date of creation of the resource.
$currency : string|null: The currency the document's amounts are expressed in (ISO 4217, e.g. "EUR").
$customer : null|array<string|int, mixed>|Organization|Person: The party the document is addressed to.
$description : string|object|array<string|int, mixed>|null: A short description of the item.
$direction : null|string|BusinessDocumentDirection: The commercial direction of the document (sale / purchase), from the operator's point of view — which of {@see self::$seller} / {@see self::$customer} is the operator's own organization.
$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.
$documentLines : null|array<string|int, mixed>|BusinessDocumentLine: The lines of the document.
$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.
$issueDate : string|int|null: The date the document was issued.
$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.
$orderDelivery : null|array<string|int, mixed>|ParcelDelivery: The delivery attached to the document: the shipping address (a frozen copy), the delivery method and the requested date. Reuses the name already used by {@see DeliveryNote::$orderDelivery} for internal consistency.
$owner : null|string|Thing: The owner of this Thing.
$paymentTerms : null|string|array<string|int, mixed>|PaymentSchedule: The payment terms — free text, or a structured {@see PaymentSchedule}.
$pointOfSale : null|array<string|int, mixed>|Place: The point of sale (store, outlet, warehouse) the document is bound to — the outlet that carries it and drives its pricing. A frozen copy, like the other header references.
$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.
$references : null|array<string|int, mixed>|string: References to other related documents (e.g. a purchase order number quoted on an invoice).
$sameAs : string|array<string|int, mixed>|null: URL of a reference Web page that unambiguously indicates the item's identity.
$seller : null|array<string|int, mixed>|Organization|Person: The party issuing the document.
$status : null|string|BusinessDocumentStatus: The lifecycle status of the document.
$subjectOf : null|string|array<string|int, mixed>|CreativeWork|Event: A CreativeWork or Event about this Thing.
$taxes : null|array<string|int, mixed>|TaxDetail: The document-level taxes (as opposed to a specific line's taxes).
$totals : null|array<string|int, mixed>|DocumentTotals: The document's monetary summary.
$url : int|string|null: URL of the item.
$validThrough : string|int|null: The date after which the quote is no longer valid.
$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`.

ADJUSTMENTS


    public
        string
    ADJUSTMENTS
    = 'adjustments'

ATTACHMENTS


    public
        string
    ATTACHMENTS
    = 'attachments'

AUTHOR


    public
        string
    AUTHOR
    = 'author'

BILLING_ADDRESS


    public
        string
    BILLING_ADDRESS
    = 'billingAddress'

CONTACT


    public
        string
    CONTACT
    = 'contact'

CONTEXT

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


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

CURRENCY


    public
        string
    CURRENCY
    = 'currency'

CUSTOMER


    public
        string
    CUSTOMER
    = 'customer'

DIRECTION


    public
        string
    DIRECTION
    = 'direction'

DOCUMENT_LINES


    public
        string
    DOCUMENT_LINES
    = 'documentLines'

ISSUE_DATE


    public
        string
    ISSUE_DATE
    = 'issueDate'

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.

ORDER_DELIVERY


    public
        string
    ORDER_DELIVERY
    = 'orderDelivery'

PAYMENT_TERMS


    public
        string
    PAYMENT_TERMS
    = 'paymentTerms'

POINT_OF_SALE


    public
        string
    POINT_OF_SALE
    = 'pointOfSale'

REFERENCES


    public
        string
    REFERENCES
    = 'references'

SELLER


    public
        string
    SELLER
    = 'seller'

STATUS


    public
        string
    STATUS
    = 'status'

TAXES


    public
        string
    TAXES
    = 'taxes'

TOTALS


    public
        string
    TOTALS
    = 'totals'

VALID_THROUGH


    public
        string
    VALID_THROUGH
    = 'validThrough'

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

$adjustments

The document-level adjustments (discounts, surcharges, shipping fees, packaging...) applying to the whole document, as opposed to a specific line's {@see BusinessDocumentLine::$adjustments}.


        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

$attachments

Files attached to the document (e.g. a signed PDF, supporting documents).


        public
            null|array<string|int, mixed>|string|MediaObject
    $attachments

$author

The author of the document — the party (organization or person) who authored it. Reuses the Schema.org `author` name.


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

#[HydrateWith]: \org\schema\Organization::class; \org\schema\Person::class

$billingAddress

The address the document is billed to — stored as a frozen copy so the document stays self-contained even if the party's address book changes later. Reuses the Schema.org `billingAddress` name from `Order`.


        public
            null|array<string|int, mixed>|PostalAddress
    $billingAddress

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

$contact

The individual to deal with about the document (the interlocutor on the customer's side) — distinct from the {@see BusinessDocument::$customer} party the document is addressed to. Absent from Schema.org's commercial documents, hence added here.


        public
            null|array<string|int, mixed>|Person
    $contact

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

$created

Date of creation of the resource.


        public
            null|string
    $created

$currency

The currency the document's amounts are expressed in (ISO 4217, e.g. "EUR").


        public
            string|null
    $currency

$customer

The party the document is addressed to.


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

#[HydrateWith]: \org\schema\Organization::class; \org\schema\Person::class

$description

A short description of the item.


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

$direction

The commercial direction of the document (sale / purchase), from the operator's point of view — which of {@see self::$seller} / {@see self::$customer} is the operator's own organization.


        public
            null|string|BusinessDocumentDirection
    $direction

$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

$documentLines

The lines of the document.


        public
            null|array<string|int, mixed>|BusinessDocumentLine
    $documentLines

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

$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

$issueDate

The date the document was issued.


        public
            string|int|null
    $issueDate

$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

$orderDelivery

The delivery attached to the document: the shipping address (a frozen copy), the delivery method and the requested date. Reuses the name already used by {@see DeliveryNote::$orderDelivery} for internal consistency.


        public
            null|array<string|int, mixed>|ParcelDelivery
    $orderDelivery

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

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

$paymentTerms

The payment terms — free text, or a structured {@see PaymentSchedule}.


        public
            null|string|array<string|int, mixed>|PaymentSchedule
    $paymentTerms

#[HydrateAs]: \xyz\oihana\schema\business\documents\PaymentSchedule::class

$pointOfSale

The point of sale (store, outlet, warehouse) the document is bound to — the outlet that carries it and drives its pricing. A frozen copy, like the other header references.


        public
            null|array<string|int, mixed>|Place
    $pointOfSale

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

$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

$references

References to other related documents (e.g. a purchase order number quoted on an invoice).


        public
            null|array<string|int, mixed>|string
    $references

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

$seller

The party issuing the document.


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

#[HydrateWith]: \org\schema\Organization::class; \org\schema\Person::class

$status

The lifecycle status of the document.


        public
            null|string|BusinessDocumentStatus
    $status

$subjectOf

A CreativeWork or Event about this Thing.


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

$taxes

The document-level taxes (as opposed to a specific line's taxes).


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

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

$totals

The document's monetary summary.


        public
            null|array<string|int, mixed>|DocumentTotals
    $totals

#[HydrateAs]: \xyz\oihana\schema\business\documents\DocumentTotals::class

$url

URL of the item.


        public
            int|string|null
    $url

$validThrough

The date after which the quote is no longer valid.


        public
            string|int|null
    $validThrough

$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

Quote extends BusinessDocument uses QuoteTrait

Tags

Table of Contents

Constants

Properties

Methods

Constants

ADJUSTMENTS

ATTACHMENTS

AUTHOR

BILLING_ADDRESS

CONTACT

CONTEXT

CURRENCY

CUSTOMER

DIRECTION

DOCUMENT_LINES

ISSUE_DATE

JSON_PRIORITY_KEYS

ORDER_DELIVERY

PAYMENT_TERMS

POINT_OF_SALE

REFERENCES

SELLER

STATUS

TAXES

TOTALS

VALID_THROUGH

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalType

$adjustments

Attributes

$alternateName

$attachments

$author

Attributes

$billingAddress

Attributes

$contact

Attributes

$created

$currency

$customer

Attributes

$description

$direction

$disambiguatingDescription

$documentLines

Attributes

$hasPart

$id

$identifier

$image

$isPartOf

$issueDate

$license

$mainEntityOfPage

$modified

$name

$orderDelivery

Attributes

$owner

$paymentTerms

Attributes

$pointOfSale

Attributes

$potentialAction

$publisher

$references

$sameAs

$seller

Attributes

$status

$subjectOf