Oihana PHP System

UnitPriceSpecification extends PriceSpecification

The price asked for a given offer by the respective organization or person.

Tags
see
https://schema.org/UnitPriceSpecification

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.
$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.
$billingDuration  : Duration|int|float|QuantitativeValue|null
Specifies for how long this price (or price component) will be billed.
$billingIncrement  : int|null
This property specifies the minimal quantity and rounding increment that will be the basis for the billing.
$billingStart  : int|null
Specifies after how much time this price (or price component) becomes valid and billing starts.
$created  : null|string|DateTime
Date of creation of the resource.
$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.
$eligibleQuantity  : QuantitativeValue|null
The interval and unit of measurement of ordering quantities for which the offer or price specification is valid.
$eligibleTransactionVolume  : PriceSpecification|null
The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.
$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.
$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.
$maxPrice  : int|float|null
The highest price if the price is a range.
$membershipPointsEarned  : int|float|QuantitativeValue|null
The number of membership points earned by the member.
$minPrice  : int|float|null
The lowest price if the price is a range.
$modified  : null|string|DateTime
Date on which the resource was changed.
$name  : int|string|null
The name of the item.
$price  : int|float|string|null
The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.
$priceComponentType  : string|Enumeration|DefinedTerm|null
Identifies a price component (for example, a line item on an invoice), part of the total price for an offer.
$priceCurrency  : string|null
he currency of the price, or a price component when attached to PriceSpecification and its subtypes.
$priceType  : string|Enumeration|DefinedTerm|null
Defines the type of a price specified for an offered product, for example a list price, a (temporary) sale price or a manufacturer suggested retail price.
$publisher  : string|array<string|int, mixed>|Person|Organization|null
The publisher of the resource.
$referenceQuantity  : QuantitativeValue|null
The reference quantity for which a certain price applies, e.g. 1 EUR per 4 kWh of electricity.
$unitCode  : null|string
The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL.
$unitText  : null|string
A string or text indicating the unit of measurement.
$url  : int|string|null
URL of the item.
$validForMemberTier  : MemberProgramTier|null
The membership program tier an Offer (or a PriceSpecification, OfferShippingDetails, or MerchantReturnPolicy under an Offer) is valid for.
$validFrom  : string|DateTime|null
The date when the item becomes valid.
$validThrough  : string|DateTime|null
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
$valueAddedTaxIncluded  : bool|null
Specifies whether the applicable value-added tax (VAT) is included in the price specification or not.

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

$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

$billingDuration

Specifies for how long this price (or price component) will be billed.

public Duration|int|float|QuantitativeValue|null $billingDuration

Can be used, for example, to model the contractual duration of a subscription or payment plan. Type can be either a Duration or a Number (in which case the unit of measurement, for example month, is specified by the unitCode property).

$billingIncrement

This property specifies the minimal quantity and rounding increment that will be the basis for the billing.

public int|null $billingIncrement

The unit of measurement is specified by the unitCode property.

$billingStart

Specifies after how much time this price (or price component) becomes valid and billing starts.

public int|null $billingStart

Can be used, for example, to model a price increase after the first year of a subscription. The unit of measurement is specified by the unitCode property.

$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

$eligibleQuantity

The interval and unit of measurement of ordering quantities for which the offer or price specification is valid.

public QuantitativeValue|null $eligibleQuantity

This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.

$eligibleTransactionVolume

The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.

public PriceSpecification|null $eligibleTransactionVolume

$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

$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

$maxPrice

The highest price if the price is a range.

public int|float|null $maxPrice

$membershipPointsEarned

The number of membership points earned by the member.

public int|float|QuantitativeValue|null $membershipPointsEarned

If necessary, the unitText can be used to express the units the points are issued in. (E.g. stars, miles, etc.)

$minPrice

The lowest price if the price is a range.

public int|float|null $minPrice

$modified

Date on which the resource was changed.

public null|string|DateTime $modified

$name

The name of the item.

public int|string|null $name

$price

The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.

public int|float|string|null $price

$priceComponentType

Identifies a price component (for example, a line item on an invoice), part of the total price for an offer.

public string|Enumeration|DefinedTerm|null $priceComponentType

Example :

  • ActivationFee
  • CleaningFee
  • DistanceFee
  • Downpayment
  • Installment
  • Subscription
Tags
see

$priceCurrency

he currency of the price, or a price component when attached to PriceSpecification and its subtypes.

public string|null $priceCurrency

$priceType

Defines the type of a price specified for an offered product, for example a list price, a (temporary) sale price or a manufacturer suggested retail price.

public string|Enumeration|DefinedTerm|null $priceType

If multiple prices are specified for an offer the priceType property can be used to identify the type of each such specified price. The value of priceType can be specified as a value from enumeration PriceTypeEnumeration or as a free form text string for price types that are not already predefined in PriceTypeEnumeration. Example:

  • ActivationFee
  • CleaningFee
  • DistanceFee
  • Downpayment
  • Installment
  • Subscription
Tags
see
https://schema.org/PriceTypeEnumeration

$referenceQuantity

The reference quantity for which a certain price applies, e.g. 1 EUR per 4 kWh of electricity.

public QuantitativeValue|null $referenceQuantity

This property is a replacement for unitOfMeasurement for the advanced cases where the price does not relate to a standard unit.

$unitCode

The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL.

public null|string $unitCode

Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon.

$unitText

A string or text indicating the unit of measurement.

public null|string $unitText

Useful if you cannot provide a standard unit code for unitCode.

$url

URL of the item.

public int|string|null $url

$validForMemberTier

The membership program tier an Offer (or a PriceSpecification, OfferShippingDetails, or MerchantReturnPolicy under an Offer) is valid for.

public MemberProgramTier|null $validForMemberTier

$validFrom

The date when the item becomes valid.

public string|DateTime|null $validFrom

$validThrough

The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.

public string|DateTime|null $validThrough

$valueAddedTaxIncluded

Specifies whether the applicable value-added tax (VAT) is included in the price specification or not.

public bool|null $valueAddedTaxIncluded

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