313 lines
9.6 KiB
PHP
313 lines
9.6 KiB
PHP
<?php
|
|
|
|
namespace Spatie\SchemaOrg;
|
|
|
|
use Spatie\SchemaOrg\Contracts\IntangibleContract;
|
|
use Spatie\SchemaOrg\Contracts\LinkRoleContract;
|
|
use Spatie\SchemaOrg\Contracts\RoleContract;
|
|
use Spatie\SchemaOrg\Contracts\ThingContract;
|
|
|
|
/**
|
|
* A Role that represents a Web link, e.g. as expressed via the 'url' property.
|
|
* Its linkRelationship property can indicate URL-based and plain textual link
|
|
* types, e.g. those in IANA link registry or others such as 'amphtml'. This
|
|
* structure provides a placeholder where details from HTML's link element can
|
|
* be represented outside of HTML, e.g. in JSON-LD feeds.
|
|
*
|
|
* @see https://schema.org/LinkRole
|
|
* @see https://pending.schema.org
|
|
* @link https://github.com/schemaorg/schemaorg/issues/1045
|
|
*
|
|
*/
|
|
class LinkRole extends BaseType implements LinkRoleContract, IntangibleContract, RoleContract, 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);
|
|
}
|
|
|
|
/**
|
|
* 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 end date and time of the item (in [ISO 8601 date
|
|
* format](http://en.wikipedia.org/wiki/ISO_8601)).
|
|
*
|
|
* @param \DateTimeInterface|\DateTimeInterface[] $endDate
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/endDate
|
|
* @link https://github.com/schemaorg/schemaorg/issues/2486
|
|
*/
|
|
public function endDate($endDate)
|
|
{
|
|
return $this->setProperty('endDate', $endDate);
|
|
}
|
|
|
|
/**
|
|
* 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 language of the content or performance or used in an action. Please
|
|
* use one of the language codes from the [IETF BCP 47
|
|
* standard](http://tools.ietf.org/html/bcp47). See also
|
|
* [[availableLanguage]].
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/inLanguage
|
|
* @link https://github.com/schemaorg/schemaorg/issues/2382
|
|
*/
|
|
public function inLanguage($inLanguage)
|
|
{
|
|
return $this->setProperty('inLanguage', $inLanguage);
|
|
}
|
|
|
|
/**
|
|
* Indicates the relationship type of a Web link.
|
|
*
|
|
* @param string|string[] $linkRelationship
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/linkRelationship
|
|
* @see https://pending.schema.org
|
|
* @link https://github.com/schemaorg/schemaorg/issues/1045
|
|
*/
|
|
public function linkRelationship($linkRelationship)
|
|
{
|
|
return $this->setProperty('linkRelationship', $linkRelationship);
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
/**
|
|
* A position played, performed or filled by a person or organization, as
|
|
* part of an organization. For example, an athlete in a SportsTeam might
|
|
* play in the position named 'Quarterback'.
|
|
*
|
|
* @param string|string[] $namedPosition
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/namedPosition
|
|
*/
|
|
public function namedPosition($namedPosition)
|
|
{
|
|
return $this->setProperty('namedPosition', $namedPosition);
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
/**
|
|
* A role played, performed or filled by a person or organization. For
|
|
* example, the team of creators for a comic book might fill the roles named
|
|
* 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might
|
|
* play in the position named 'Quarterback'.
|
|
*
|
|
* @param string|string[] $roleName
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/roleName
|
|
*/
|
|
public function roleName($roleName)
|
|
{
|
|
return $this->setProperty('roleName', $roleName);
|
|
}
|
|
|
|
/**
|
|
* 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 start date and time of the item (in [ISO 8601 date
|
|
* format](http://en.wikipedia.org/wiki/ISO_8601)).
|
|
*
|
|
* @param \DateTimeInterface|\DateTimeInterface[] $startDate
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/startDate
|
|
* @link https://github.com/schemaorg/schemaorg/issues/2486
|
|
*/
|
|
public function startDate($startDate)
|
|
{
|
|
return $this->setProperty('startDate', $startDate);
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
}
|