Oihana PHP System

FinancialIncentive extends Intangible

An event happening at a certain time and location, such as a concert, lecture, or festival. Repeated events may be structured as separate Event objects.

Tags
see
https://schema.org/FinancialIncentive

Table of Contents

Constants

CONTEXT  = 'https://schema.org'
JSON-LD @context declaration for Schema.org.
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]
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 active 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.
$areaServed  : null|string|Place|GeoShape|AdministrativeArea|array<string|int, mixed>
The geographic area where a service or offered item is provided.
$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.
$eligibleWithSupplier  : Organization|null
The supplier of the incentivized item/service for which the incentive is valid for such as a utility company, merchant, or contractor.
$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.
$incentiveAmount  : QuantitativeValue|UnitPriceSpecification|LoanOrCredit|null
Describes the amount that can be redeemed from this incentive.
$incentiveStatus  : null|string|IncentiveStatus|DefinedTerm
The status of the incentive (active, on hold, retired, etc.).
$incentiveType  : null|string|IncentiveType|DefinedTerm
The type of incentive offered (tax credit/rebate, tax deduction, tax waiver, subsidies, etc.).
$incentivizedItem  : array<string|int, mixed>|DefinedTerm|Product|null
The type or specific product(s) and/or service(s) being incentivized.
$incomeLimit  : string|null|MonetaryAmount
Income limit for which the incentive is applicable for (Optional).
$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.
$provider  : null|Organization|Person
The service provider, service operator, or service performer; the goods producer.
$publisher  : string|array<string|int, string|Person|Organization>|Person|Organization|null
The publisher of the resource.
$purchasePriceLimit  : null
The maximum price the item can have and still qualify for this offer (Optional).
$purchaseType  : string|DefinedTerm|Enumeration|null
The type of purchase the consumer must make in order to qualify for this incentive (Optional).
$qualifiedExpense  : string|DefinedTerm|Enumeration|null
The types of expenses that are covered by the incentive (Optional).
$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.
$url  : int|string|null
URL of the item.
$validFrom  : null|string|int
The date when the item becomes valid.
$validThrough  : null|string|int
The end of the validity of offer, price specification, or opening hours data.
$atContext  : string|null
The JSON-LD `@context` value.
$atType  : string|null
The JSON-LD `@type` value.

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

Constants

CONTEXT

JSON-LD @context declaration for Schema.org.

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

JSON_PRIORITY_KEYS

Defines the priority order of keys when serializing the object to JSON-LD.

public array<string|int, string> 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.

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

$eligibleWithSupplier

The supplier of the incentivized item/service for which the incentive is valid for such as a utility company, merchant, or contractor.

public Organization|null $eligibleWithSupplier

$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

$incentiveStatus

The status of the incentive (active, on hold, retired, etc.).

public null|string|IncentiveStatus|DefinedTerm $incentiveStatus

Example:

  • IncentiveStatusActive
  • IncentiveStatusInDevelopment
  • IncentiveStatusOnHold
  • IncentiveStatusRetired

$incentiveType

The type of incentive offered (tax credit/rebate, tax deduction, tax waiver, subsidies, etc.).

public null|string|IncentiveType|DefinedTerm $incentiveType

Example:

  • IncentiveTypeLoan
  • IncentiveTypeRebateOrSubsidy
  • IncentiveTypeTaxCredit
  • IncentiveTypeTaxDeduction
  • IncentiveTypeTaxWaiver

$incentivizedItem

The type or specific product(s) and/or service(s) being incentivized.

public array<string|int, mixed>|DefinedTerm|Product|null $incentivizedItem

DefinedTermSets are used for product and service categories such as the United Nations Standard Products and Services Code:

{
  "@type": "DefinedTerm",
  "inDefinedTermSet": "https://www.unspsc.org/",
  "termCode": "261315XX",
  "name": "Photovoltaic module"
}

$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

$provider

The service provider, service operator, or service performer; the goods producer.

public null|Organization|Person $provider

Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

$purchasePriceLimit

The maximum price the item can have and still qualify for this offer (Optional).

public null $purchasePriceLimit

$purchaseType

The type of purchase the consumer must make in order to qualify for this incentive (Optional).

public string|DefinedTerm|Enumeration|null $purchaseType

Example :

  • PurchaseTypeLease
  • PurchaseTypeNewPurchase
  • PurchaseTypeTradeIn
  • PurchaseTypeUsedPurchase

$qualifiedExpense

The types of expenses that are covered by the incentive (Optional).

public string|DefinedTerm|Enumeration|null $qualifiedExpense

For example some incentives are only for the goods (tangible items) but the services (labor) are excluded. Example :

  • IncentiveQualifiedExpenseTypeGoodsOnly
  • IncentiveQualifiedExpenseTypeGoodsOrServices
  • IncentiveQualifiedExpenseTypeServicesOnly
  • IncentiveQualifiedExpenseTypeUtilityBill

$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

$url

URL of the item.

public int|string|null $url

$validFrom

The date when the item becomes valid.

public null|string|int $validFrom

$validThrough

The end of the validity of offer, price specification, or opening hours data.

public null|string|int $validThrough

$atContext

The JSON-LD `@context` value.

private string|null $atContext = null

Default is https://schema.org.

$atType

The JSON-LD `@type` value.

private string|null $atType = null

This can be manually set or automatically inferred from the class name.

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
throws
ReflectionException
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>

Includes public properties, the JSON-LD @context and @type. Null values are automatically removed.

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>

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

        
On this page

Search results