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.

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.
$areaServed  : null|string|Place|GeoShape
The geographic area where a service or offered item is provided.
$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.
$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, 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.
$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, 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.
$provider  : null|Organization|Person
The service provider, service operator, or service performer; the goods producer.
$publisher  : string|array<string|int, mixed>|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).
$url  : int|string|null
URL of the item.
$validFrom  : null|string|int|DateTime
The date when the item becomes valid (DateTime).
$validThrough  : null|string|int|DateTime
The end of the validity of offer, price specification, or opening hours data (DateTime).

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

$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

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

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

$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

$url

URL of the item.

public int|string|null $url

$validFrom

The date when the item becomes valid (DateTime).

public null|string|int|DateTime $validFrom

$validThrough

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

public null|string|int|DateTime $validThrough

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