Oihana Php Schema

PriceComponentType extends PriceComponentTypeEnumeration

Enumerates different price components that together make up the total price for an offered product.

Constants

ACTIVATION_FEE : string = 'https://schema.org/ActivationFee': Represents the schema.org URL for "Activation fee" constant.
ADDITIONAL_FEE : string = 'https://schema.oihana.xyz/AdditionalFee': Represents the schema.org URL for "Additional Fee" constant.
BUYING_PRICE_MARGIN : string = 'https://schema.oihana.xyz/BuyingPriceMargin': Represents the schema.org URL for "Buying Price Margin" constant.
BUYING_PRICE_VARIATIONS : string = 'https://schema.oihana.xyz/BuyingPriceVariations': Represents the schema.org URL for "Buying Variations" constant.
CLEANING_FEE : string = 'https://schema.org/CleaningFee': Represents the schema.org URL for "Cleaning fee" constant.
CONTEXT : string = 'https://schema.org': JSON-LD @context declaration for Schema.org.
COST_FACTOR : string = 'https://schema.oihana.xyz/CostFactor': Represents the schema.org URL for "Cost Factor" constant.
DEPOSIT : string = 'https://schema.oihana.xyz/Deposit': Represents the schema.org URL for "Deposit" constant.
DISCOUNT : string = 'https://schema.oihana.xyz/Discount': Represents the schema.org URL for "Discount" constant.
DISTANCE_FEE : string = 'https://schema.org/DistanceFee': Represents the schema.org URL for "Distance fee" constant.
DOWN_PAYMENT : string = 'https://schema.org/Downpayment': Represents the schema.org URL for "Down payment" constant.
ENVIRONMENTAL_FEE : string = 'https://schema.oihana.xyz/EnvironmentalFee': Represents the schema.org URL for "Environmental Fee" constant.
EXTRA_1_FEE : string = 'https://schema.oihana.xyz/Extra1Fee': Represents the schema.org URL for "First Extra Fee" constant.
EXTRA_2_FEE : string = 'https://schema.oihana.xyz/Extra2Fee': Represents the schema.org URL for "Second Extra Fee" constant.
INSTALLMENT : string = 'https://schema.org/Installment': Represents the schema.org URL for "Installment“ constant.
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.
PACKAGING : string = 'https://schema.oihana.xyz/Packaging': Represents the schema.org URL for "Packaging" constant.
PRICE_FACTOR : string = 'https://schema.oihana.xyz/PriceFactor': Represents the schema.org URL for "Price Factor" constant.
SELLING_FACTOR : string = 'https://schema.oihana.xyz/SellingFactor': Represents the schema.org URL for "Selling Factor" constant.
SELLING_MARGIN : string = 'https://schema.oihana.xyz/SellingMargin': Represents the schema.org URL for "Selling Margin" constant.
SELLING_REFERENCE_FACTOR : string = 'https://schema.oihana.xyz/SellingReferenceFactor': Represents the schema.org URL for "Selling Reference Factor" constant.
SERVICE_FEE : string = 'https://schema.oihana.xyz/ServiceFee': Represents the schema.org URL for "Service Fee" constant.
SHIPPING_FEE : string = 'https://schema.oihana.xyz/ShippingFee': Represents the schema.org URL for "Shipping Fee" constant.
SUBSCRIPTION : string = 'https://schema.org/Subscription': Represents the schema.org URL for "Subscription" constant.
SURCHARGE : string = 'https://schema.oihana.xyz/Surcharge': Represents the schema.org URL for "Surcharge" constant.

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.
$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.
$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.
$publisher : string|array<string|int, string|Person|Organization>|Person|Organization|null: The publisher of the resource.
$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.
$supersededBy : null|Type|Enumeration|Property
$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`.

ACTIVATION_FEE

Represents the schema.org URL for "Activation fee" constant.


    public
        string
    ACTIVATION_FEE
    = 'https://schema.org/ActivationFee'

Note : frais d'activation (fr)

ADDITIONAL_FEE

Represents the schema.org URL for "Additional Fee" constant.


    public
        string
    ADDITIONAL_FEE
    = 'https://schema.oihana.xyz/AdditionalFee'

Note : frais additionnels (fr)

BUYING_PRICE_MARGIN

Represents the schema.org URL for "Buying Price Margin" constant.


    public
        string
    BUYING_PRICE_MARGIN
    = 'https://schema.oihana.xyz/BuyingPriceMargin'

Note : Marge appliquée sur le prix d'achat (fr)

BUYING_PRICE_VARIATIONS

Represents the schema.org URL for "Buying Variations" constant.


    public
        string
    BUYING_PRICE_VARIATIONS
    = 'https://schema.oihana.xyz/BuyingPriceVariations'

Note : Total des variations sur le prix d'achat (remise et plus-values) (fr)

CLEANING_FEE

Represents the schema.org URL for "Cleaning fee" constant.


    public
        string
    CLEANING_FEE
    = 'https://schema.org/CleaningFee'

Note : frais de nettoyage (fr)

CONTEXT

JSON-LD @context declaration for Schema.org.


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

COST_FACTOR

Represents the schema.org URL for "Cost Factor" constant.


    public
        string
    COST_FACTOR
    = 'https://schema.oihana.xyz/CostFactor'

Used the cost factor to describe a multiplier applied to direct costs to include a portion of indirect costs or overhead expenses. This allows for the calculation of the total cost of a product or service.

DEPOSIT

Represents the schema.org URL for "Deposit" constant.


    public
        string
    DEPOSIT
    = 'https://schema.oihana.xyz/Deposit'

Note : consigne (fr)

DISCOUNT

Represents the schema.org URL for "Discount" constant.


    public
        string
    DISCOUNT
    = 'https://schema.oihana.xyz/Discount'

Note : remise (fr)

DISTANCE_FEE

Represents the schema.org URL for "Distance fee" constant.


    public
        string
    DISTANCE_FEE
    = 'https://schema.org/DistanceFee'

Note = frais kilométriques (fr)

DOWN_PAYMENT

Represents the schema.org URL for "Down payment" constant.


    public
        string
    DOWN_PAYMENT
    = 'https://schema.org/Downpayment'

Note : acompte (fr)

ENVIRONMENTAL_FEE

Represents the schema.org URL for "Environmental Fee" constant.


    public
        string
    ENVIRONMENTAL_FEE
    = 'https://schema.oihana.xyz/EnvironmentalFee'

Note : éco-participation (fr)

EXTRA_1_FEE

Represents the schema.org URL for "First Extra Fee" constant.


    public
        string
    EXTRA_1_FEE
    = 'https://schema.oihana.xyz/Extra1Fee'

Note : frais libres 1 (fr)

EXTRA_2_FEE

Represents the schema.org URL for "Second Extra Fee" constant.


    public
        string
    EXTRA_2_FEE
    = 'https://schema.oihana.xyz/Extra2Fee'

Note : frais libres 2 (fr)

INSTALLMENT

Represents the schema.org URL for "Installment“ constant.


    public
        string
    INSTALLMENT
    = 'https://schema.org/Installment'

Note : versement (fr)

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.

PACKAGING

Represents the schema.org URL for "Packaging" constant.


    public
        string
    PACKAGING
    = 'https://schema.oihana.xyz/Packaging'

Note : emballage (fr)

PRICE_FACTOR

Represents the schema.org URL for "Price Factor" constant.


    public
        string
    PRICE_FACTOR
    = 'https://schema.oihana.xyz/PriceFactor'

Note : Taux fixé du prix de vente de reference (T4 fixé)

SELLING_FACTOR

Represents the schema.org URL for "Selling Factor" constant.


    public
        string
    SELLING_FACTOR
    = 'https://schema.oihana.xyz/SellingFactor'

Note : Taux spécifique à appliquer sur un prix de vente (fr)

SELLING_MARGIN

Represents the schema.org URL for "Selling Margin" constant.


    public
        string
    SELLING_MARGIN
    = 'https://schema.oihana.xyz/SellingMargin'

Note : Marge dégagée sur une vente — prix de vente moins prix de revient (fr)

SELLING_REFERENCE_FACTOR

Represents the schema.org URL for "Selling Reference Factor" constant.


    public
        string
    SELLING_REFERENCE_FACTOR
    = 'https://schema.oihana.xyz/SellingReferenceFactor'

Note : Taux du prix de vente de reference (T4) (fr)

SERVICE_FEE

Represents the schema.org URL for "Service Fee" constant.


    public
        string
    SERVICE_FEE
    = 'https://schema.oihana.xyz/ServiceFee'

Note : frais de service (fr)

SHIPPING_FEE

Represents the schema.org URL for "Shipping Fee" constant.


    public
        string
    SHIPPING_FEE
    = 'https://schema.oihana.xyz/ShippingFee'

Note : frais de transport (fr)

SUBSCRIPTION

Represents the schema.org URL for "Subscription" constant.


    public
        string
    SUBSCRIPTION
    = 'https://schema.org/Subscription'

Note : abonnement (fr)

SURCHARGE

Represents the schema.org URL for "Surcharge" constant.


    public
        string
    SURCHARGE
    = 'https://schema.oihana.xyz/Surcharge'

Note : majoration (fr)

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

$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

$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

$publisher

The publisher of the resource.


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

$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

$supersededBy


        public
            null|Type|Enumeration|Property
    $supersededBy

$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

PriceComponentType extends PriceComponentTypeEnumeration

Tags

Table of Contents

Constants

Properties

Methods

Constants

ACTIVATION_FEE

ADDITIONAL_FEE

BUYING_PRICE_MARGIN

BUYING_PRICE_VARIATIONS

CLEANING_FEE

CONTEXT

COST_FACTOR

DEPOSIT

DISCOUNT

DISTANCE_FEE

DOWN_PAYMENT

ENVIRONMENTAL_FEE

EXTRA_1_FEE

EXTRA_2_FEE

INSTALLMENT

JSON_PRIORITY_KEYS

PACKAGING

PRICE_FACTOR

SELLING_FACTOR

SELLING_MARGIN

SELLING_REFERENCE_FACTOR

SERVICE_FEE

SHIPPING_FEE

SUBSCRIPTION

SURCHARGE

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalType

$alternateName

$created

$description

$disambiguatingDescription

$hasPart

$id

$identifier

$image

$isPartOf

$license

$mainEntityOfPage

$modified

$name

$owner

$potentialAction

$publisher

$sameAs

$subjectOf

$supersededBy

$url

$atContext

$atType

$DEFAULT_JSON_SERIALIZE_OPTIONS

$schemaTypeCache

Methods

__construct()

Parameters

Tags

getJsonSerializeOptions()

Return values

getSchemaType()

Return values

jsonSerialize()

Tags

Return values

withAtContext()

Parameters

Return values

withAtType()

Parameters