356 lines
11 KiB
PHP
356 lines
11 KiB
PHP
<?php
|
|
|
|
namespace Spatie\SchemaOrg;
|
|
|
|
use Spatie\SchemaOrg\Contracts\ContactPointContract;
|
|
use Spatie\SchemaOrg\Contracts\IntangibleContract;
|
|
use Spatie\SchemaOrg\Contracts\StructuredValueContract;
|
|
use Spatie\SchemaOrg\Contracts\ThingContract;
|
|
|
|
/**
|
|
* A contact point—for example, a Customer Complaints department.
|
|
*
|
|
* @see https://schema.org/ContactPoint
|
|
*
|
|
*/
|
|
class ContactPoint extends BaseType implements ContactPointContract, IntangibleContract, 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 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 language someone may use with or at the item, service or place. Please
|
|
* use one of the language codes from the [IETF BCP 47
|
|
* standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]].
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $availableLanguage
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/availableLanguage
|
|
*/
|
|
public function availableLanguage($availableLanguage)
|
|
{
|
|
return $this->setProperty('availableLanguage', $availableLanguage);
|
|
}
|
|
|
|
/**
|
|
* An option available on this contact point (e.g. a toll-free number or
|
|
* support for hearing-impaired callers).
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\ContactPointOptionContract|\Spatie\SchemaOrg\Contracts\ContactPointOptionContract[] $contactOption
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/contactOption
|
|
*/
|
|
public function contactOption($contactOption)
|
|
{
|
|
return $this->setProperty('contactOption', $contactOption);
|
|
}
|
|
|
|
/**
|
|
* A person or organization can have different contact points, for different
|
|
* purposes. For example, a sales contact point, a PR contact point and so
|
|
* on. This property is used to specify the kind of contact point.
|
|
*
|
|
* @param string|string[] $contactType
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/contactType
|
|
*/
|
|
public function contactType($contactType)
|
|
{
|
|
return $this->setProperty('contactType', $contactType);
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
/**
|
|
* Email address.
|
|
*
|
|
* @param string|string[] $email
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/email
|
|
*/
|
|
public function email($email)
|
|
{
|
|
return $this->setProperty('email', $email);
|
|
}
|
|
|
|
/**
|
|
* The fax number.
|
|
*
|
|
* @param string|string[] $faxNumber
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/faxNumber
|
|
*/
|
|
public function faxNumber($faxNumber)
|
|
{
|
|
return $this->setProperty('faxNumber', $faxNumber);
|
|
}
|
|
|
|
/**
|
|
* The hours during which this service or contact is available.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $hoursAvailable
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/hoursAvailable
|
|
*/
|
|
public function hoursAvailable($hoursAvailable)
|
|
{
|
|
return $this->setProperty('hoursAvailable', $hoursAvailable);
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
/**
|
|
* 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 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 product or service this support contact point is related to (such as
|
|
* product support for a particular product line). This can be a specific
|
|
* product or product line (e.g. "iPhone") or a general category of products
|
|
* or services (e.g. "smartphones").
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|string|string[] $productSupported
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/productSupported
|
|
*/
|
|
public function productSupported($productSupported)
|
|
{
|
|
return $this->setProperty('productSupported', $productSupported);
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
/**
|
|
* The geographic area where the service 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[] $serviceArea
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/serviceArea
|
|
*/
|
|
public function serviceArea($serviceArea)
|
|
{
|
|
return $this->setProperty('serviceArea', $serviceArea);
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
/**
|
|
* The telephone number.
|
|
*
|
|
* @param string|string[] $telephone
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/telephone
|
|
*/
|
|
public function telephone($telephone)
|
|
{
|
|
return $this->setProperty('telephone', $telephone);
|
|
}
|
|
|
|
/**
|
|
* URL of the item.
|
|
*
|
|
* @param string|string[] $url
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/url
|
|
*/
|
|
public function url($url)
|
|
{
|
|
return $this->setProperty('url', $url);
|
|
}
|
|
}
|