Oihana PHP System

Review extends CreativeWork

A review of an item - for example, of a restaurant, movie, or store.

Table of Contents

Constants

CONTEXT  = 'https://schema.org'
JSON-LD @context declaration for Schema.org.

Properties

$_from  : string|null
The metadata to indicates the edge 'from' identifier.
$_id  : null|string
The metadata identifier of the item.
$_key  : null|string
The metadata unique key identifier of the thing.
$_rev  : null|string
The metadata revision value of the thing.
$_to  : string|null
The metadata to indicates the edge 'to' identifier.
$about  : string|object|null
The subject matter of the content.
$abstract  : string|null
An abstract is a short description that summarizes a CreativeWork.
$accessibilityAPI  : string|null
Indicates that the resource is compatible with the referenced accessibility API.
$accessibilityControl  : string|null
Identifies input methods that are sufficient to fully control the described resource.
$accessibilityFeature  : string|null
Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility.
$accessibilityHazard  : string|null
A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3.
$accessibilitySummary  : string|null
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".
$accessMode  : string|null
The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.
$accessModeSufficient  : ItemList|null
A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource.
$accountablePerson  : array<string|int, mixed>|Person|null
Specifies the Person that is legally accountable for the CreativeWork.
$acquireLicensePage  : string|CreativeWork|null
Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
$active  : bool|null
The active flag.
$additionalType  : array<string|int, mixed>|string|null|object
An additionalType for the item.
$aggregateRating  : array<string|int, mixed>|AggregateRating|null
The overall rating, based on a collection of reviews or ratings, of the item.
$alternateName  : string|object|null
An alias for the item.
$alternativeHeadline  : string|object|null
The alternative headline of this content.
$archivedAt  : string|WebPage|null
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.
$assesses  : string|DefinedTerm|null
The item being described is intended to assess the competency or learning outcome defined by the referenced term.
$associatedMedia  : array<string|int, mixed>|MediaObject|null
A media object that encodes this CreativeWork. This property is a synonym for encoding.
$audience  : null|array<string|int, mixed>|Audience
An intended audience, i.e. a group for whom something was created.
$audio  : object|null
An embedded audio object.
$author  : null|string|AudioObject
The author of this content.
$contentLocation  : string|Place|null
The location depicted or described in the content. For example, the location in a photograph or painting.
$contentRating  : string
Official rating of a piece of content—for example,'MPAA PG-13'.
$contributor  : string|object|null
A secondary contributor to the CreativeWork or Event.
$copyrightHolder  : string|null
The party holding the legal copyright to the CreativeWork.
$copyrightYear  : string|null
The year during which the claimed copyright for the CreativeWork was first asserted.
$created  : null|string|DateTime
Date of creation of the resource.
$dateCreated  : string|null
The date on which the CreativeWork was created or the item was added to a DataFeed.
$dateModified  : string|null
The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
$datePublished  : string|null
Date of first broadcast/publication.
$description  : string|null
A short description of the item.
$disambiguatingDescription  : string|null
A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
$editor  : string|null
Specifies the Person who edited the CreativeWork.
$encoding  : string|null
The encoding of this content.
$encodingFormat  : string|null
Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.).
$expires  : string|null
Date the content expires and is no longer useful or available. For example a VideoObject or NewsArticle whose availability or relevance is time-limited, or a ClaimReview fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
$hasPart  : string|Thing|array<string|int, mixed>|null
Indicates an item that this part of this item.
$headline  : string|object|null
The headline of this content.
$id  : null|int|string
The unique identifier of the item.
$identifier  : string|null
The identifier of the item.
$image  : string|object|null
The image reference of this resource.
$inLanguage  : array<string|int, mixed>|string|null
The language of the content or performance or used in an action.
$interactionStatistic  : InteractionCounter|array<string|int, mixed>|null
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication.
$isAccessibleForFree  : bool|null
A flag to signal that the item, event, or place is accessible for free.
$isBasedOn  : array<string|int, mixed>|object|null
A resource that was used in the creation of this resource. This term can be repeated for multiple sources.
$isPartOf  : string|Thing|array<string|int, mixed>|null
Indicates an item that this item is part of.
$itemReviewed  : Thing|null
The item that is being reviewed/rated.
$keywords  : string|DefinedTerm|array<string|int, mixed>|null
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.
$license  : string|object|null
A legal document giving official permission to do something with the resource.
$locationCreated  : string|object|null
The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
$mainEntity  : string|object|null
Indicates the primary entity described in some page or other CreativeWork.
$material  : array<string|int, mixed>|Product|string|null
A material that something is made from, e.g. leather, wool, cotton, paper.
$mentions  : array<string|int, mixed>|string|null
The mentions of this content.
$modified  : null|string|DateTime
Date on which the resource was changed.
$name  : int|string|null
The name of the item.
$offers  : array<string|int, mixed>|Offer|null|Demand
An offer to provide this item.
$position  : int|null
The position of an item in a series or sequence of items.
$producer  : object|null
The person or organization who produced the work.
$provider  : string|object|null
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.
$publisher  : string|array<string|int, mixed>|Person|Organization|null
The publisher of the resource.
$recordedAt  : object|null
The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
$releaseEvent  : object|null
The place and time the release was issued, expressed as a PublicationEvent.
$review  : array<string|int, mixed>|Review|null
A review of the item.
$reviewAspect  : string|null
This Review or Rating is relevant to this part or facet of the itemReviewed.
$reviewBody  : string|null
The actual body of the review.
$sourceOrganization  : object|null
The Organization on whose behalf the creator was working.
$sponsor  : array<string|int, mixed>|object|string|null
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.
$temporal  : string|object|null
The "temporal" property can be used in cases where more specific properties (e.g. temporalCoverage, dateCreated, dateModified, datePublished) are not known to be appropriate.
$temporalCoverage  : string|object|null
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. 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".
$text  : string|object|null
The text of the creative work.
$thumbnailUrl  : string|object|null
A thumbnail image relevant to the Thing.
$timeRequired  : string|null
Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
$translator  : string|object|null
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.
$typicalAgeRange  : string|object|null
The typical expected age range, e.g. '7-9', '11-'.
$url  : int|string|null
URL of the item.
$usageInfo  : string|CreativeWork|null
The schema.org usageInfo property indicates further information about a CreativeWork.
$version  : null|string|int
The version of the CreativeWork embodied by a specified resource.
$video  : string|object|null
An embedded video object.

Methods

__construct()  : mixed
Constructor to hydrate public properties from an array or stdClass.
jsonSerialize()  : array<string|int, mixed>
Serializes the current object into a JSON-LD array.

Constants

CONTEXT

JSON-LD @context declaration for Schema.org.

public mixed CONTEXT = 'https://schema.org'

Properties

$_from

The metadata to indicates the edge 'from' identifier.

public string|null $_from

$_id

The metadata identifier of the item.

public null|string $_id

$_key

The metadata unique key identifier of the thing.

public null|string $_key

$_rev

The metadata revision value of the thing.

public null|string $_rev

$_to

The metadata to indicates the edge 'to' identifier.

public string|null $_to

$abstract

An abstract is a short description that summarizes a CreativeWork.

public string|null $abstract

$accessibilityAPI

Indicates that the resource is compatible with the referenced accessibility API.

public string|null $accessibilityAPI

$accessibilityControl

Identifies input methods that are sufficient to fully control the described resource.

public string|null $accessibilityControl

$accessibilityFeature

Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility.

public string|null $accessibilityFeature

$accessibilityHazard

A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3.

public string|null $accessibilityHazard

$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".

public string|null $accessibilitySummary

$accessMode

The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.

public string|null $accessMode

$accessModeSufficient

A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource.

public ItemList|null $accessModeSufficient

$accountablePerson

Specifies the Person that is legally accountable for the CreativeWork.

public array<string|int, mixed>|Person|null $accountablePerson

$acquireLicensePage

Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.

public string|CreativeWork|null $acquireLicensePage

$active

The active flag.

public bool|null $active

$additionalType

An additionalType for the item.

public array<string|int, mixed>|string|null|object $additionalType

$aggregateRating

The overall rating, based on a collection of reviews or ratings, of the item.

public array<string|int, mixed>|AggregateRating|null $aggregateRating

$alternateName

An alias for the item.

public string|object|null $alternateName

$alternativeHeadline

The alternative headline of this content.

public string|object|null $alternativeHeadline

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

public string|WebPage|null $archivedAt

In such cases, the referenced page may not directly publish the content.

$assesses

The item being described is intended to assess the competency or learning outcome defined by the referenced term.

public string|DefinedTerm|null $assesses

$associatedMedia

A media object that encodes this CreativeWork. This property is a synonym for encoding.

public array<string|int, mixed>|MediaObject|null $associatedMedia

$audience

An intended audience, i.e. a group for whom something was created.

public null|array<string|int, mixed>|Audience $audience

$contentLocation

The location depicted or described in the content. For example, the location in a photograph or painting.

public string|Place|null $contentLocation

$contentRating

Official rating of a piece of content—for example,'MPAA PG-13'.

public string $contentRating

$contributor

A secondary contributor to the CreativeWork or Event.

public string|object|null $contributor

$copyrightHolder

The party holding the legal copyright to the CreativeWork.

public string|null $copyrightHolder

$copyrightYear

The year during which the claimed copyright for the CreativeWork was first asserted.

public string|null $copyrightYear

$created

Date of creation of the resource.

public null|string|DateTime $created

$dateCreated

The date on which the CreativeWork was created or the item was added to a DataFeed.

public string|null $dateCreated

$dateModified

The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.

public string|null $dateModified

$datePublished

Date of first broadcast/publication.

public string|null $datePublished

$description

A short description of the item.

public string|null $description

$disambiguatingDescription

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

public string|null $disambiguatingDescription

$editor

Specifies the Person who edited the CreativeWork.

public string|null $editor

$encodingFormat

Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.).

public string|null $encodingFormat

$expires

Date the content expires and is no longer useful or available. For example a VideoObject or NewsArticle whose availability or relevance is time-limited, or a ClaimReview fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.

public string|null $expires

$hasPart

Indicates an item that this part of this item.

public string|Thing|array<string|int, mixed>|null $hasPart

$headline

The headline of this content.

public string|object|null $headline

$id

The unique identifier of the item.

public null|int|string $id

$identifier

The identifier of the item.

public string|null $identifier

$image

The image reference of this resource.

public string|object|null $image

$inLanguage

The language of the content or performance or used in an action.

public array<string|int, mixed>|string|null $inLanguage

$interactionStatistic

The number of interactions for the CreativeWork using the WebSite or SoftwareApplication.

public InteractionCounter|array<string|int, mixed>|null $interactionStatistic

The most specific child type of InteractionCounter should be used.

$isAccessibleForFree

A flag to signal that the item, event, or place is accessible for free.

public bool|null $isAccessibleForFree

$isBasedOn

A resource that was used in the creation of this resource. This term can be repeated for multiple sources.

public array<string|int, mixed>|object|null $isBasedOn

$isPartOf

Indicates an item that this item is part of.

public string|Thing|array<string|int, mixed>|null $isPartOf

$itemReviewed

The item that is being reviewed/rated.

public Thing|null $itemReviewed

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

public string|DefinedTerm|array<string|int, mixed>|null $keywords

$license

A legal document giving official permission to do something with the resource.

public string|object|null $license

$locationCreated

The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.

public string|object|null $locationCreated

$mainEntity

Indicates the primary entity described in some page or other CreativeWork.

public string|object|null $mainEntity

$material

A material that something is made from, e.g. leather, wool, cotton, paper.

public array<string|int, mixed>|Product|string|null $material

$mentions

The mentions of this content.

public array<string|int, mixed>|string|null $mentions

$modified

Date on which the resource was changed.

public null|string|DateTime $modified

$name

The name of the item.

public int|string|null $name

$position

The position of an item in a series or sequence of items.

public int|null $position

$producer

The person or organization who produced the work.

public object|null $producer

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

public string|object|null $provider

$recordedAt

The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.

public object|null $recordedAt

$releaseEvent

The place and time the release was issued, expressed as a PublicationEvent.

public object|null $releaseEvent

$reviewAspect

This Review or Rating is relevant to this part or facet of the itemReviewed.

public string|null $reviewAspect

$reviewBody

The actual body of the review.

public string|null $reviewBody

$sourceOrganization

The Organization on whose behalf the creator was working.

public object|null $sourceOrganization

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

public array<string|int, mixed>|object|string|null $sponsor

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

public string|object|null $temporal

$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. 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".

public string|object|null $temporalCoverage

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. Supersedes datasetTimeInterval.

$thumbnailUrl

A thumbnail image relevant to the Thing.

public string|object|null $thumbnailUrl

$timeRequired

Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.

public string|null $timeRequired

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

public string|object|null $translator

$typicalAgeRange

The typical expected age range, e.g. '7-9', '11-'.

public string|object|null $typicalAgeRange

$url

URL of the item.

public int|string|null $url

$usageInfo

The schema.org usageInfo property indicates further information about a CreativeWork.

public string|CreativeWork|null $usageInfo

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.

$version

The version of the CreativeWork embodied by a specified resource.

public null|string|int $version

Methods

__construct()

Constructor to hydrate public properties from an array or stdClass.

public __construct([array<string|int, mixed>|object|null $init = null ]) : mixed

This allows objects to be quickly populated with associative data without manually setting each property.

Parameters
$init : array<string|int, mixed>|object|null = null

A data array or object used to initialize the instance. Keys must match public property names.

Tags
example
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person
([
    Prop::NAME => 'Jane Doe',
    Prop::URL  => 'https://example.com/janedoe'
]);

echo $person->name; // Outputs: Jane Doe

jsonSerialize()

Serializes the current object into a JSON-LD array.

public jsonSerialize() : array<string|int, mixed>

This method will include all public properties, the schema.org @context, and the inferred @type based on the class name.

Null values will be automatically removed using compress().

Tags
throws
ReflectionException

If reflection fails when accessing properties.

example
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person([
    Prop::NAME => 'John Smith',
    Prop::ID   => 'jsmith-001'
]);

echo json_encode($person, JSON_PRETTY_PRINT);

Output:

{
  "@type": "Person",
  "@context": "https://schema.org",
  "id": "jsmith-001",
  "name": "John Smith"
}
Return values
array<string|int, mixed>

A JSON-LD array representation of the object.


        
On this page

Search results