DigitalDocument extends CreativeWork

An electronic file or document.

Tags

see

https://schema.org/DigitalDocument

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.

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

An award won by or for this item.

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

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

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

$hasDigitalDocumentPermission  : null|array<string|int, mixed>|DigitalDocumentPermission

A permission related to the access to this document (e.g. permission to read or write an electronic document).

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

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

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

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

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