code
stringlengths 17
296k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function isBasedOnUrl($isBasedOnUrl)
{
return $this->setProperty('isBasedOnUrl', $isBasedOnUrl);
} | A resource that was used in the creation of this resource. This term can
be repeated for multiple sources. For example,
http://example.com/great-multiplication-intro.html.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|string|string[] $isBasedOnUrl
@return static
@see https://schema.org/isBasedOnUrl | isBasedOnUrl | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function isFamilyFriendly($isFamilyFriendly)
{
return $this->setProperty('isFamilyFriendly', $isFamilyFriendly);
} | Indicates whether this content is family friendly.
@param bool|bool[] $isFamilyFriendly
@return static
@see https://schema.org/isFamilyFriendly | isFamilyFriendly | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function isPartOf($isPartOf)
{
return $this->setProperty('isPartOf', $isPartOf);
} | Indicates an item or CreativeWork that this item, or CreativeWork (in
some sense), is part of.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $isPartOf
@return static
@see https://schema.org/isPartOf | isPartOf | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function keywords($keywords)
{
return $this->setProperty('keywords', $keywords);
} | Keywords or tags used to describe some item. Multiple textual entries in
a keywords list are typically delimited by commas, or by repeating the
property.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $keywords
@return static
@see https://schema.org/keywords | keywords | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function learningResourceType($learningResourceType)
{
return $this->setProperty('learningResourceType', $learningResourceType);
} | The predominant type or kind characterizing the learning resource. For
example, 'presentation', 'handout'.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $learningResourceType
@return static
@see https://schema.org/learningResourceType | learningResourceType | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function license($license)
{
return $this->setProperty('license', $license);
} | A license document that applies to this content, typically indicated by
URL.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $license
@return static
@see https://schema.org/license | license | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function locationCreated($locationCreated)
{
return $this->setProperty('locationCreated', $locationCreated);
} | The location where the CreativeWork was created, which may not be the
same as the location depicted in the CreativeWork.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $locationCreated
@return static
@see https://schema.org/locationCreated | locationCreated | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function mainEntity($mainEntity)
{
return $this->setProperty('mainEntity', $mainEntity);
} | Indicates the primary entity described in some page or other
CreativeWork.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $mainEntity
@return static
@see https://schema.org/mainEntity | mainEntity | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function mainEntityOfPage($mainEntityOfPage)
{
return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
} | 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 | mainEntityOfPage | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function maintainer($maintainer)
{
return $this->setProperty('maintainer', $maintainer);
} | A maintainer of a [[Dataset]], software package
([[SoftwareApplication]]), or other [[Project]]. A maintainer is a
[[Person]] or [[Organization]] that manages contributions to, and/or
publication of, some (typically complex) artifact. It is common for
distributions of software and data to be based on "upstream" sources.
When [[maintainer]] is applied to a specific version of something e.g. a
particular version or packaging of a [[Dataset]], it is always possible
that the upstream source has a different maintainer. The [[isBasedOn]]
property can be used to indicate such relationships between datasets to
make the different maintenance roles clear. Similarly in the case of
software, a package may have dedicated maintainers working on integration
into software distributions such as Ubuntu, as well as upstream
maintainers of the underlying work.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $maintainer
@return static
@see https://schema.org/maintainer
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2311 | maintainer | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function material($material)
{
return $this->setProperty('material', $material);
} | A material that something is made from, e.g. leather, wool, cotton,
paper.
@param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|string|string[] $material
@return static
@see https://schema.org/material | material | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function materialExtent($materialExtent)
{
return $this->setProperty('materialExtent', $materialExtent);
} | The quantity of the materials being described or an expression of the
physical space they occupy.
@param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|string|string[] $materialExtent
@return static
@see https://schema.org/materialExtent
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1759 | materialExtent | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function mentions($mentions)
{
return $this->setProperty('mentions', $mentions);
} | Indicates that the CreativeWork contains a reference to, but is not
necessarily about a concept.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $mentions
@return static
@see https://schema.org/mentions | mentions | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function offers($offers)
{
return $this->setProperty('offers', $offers);
} | An offer to provide this item—for example, an offer to sell a
product, rent the DVD of a movie, perform a service, or give away tickets
to an event. Use [[businessFunction]] to indicate the kind of transaction
offered, i.e. sell, lease, etc. This property can also be used to
describe a [[Demand]]. While this property is listed as expected on a
number of common types, it can be used in others. In that case, using a
second type, such as Product or a subtype of Product, can clarify the
nature of the offer.
@param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
@return static
@see https://schema.org/offers
@link https://github.com/schemaorg/schemaorg/issues/2289 | offers | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function pattern($pattern)
{
return $this->setProperty('pattern', $pattern);
} | A pattern that something has, for example 'polka dot', 'striped',
'Canadian flag'. Values are typically expressed as text, although links
to controlled value schemes are also supported.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $pattern
@return static
@see https://schema.org/pattern
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1797 | pattern | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function position($position)
{
return $this->setProperty('position', $position);
} | The position of an item in a series or sequence of items.
@param int|int[]|string|string[] $position
@return static
@see https://schema.org/position | position | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function potentialAction($potentialAction)
{
return $this->setProperty('potentialAction', $potentialAction);
} | 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 | potentialAction | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function producer($producer)
{
return $this->setProperty('producer', $producer);
} | The person or organization who produced the work (e.g. music album,
movie, TV/radio series etc.).
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $producer
@return static
@see https://schema.org/producer | producer | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function provider($provider)
{
return $this->setProperty('provider', $provider);
} | The service provider, service operator, or service performer; the goods
producer. Another party (a seller) may offer those services or goods on
behalf of the provider. A provider may also serve as the seller.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider
@return static
@see https://schema.org/provider
@see https://pending.schema.org | provider | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function publication($publication)
{
return $this->setProperty('publication', $publication);
} | A publication event associated with the item.
@param \Spatie\SchemaOrg\Contracts\PublicationEventContract|\Spatie\SchemaOrg\Contracts\PublicationEventContract[] $publication
@return static
@see https://schema.org/publication | publication | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function publisher($publisher)
{
return $this->setProperty('publisher', $publisher);
} | The publisher of the creative work.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $publisher
@return static
@see https://schema.org/publisher | publisher | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function publisherImprint($publisherImprint)
{
return $this->setProperty('publisherImprint', $publisherImprint);
} | The publishing division which published the comic.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $publisherImprint
@return static
@see https://schema.org/publisherImprint
@see https://bib.schema.org | publisherImprint | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function publishingPrinciples($publishingPrinciples)
{
return $this->setProperty('publishingPrinciples', $publishingPrinciples);
} | The publishingPrinciples property indicates (typically via [[URL]]) a
document describing the editorial principles of an [[Organization]] (or
individual, e.g. a [[Person]] writing a blog) that relate to their
activities as a publisher, e.g. ethics or diversity policies. When
applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are
those of the party primarily responsible for the creation of the
[[CreativeWork]].
While such policies are most typically expressed in natural language,
sometimes related information (e.g. indicating a [[funder]]) can be
expressed using schema.org terminology.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $publishingPrinciples
@return static
@see https://schema.org/publishingPrinciples | publishingPrinciples | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function recordedAt($recordedAt)
{
return $this->setProperty('recordedAt', $recordedAt);
} | The Event where the CreativeWork was recorded. The CreativeWork may
capture all or part of the event.
@param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $recordedAt
@return static
@see https://schema.org/recordedAt | recordedAt | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function releasedEvent($releasedEvent)
{
return $this->setProperty('releasedEvent', $releasedEvent);
} | The place and time the release was issued, expressed as a
PublicationEvent.
@param \Spatie\SchemaOrg\Contracts\PublicationEventContract|\Spatie\SchemaOrg\Contracts\PublicationEventContract[] $releasedEvent
@return static
@see https://schema.org/releasedEvent | releasedEvent | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function sameAs($sameAs)
{
return $this->setProperty('sameAs', $sameAs);
} | 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 | sameAs | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function schemaVersion($schemaVersion)
{
return $this->setProperty('schemaVersion', $schemaVersion);
} | Indicates (by URL or string) a particular version of a schema used in
some CreativeWork. This property was created primarily to
indicate the use of a specific schema.org release, e.g. ```10.0``` as
a simple string, or more explicitly via URL,
```https://schema.org/docs/releases.html#v10.0```. There may be
situations in which other schemas might usefully be referenced this way,
e.g.
```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```
but this has not been carefully explored in the community.
@param string|string[] $schemaVersion
@return static
@see https://schema.org/schemaVersion | schemaVersion | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function sdDatePublished($sdDatePublished)
{
return $this->setProperty('sdDatePublished', $sdDatePublished);
} | Indicates the date on which the current structured data was generated /
published. Typically used alongside [[sdPublisher]].
@param \DateTimeInterface|\DateTimeInterface[] $sdDatePublished
@return static
@see https://schema.org/sdDatePublished
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1886 | sdDatePublished | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function sdLicense($sdLicense)
{
return $this->setProperty('sdLicense', $sdLicense);
} | A license document that applies to this structured data, typically
indicated by URL.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $sdLicense
@return static
@see https://schema.org/sdLicense
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1886 | sdLicense | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function sdPublisher($sdPublisher)
{
return $this->setProperty('sdPublisher', $sdPublisher);
} | Indicates the party responsible for generating and publishing the current
structured data markup, typically in cases where the structured data is
derived automatically from existing published content but published on a
different site. For example, student projects and open data initiatives
often re-publish existing content with more explicitly structured
metadata. The
[[sdPublisher]] property helps make such practices more explicit.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sdPublisher
@return static
@see https://schema.org/sdPublisher
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1886 | sdPublisher | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function size($size)
{
return $this->setProperty('size', $size);
} | A standardized size of a product or creative work, specified either
through a simple textual string (for example 'XL', '32Wx34L'), a
QuantitativeValue with a unitCode, or a comprehensive and structured
[[SizeSpecification]]; in other cases, the [[width]], [[height]],
[[depth]] and [[weight]] properties may be more applicable.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|\Spatie\SchemaOrg\Contracts\SizeSpecificationContract|\Spatie\SchemaOrg\Contracts\SizeSpecificationContract[]|string|string[] $size
@return static
@see https://schema.org/size
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1797 | size | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function sourceOrganization($sourceOrganization)
{
return $this->setProperty('sourceOrganization', $sourceOrganization);
} | The Organization on whose behalf the creator was working.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $sourceOrganization
@return static
@see https://schema.org/sourceOrganization | sourceOrganization | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function spatial($spatial)
{
return $this->setProperty('spatial', $spatial);
} | The "spatial" property can be used in cases when more specific properties
(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are
not known to be appropriate.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $spatial
@return static
@see https://schema.org/spatial | spatial | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function spatialCoverage($spatialCoverage)
{
return $this->setProperty('spatialCoverage', $spatialCoverage);
} | The spatialCoverage of a CreativeWork indicates the place(s) which are
the focus of the content. It is a subproperty of
contentLocation intended primarily for more technical and detailed
materials. For example with a Dataset, it indicates
areas that the dataset describes: a dataset of New York weather
would have spatialCoverage which was the place: the state of New York.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $spatialCoverage
@return static
@see https://schema.org/spatialCoverage | spatialCoverage | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function sponsor($sponsor)
{
return $this->setProperty('sponsor', $sponsor);
} | A person or organization that supports a thing through a pledge, promise,
or financial contribution. E.g. a sponsor of a Medical Study or a
corporate sponsor of an event.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
@return static
@see https://schema.org/sponsor | sponsor | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function subjectOf($subjectOf)
{
return $this->setProperty('subjectOf', $subjectOf);
} | 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 | subjectOf | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function teaches($teaches)
{
return $this->setProperty('teaches', $teaches);
} | The item being described is intended to help a person learn the
competency or learning outcome defined by the referenced term.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $teaches
@return static
@see https://schema.org/teaches
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2427 | teaches | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function temporal($temporal)
{
return $this->setProperty('temporal', $temporal);
} | The "temporal" property can be used in cases where more specific
properties
(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]],
[[datePublished]]) are not known to be appropriate.
@param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal
@return static
@see https://schema.org/temporal | temporal | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function temporalCoverage($temporalCoverage)
{
return $this->setProperty('temporalCoverage', $temporalCoverage);
} | The temporalCoverage of a CreativeWork indicates the period that the
content applies to, i.e. that it describes, either as a DateTime or as a
textual string indicating a time period in [ISO 8601 time interval
format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In
the case of a Dataset it will typically indicate the relevant time
period in a precise notation (e.g. for a 2011 census dataset, the year
2011 would be written "2011/2012"). Other forms of content, e.g.
ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their
temporalCoverage in broader terms - textually or via well-known URL.
Written works such as books may sometimes have precise temporal
coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601
interval format format via "1939/1945".
Open-ended date ranges can be written with ".." in place of the end date.
For example, "2015-11/.." indicates a range beginning in November 2015
and with no specified final date. This is tentative and might be updated
in future when ISO 8601 is officially updated.
@param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage
@return static
@see https://schema.org/temporalCoverage | temporalCoverage | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function text($text)
{
return $this->setProperty('text', $text);
} | The textual content of this CreativeWork.
@param string|string[] $text
@return static
@see https://schema.org/text | text | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function thumbnail($thumbnail)
{
return $this->setProperty('thumbnail', $thumbnail);
} | Thumbnail image for an image or video.
@param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[] $thumbnail
@return static
@see https://schema.org/thumbnail | thumbnail | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function thumbnailUrl($thumbnailUrl)
{
return $this->setProperty('thumbnailUrl', $thumbnailUrl);
} | A thumbnail image relevant to the Thing.
@param string|string[] $thumbnailUrl
@return static
@see https://schema.org/thumbnailUrl | thumbnailUrl | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function timeRequired($timeRequired)
{
return $this->setProperty('timeRequired', $timeRequired);
} | Approximate or typical time it usually takes to work with or through the
content of this work for the typical or target audience.
@param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $timeRequired
@return static
@see https://schema.org/timeRequired | timeRequired | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function translationOfWork($translationOfWork)
{
return $this->setProperty('translationOfWork', $translationOfWork);
} | The work that this work has been translated from. E.g. 物种起源 is a
translationOf “On the Origin of Species”.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $translationOfWork
@return static
@see https://schema.org/translationOfWork
@see https://bib.schema.org | translationOfWork | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function translator($translator)
{
return $this->setProperty('translator', $translator);
} | Organization or person who adapts a creative work to different languages,
regional differences and technical requirements of a target market, or
that translates during some event.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
@return static
@see https://schema.org/translator | translator | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function typicalAgeRange($typicalAgeRange)
{
return $this->setProperty('typicalAgeRange', $typicalAgeRange);
} | The typical expected age range, e.g. '7-9', '11-'.
@param string|string[] $typicalAgeRange
@return static
@see https://schema.org/typicalAgeRange | typicalAgeRange | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function usageInfo($usageInfo)
{
return $this->setProperty('usageInfo', $usageInfo);
} | The schema.org [[usageInfo]] property indicates further information about
a [[CreativeWork]]. This property is applicable both to works that are
freely available and to those that require payment or other transactions.
It can reference additional information, e.g. community expectations on
preferred linking and citation conventions, as well as purchasing
details. For something that can be commercially licensed, usageInfo can
provide detailed, resource-specific information about licensing options.
This property can be used alongside the license property which indicates
license(s) applicable to some piece of content. The usageInfo property
can provide information about other licensing options, e.g. acquiring
commercial usage rights for an image that is also available under
non-commercial creative commons licenses.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $usageInfo
@return static
@see https://schema.org/usageInfo
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2454 | usageInfo | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function version($version)
{
return $this->setProperty('version', $version);
} | The version of the CreativeWork embodied by a specified resource.
@param float|float[]|int|int[]|string|string[] $version
@return static
@see https://schema.org/version | version | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function workExample($workExample)
{
return $this->setProperty('workExample', $workExample);
} | Example/instance/realization/derivation of the concept of this creative
work. E.g. the paperback edition, first edition, or e-book.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workExample
@return static
@see https://schema.org/workExample | workExample | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function workTranslation($workTranslation)
{
return $this->setProperty('workTranslation', $workTranslation);
} | A work that is a translation of the content of this work. E.g. 西遊記
has an English workTranslation “Journey to the West”, a German
workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation
Tây du ký bình khảo.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workTranslation
@return static
@see https://schema.org/workTranslation
@see https://bib.schema.org | workTranslation | php | spatie/schema-org | src/Code.php | https://github.com/spatie/schema-org/blob/master/src/Code.php | MIT |
public function additionalType($additionalType)
{
return $this->setProperty('additionalType', $additionalType);
} | 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 | additionalType | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function broadcastChannelId($broadcastChannelId)
{
return $this->setProperty('broadcastChannelId', $broadcastChannelId);
} | The unique address by which the BroadcastService can be identified in a
provider lineup. In US, this is typically a number.
@param string|string[] $broadcastChannelId
@return static
@see https://schema.org/broadcastChannelId | broadcastChannelId | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function broadcastFrequency($broadcastFrequency)
{
return $this->setProperty('broadcastFrequency', $broadcastFrequency);
} | The frequency used for over-the-air broadcasts. Numeric values or simple
ranges, e.g. 87-99. In addition a shortcut idiom is supported for
frequencies of AM and FM radio channels, e.g. "87 FM".
@param \Spatie\SchemaOrg\Contracts\BroadcastFrequencySpecificationContract|\Spatie\SchemaOrg\Contracts\BroadcastFrequencySpecificationContract[]|string|string[] $broadcastFrequency
@return static
@see https://schema.org/broadcastFrequency
@link https://github.com/schemaorg/schemaorg/issues/1004 | broadcastFrequency | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function broadcastServiceTier($broadcastServiceTier)
{
return $this->setProperty('broadcastServiceTier', $broadcastServiceTier);
} | The type of service required to have access to the channel (e.g. Standard
or Premium).
@param string|string[] $broadcastServiceTier
@return static
@see https://schema.org/broadcastServiceTier | broadcastServiceTier | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function disambiguatingDescription($disambiguatingDescription)
{
return $this->setProperty('disambiguatingDescription', $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.
@param string|string[] $disambiguatingDescription
@return static
@see https://schema.org/disambiguatingDescription | disambiguatingDescription | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function genre($genre)
{
return $this->setProperty('genre', $genre);
} | Genre of the creative work, broadcast channel or group.
@param string|string[] $genre
@return static
@see https://schema.org/genre | genre | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function identifier($identifier)
{
return $this->setProperty('identifier', $identifier);
} | 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 | identifier | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function image($image)
{
return $this->setProperty('image', $image);
} | 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 | image | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function inBroadcastLineup($inBroadcastLineup)
{
return $this->setProperty('inBroadcastLineup', $inBroadcastLineup);
} | The CableOrSatelliteService offering the channel.
@param \Spatie\SchemaOrg\Contracts\CableOrSatelliteServiceContract|\Spatie\SchemaOrg\Contracts\CableOrSatelliteServiceContract[] $inBroadcastLineup
@return static
@see https://schema.org/inBroadcastLineup | inBroadcastLineup | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function mainEntityOfPage($mainEntityOfPage)
{
return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
} | 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 | mainEntityOfPage | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function potentialAction($potentialAction)
{
return $this->setProperty('potentialAction', $potentialAction);
} | 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 | potentialAction | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function providesBroadcastService($providesBroadcastService)
{
return $this->setProperty('providesBroadcastService', $providesBroadcastService);
} | The BroadcastService offered on this channel.
@param \Spatie\SchemaOrg\Contracts\BroadcastServiceContract|\Spatie\SchemaOrg\Contracts\BroadcastServiceContract[] $providesBroadcastService
@return static
@see https://schema.org/providesBroadcastService | providesBroadcastService | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function sameAs($sameAs)
{
return $this->setProperty('sameAs', $sameAs);
} | 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 | sameAs | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function subjectOf($subjectOf)
{
return $this->setProperty('subjectOf', $subjectOf);
} | 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 | subjectOf | php | spatie/schema-org | src/FMRadioChannel.php | https://github.com/spatie/schema-org/blob/master/src/FMRadioChannel.php | MIT |
public function about($about)
{
return $this->setProperty('about', $about);
} | The subject matter of the content.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
@return static
@see https://schema.org/about
@link https://github.com/schemaorg/schemaorg/issues/1670 | about | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function abstract($abstract)
{
return $this->setProperty('abstract', $abstract);
} | An abstract is a short description that summarizes a [[CreativeWork]].
@param string|string[] $abstract
@return static
@see https://schema.org/abstract
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/276 | abstract | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function accessMode($accessMode)
{
return $this->setProperty('accessMode', $accessMode);
} | The human sensory perceptual system or cognitive faculty through which a
person may process or perceive information. Values should be drawn from
the [approved
vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
@param string|string[] $accessMode
@return static
@see https://schema.org/accessMode
@link https://github.com/schemaorg/schemaorg/issues/1100 | accessMode | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function accessModeSufficient($accessModeSufficient)
{
return $this->setProperty('accessModeSufficient', $accessModeSufficient);
} | A list of single or combined accessModes that are sufficient to
understand all the intellectual content of a resource. Values should be
drawn from the [approved
vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
@param \Spatie\SchemaOrg\Contracts\ItemListContract|\Spatie\SchemaOrg\Contracts\ItemListContract[] $accessModeSufficient
@return static
@see https://schema.org/accessModeSufficient
@link https://github.com/schemaorg/schemaorg/issues/1100 | accessModeSufficient | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function accessibilityAPI($accessibilityAPI)
{
return $this->setProperty('accessibilityAPI', $accessibilityAPI);
} | Indicates that the resource is compatible with the referenced
accessibility API. Values should be drawn from the [approved
vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
@param string|string[] $accessibilityAPI
@return static
@see https://schema.org/accessibilityAPI | accessibilityAPI | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function accessibilityControl($accessibilityControl)
{
return $this->setProperty('accessibilityControl', $accessibilityControl);
} | Identifies input methods that are sufficient to fully control the
described resource. Values should be drawn from the [approved
vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
@param string|string[] $accessibilityControl
@return static
@see https://schema.org/accessibilityControl | accessibilityControl | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function accessibilityFeature($accessibilityFeature)
{
return $this->setProperty('accessibilityFeature', $accessibilityFeature);
} | Content features of the resource, such as accessible media, alternatives
and supported enhancements for accessibility. Values should be drawn from
the [approved
vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
@param string|string[] $accessibilityFeature
@return static
@see https://schema.org/accessibilityFeature | accessibilityFeature | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function accessibilityHazard($accessibilityHazard)
{
return $this->setProperty('accessibilityHazard', $accessibilityHazard);
} | A characteristic of the described resource that is physiologically
dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should
be drawn from the [approved
vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
@param string|string[] $accessibilityHazard
@return static
@see https://schema.org/accessibilityHazard | accessibilityHazard | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function accessibilitySummary($accessibilitySummary)
{
return $this->setProperty('accessibilitySummary', $accessibilitySummary);
} | A human-readable summary of specific accessibility features or
deficiencies, consistent with the other accessibility metadata but
expressing subtleties such as "short descriptions are present but long
descriptions will be needed for non-visual users" or "short descriptions
are present and no long descriptions are needed".
@param string|string[] $accessibilitySummary
@return static
@see https://schema.org/accessibilitySummary
@link https://github.com/schemaorg/schemaorg/issues/1100 | accessibilitySummary | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function accountablePerson($accountablePerson)
{
return $this->setProperty('accountablePerson', $accountablePerson);
} | Specifies the Person that is legally accountable for the CreativeWork.
@param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $accountablePerson
@return static
@see https://schema.org/accountablePerson | accountablePerson | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function acquireLicensePage($acquireLicensePage)
{
return $this->setProperty('acquireLicensePage', $acquireLicensePage);
} | Indicates a page documenting how licenses can be purchased or otherwise
acquired, for the current item.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $acquireLicensePage
@return static
@see https://schema.org/acquireLicensePage
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2454 | acquireLicensePage | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function additionalType($additionalType)
{
return $this->setProperty('additionalType', $additionalType);
} | 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 | additionalType | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function aggregateRating($aggregateRating)
{
return $this->setProperty('aggregateRating', $aggregateRating);
} | The overall rating, based on a collection of reviews or ratings, of the
item.
@param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
@return static
@see https://schema.org/aggregateRating | aggregateRating | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function alternativeHeadline($alternativeHeadline)
{
return $this->setProperty('alternativeHeadline', $alternativeHeadline);
} | A secondary title of the CreativeWork.
@param string|string[] $alternativeHeadline
@return static
@see https://schema.org/alternativeHeadline | alternativeHeadline | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function archivedAt($archivedAt)
{
return $this->setProperty('archivedAt', $archivedAt);
} | Indicates a page or other link involved in archival of a
[[CreativeWork]]. In the case of [[MediaReview]], the items in a
[[MediaReviewItem]] may often become inaccessible, but be archived by
archival, journalistic, activist, or law enforcement organizations. In
such cases, the referenced page may not directly publish the content.
@param \Spatie\SchemaOrg\Contracts\WebPageContract|\Spatie\SchemaOrg\Contracts\WebPageContract[]|string|string[] $archivedAt
@return static
@see https://schema.org/archivedAt
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2450 | archivedAt | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function assesses($assesses)
{
return $this->setProperty('assesses', $assesses);
} | The item being described is intended to assess the competency or learning
outcome defined by the referenced term.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $assesses
@return static
@see https://schema.org/assesses
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2427 | assesses | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function associatedMedia($associatedMedia)
{
return $this->setProperty('associatedMedia', $associatedMedia);
} | A media object that encodes this CreativeWork. This property is a synonym
for encoding.
@param \Spatie\SchemaOrg\Contracts\MediaObjectContract|\Spatie\SchemaOrg\Contracts\MediaObjectContract[] $associatedMedia
@return static
@see https://schema.org/associatedMedia | associatedMedia | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function audience($audience)
{
return $this->setProperty('audience', $audience);
} | An intended audience, i.e. a group for whom something was created.
@param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
@return static
@see https://schema.org/audience | audience | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function author($author)
{
return $this->setProperty('author', $author);
} | The author of this content or rating. Please note that author is special
in that HTML 5 provides a special mechanism for indicating authorship via
the rel tag. That is equivalent to this and may be used interchangeably.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $author
@return static
@see https://schema.org/author | author | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function award($award)
{
return $this->setProperty('award', $award);
} | An award won by or for this item.
@param string|string[] $award
@return static
@see https://schema.org/award | award | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function awards($awards)
{
return $this->setProperty('awards', $awards);
} | Awards won by or for this item.
@param string|string[] $awards
@return static
@see https://schema.org/awards | awards | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function character($character)
{
return $this->setProperty('character', $character);
} | Fictional person connected with a creative work.
@param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $character
@return static
@see https://schema.org/character | character | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function citation($citation)
{
return $this->setProperty('citation', $citation);
} | A citation or reference to another creative work, such as another
publication, web page, scholarly article, etc.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $citation
@return static
@see https://schema.org/citation | citation | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function comment($comment)
{
return $this->setProperty('comment', $comment);
} | Comments, typically from users.
@param \Spatie\SchemaOrg\Contracts\CommentContract|\Spatie\SchemaOrg\Contracts\CommentContract[] $comment
@return static
@see https://schema.org/comment | comment | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function commentCount($commentCount)
{
return $this->setProperty('commentCount', $commentCount);
} | The number of comments this CreativeWork (e.g. Article, Question or
Answer) has received. This is most applicable to works published in Web
sites with commenting system; additional comments may exist elsewhere.
@param int|int[] $commentCount
@return static
@see https://schema.org/commentCount | commentCount | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function conditionsOfAccess($conditionsOfAccess)
{
return $this->setProperty('conditionsOfAccess', $conditionsOfAccess);
} | Conditions that affect the availability of, or method(s) of access to, an
item. Typically used for real world items such as an [[ArchiveComponent]]
held by an [[ArchiveOrganization]]. This property is not suitable for use
as a general Web access control mechanism. It is expressed only in
natural language.
For example "Available by appointment from the Reading Room" or
"Accessible only from logged-in accounts ".
@param string|string[] $conditionsOfAccess
@return static
@see https://schema.org/conditionsOfAccess
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2173 | conditionsOfAccess | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function contentLocation($contentLocation)
{
return $this->setProperty('contentLocation', $contentLocation);
} | The location depicted or described in the content. For example, the
location in a photograph or painting.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $contentLocation
@return static
@see https://schema.org/contentLocation | contentLocation | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function contentRating($contentRating)
{
return $this->setProperty('contentRating', $contentRating);
} | Official rating of a piece of content—for example, 'MPAA PG-13'.
@param \Spatie\SchemaOrg\Contracts\RatingContract|\Spatie\SchemaOrg\Contracts\RatingContract[]|string|string[] $contentRating
@return static
@see https://schema.org/contentRating | contentRating | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function contentReferenceTime($contentReferenceTime)
{
return $this->setProperty('contentReferenceTime', $contentReferenceTime);
} | The specific time described by a creative work, for works (e.g. articles,
video objects etc.) that emphasise a particular moment within an Event.
@param \DateTimeInterface|\DateTimeInterface[] $contentReferenceTime
@return static
@see https://schema.org/contentReferenceTime
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1050 | contentReferenceTime | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function contributor($contributor)
{
return $this->setProperty('contributor', $contributor);
} | A secondary contributor to the CreativeWork or Event.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
@return static
@see https://schema.org/contributor | contributor | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function copyrightHolder($copyrightHolder)
{
return $this->setProperty('copyrightHolder', $copyrightHolder);
} | The party holding the legal copyright to the CreativeWork.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $copyrightHolder
@return static
@see https://schema.org/copyrightHolder | copyrightHolder | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function copyrightNotice($copyrightNotice)
{
return $this->setProperty('copyrightNotice', $copyrightNotice);
} | Text of a notice appropriate for describing the copyright aspects of this
Creative Work, ideally indicating the owner of the copyright for the
Work.
@param string|string[] $copyrightNotice
@return static
@see https://schema.org/copyrightNotice
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2659 | copyrightNotice | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function copyrightYear($copyrightYear)
{
return $this->setProperty('copyrightYear', $copyrightYear);
} | The year during which the claimed copyright for the CreativeWork was
first asserted.
@param float|float[]|int|int[] $copyrightYear
@return static
@see https://schema.org/copyrightYear | copyrightYear | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function correction($correction)
{
return $this->setProperty('correction', $correction);
} | Indicates a correction to a [[CreativeWork]], either via a
[[CorrectionComment]], textually or in another document.
@param \Spatie\SchemaOrg\Contracts\CorrectionCommentContract|\Spatie\SchemaOrg\Contracts\CorrectionCommentContract[]|string|string[] $correction
@return static
@see https://schema.org/correction
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1950 | correction | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function countryOfOrigin($countryOfOrigin)
{
return $this->setProperty('countryOfOrigin', $countryOfOrigin);
} | The country of origin of something, including products as well as
creative works such as movie and TV content.
In the case of TV and movie, this would be the country of the principle
offices of the production company or individual responsible for the
movie. For other kinds of [[CreativeWork]] it is difficult to provide
fully general guidance, and properties such as [[contentLocation]] and
[[locationCreated]] may be more applicable.
In the case of products, the country of origin of the product. The exact
interpretation of this may vary by context and product type, and cannot
be fully enumerated here.
@param \Spatie\SchemaOrg\Contracts\CountryContract|\Spatie\SchemaOrg\Contracts\CountryContract[] $countryOfOrigin
@return static
@see https://schema.org/countryOfOrigin | countryOfOrigin | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
public function creativeWorkStatus($creativeWorkStatus)
{
return $this->setProperty('creativeWorkStatus', $creativeWorkStatus);
} | The status of a creative work in terms of its stage in a lifecycle.
Example terms include Incomplete, Draft, Published, Obsolete. Some
organizations define a set of terms for the stages of their publication
lifecycle.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $creativeWorkStatus
@return static
@see https://schema.org/creativeWorkStatus
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/987 | creativeWorkStatus | php | spatie/schema-org | src/NoteDigitalDocument.php | https://github.com/spatie/schema-org/blob/master/src/NoteDigitalDocument.php | MIT |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.