Oihana Php Schema

PricingCondition extends StructuredValue

A conditional pricing rule : a discount (or a tariff substitution) granted to a scoped set of buyers on a scoped set of items, valid over a period.

A condition is a catalog/reference concept — the twin, on the sell side, of a provider buying condition — resolved most-specific-first for a given (customer, item, place) context by reading its PricingConditionSelector. It carries at most one of three mutually exclusive effects :

a list of stacked adjustment (Adjustment) applied in order (each a signed percentage or amount — a discount, or a surcharge when negative), or
a substitutesSegment (PriceSegmentation) that swaps the buyer's usual tariff segment for another, or
a fixedPrice (MonetaryAmount) that imposes a fixed net price. A free flag may additionally mark the item as granted free of charge.

excludedCustomers / excludedProducts carve exceptions out of the scope (e.g. "−10 % for this group, except these two customers"). quantityDiscount holds an optional quantity-tier effect. All effect and exclusion fields are optional : a condition with none is informational only.

Constants

CONTEXT : string = \xyz\oihana\schema\constants\Oihana::SCHEMA: The @context of the json-ld representation of the thing.
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.

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 : array<string|int, mixed>|PropertyValue|null: Additional, not-yet-modelled properties carried structurally.
$additionalType : array<string|int, mixed>|string|null|object: An additionalType for the item.
$adjustment : Adjustment|array<string|int, mixed>|null: A list of stacked adjustments applied in order (e.g. −10 %, then −5 % on the remaining amount). Each is a signed percentage or amount — a discount, or a surcharge when negative. Always a list, even for a single adjustment.
$alternateName : string|object|array<string|int, mixed>|null: An alias for the item.
$category : DefinedTerm|array<string|int, mixed>|null: The resolved price category the condition targets, when `selector.itemScope` is `CATEGORY`.
$created : null|string: Date of creation of the resource.
$customer : Customer|array<string|int, mixed>|null: The resolved buyer the condition targets, when `selector.customerScope` is `INDIVIDUAL`. Display-only : the resolver reads `selector.customerId`, never this.
$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.
$excludedCustomers : array<string|int, mixed>|null: The identifiers of the customers carved out of the scope (exceptions).
$excludedProducts : array<string|int, mixed>|null: The identifiers of the products carved out of the scope (exceptions).
$fixedPrice : MonetaryAmount|array<string|int, mixed>|null: A fixed net price imposed by this condition, applied *instead of* any adjustment or segment substitution. Mutually exclusive with `adjustment` and `substitutesSegment`.
$free : bool|null: Whether the item is granted free of charge under this condition.
$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.
$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.
$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.
$product : Product|array<string|int, mixed>|null: The resolved product the condition targets, when `selector.itemScope` is `PRODUCT`. Display-only : the resolver reads `selector.itemId`, never this.
$provider : Provider|array<string|int, mixed>|null: The resolved supplier the condition is constrained to, when `selector.providerId` is set. Display-only : the resolver reads `selector.providerId`, never this.
$publisher : string|array<string|int, string|Person|Organization>|Person|Organization|null: The publisher of the resource.
$quantityDiscount : PriceQuantityDiscount|array<string|int, mixed>|null: An optional quantity-tier effect (discounts by quantity).
$sameAs : string|array<string|int, mixed>|null: URL of a reference Web page that unambiguously indicates the item's identity.
$selector : PricingConditionSelector|array<string|int, mixed>|null: The selection criteria (who / what / where) this condition applies to.
$subjectOf : null|string|array<string|int, mixed>|CreativeWork|Event: A CreativeWork or Event about this Thing.
$subsidiary : Subsidiary|array<string|int, mixed>|null: The resolved company the condition is valid at, when `selector.areaScope` is `COMPANY`. Display-only : the resolver reads `selector.areaServed`, never this.
$substitutesSegment : PriceSegmentation|array<string|int, mixed>|null: The tariff segment substituted for the buyer's usual one, applied *instead of* a discount. Mutually exclusive with `adjustment` and `fixedPrice`.
$url : int|string|null: URL of the item.
$validFrom : string|int|null: The date from which the condition applies.
$validThrough : string|int|null: The date after which the condition no longer applies.
$warehouse : Warehouse|array<string|int, mixed>|null: The resolved point of sale the condition is valid at, when `selector.areaScope` is `WAREHOUSE`. Display-only : the resolver reads `selector.areaServed`, never this.
$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`.

CONTEXT

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


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

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.

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

Additional, not-yet-modelled properties carried structurally.


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

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

$additionalType

An additionalType for the item.


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

$adjustment

A list of stacked adjustments applied in order (e.g. −10 %, then −5 % on the remaining amount). Each is a signed percentage or amount — a discount, or a surcharge when negative. Always a list, even for a single adjustment.


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

Mutually exclusive with substitutesSegment and fixedPrice.

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

$alternateName

An alias for the item.


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

$category

The resolved price category the condition targets, when `selector.itemScope` is `CATEGORY`.


        public
            DefinedTerm|array<string|int, mixed>|null
    $category
     = null

Display-only : the resolver reads selector.itemId, never this.

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

$created

Date of creation of the resource.


        public
            null|string
    $created

$customer

The resolved buyer the condition targets, when `selector.customerScope` is `INDIVIDUAL`. Display-only : the resolver reads `selector.customerId`, never this.


        public
            Customer|array<string|int, mixed>|null
    $customer
     = null

#[HydrateAs]: \xyz\oihana\schema\organizations\Customer::class

$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

$excludedCustomers

The identifiers of the customers carved out of the scope (exceptions).


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

$excludedProducts

The identifiers of the products carved out of the scope (exceptions).


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

$fixedPrice

A fixed net price imposed by this condition, applied *instead of* any adjustment or segment substitution. Mutually exclusive with `adjustment` and `substitutesSegment`.


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

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

$free

Whether the item is granted free of charge under this condition.


        public
            bool|null
    $free

$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

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

$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

$product

The resolved product the condition targets, when `selector.itemScope` is `PRODUCT`. Display-only : the resolver reads `selector.itemId`, never this.


        public
            Product|array<string|int, mixed>|null
    $product
     = null

#[HydrateAs]: \xyz\oihana\schema\products\Product::class

$provider

The resolved supplier the condition is constrained to, when `selector.providerId` is set. Display-only : the resolver reads `selector.providerId`, never this.


        public
            Provider|array<string|int, mixed>|null
    $provider
     = null

#[HydrateAs]: \xyz\oihana\schema\organizations\Provider::class

$publisher

The publisher of the resource.


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

$quantityDiscount

An optional quantity-tier effect (discounts by quantity).


        public
            PriceQuantityDiscount|array<string|int, mixed>|null
    $quantityDiscount

#[HydrateAs]: \xyz\oihana\schema\products\PriceQuantityDiscount::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.

$selector

The selection criteria (who / what / where) this condition applies to.


        public
            PricingConditionSelector|array<string|int, mixed>|null
    $selector

#[HydrateAs]: \xyz\oihana\schema\products\PricingConditionSelector::class

$subjectOf

A CreativeWork or Event about this Thing.


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

$subsidiary

The resolved company the condition is valid at, when `selector.areaScope` is `COMPANY`. Display-only : the resolver reads `selector.areaServed`, never this.


        public
            Subsidiary|array<string|int, mixed>|null
    $subsidiary
     = null

#[HydrateAs]: \xyz\oihana\schema\organizations\Subsidiary::class

$substitutesSegment

The tariff segment substituted for the buyer's usual one, applied *instead of* a discount. Mutually exclusive with `adjustment` and `fixedPrice`.


        public
            PriceSegmentation|array<string|int, mixed>|null
    $substitutesSegment

#[HydrateAs]: \xyz\oihana\schema\products\PriceSegmentation::class

$url

URL of the item.


        public
            int|string|null
    $url

$validFrom

The date from which the condition applies.


        public
            string|int|null
    $validFrom

$validThrough

The date after which the condition no longer applies.


        public
            string|int|null
    $validThrough

$warehouse

The resolved point of sale the condition is valid at, when `selector.areaScope` is `WAREHOUSE`. Display-only : the resolver reads `selector.areaServed`, never this.


        public
            Warehouse|array<string|int, mixed>|null
    $warehouse
     = null

#[HydrateAs]: \xyz\oihana\schema\places\Warehouse::class

$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

PricingCondition extends StructuredValue

Tags

Table of Contents

Constants

Properties

Methods

Constants

CONTEXT

JSON_PRIORITY_KEYS

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalProperty

Attributes

$additionalType

$adjustment

Attributes

$alternateName

$category

Attributes

$created

$customer

Attributes

$description

$disambiguatingDescription

$excludedCustomers

$excludedProducts

$fixedPrice

Attributes

$free

$hasPart

$id

$identifier

$image

$isPartOf

$license

$mainEntityOfPage

$modified

$name

$owner

$potentialAction

$product

Attributes

$provider

Attributes

$publisher

$quantityDiscount

Attributes

$sameAs

$selector

Attributes

$subjectOf

$subsidiary

Attributes

$substitutesSegment

Attributes

$url

$validFrom

$validThrough

$warehouse

Attributes

$atContext

$atType

$DEFAULT_JSON_SERIALIZE_OPTIONS

$schemaTypeCache

Methods

__construct()

Parameters

Tags

getJsonSerializeOptions()

Return values

getSchemaType()

Return values

jsonSerialize()

Tags

Return values