Oihana PHP System

Order extends Intangible

An order is a confirmation of a transaction (a receipt), which can contain multiple line items, each represented by an Offer that has been accepted by the customer.

Tags
see
https://schema.org/Order

Table of Contents

Constants

CONTEXT  = 'https://schema.org'
JSON-LD @context declaration for Schema.org.

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.
$acceptedOffer  : array<string|int, mixed>|Offer|null
The offer(s) -- e.g., product, quantity and price combinations -- included in the order.
$active  : bool|null
The active flag.
$additionalType  : array<string|int, mixed>|string|null|object
An additionalType for the item.
$alternateName  : string|object|null
An alias for the item.
$billingAddress  : PostalAddress|null
The billing address for the order.
$broker  : Organization|Person|null
An entity that arranges for an exchange between a buyer and a seller.
$confirmationNumber  : string|int|null
A number that confirms the given order or payment has been received.
$created  : null|string|DateTime
Date of creation of the resource.
$customer  : Organization|Person|null
Party placing the order or paying the invoice.
$description  : string|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.
$discount  : int|float|string|null
Any discount applied (to an Order).
$discountCode  : string|null
Code used to redeem a discount.
$discountCurrency  : string|null
The currency of the discount.
$hasPart  : string|Thing|array<string|int, mixed>|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|object|null
The image reference of this resource.
$isGift  : bool|null
Indicates whether the offer was accepted as a gift for someone other than the buyer.
$isPartOf  : string|Thing|array<string|int, mixed>|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.
$modified  : null|string|DateTime
Date on which the resource was changed.
$name  : int|string|null
The name of the item.
$orderDate  : string|int|DateTime|null
Date order was placed.
$orderDelivery  : null|ParcelDelivery
The delivery of the parcel related to this order or order item.
$orderedItem  : array<string|int, mixed>|Product|Service|OrderItem|null
The item ordered.
$orderNumber  : int|string|null
The identifier of the transaction.
$orderStatus  : string|DefinedTerm|OrderStatus|null
The current status of the order.
$partOfInvoice  : array<string|int, mixed>|Invoice|null
The order is being paid as part of the referenced Invoice.
$paymentDueDate  : string|int|DateTime|null
The date that payment is due.
$paymentMethod  : PaymentMethod|string|null
The name of the credit card or other method of payment for the order.
$paymentMethodId  : string|null
An identifier for the method of payment used (e.g. the last 4 digits of the credit card).
$paymentUrl  : string|null
The URL for sending a payment.
$publisher  : string|array<string|int, mixed>|Person|Organization|null
The publisher of the resource.
$seller  : Organization|Person|null
An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.
$url  : int|string|null
URL of the item.

Methods

__construct()  : mixed
Constructor to hydrate public properties from an array or stdClass.
jsonSerialize()  : array<string|int, mixed>
Serializes the current object into a JSON-LD array.

Constants

CONTEXT

JSON-LD @context declaration for Schema.org.

public mixed CONTEXT = 'https://schema.org'

Properties

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

$acceptedOffer

The offer(s) -- e.g., product, quantity and price combinations -- included in the order.

public array<string|int, mixed>|Offer|null $acceptedOffer

$active

The active 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|null $alternateName

$broker

An entity that arranges for an exchange between a buyer and a seller.

public Organization|Person|null $broker

In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.

$confirmationNumber

A number that confirms the given order or payment has been received.

public string|int|null $confirmationNumber

$created

Date of creation of the resource.

public null|string|DateTime $created

$description

A short description of the item.

public string|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

$discount

Any discount applied (to an Order).

public int|float|string|null $discount

$discountCode

Code used to redeem a discount.

public string|null $discountCode

$discountCurrency

The currency of the discount.

public string|null $discountCurrency

Use standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR".

$hasPart

Indicates an item that this part of this item.

public string|Thing|array<string|int, mixed>|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|object|null $image

$isGift

Indicates whether the offer was accepted as a gift for someone other than the buyer.

public bool|null $isGift

$isPartOf

Indicates an item that this item is part of.

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

$license

A legal document giving official permission to do something with the resource.

public string|object|null $license

$modified

Date on which the resource was changed.

public null|string|DateTime $modified

$name

The name of the item.

public int|string|null $name

$orderDate

Date order was placed.

public string|int|DateTime|null $orderDate

$orderDelivery

The delivery of the parcel related to this order or order item.

public null|ParcelDelivery $orderDelivery

$orderNumber

The identifier of the transaction.

public int|string|null $orderNumber

$partOfInvoice

The order is being paid as part of the referenced Invoice.

public array<string|int, mixed>|Invoice|null $partOfInvoice

$paymentDueDate

The date that payment is due.

public string|int|DateTime|null $paymentDueDate

$paymentMethod

The name of the credit card or other method of payment for the order.

public PaymentMethod|string|null $paymentMethod

$paymentMethodId

An identifier for the method of payment used (e.g. the last 4 digits of the credit card).

public string|null $paymentMethodId

$paymentUrl

The URL for sending a payment.

public string|null $paymentUrl

$seller

An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.

public Organization|Person|null $seller

$url

URL of the item.

public int|string|null $url

Methods

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

Tags
example 
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person
([
    Prop::NAME => 'Jane Doe',
    Prop::URL  => 'https://example.com/janedoe'
]);

echo $person->name; // Outputs: Jane Doe

jsonSerialize()

Serializes the current object into a JSON-LD array.

public jsonSerialize() : array<string|int, mixed>

This method will include all public properties, the schema.org @context, and the inferred @type based on the class name.

Null values will be automatically removed using compress().

Tags
throws
ReflectionException

If reflection fails when accessing properties.

example 
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person([
    Prop::NAME => 'John Smith',
    Prop::ID   => 'jsmith-001'
]);

echo json_encode($person, JSON_PRETTY_PRINT);

Output:

{
  "@type": "Person",
  "@context": "https://schema.org",
  "id": "jsmith-001",
  "name": "John Smith"
}
Return values
array<string|int, mixed> —

A JSON-LD array representation of the object.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results