444 lines
15 KiB
PHP
444 lines
15 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
namespace Spatie\SchemaOrg;
|
||
|
|
|
||
|
|
use Spatie\SchemaOrg\Contracts\DeliveryChargeSpecificationContract;
|
||
|
|
use Spatie\SchemaOrg\Contracts\IntangibleContract;
|
||
|
|
use Spatie\SchemaOrg\Contracts\PriceSpecificationContract;
|
||
|
|
use Spatie\SchemaOrg\Contracts\StructuredValueContract;
|
||
|
|
use Spatie\SchemaOrg\Contracts\ThingContract;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The price for the delivery of an offer using a particular delivery method.
|
||
|
|
*
|
||
|
|
* @see https://schema.org/DeliveryChargeSpecification
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
class DeliveryChargeSpecification extends BaseType implements DeliveryChargeSpecificationContract, IntangibleContract, PriceSpecificationContract, StructuredValueContract, ThingContract
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* An additional type for the item, typically used for adding more specific
|
||
|
|
* types from external vocabularies in microdata syntax. This is a
|
||
|
|
* relationship between something and a class that the thing is in.
|
||
|
|
* Typically the value is a URI-identified RDF class, and in this case
|
||
|
|
* corresponds to the
|
||
|
|
* use of rdf:type in RDF. Text values can be used sparingly, for cases
|
||
|
|
* where useful information can be added without their being an appropriate
|
||
|
|
* schema to reference. In the case of text values, the class label should
|
||
|
|
* follow the schema.org [style
|
||
|
|
* guide](https://schema.org/docs/styleguide.html).
|
||
|
|
*
|
||
|
|
* @param string|string[] $additionalType
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/additionalType
|
||
|
|
*/
|
||
|
|
public function additionalType($additionalType)
|
||
|
|
{
|
||
|
|
return $this->setProperty('additionalType', $additionalType);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An alias for the item.
|
||
|
|
*
|
||
|
|
* @param string|string[] $alternateName
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/alternateName
|
||
|
|
*/
|
||
|
|
public function alternateName($alternateName)
|
||
|
|
{
|
||
|
|
return $this->setProperty('alternateName', $alternateName);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The delivery method(s) to which the delivery charge or payment charge
|
||
|
|
* specification applies.
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\DeliveryMethodContract|\Spatie\SchemaOrg\Contracts\DeliveryMethodContract[] $appliesToDeliveryMethod
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/appliesToDeliveryMethod
|
||
|
|
*/
|
||
|
|
public function appliesToDeliveryMethod($appliesToDeliveryMethod)
|
||
|
|
{
|
||
|
|
return $this->setProperty('appliesToDeliveryMethod', $appliesToDeliveryMethod);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The geographic area where a service or offered item is provided.
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\AdministrativeAreaContract|\Spatie\SchemaOrg\Contracts\AdministrativeAreaContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|string|string[] $areaServed
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/areaServed
|
||
|
|
*/
|
||
|
|
public function areaServed($areaServed)
|
||
|
|
{
|
||
|
|
return $this->setProperty('areaServed', $areaServed);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A description of the item.
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\TextObjectContract|\Spatie\SchemaOrg\Contracts\TextObjectContract[]|string|string[] $description
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/description
|
||
|
|
*/
|
||
|
|
public function description($description)
|
||
|
|
{
|
||
|
|
return $this->setProperty('description', $description);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
*
|
||
|
|
* @param string|string[] $disambiguatingDescription
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/disambiguatingDescription
|
||
|
|
*/
|
||
|
|
public function disambiguatingDescription($disambiguatingDescription)
|
||
|
|
{
|
||
|
|
return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The interval and unit of measurement of ordering quantities for which the
|
||
|
|
* offer or price specification is valid. This allows e.g. specifying that a
|
||
|
|
* certain freight charge is valid only for a certain quantity.
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $eligibleQuantity
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/eligibleQuantity
|
||
|
|
*/
|
||
|
|
public function eligibleQuantity($eligibleQuantity)
|
||
|
|
{
|
||
|
|
return $this->setProperty('eligibleQuantity', $eligibleQuantity);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the
|
||
|
|
* GeoShape for the geo-political region(s) for which the offer or delivery
|
||
|
|
* charge specification is valid.
|
||
|
|
*
|
||
|
|
* See also [[ineligibleRegion]].
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|string|string[] $eligibleRegion
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/eligibleRegion
|
||
|
|
* @link https://github.com/schemaorg/schemaorg/issues/1741
|
||
|
|
*/
|
||
|
|
public function eligibleRegion($eligibleRegion)
|
||
|
|
{
|
||
|
|
return $this->setProperty('eligibleRegion', $eligibleRegion);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[] $eligibleTransactionVolume
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/eligibleTransactionVolume
|
||
|
|
*/
|
||
|
|
public function eligibleTransactionVolume($eligibleTransactionVolume)
|
||
|
|
{
|
||
|
|
return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The identifier property represents any kind of identifier for any kind of
|
||
|
|
* [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
|
||
|
|
* dedicated properties for representing many of these, either as textual
|
||
|
|
* strings or as URL (URI) links. See [background
|
||
|
|
* notes](/docs/datamodel.html#identifierBg) for more details.
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/identifier
|
||
|
|
*/
|
||
|
|
public function identifier($identifier)
|
||
|
|
{
|
||
|
|
return $this->setProperty('identifier', $identifier);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An image of the item. This can be a [[URL]] or a fully described
|
||
|
|
* [[ImageObject]].
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/image
|
||
|
|
*/
|
||
|
|
public function image($image)
|
||
|
|
{
|
||
|
|
return $this->setProperty('image', $image);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the
|
||
|
|
* GeoShape for the geo-political region(s) for which the offer or delivery
|
||
|
|
* charge specification is not valid, e.g. a region where the transaction is
|
||
|
|
* not allowed.
|
||
|
|
*
|
||
|
|
* See also [[eligibleRegion]].
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|string|string[] $ineligibleRegion
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/ineligibleRegion
|
||
|
|
* @see https://pending.schema.org
|
||
|
|
* @link https://github.com/schemaorg/schemaorg/issues/2242
|
||
|
|
*/
|
||
|
|
public function ineligibleRegion($ineligibleRegion)
|
||
|
|
{
|
||
|
|
return $this->setProperty('ineligibleRegion', $ineligibleRegion);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Indicates a page (or other CreativeWork) for which this thing is the main
|
||
|
|
* entity being described. See [background
|
||
|
|
* notes](/docs/datamodel.html#mainEntityBackground) for details.
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/mainEntityOfPage
|
||
|
|
*/
|
||
|
|
public function mainEntityOfPage($mainEntityOfPage)
|
||
|
|
{
|
||
|
|
return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The highest price if the price is a range.
|
||
|
|
*
|
||
|
|
* @param float|float[]|int|int[] $maxPrice
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/maxPrice
|
||
|
|
*/
|
||
|
|
public function maxPrice($maxPrice)
|
||
|
|
{
|
||
|
|
return $this->setProperty('maxPrice', $maxPrice);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The lowest price if the price is a range.
|
||
|
|
*
|
||
|
|
* @param float|float[]|int|int[] $minPrice
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/minPrice
|
||
|
|
*/
|
||
|
|
public function minPrice($minPrice)
|
||
|
|
{
|
||
|
|
return $this->setProperty('minPrice', $minPrice);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The name of the item.
|
||
|
|
*
|
||
|
|
* @param string|string[] $name
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/name
|
||
|
|
*/
|
||
|
|
public function name($name)
|
||
|
|
{
|
||
|
|
return $this->setProperty('name', $name);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Indicates a potential Action, which describes an idealized action in
|
||
|
|
* which this thing would play an 'object' role.
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/potentialAction
|
||
|
|
*/
|
||
|
|
public function potentialAction($potentialAction)
|
||
|
|
{
|
||
|
|
return $this->setProperty('potentialAction', $potentialAction);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The offer price of a product, or of a price component when attached to
|
||
|
|
* PriceSpecification and its subtypes.
|
||
|
|
*
|
||
|
|
* Usage guidelines:
|
||
|
|
*
|
||
|
|
* * Use the [[priceCurrency]] property (with standard formats: [ISO 4217
|
||
|
|
* currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD";
|
||
|
|
* [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)
|
||
|
|
* for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange
|
||
|
|
* Trading
|
||
|
|
* Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)
|
||
|
|
* (LETS) and other currency types, e.g. "Ithaca HOUR") instead of including
|
||
|
|
* [ambiguous
|
||
|
|
* symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)
|
||
|
|
* such as '$' in the value.
|
||
|
|
* * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
|
||
|
|
* decimal point. Avoid using these symbols as a readability separator.
|
||
|
|
* * Note that both
|
||
|
|
* [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)
|
||
|
|
* and Microdata syntax allow the use of a "content=" attribute for
|
||
|
|
* publishing simple machine-readable values alongside more human-friendly
|
||
|
|
* formatting.
|
||
|
|
* * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
|
||
|
|
* NINE' (U+0039)) rather than superficially similar Unicode symbols.
|
||
|
|
*
|
||
|
|
* @param float|float[]|int|int[]|string|string[] $price
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/price
|
||
|
|
*/
|
||
|
|
public function price($price)
|
||
|
|
{
|
||
|
|
return $this->setProperty('price', $price);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The currency of the price, or a price component when attached to
|
||
|
|
* [[PriceSpecification]] and its subtypes.
|
||
|
|
*
|
||
|
|
* Use standard formats: [ISO 4217 currency
|
||
|
|
* format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker
|
||
|
|
* symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for
|
||
|
|
* cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange
|
||
|
|
* Trading
|
||
|
|
* Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)
|
||
|
|
* (LETS) and other currency types, e.g. "Ithaca HOUR".
|
||
|
|
*
|
||
|
|
* @param string|string[] $priceCurrency
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/priceCurrency
|
||
|
|
*/
|
||
|
|
public function priceCurrency($priceCurrency)
|
||
|
|
{
|
||
|
|
return $this->setProperty('priceCurrency', $priceCurrency);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* URL of a reference Web page that unambiguously indicates the item's
|
||
|
|
* identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
|
||
|
|
* official website.
|
||
|
|
*
|
||
|
|
* @param string|string[] $sameAs
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/sameAs
|
||
|
|
*/
|
||
|
|
public function sameAs($sameAs)
|
||
|
|
{
|
||
|
|
return $this->setProperty('sameAs', $sameAs);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A CreativeWork or Event about this Thing.
|
||
|
|
*
|
||
|
|
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/subjectOf
|
||
|
|
* @link https://github.com/schemaorg/schemaorg/issues/1670
|
||
|
|
*/
|
||
|
|
public function subjectOf($subjectOf)
|
||
|
|
{
|
||
|
|
return $this->setProperty('subjectOf', $subjectOf);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* URL of the item.
|
||
|
|
*
|
||
|
|
* @param string|string[] $url
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/url
|
||
|
|
*/
|
||
|
|
public function url($url)
|
||
|
|
{
|
||
|
|
return $this->setProperty('url', $url);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The date when the item becomes valid.
|
||
|
|
*
|
||
|
|
* @param \DateTimeInterface|\DateTimeInterface[] $validFrom
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/validFrom
|
||
|
|
*/
|
||
|
|
public function validFrom($validFrom)
|
||
|
|
{
|
||
|
|
return $this->setProperty('validFrom', $validFrom);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The date after when the item is not valid. For example the end of an
|
||
|
|
* offer, salary period, or a period of opening hours.
|
||
|
|
*
|
||
|
|
* @param \DateTimeInterface|\DateTimeInterface[] $validThrough
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/validThrough
|
||
|
|
*/
|
||
|
|
public function validThrough($validThrough)
|
||
|
|
{
|
||
|
|
return $this->setProperty('validThrough', $validThrough);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Specifies whether the applicable value-added tax (VAT) is included in the
|
||
|
|
* price specification or not.
|
||
|
|
*
|
||
|
|
* @param bool|bool[] $valueAddedTaxIncluded
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*
|
||
|
|
* @see https://schema.org/valueAddedTaxIncluded
|
||
|
|
*/
|
||
|
|
public function valueAddedTaxIncluded($valueAddedTaxIncluded)
|
||
|
|
{
|
||
|
|
return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded);
|
||
|
|
}
|
||
|
|
}
|