Oihana Php Schema

ProductCollection extends Product uses CreativeWorkTrait, CollectionTrait

Any offered product or service. For example: a pair of shoes; a concert ticket; the rental of a car; a haircut; or an episode of a TV show streamed online.

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.
$additionalProperty : null|array<string|int, mixed>|PropertyValue: A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.
$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.
$asin : null|string: An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization.
$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.
$award : null|string|array<string|int, mixed>: An award won by or for this item.
$brand : Brand|Organization|array<string|int, mixed>|null: The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
$category : null|array<string|int, mixed>|string|CategoryCode|Thing: A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
$character : null|array<string|int, mixed>|Person: Fictional person connected with a creative work.
$citation : null|string|CreativeWork|array<string|int, mixed>: A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
$collectionSize : int|null: The number of items in the Collection.
$color : string|null: The color of the product.
$colorSwatch : string|object|null: A color swatch image, visualizing the color of a Product
$comment : Comment|array<string|int, mixed>|null: Comments, typically from users.
$commentCount : int|null: The number of comments this CreativeWork (e.g. Article, Question or Answer) has received.
$conditionsOfAccess : null|string|object: Conditions that affect the availability of, or method(s) of access to, an item.
$contentLocation : string|Place|null: The location depicted or described in the content. For example, the location in a photograph or painting.
$contentRating : null|string|Rating|array<string|int, mixed>: Official rating of a piece of content—for example,'MPAA PG-13'.
$contentReferenceTime : string|null|DateTime: The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
$contributor : null|Organization|Person|array<string|int, mixed>: A secondary contributor to the CreativeWork or Event.
$copyrightHolder : null|Organization|Person|array<string|int, mixed>: The party holding the legal copyright to the CreativeWork.
$copyrightNotice : string|object|null: Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
$copyrightYear : null|int|string: The year during which the claimed copyright for the CreativeWork was first asserted.
$correction : null|CorrectionComment|string: Indicates a correction to a CreativeWork, either via a CorrectionComment, textually or in another document.
$countryOfOrigin : Country|null: The country of origin of something, including products as well as creative works such as movie and TV content.
$created : null|string|DateTime: Date of creation of the resource.
$creativeWorkStatus : string|DefinedTerm|null: The status of a creative work in terms of its stage in a lifecycle.
$creator : Organization|Person|array<string|int, mixed>|null: The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
$creditText : null|object|string: Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
$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.
$depth : float|null: The depth of the item.
$description : string|null: A short description of the item.
$digitalSourceType : null|IPTCDigitalSourceEnumeration: Indicates an IPTCDigitalSourceEnumeration code indicating the nature of the digital source(s) for some CreativeWork.
$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.
$discussionUrl : null|string: A link to the page containing the comments of the CreativeWork.
$editEIDR : null|string: An EIDR (Entertainment Identifier Registry) identifier representing a specific edit / edition for a work of film or television.
$editor : string|null: Specifies the Person who edited the CreativeWork.
$educationalAlignment : AlignmentObject|null: An alignment to an established educational framework.
$educationalLevel : null|string|DefinedTerm: The level in terms of progression through an educational or training context.
$educationalUse : null|string|DefinedTerm: The purpose of a work in the context of education; for example, 'assignment', 'group work'.
$encoding : null|string|MediaObject: A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
$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.).
$exampleOfWork : array<string|int, mixed>|CreativeWork|null: A creative work that this work is an example/instance/realization/derivation of.
$expires : string|null: Date the content expires and is no longer useful or available.
$funder : null|Organization|Person: A person or organization that supports (sponsors) something through some kind of financial contribution.
$funding : null|Grant|array<string|int, mixed>: A Grant that directly or indirectly provide funding or sponsorship for this item.
$genre : null|string|DefinedTerm: Genre of the creative work, broadcast channel or group.
$gtin : string|null: A correct gtin value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string.
$gtin12 : string|null: The GTIN-12 code of the product, or the product to which the offer refers.
$gtin13 : string|null: The GTIN-13 code of the product, or the product to which the offer refers.
$gtin14 : string|null: The GTIN-14 code of the product, or the product to which the offer refers.
$gtin8 : string|null: The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN.
$hasAdultConsideration : string|Enumeration|DefinedTerm|array<string|int, mixed>|null: Used to tag an item to be intended or suitable for consumption or use by adults only.
$hasCertification : null|array<string|int, mixed>|Certification: Certification information about a product, organization, service, place, or person.
$hasMeasurement : null|array<string|int, mixed>|QuantitativeValue: A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority.
$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.
$height : float|null: The height of the item.
$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.
$includesObject : array<string|int, mixed>|TypeAndQuantityNode|null: This links to a node or nodes indicating the exact quantity of the products included in an Offer or ProductCollection.
$inLanguage : array<string|int, mixed>|string|null: The language of the content or performance or used in an action.
$inProductGroupWithID : string|null: Indicates the productGroupID for a ProductGroup that this product isVariantOf.
$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.
$isAccessoryOrSparePartFor : null|Product|array<string|int, mixed>: A pointer to another product (or multiple products) for which this product is an accessory or spare part.
$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.
$isConsumableFor : null|Product|array<string|int, mixed>: A pointer to another product (or multiple products) for which this product is a consumable.
$isFamilyFriendly : bool|null: Indicates whether this content is family friendly.
$isPartOf : string|Thing|array<string|int, mixed>|null: Indicates an item that this item is part of.
$isRelatedTo : Product|Service|array<string|int, mixed>|null: A pointer to another, somehow related product (or multiple products).
$isSimilarTo : Product|Service|array<string|int, mixed>|null: A pointer to another, functionally similar product (or multiple products).
$isVariantOf : null|array<string|int, mixed>|ProductModel|ProductGroup: Indicates the kind of product that this is a variant of. In the case of ProductModel, this is a pointer (from a ProductModel) to a base product from which this product is a variant.
$itemCondition : DefinedTerm|string|Enumeration|null: A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer.
$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.
$logo : string|ImageObject|null: An associated logo.
$mainEntity : string|object|null: Indicates the primary entity described in some page or other CreativeWork.
$manufacturer : int|Organization|string|null: The manufacturer of the product.
$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.
$mobileUrl : string|null: The mobileUrl property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.
$model : ProductModel|string|null: The model of the product.
$modified : null|string|DateTime: Date on which the resource was changed.
$mpn : string|null: The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
$name : int|string|null: The name of the item.
$nsn : string|null: Indicates the NATO stock number (nsn) of a Product.
$offers : array<string|int, mixed>|Offer|null|Demand: An offer to provide this item.
$pattern : string|DefinedTerm|null: 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.
$position : null|int|string: The position of an item in a series or sequence of items.
$producer : object|null: The person or organization who produced the work.
$productID : string|null: The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".
$productionDate : string|DateTime|null: The date of production of the item, e.g. vehicle.
$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.
$purchaseDate : string|DateTime|null: The date the item, e.g. vehicle, was purchased by the current owner.
$recordedAt : object|null: The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
$releaseDate : string|DateTime|null: The release date of a product or product model.
$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.
$size : null|string|DefinedTerm|QuantitativeValue|SizeSpecification|array<string|int, mixed>: 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.
$sku : string|null: The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
$slogan : string|null: A slogan or motto associated with the item.
$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.
$weight : float|null: The weight of the item.
$width : float|null: The width of the item.
$atContext : string|null: The JSON-LD `@context` value.
$atType : string|null: The JSON-LD `@type` value.

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.
withAtContext() : $this: Sets the internal JSON-LD `@context` attribute.
withAtType() : $this: Sets the internal JSON-LD `@type` attribute.
withJSONLDMeta() : $this: Initializes both JSON-LD metadata: `@type` and `@context`.

CONTEXT

JSON-LD @context declaration for Schema.org.


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

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

$about

The subject matter of the content.


        public
            string|object|null
    $about

$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

$additionalProperty

A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.


        public
            null|array<string|int, mixed>|PropertyValue
    $additionalProperty
     = null

#[HydrateWith]: \org\schema\PropertyValue::class

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

$asin

An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization.


        public
            null|string
    $asin

$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

$audio

An embedded audio object.


        public
            object|null
    $audio

$author

The author of this content.


        public
            null|string|AudioObject
    $author

$award

An award won by or for this item.


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

$brand

The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.


        public
            Brand|Organization|array<string|int, mixed>|null
    $brand

$category

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.


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

$character

Fictional person connected with a creative work.


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

$citation

A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.


        public
            null|string|CreativeWork|array<string|int, mixed>
    $citation

$collectionSize

The number of items in the Collection.


        public
            int|null
    $collectionSize

$color

The color of the product.


        public
            string|null
    $color

$colorSwatch

A color swatch image, visualizing the color of a Product


        public
            string|object|null
    $colorSwatch

$comment

Comments, typically from users.


        public
            Comment|array<string|int, mixed>|null
    $comment

$commentCount

The number of comments this CreativeWork (e.g. Article, Question or Answer) has received.


        public
            int|null
    $commentCount

This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.

$conditionsOfAccess

Conditions that affect the availability of, or method(s) of access to, an item.


        public
            null|string|object
    $conditionsOfAccess

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

$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
            null|string|Rating|array<string|int, mixed>
    $contentRating

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


        public
            string|null|DateTime
    $contentReferenceTime

$contributor

A secondary contributor to the CreativeWork or Event.


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

$copyrightHolder

The party holding the legal copyright to the CreativeWork.


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

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


        public
            string|object|null
    $copyrightNotice

$copyrightYear

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


        public
            null|int|string
    $copyrightYear

$correction

Indicates a correction to a CreativeWork, either via a CorrectionComment, textually or in another document.


        public
            null|CorrectionComment|string
    $correction

$countryOfOrigin

The country of origin of something, including products as well as creative works such as movie and TV content.


        public
            Country|null
    $countryOfOrigin

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.

$created

Date of creation of the resource.


        public
            null|string|DateTime
    $created

$creativeWorkStatus

The status of a creative work in terms of its stage in a lifecycle.


        public
            string|DefinedTerm|null
    $creativeWorkStatus

Example terms include Incomplete, Draft, Published, Obsolete.

Some organizations define a set of terms for the stages of their publication lifecycle.

$creator

The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.


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

$creditText

Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.


        public
            null|object|string
    $creditText

$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

$depth

The depth of the item.


        public
            float|null
    $depth

$description

A short description of the item.


        public
            string|null
    $description

$digitalSourceType

Indicates an IPTCDigitalSourceEnumeration code indicating the nature of the digital source(s) for some CreativeWork.


        public
            null|IPTCDigitalSourceEnumeration
    $digitalSourceType

$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

$discussionUrl

A link to the page containing the comments of the CreativeWork.


        public
            null|string
    $discussionUrl

$editEIDR

An EIDR (Entertainment Identifier Registry) identifier representing a specific edit / edition for a work of film or television.


        public
            null|string
    $editEIDR

For example, the motion picture known as "Ghostbusters" whose titleEIDR is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".

Since schema.org types like Movie and TVEpisode can be used for both works and their multiple expressions, it is possible to use titleEIDR alone (for a general description), or alongside editEIDR for a more edit-specific description.

$editor

Specifies the Person who edited the CreativeWork.


        public
            string|null
    $editor

$educationalAlignment

An alignment to an established educational framework.


        public
            AlignmentObject|null
    $educationalAlignment

This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource teaches or assesses a competency.

$educationalLevel

The level in terms of progression through an educational or training context.


        public
            null|string|DefinedTerm
    $educationalLevel

Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.

$educationalUse

The purpose of a work in the context of education; for example, 'assignment', 'group work'.


        public
            null|string|DefinedTerm
    $educationalUse

$encoding

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


        public
            null|string|MediaObject
    $encoding

$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

In cases where a CreativeWork has several media type representations, encoding can be used to indicate each MediaObject alongside particular encodingFormat information.

Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.

$exampleOfWork

A creative work that this work is an example/instance/realization/derivation of.


        public
            array<string|int, mixed>|CreativeWork|null
    $exampleOfWork

Inverse property: workExample

$expires

Date the content expires and is no longer useful or available.


        public
            string|null
    $expires

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.

$funder

A person or organization that supports (sponsors) something through some kind of financial contribution.


        public
            null|Organization|Person
    $funder

$funding

A Grant that directly or indirectly provide funding or sponsorship for this item.


        public
            null|Grant|array<string|int, mixed>
    $funding

$genre

Genre of the creative work, broadcast channel or group.


        public
            null|string|DefinedTerm
    $genre

$gtin

A correct gtin value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string.


        public
            string|null
    $gtin

The numeric component should also have a valid GS1 check digit and meet the other rules for valid GTINs.

$gtin12

The GTIN-12 code of the product, or the product to which the offer refers.


        public
            string|null
    $gtin12

The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items.

$gtin13

The GTIN-13 code of the product, or the product to which the offer refers.


        public
            string|null
    $gtin13

This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero.

$gtin14

The GTIN-14 code of the product, or the product to which the offer refers.


        public
            string|null
    $gtin14

$gtin8

The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN.


        public
            string|null
    $gtin8

$hasAdultConsideration

Used to tag an item to be intended or suitable for consumption or use by adults only.


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

Example:

AlcoholConsideration
DangerousGoodConsideration
HealthcareConsideration
NarcoticConsideration
ReducedRelevanceForChildrenConsideration
SexualContentConsideration
TobaccoNicotineConsideration
UnclassifiedAdultConsideration
ViolenceConsideration
WeaponConsideration

$hasCertification

Certification information about a product, organization, service, place, or person.


        public
            null|array<string|int, mixed>|Certification
    $hasCertification

#[HydrateWith]: \org\schema\creativeWork\Certification::class

$hasMeasurement

A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority.


        public
            null|array<string|int, mixed>|QuantitativeValue
    $hasMeasurement

Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.

#[HydrateWith]: \org\schema\QuantitativeValue::class

$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

$height

The height of the item.


        public
            float|null
    $height

$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

$includesObject

This links to a node or nodes indicating the exact quantity of the products included in an Offer or ProductCollection.


        public
            array<string|int, mixed>|TypeAndQuantityNode|null
    $includesObject

$inLanguage

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


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

$inProductGroupWithID

Indicates the productGroupID for a ProductGroup that this product isVariantOf.


        public
            string|null
    $inProductGroupWithID

$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

$isAccessoryOrSparePartFor

A pointer to another product (or multiple products) for which this product is an accessory or spare part.


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

#[HydrateWith]: \org\schema\Product::class

$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

$isConsumableFor

A pointer to another product (or multiple products) for which this product is a consumable.


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

#[HydrateWith]: \org\schema\Product::class

$isFamilyFriendly

Indicates whether this content is family friendly.


        public
            bool|null
    $isFamilyFriendly

$isPartOf

Indicates an item that this item is part of.


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

$isRelatedTo

A pointer to another, somehow related product (or multiple products).


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

$isSimilarTo

A pointer to another, functionally similar product (or multiple products).


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

$isVariantOf

Indicates the kind of product that this is a variant of. In the case of ProductModel, this is a pointer (from a ProductModel) to a base product from which this product is a variant.


        public
            null|array<string|int, mixed>|ProductModel|ProductGroup
    $isVariantOf

#[HydrateWith]: \org\schema\ProductModel::class; \org\schema\ProductGroup::class

$itemCondition

A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer.


        public
            DefinedTerm|string|Enumeration|null
    $itemCondition

Also used for product return policies to specify the condition of products accepted for returns. Example:

DamagedCondition
NewCondition
RefurbishedCondition
UsedCondition

$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

$logo

An associated logo.


        public
            string|ImageObject|null
    $logo

$mainEntity

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


        public
            string|object|null
    $mainEntity

$manufacturer

The manufacturer of the product.


        public
            int|Organization|string|null
    $manufacturer

$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

$mobileUrl

The mobileUrl property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.


        public
            string|null
    $mobileUrl

$model

The model of the product.


        public
            ProductModel|string|null
    $model

$modified

Date on which the resource was changed.


        public
            null|string|DateTime
    $modified

$mpn

The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.


        public
            string|null
    $mpn

$name

The name of the item.


        public
            int|string|null
    $name

$nsn

Indicates the NATO stock number (nsn) of a Product.


        public
            string|null
    $nsn

$offers

An offer to provide this item.


        public
            array<string|int, mixed>|Offer|null|Demand
    $offers

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


        public
            string|DefinedTerm|null
    $pattern

$position

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


        public
            null|int|string
    $position

$producer

The person or organization who produced the work.


        public
            object|null
    $producer

$productID

The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".


        public
            string|null
    $productID

$productionDate

The date of production of the item, e.g. vehicle.


        public
            string|DateTime|null
    $productionDate

$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

$publisher

The publisher of the resource.


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

$purchaseDate

The date the item, e.g. vehicle, was purchased by the current owner.


        public
            string|DateTime|null
    $purchaseDate

$recordedAt

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


        public
            object|null
    $recordedAt

$releaseDate

The release date of a product or product model.


        public
            string|DateTime|null
    $releaseDate

This can be used to distinguish the exact variant of a product.

$releaseEvent

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


        public
            object|null
    $releaseEvent

$review

A review of the item.


        public
            array<string|int, mixed>|Review|null
    $review

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


        public
            null|string|DefinedTerm|QuantitativeValue|SizeSpecification|array<string|int, mixed>
    $size

#[HydrateWith]: \org\schema\DefinedTerm::class; \org\schema\QuantitativeValue::class; \org\schema\SizeSpecification::class

$sku

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.


        public
            string|null
    $sku

$slogan

A slogan or motto associated with the item.


        public
            string|null
    $slogan

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

$text

The text of the creative work.


        public
            string|object|null
    $text

$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

$video

An embedded video object.


        public
            string|object|null
    $video

$weight

The weight of the item.


        public
            float|null
    $weight

$width

The width of the item.


        public
            float|null
    $width

$atContext

The JSON-LD `@context` value.


        private
            string|null
    $atContext
     = null

Default is https://schema.org.

$atType

The JSON-LD `@type` value.


        private
            string|null
    $atType
     = null

This can be manually set or automatically inferred from the class name.

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

jsonSerialize()

Serializes the current object into a JSON-LD array.


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

Includes public properties, the JSON-LD @context and @type. Null values are automatically removed.

Return values

array<string|int, mixed> —

JSON-LD representation of the object.

withAtContext()

Sets the internal JSON-LD `@context` attribute.


    public
                    withAtContext(string $context) : $this

Useful if you need a custom JSON-LD context.

Parameters

$context : string

Return values

$this

withAtType()

Sets the internal JSON-LD `@type` attribute.


    public
                    withAtType(string $type) : $this

Allows overriding the default type inferred from the class.

Parameters

$type : string

Return values

$this

withJSONLDMeta()

Initializes both JSON-LD metadata: `@type` and `@context`.


    public
                    withJSONLDMeta([string|null $atType = null ][, string|null $atContext = null ]) : $this

Can be called from constructor or later to override default values.

Parameters

$atType : string|null = null: Optional JSON-LD type
$atContext : string|null = null: Optional JSON-LD context

Return values

$this

ProductCollection extends Product uses CreativeWorkTrait, CollectionTrait

Tags

Table of Contents

Constants

Properties

Methods

Constants

CONTEXT

Properties

$_from

$_id

$_key

$_rev

$_to

$about

$abstract

$accessibilityAPI

$accessibilityControl

$accessibilityFeature

$accessibilityHazard

$accessibilitySummary

$accessMode

$accessModeSufficient

$accountablePerson

$acquireLicensePage

$active

$additionalProperty

Attributes

$additionalType

$aggregateRating

$alternateName

$alternativeHeadline

$archivedAt

$asin

$assesses

$associatedMedia

$audience

$audio

$author

$award

$brand

$category

$character

$citation

$collectionSize

$color

$colorSwatch

$comment

$commentCount

$conditionsOfAccess

$contentLocation

$contentRating

$contentReferenceTime

$contributor

$copyrightHolder

$copyrightNotice

$copyrightYear

$correction

$countryOfOrigin

$created

$creativeWorkStatus

$creator

$creditText

$dateCreated

$dateModified

$datePublished

$depth

$description

$digitalSourceType

$disambiguatingDescription

$discussionUrl

$editEIDR

$editor

$educationalAlignment

$educationalLevel

$educationalUse

$encoding

$encodingFormat

$exampleOfWork

$expires