vendor/spatie/schema-org/src/ImageObject.php line 16

Open in your IDE?
  1. <?php
  3. namespace Spatie\SchemaOrg;
  5. use Spatie\SchemaOrg\Contracts\CreativeWorkContract;
  6. use Spatie\SchemaOrg\Contracts\ImageObjectContract;
  7. use Spatie\SchemaOrg\Contracts\MediaObjectContract;
  8. use Spatie\SchemaOrg\Contracts\ThingContract;
  10. /**
  11. * An image file.
  12. *
  13. * @see https://schema.org/ImageObject
  14. *
  15. */
  16. class ImageObject extends BaseType implements ImageObjectContract, CreativeWorkContract, MediaObjectContract, ThingContract
  17. {
  18. /**
  19. * The subject matter of the content.
  20. *
  21. * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
  22. *
  23. * @return static
  24. *
  25. * @see https://schema.org/about
  26. * @link https://github.com/schemaorg/schemaorg/issues/1670
  27. */
  28. public function about($about)
  29. {
  30. return $this->setProperty('about', $about);
  31. }
  33. /**
  34. * An abstract is a short description that summarizes a [[CreativeWork]].
  35. *
  36. * @param string|string[] $abstract
  37. *
  38. * @return static
  39. *
  40. * @see https://schema.org/abstract
  41. * @see https://pending.schema.org
  42. * @link https://github.com/schemaorg/schemaorg/issues/276
  43. */
  44. public function abstract($abstract)
  45. {
  46. return $this->setProperty('abstract', $abstract);
  47. }
  49. /**
  50. * The human sensory perceptual system or cognitive faculty through which a
  51. * person may process or perceive information. Values should be drawn from
  52. * the [approved
  53. * vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
  54. *
  55. * @param string|string[] $accessMode
  56. *
  57. * @return static
  58. *
  59. * @see https://schema.org/accessMode
  60. * @link https://github.com/schemaorg/schemaorg/issues/1100
  61. */
  62. public function accessMode($accessMode)
  63. {
  64. return $this->setProperty('accessMode', $accessMode);
  65. }
  67. /**
  68. * A list of single or combined accessModes that are sufficient to
  69. * understand all the intellectual content of a resource. Values should be
  70. * drawn from the [approved
  71. * vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
  72. *
  73. * @param \Spatie\SchemaOrg\Contracts\ItemListContract|\Spatie\SchemaOrg\Contracts\ItemListContract[] $accessModeSufficient
  74. *
  75. * @return static
  76. *
  77. * @see https://schema.org/accessModeSufficient
  78. * @link https://github.com/schemaorg/schemaorg/issues/1100
  79. */
  80. public function accessModeSufficient($accessModeSufficient)
  81. {
  82. return $this->setProperty('accessModeSufficient', $accessModeSufficient);
  83. }
  85. /**
  86. * Indicates that the resource is compatible with the referenced
  87. * accessibility API. Values should be drawn from the [approved
  88. * vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
  89. *
  90. * @param string|string[] $accessibilityAPI
  91. *
  92. * @return static
  93. *
  94. * @see https://schema.org/accessibilityAPI
  95. */
  96. public function accessibilityAPI($accessibilityAPI)
  97. {
  98. return $this->setProperty('accessibilityAPI', $accessibilityAPI);
  99. }
  101. /**
  102. * Identifies input methods that are sufficient to fully control the
  103. * described resource. Values should be drawn from the [approved
  104. * vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
  105. *
  106. * @param string|string[] $accessibilityControl
  107. *
  108. * @return static
  109. *
  110. * @see https://schema.org/accessibilityControl
  111. */
  112. public function accessibilityControl($accessibilityControl)
  113. {
  114. return $this->setProperty('accessibilityControl', $accessibilityControl);
  115. }
  117. /**
  118. * Content features of the resource, such as accessible media, alternatives
  119. * and supported enhancements for accessibility. Values should be drawn from
  120. * the [approved
  121. * vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
  122. *
  123. * @param string|string[] $accessibilityFeature
  124. *
  125. * @return static
  126. *
  127. * @see https://schema.org/accessibilityFeature
  128. */
  129. public function accessibilityFeature($accessibilityFeature)
  130. {
  131. return $this->setProperty('accessibilityFeature', $accessibilityFeature);
  132. }
  134. /**
  135. * A characteristic of the described resource that is physiologically
  136. * dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should
  137. * be drawn from the [approved
  138. * vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
  139. *
  140. * @param string|string[] $accessibilityHazard
  141. *
  142. * @return static
  143. *
  144. * @see https://schema.org/accessibilityHazard
  145. */
  146. public function accessibilityHazard($accessibilityHazard)
  147. {
  148. return $this->setProperty('accessibilityHazard', $accessibilityHazard);
  149. }
  151. /**
  152. * A human-readable summary of specific accessibility features or
  153. * deficiencies, consistent with the other accessibility metadata but
  154. * expressing subtleties such as "short descriptions are present but long
  155. * descriptions will be needed for non-visual users" or "short descriptions
  156. * are present and no long descriptions are needed".
  157. *
  158. * @param string|string[] $accessibilitySummary
  159. *
  160. * @return static
  161. *
  162. * @see https://schema.org/accessibilitySummary
  163. * @link https://github.com/schemaorg/schemaorg/issues/1100
  164. */
  165. public function accessibilitySummary($accessibilitySummary)
  166. {
  167. return $this->setProperty('accessibilitySummary', $accessibilitySummary);
  168. }
  170. /**
  171. * Specifies the Person that is legally accountable for the CreativeWork.
  172. *
  173. * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $accountablePerson
  174. *
  175. * @return static
  176. *
  177. * @see https://schema.org/accountablePerson
  178. */
  179. public function accountablePerson($accountablePerson)
  180. {
  181. return $this->setProperty('accountablePerson', $accountablePerson);
  182. }
  184. /**
  185. * Indicates a page documenting how licenses can be purchased or otherwise
  186. * acquired, for the current item.
  187. *
  188. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $acquireLicensePage
  189. *
  190. * @return static
  191. *
  192. * @see https://schema.org/acquireLicensePage
  193. * @see https://pending.schema.org
  194. * @link https://github.com/schemaorg/schemaorg/issues/2454
  195. */
  196. public function acquireLicensePage($acquireLicensePage)
  197. {
  198. return $this->setProperty('acquireLicensePage', $acquireLicensePage);
  199. }
  201. /**
  202. * An additional type for the item, typically used for adding more specific
  203. * types from external vocabularies in microdata syntax. This is a
  204. * relationship between something and a class that the thing is in.
  205. * Typically the value is a URI-identified RDF class, and in this case
  206. * corresponds to the
  207. * use of rdf:type in RDF. Text values can be used sparingly, for cases
  208. * where useful information can be added without their being an appropriate
  209. * schema to reference. In the case of text values, the class label should
  210. * follow the schema.org [style
  211. * guide](https://schema.org/docs/styleguide.html).
  212. *
  213. * @param string|string[] $additionalType
  214. *
  215. * @return static
  216. *
  217. * @see https://schema.org/additionalType
  218. */
  219. public function additionalType($additionalType)
  220. {
  221. return $this->setProperty('additionalType', $additionalType);
  222. }
  224. /**
  225. * The overall rating, based on a collection of reviews or ratings, of the
  226. * item.
  227. *
  228. * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
  229. *
  230. * @return static
  231. *
  232. * @see https://schema.org/aggregateRating
  233. */
  234. public function aggregateRating($aggregateRating)
  235. {
  236. return $this->setProperty('aggregateRating', $aggregateRating);
  237. }
  239. /**
  240. * An alias for the item.
  241. *
  242. * @param string|string[] $alternateName
  243. *
  244. * @return static
  245. *
  246. * @see https://schema.org/alternateName
  247. */
  248. public function alternateName($alternateName)
  249. {
  250. return $this->setProperty('alternateName', $alternateName);
  251. }
  253. /**
  254. * A secondary title of the CreativeWork.
  255. *
  256. * @param string|string[] $alternativeHeadline
  257. *
  258. * @return static
  259. *
  260. * @see https://schema.org/alternativeHeadline
  261. */
  262. public function alternativeHeadline($alternativeHeadline)
  263. {
  264. return $this->setProperty('alternativeHeadline', $alternativeHeadline);
  265. }
  267. /**
  268. * Indicates a page or other link involved in archival of a
  269. * [[CreativeWork]]. In the case of [[MediaReview]], the items in a
  270. * [[MediaReviewItem]] may often become inaccessible, but be archived by
  271. * archival, journalistic, activist, or law enforcement organizations. In
  272. * such cases, the referenced page may not directly publish the content.
  273. *
  274. * @param \Spatie\SchemaOrg\Contracts\WebPageContract|\Spatie\SchemaOrg\Contracts\WebPageContract[]|string|string[] $archivedAt
  275. *
  276. * @return static
  277. *
  278. * @see https://schema.org/archivedAt
  279. * @see https://pending.schema.org
  280. * @link https://github.com/schemaorg/schemaorg/issues/2450
  281. */
  282. public function archivedAt($archivedAt)
  283. {
  284. return $this->setProperty('archivedAt', $archivedAt);
  285. }
  287. /**
  288. * The item being described is intended to assess the competency or learning
  289. * outcome defined by the referenced term.
  290. *
  291. * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $assesses
  292. *
  293. * @return static
  294. *
  295. * @see https://schema.org/assesses
  296. * @see https://pending.schema.org
  297. * @link https://github.com/schemaorg/schemaorg/issues/2427
  298. */
  299. public function assesses($assesses)
  300. {
  301. return $this->setProperty('assesses', $assesses);
  302. }
  304. /**
  305. * A NewsArticle associated with the Media Object.
  306. *
  307. * @param \Spatie\SchemaOrg\Contracts\NewsArticleContract|\Spatie\SchemaOrg\Contracts\NewsArticleContract[] $associatedArticle
  308. *
  309. * @return static
  310. *
  311. * @see https://schema.org/associatedArticle
  312. */
  313. public function associatedArticle($associatedArticle)
  314. {
  315. return $this->setProperty('associatedArticle', $associatedArticle);
  316. }
  318. /**
  319. * A media object that encodes this CreativeWork. This property is a synonym
  320. * for encoding.
  321. *
  322. * @param \Spatie\SchemaOrg\Contracts\MediaObjectContract|\Spatie\SchemaOrg\Contracts\MediaObjectContract[] $associatedMedia
  323. *
  324. * @return static
  325. *
  326. * @see https://schema.org/associatedMedia
  327. */
  328. public function associatedMedia($associatedMedia)
  329. {
  330. return $this->setProperty('associatedMedia', $associatedMedia);
  331. }
  333. /**
  334. * An intended audience, i.e. a group for whom something was created.
  335. *
  336. * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
  337. *
  338. * @return static
  339. *
  340. * @see https://schema.org/audience
  341. */
  342. public function audience($audience)
  343. {
  344. return $this->setProperty('audience', $audience);
  345. }
  347. /**
  348. * An embedded audio object.
  349. *
  350. * @param \Spatie\SchemaOrg\Contracts\AudioObjectContract|\Spatie\SchemaOrg\Contracts\AudioObjectContract[]|\Spatie\SchemaOrg\Contracts\ClipContract|\Spatie\SchemaOrg\Contracts\ClipContract[]|\Spatie\SchemaOrg\Contracts\MusicRecordingContract|\Spatie\SchemaOrg\Contracts\MusicRecordingContract[] $audio
  351. *
  352. * @return static
  353. *
  354. * @see https://schema.org/audio
  355. * @link https://github.com/schemaorg/schemaorg/issues/2420
  356. */
  357. public function audio($audio)
  358. {
  359. return $this->setProperty('audio', $audio);
  360. }
  362. /**
  363. * The author of this content or rating. Please note that author is special
  364. * in that HTML 5 provides a special mechanism for indicating authorship via
  365. * the rel tag. That is equivalent to this and may be used interchangeably.
  366. *
  367. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $author
  368. *
  369. * @return static
  370. *
  371. * @see https://schema.org/author
  372. */
  373. public function author($author)
  374. {
  375. return $this->setProperty('author', $author);
  376. }
  378. /**
  379. * An award won by or for this item.
  380. *
  381. * @param string|string[] $award
  382. *
  383. * @return static
  384. *
  385. * @see https://schema.org/award
  386. */
  387. public function award($award)
  388. {
  389. return $this->setProperty('award', $award);
  390. }
  392. /**
  393. * Awards won by or for this item.
  394. *
  395. * @param string|string[] $awards
  396. *
  397. * @return static
  398. *
  399. * @see https://schema.org/awards
  400. */
  401. public function awards($awards)
  402. {
  403. return $this->setProperty('awards', $awards);
  404. }
  406. /**
  407. * The bitrate of the media object.
  408. *
  409. * @param string|string[] $bitrate
  410. *
  411. * @return static
  412. *
  413. * @see https://schema.org/bitrate
  414. */
  415. public function bitrate($bitrate)
  416. {
  417. return $this->setProperty('bitrate', $bitrate);
  418. }
  420. /**
  421. * The caption for this object. For downloadable machine formats (closed
  422. * caption, subtitles etc.) use MediaObject and indicate the
  423. * [[encodingFormat]].
  424. *
  425. * @param \Spatie\SchemaOrg\Contracts\MediaObjectContract|\Spatie\SchemaOrg\Contracts\MediaObjectContract[]|string|string[] $caption
  426. *
  427. * @return static
  428. *
  429. * @see https://schema.org/caption
  430. */
  431. public function caption($caption)
  432. {
  433. return $this->setProperty('caption', $caption);
  434. }
  436. /**
  437. * Fictional person connected with a creative work.
  438. *
  439. * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $character
  440. *
  441. * @return static
  442. *
  443. * @see https://schema.org/character
  444. */
  445. public function character($character)
  446. {
  447. return $this->setProperty('character', $character);
  448. }
  450. /**
  451. * A citation or reference to another creative work, such as another
  452. * publication, web page, scholarly article, etc.
  453. *
  454. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $citation
  455. *
  456. * @return static
  457. *
  458. * @see https://schema.org/citation
  459. */
  460. public function citation($citation)
  461. {
  462. return $this->setProperty('citation', $citation);
  463. }
  465. /**
  466. * Comments, typically from users.
  467. *
  468. * @param \Spatie\SchemaOrg\Contracts\CommentContract|\Spatie\SchemaOrg\Contracts\CommentContract[] $comment
  469. *
  470. * @return static
  471. *
  472. * @see https://schema.org/comment
  473. */
  474. public function comment($comment)
  475. {
  476. return $this->setProperty('comment', $comment);
  477. }
  479. /**
  480. * The number of comments this CreativeWork (e.g. Article, Question or
  481. * Answer) has received. This is most applicable to works published in Web
  482. * sites with commenting system; additional comments may exist elsewhere.
  483. *
  484. * @param int|int[] $commentCount
  485. *
  486. * @return static
  487. *
  488. * @see https://schema.org/commentCount
  489. */
  490. public function commentCount($commentCount)
  491. {
  492. return $this->setProperty('commentCount', $commentCount);
  493. }
  495. /**
  496. * Conditions that affect the availability of, or method(s) of access to, an
  497. * item. Typically used for real world items such as an [[ArchiveComponent]]
  498. * held by an [[ArchiveOrganization]]. This property is not suitable for use
  499. * as a general Web access control mechanism. It is expressed only in
  500. * natural language.
  501. *
  502. * For example "Available by appointment from the Reading Room" or
  503. * "Accessible only from logged-in accounts ".
  504. *
  505. * @param string|string[] $conditionsOfAccess
  506. *
  507. * @return static
  508. *
  509. * @see https://schema.org/conditionsOfAccess
  510. * @see https://pending.schema.org
  511. * @link https://github.com/schemaorg/schemaorg/issues/2173
  512. */
  513. public function conditionsOfAccess($conditionsOfAccess)
  514. {
  515. return $this->setProperty('conditionsOfAccess', $conditionsOfAccess);
  516. }
  518. /**
  519. * The location depicted or described in the content. For example, the
  520. * location in a photograph or painting.
  521. *
  522. * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $contentLocation
  523. *
  524. * @return static
  525. *
  526. * @see https://schema.org/contentLocation
  527. */
  528. public function contentLocation($contentLocation)
  529. {
  530. return $this->setProperty('contentLocation', $contentLocation);
  531. }
  533. /**
  534. * Official rating of a piece of content&#x2014;for example, 'MPAA PG-13'.
  535. *
  536. * @param \Spatie\SchemaOrg\Contracts\RatingContract|\Spatie\SchemaOrg\Contracts\RatingContract[]|string|string[] $contentRating
  537. *
  538. * @return static
  539. *
  540. * @see https://schema.org/contentRating
  541. */
  542. public function contentRating($contentRating)
  543. {
  544. return $this->setProperty('contentRating', $contentRating);
  545. }
  547. /**
  548. * The specific time described by a creative work, for works (e.g. articles,
  549. * video objects etc.) that emphasise a particular moment within an Event.
  550. *
  551. * @param \DateTimeInterface|\DateTimeInterface[] $contentReferenceTime
  552. *
  553. * @return static
  554. *
  555. * @see https://schema.org/contentReferenceTime
  556. * @see https://pending.schema.org
  557. * @link https://github.com/schemaorg/schemaorg/issues/1050
  558. */
  559. public function contentReferenceTime($contentReferenceTime)
  560. {
  561. return $this->setProperty('contentReferenceTime', $contentReferenceTime);
  562. }
  564. /**
  565. * File size in (mega/kilo)bytes.
  566. *
  567. * @param string|string[] $contentSize
  568. *
  569. * @return static
  570. *
  571. * @see https://schema.org/contentSize
  572. */
  573. public function contentSize($contentSize)
  574. {
  575. return $this->setProperty('contentSize', $contentSize);
  576. }
  578. /**
  579. * Actual bytes of the media object, for example the image file or video
  580. * file.
  581. *
  582. * @param string|string[] $contentUrl
  583. *
  584. * @return static
  585. *
  586. * @see https://schema.org/contentUrl
  587. */
  588. public function contentUrl($contentUrl)
  589. {
  590. return $this->setProperty('contentUrl', $contentUrl);
  591. }
  593. /**
  594. * A secondary contributor to the CreativeWork or Event.
  595. *
  596. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
  597. *
  598. * @return static
  599. *
  600. * @see https://schema.org/contributor
  601. */
  602. public function contributor($contributor)
  603. {
  604. return $this->setProperty('contributor', $contributor);
  605. }
  607. /**
  608. * The party holding the legal copyright to the CreativeWork.
  609. *
  610. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $copyrightHolder
  611. *
  612. * @return static
  613. *
  614. * @see https://schema.org/copyrightHolder
  615. */
  616. public function copyrightHolder($copyrightHolder)
  617. {
  618. return $this->setProperty('copyrightHolder', $copyrightHolder);
  619. }
  621. /**
  622. * Text of a notice appropriate for describing the copyright aspects of this
  623. * Creative Work, ideally indicating the owner of the copyright for the
  624. * Work.
  625. *
  626. * @param string|string[] $copyrightNotice
  627. *
  628. * @return static
  629. *
  630. * @see https://schema.org/copyrightNotice
  631. * @see https://pending.schema.org
  632. * @link https://github.com/schemaorg/schemaorg/issues/2659
  633. */
  634. public function copyrightNotice($copyrightNotice)
  635. {
  636. return $this->setProperty('copyrightNotice', $copyrightNotice);
  637. }
  639. /**
  640. * The year during which the claimed copyright for the CreativeWork was
  641. * first asserted.
  642. *
  643. * @param float|float[]|int|int[] $copyrightYear
  644. *
  645. * @return static
  646. *
  647. * @see https://schema.org/copyrightYear
  648. */
  649. public function copyrightYear($copyrightYear)
  650. {
  651. return $this->setProperty('copyrightYear', $copyrightYear);
  652. }
  654. /**
  655. * Indicates a correction to a [[CreativeWork]], either via a
  656. * [[CorrectionComment]], textually or in another document.
  657. *
  658. * @param \Spatie\SchemaOrg\Contracts\CorrectionCommentContract|\Spatie\SchemaOrg\Contracts\CorrectionCommentContract[]|string|string[] $correction
  659. *
  660. * @return static
  661. *
  662. * @see https://schema.org/correction
  663. * @see https://pending.schema.org
  664. * @link https://github.com/schemaorg/schemaorg/issues/1950
  665. */
  666. public function correction($correction)
  667. {
  668. return $this->setProperty('correction', $correction);
  669. }
  671. /**
  672. * The country of origin of something, including products as well as
  673. * creative works such as movie and TV content.
  674. *
  675. * In the case of TV and movie, this would be the country of the principle
  676. * offices of the production company or individual responsible for the
  677. * movie. For other kinds of [[CreativeWork]] it is difficult to provide
  678. * fully general guidance, and properties such as [[contentLocation]] and
  679. * [[locationCreated]] may be more applicable.
  680. *
  681. * In the case of products, the country of origin of the product. The exact
  682. * interpretation of this may vary by context and product type, and cannot
  683. * be fully enumerated here.
  684. *
  685. * @param \Spatie\SchemaOrg\Contracts\CountryContract|\Spatie\SchemaOrg\Contracts\CountryContract[] $countryOfOrigin
  686. *
  687. * @return static
  688. *
  689. * @see https://schema.org/countryOfOrigin
  690. */
  691. public function countryOfOrigin($countryOfOrigin)
  692. {
  693. return $this->setProperty('countryOfOrigin', $countryOfOrigin);
  694. }
  696. /**
  697. * The status of a creative work in terms of its stage in a lifecycle.
  698. * Example terms include Incomplete, Draft, Published, Obsolete. Some
  699. * organizations define a set of terms for the stages of their publication
  700. * lifecycle.
  701. *
  702. * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $creativeWorkStatus
  703. *
  704. * @return static
  705. *
  706. * @see https://schema.org/creativeWorkStatus
  707. * @see https://pending.schema.org
  708. * @link https://github.com/schemaorg/schemaorg/issues/987
  709. */
  710. public function creativeWorkStatus($creativeWorkStatus)
  711. {
  712. return $this->setProperty('creativeWorkStatus', $creativeWorkStatus);
  713. }
  715. /**
  716. * The creator/author of this CreativeWork. This is the same as the Author
  717. * property for CreativeWork.
  718. *
  719. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $creator
  720. *
  721. * @return static
  722. *
  723. * @see https://schema.org/creator
  724. */
  725. public function creator($creator)
  726. {
  727. return $this->setProperty('creator', $creator);
  728. }
  730. /**
  731. * Text that can be used to credit person(s) and/or organization(s)
  732. * associated with a published Creative Work.
  733. *
  734. * @param string|string[] $creditText
  735. *
  736. * @return static
  737. *
  738. * @see https://schema.org/creditText
  739. * @see https://pending.schema.org
  740. * @link https://github.com/schemaorg/schemaorg/issues/2659
  741. */
  742. public function creditText($creditText)
  743. {
  744. return $this->setProperty('creditText', $creditText);
  745. }
  747. /**
  748. * The date on which the CreativeWork was created or the item was added to a
  749. * DataFeed.
  750. *
  751. * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated
  752. *
  753. * @return static
  754. *
  755. * @see https://schema.org/dateCreated
  756. */
  757. public function dateCreated($dateCreated)
  758. {
  759. return $this->setProperty('dateCreated', $dateCreated);
  760. }
  762. /**
  763. * The date on which the CreativeWork was most recently modified or when the
  764. * item's entry was modified within a DataFeed.
  765. *
  766. * @param \DateTimeInterface|\DateTimeInterface[] $dateModified
  767. *
  768. * @return static
  769. *
  770. * @see https://schema.org/dateModified
  771. */
  772. public function dateModified($dateModified)
  773. {
  774. return $this->setProperty('dateModified', $dateModified);
  775. }
  777. /**
  778. * Date of first publication or broadcast. For example the date a
  779. * [[CreativeWork]] was broadcast or a [[Certification]] was issued.
  780. *
  781. * @param \DateTimeInterface|\DateTimeInterface[] $datePublished
  782. *
  783. * @return static
  784. *
  785. * @see https://schema.org/datePublished
  786. */
  787. public function datePublished($datePublished)
  788. {
  789. return $this->setProperty('datePublished', $datePublished);
  790. }
  792. /**
  793. * A description of the item.
  794. *
  795. * @param \Spatie\SchemaOrg\Contracts\TextObjectContract|\Spatie\SchemaOrg\Contracts\TextObjectContract[]|string|string[] $description
  796. *
  797. * @return static
  798. *
  799. * @see https://schema.org/description
  800. */
  801. public function description($description)
  802. {
  803. return $this->setProperty('description', $description);
  804. }
  806. /**
  807. * Indicates an IPTCDigitalSourceEnumeration code indicating the nature of
  808. * the digital source(s) for some [[CreativeWork]].
  809. *
  810. * @param \Spatie\SchemaOrg\Contracts\IPTCDigitalSourceEnumerationContract|\Spatie\SchemaOrg\Contracts\IPTCDigitalSourceEnumerationContract[] $digitalSourceType
  811. *
  812. * @return static
  813. *
  814. * @see https://schema.org/digitalSourceType
  815. * @see https://pending.schema.org
  816. * @link https://github.com/schemaorg/schemaorg/issues/3392
  817. */
  818. public function digitalSourceType($digitalSourceType)
  819. {
  820. return $this->setProperty('digitalSourceType', $digitalSourceType);
  821. }
  823. /**
  824. * A sub property of description. A short description of the item used to
  825. * disambiguate from other, similar items. Information from other properties
  826. * (in particular, name) may be necessary for the description to be useful
  827. * for disambiguation.
  828. *
  829. * @param string|string[] $disambiguatingDescription
  830. *
  831. * @return static
  832. *
  833. * @see https://schema.org/disambiguatingDescription
  834. */
  835. public function disambiguatingDescription($disambiguatingDescription)
  836. {
  837. return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
  838. }
  840. /**
  841. * A link to the page containing the comments of the CreativeWork.
  842. *
  843. * @param string|string[] $discussionUrl
  844. *
  845. * @return static
  846. *
  847. * @see https://schema.org/discussionUrl
  848. */
  849. public function discussionUrl($discussionUrl)
  850. {
  851. return $this->setProperty('discussionUrl', $discussionUrl);
  852. }
  854. /**
  855. * The duration of the item (movie, audio recording, event, etc.) in [ISO
  856. * 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).
  857. *
  858. * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
  859. *
  860. * @return static
  861. *
  862. * @see https://schema.org/duration
  863. */
  864. public function duration($duration)
  865. {
  866. return $this->setProperty('duration', $duration);
  867. }
  869. /**
  870. * An [EIDR](https://eidr.org/) (Entertainment Identifier Registry)
  871. * [[identifier]] representing a specific edit / edition for a work of film
  872. * or television.
  873. *
  874. * For example, the motion picture known as "Ghostbusters" whose
  875. * [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits,
  876. * e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and
  877. * "10.5240/8A35-3BEE-6497-5D12-9E4F-3".
  878. *
  879. * Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for
  880. * both works and their multiple expressions, it is possible to use
  881. * [[titleEIDR]] alone (for a general description), or alongside
  882. * [[editEIDR]] for a more edit-specific description.
  883. *
  884. * @param string|string[] $editEIDR
  885. *
  886. * @return static
  887. *
  888. * @see https://schema.org/editEIDR
  889. * @see https://pending.schema.org
  890. * @link https://github.com/schemaorg/schemaorg/issues/2469
  891. */
  892. public function editEIDR($editEIDR)
  893. {
  894. return $this->setProperty('editEIDR', $editEIDR);
  895. }
  897. /**
  898. * Specifies the Person who edited the CreativeWork.
  899. *
  900. * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $editor
  901. *
  902. * @return static
  903. *
  904. * @see https://schema.org/editor
  905. */
  906. public function editor($editor)
  907. {
  908. return $this->setProperty('editor', $editor);
  909. }
  911. /**
  912. * An alignment to an established educational framework.
  913. *
  914. * This property should not be used where the nature of the alignment can be
  915. * described using a simple property, for example to express that a resource
  916. * [[teaches]] or [[assesses]] a competency.
  917. *
  918. * @param \Spatie\SchemaOrg\Contracts\AlignmentObjectContract|\Spatie\SchemaOrg\Contracts\AlignmentObjectContract[] $educationalAlignment
  919. *
  920. * @return static
  921. *
  922. * @see https://schema.org/educationalAlignment
  923. */
  924. public function educationalAlignment($educationalAlignment)
  925. {
  926. return $this->setProperty('educationalAlignment', $educationalAlignment);
  927. }
  929. /**
  930. * The level in terms of progression through an educational or training
  931. * context. Examples of educational levels include 'beginner',
  932. * 'intermediate' or 'advanced', and formal sets of level indicators.
  933. *
  934. * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $educationalLevel
  935. *
  936. * @return static
  937. *
  938. * @see https://schema.org/educationalLevel
  939. * @see https://pending.schema.org
  940. * @link https://github.com/schemaorg/schemaorg/issues/1779
  941. */
  942. public function educationalLevel($educationalLevel)
  943. {
  944. return $this->setProperty('educationalLevel', $educationalLevel);
  945. }
  947. /**
  948. * The purpose of a work in the context of education; for example,
  949. * 'assignment', 'group work'.
  950. *
  951. * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $educationalUse
  952. *
  953. * @return static
  954. *
  955. * @see https://schema.org/educationalUse
  956. */
  957. public function educationalUse($educationalUse)
  958. {
  959. return $this->setProperty('educationalUse', $educationalUse);
  960. }
  962. /**
  963. * A URL pointing to a player for a specific video. In general, this is the
  964. * information in the ```src``` element of an ```embed``` tag and should not
  965. * be the same as the content of the ```loc``` tag.
  966. *
  967. * @param string|string[] $embedUrl
  968. *
  969. * @return static
  970. *
  971. * @see https://schema.org/embedUrl
  972. */
  973. public function embedUrl($embedUrl)
  974. {
  975. return $this->setProperty('embedUrl', $embedUrl);
  976. }
  978. /**
  979. * Represents textual captioning from a [[MediaObject]], e.g. text of a
  980. * 'meme'.
  981. *
  982. * @param string|string[] $embeddedTextCaption
  983. *
  984. * @return static
  985. *
  986. * @see https://schema.org/embeddedTextCaption
  987. * @see https://pending.schema.org
  988. * @link https://github.com/schemaorg/schemaorg/issues/2450
  989. */
  990. public function embeddedTextCaption($embeddedTextCaption)
  991. {
  992. return $this->setProperty('embeddedTextCaption', $embeddedTextCaption);
  993. }
  995. /**
  996. * The CreativeWork encoded by this media object.
  997. *
  998. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $encodesCreativeWork
  999. *
  1000. * @return static
  1001. *
  1002. * @see https://schema.org/encodesCreativeWork
  1003. */
  1004. public function encodesCreativeWork($encodesCreativeWork)
  1005. {
  1006. return $this->setProperty('encodesCreativeWork', $encodesCreativeWork);
  1007. }
  1009. /**
  1010. * A media object that encodes this CreativeWork. This property is a synonym
  1011. * for associatedMedia.
  1012. *
  1013. * @param \Spatie\SchemaOrg\Contracts\MediaObjectContract|\Spatie\SchemaOrg\Contracts\MediaObjectContract[] $encoding
  1014. *
  1015. * @return static
  1016. *
  1017. * @see https://schema.org/encoding
  1018. */
  1019. public function encoding($encoding)
  1020. {
  1021. return $this->setProperty('encoding', $encoding);
  1022. }
  1024. /**
  1025. * Media type typically expressed using a MIME format (see [IANA
  1026. * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and
  1027. * [MDN
  1028. * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),
  1029. * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for
  1030. * .mp3 etc.
  1031. *
  1032. * In cases where a [[CreativeWork]] has several media type representations,
  1033. * [[encoding]] can be used to indicate each [[MediaObject]] alongside
  1034. * particular [[encodingFormat]] information.
  1035. *
  1036. * Unregistered or niche encoding and file formats can be indicated instead
  1037. * via the most appropriate URL, e.g. defining Web page or a
  1038. * Wikipedia/Wikidata entry.
  1039. *
  1040. * @param string|string[] $encodingFormat
  1041. *
  1042. * @return static
  1043. *
  1044. * @see https://schema.org/encodingFormat
  1045. */
  1046. public function encodingFormat($encodingFormat)
  1047. {
  1048. return $this->setProperty('encodingFormat', $encodingFormat);
  1049. }
  1051. /**
  1052. * A media object that encodes this CreativeWork.
  1053. *
  1054. * @param \Spatie\SchemaOrg\Contracts\MediaObjectContract|\Spatie\SchemaOrg\Contracts\MediaObjectContract[] $encodings
  1055. *
  1056. * @return static
  1057. *
  1058. * @see https://schema.org/encodings
  1059. */
  1060. public function encodings($encodings)
  1061. {
  1062. return $this->setProperty('encodings', $encodings);
  1063. }
  1065. /**
  1066. * The endTime of something. For a reserved event or service (e.g.
  1067. * FoodEstablishmentReservation), the time that it is expected to end. For
  1068. * actions that span a period of time, when the action was performed. E.g.
  1069. * John wrote a book from January to *December*. For media, including audio
  1070. * and video, it's the time offset of the end of a clip within a larger
  1071. * file.
  1072. *
  1073. * Note that Event uses startDate/endDate instead of startTime/endTime, even
  1074. * when describing dates with times. This situation may be clarified in
  1075. * future revisions.
  1076. *
  1077. * @param \DateTimeInterface|\DateTimeInterface[] $endTime
  1078. *
  1079. * @return static
  1080. *
  1081. * @see https://schema.org/endTime
  1082. * @link https://github.com/schemaorg/schemaorg/issues/2493
  1083. */
  1084. public function endTime($endTime)
  1085. {
  1086. return $this->setProperty('endTime', $endTime);
  1087. }
  1089. /**
  1090. * A creative work that this work is an
  1091. * example/instance/realization/derivation of.
  1092. *
  1093. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $exampleOfWork
  1094. *
  1095. * @return static
  1096. *
  1097. * @see https://schema.org/exampleOfWork
  1098. */
  1099. public function exampleOfWork($exampleOfWork)
  1100. {
  1101. return $this->setProperty('exampleOfWork', $exampleOfWork);
  1102. }
  1104. /**
  1105. * exif data for this object.
  1106. *
  1107. * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $exifData
  1108. *
  1109. * @return static
  1110. *
  1111. * @see https://schema.org/exifData
  1112. */
  1113. public function exifData($exifData)
  1114. {
  1115. return $this->setProperty('exifData', $exifData);
  1116. }
  1118. /**
  1119. * Date the content expires and is no longer useful or available. For
  1120. * example a [[VideoObject]] or [[NewsArticle]] whose availability or
  1121. * relevance is time-limited, a [[ClaimReview]] fact check whose publisher
  1122. * wants to indicate that it may no longer be relevant (or helpful to
  1123. * highlight) after some date, or a [[Certification]] the validity has
  1124. * expired.
  1125. *
  1126. * @param \DateTimeInterface|\DateTimeInterface[] $expires
  1127. *
  1128. * @return static
  1129. *
  1130. * @see https://schema.org/expires
  1131. */
  1132. public function expires($expires)
  1133. {
  1134. return $this->setProperty('expires', $expires);
  1135. }
  1137. /**
  1138. * Media type, typically MIME format (see [IANA
  1139. * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of
  1140. * the content, e.g. application/zip of a SoftwareApplication binary. In
  1141. * cases where a CreativeWork has several media type representations,
  1142. * 'encoding' can be used to indicate each MediaObject alongside particular
  1143. * fileFormat information. Unregistered or niche file formats can be
  1144. * indicated instead via the most appropriate URL, e.g. defining Web page or
  1145. * a Wikipedia entry.
  1146. *
  1147. * @param string|string[] $fileFormat
  1148. *
  1149. * @return static
  1150. *
  1151. * @see https://schema.org/fileFormat
  1152. */
  1153. public function fileFormat($fileFormat)
  1154. {
  1155. return $this->setProperty('fileFormat', $fileFormat);
  1156. }
  1158. /**
  1159. * A person or organization that supports (sponsors) something through some
  1160. * kind of financial contribution.
  1161. *
  1162. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
  1163. *
  1164. * @return static
  1165. *
  1166. * @see https://schema.org/funder
  1167. */
  1168. public function funder($funder)
  1169. {
  1170. return $this->setProperty('funder', $funder);
  1171. }
  1173. /**
  1174. * A [[Grant]] that directly or indirectly provide funding or sponsorship
  1175. * for this item. See also [[ownershipFundingInfo]].
  1176. *
  1177. * @param \Spatie\SchemaOrg\Contracts\GrantContract|\Spatie\SchemaOrg\Contracts\GrantContract[] $funding
  1178. *
  1179. * @return static
  1180. *
  1181. * @see https://schema.org/funding
  1182. * @see https://pending.schema.org
  1183. * @link https://github.com/schemaorg/schemaorg/issues/383
  1184. */
  1185. public function funding($funding)
  1186. {
  1187. return $this->setProperty('funding', $funding);
  1188. }
  1190. /**
  1191. * Genre of the creative work, broadcast channel or group.
  1192. *
  1193. * @param string|string[] $genre
  1194. *
  1195. * @return static
  1196. *
  1197. * @see https://schema.org/genre
  1198. */
  1199. public function genre($genre)
  1200. {
  1201. return $this->setProperty('genre', $genre);
  1202. }
  1204. /**
  1205. * Indicates an item or CreativeWork that is part of this item, or
  1206. * CreativeWork (in some sense).
  1207. *
  1208. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $hasPart
  1209. *
  1210. * @return static
  1211. *
  1212. * @see https://schema.org/hasPart
  1213. */
  1214. public function hasPart($hasPart)
  1215. {
  1216. return $this->setProperty('hasPart', $hasPart);
  1217. }
  1219. /**
  1220. * Headline of the article.
  1221. *
  1222. * @param string|string[] $headline
  1223. *
  1224. * @return static
  1225. *
  1226. * @see https://schema.org/headline
  1227. */
  1228. public function headline($headline)
  1229. {
  1230. return $this->setProperty('headline', $headline);
  1231. }
  1233. /**
  1234. * The height of the item.
  1235. *
  1236. * @param \Spatie\SchemaOrg\Contracts\DistanceContract|\Spatie\SchemaOrg\Contracts\DistanceContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $height
  1237. *
  1238. * @return static
  1239. *
  1240. * @see https://schema.org/height
  1241. */
  1242. public function height($height)
  1243. {
  1244. return $this->setProperty('height', $height);
  1245. }
  1247. /**
  1248. * The identifier property represents any kind of identifier for any kind of
  1249. * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
  1250. * dedicated properties for representing many of these, either as textual
  1251. * strings or as URL (URI) links. See [background
  1252. * notes](/docs/datamodel.html#identifierBg) for more details.
  1253. *
  1254. * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
  1255. *
  1256. * @return static
  1257. *
  1258. * @see https://schema.org/identifier
  1259. */
  1260. public function identifier($identifier)
  1261. {
  1262. return $this->setProperty('identifier', $identifier);
  1263. }
  1265. /**
  1266. * An image of the item. This can be a [[URL]] or a fully described
  1267. * [[ImageObject]].
  1268. *
  1269. * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
  1270. *
  1271. * @return static
  1272. *
  1273. * @see https://schema.org/image
  1274. */
  1275. public function image($image)
  1276. {
  1277. return $this->setProperty('image', $image);
  1278. }
  1280. /**
  1281. * The language of the content or performance or used in an action. Please
  1282. * use one of the language codes from the [IETF BCP 47
  1283. * standard](http://tools.ietf.org/html/bcp47). See also
  1284. * [[availableLanguage]].
  1285. *
  1286. * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
  1287. *
  1288. * @return static
  1289. *
  1290. * @see https://schema.org/inLanguage
  1291. * @link https://github.com/schemaorg/schemaorg/issues/2382
  1292. */
  1293. public function inLanguage($inLanguage)
  1294. {
  1295. return $this->setProperty('inLanguage', $inLanguage);
  1296. }
  1298. /**
  1299. * The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the
  1300. * GeoShape for the geo-political region(s) for which the offer or delivery
  1301. * charge specification is not valid, e.g. a region where the transaction is
  1302. * not allowed.
  1303. *
  1304. * See also [[eligibleRegion]].
  1305. *
  1306. * @param \Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|string|string[] $ineligibleRegion
  1307. *
  1308. * @return static
  1309. *
  1310. * @see https://schema.org/ineligibleRegion
  1311. * @see https://pending.schema.org
  1312. * @link https://github.com/schemaorg/schemaorg/issues/2242
  1313. */
  1314. public function ineligibleRegion($ineligibleRegion)
  1315. {
  1316. return $this->setProperty('ineligibleRegion', $ineligibleRegion);
  1317. }
  1319. /**
  1320. * The number of interactions for the CreativeWork using the WebSite or
  1321. * SoftwareApplication. The most specific child type of InteractionCounter
  1322. * should be used.
  1323. *
  1324. * @param \Spatie\SchemaOrg\Contracts\InteractionCounterContract|\Spatie\SchemaOrg\Contracts\InteractionCounterContract[] $interactionStatistic
  1325. *
  1326. * @return static
  1327. *
  1328. * @see https://schema.org/interactionStatistic
  1329. * @link https://github.com/schemaorg/schemaorg/issues/2421
  1330. */
  1331. public function interactionStatistic($interactionStatistic)
  1332. {
  1333. return $this->setProperty('interactionStatistic', $interactionStatistic);
  1334. }
  1336. /**
  1337. * The predominant mode of learning supported by the learning resource.
  1338. * Acceptable values are 'active', 'expositive', or 'mixed'.
  1339. *
  1340. * @param string|string[] $interactivityType
  1341. *
  1342. * @return static
  1343. *
  1344. * @see https://schema.org/interactivityType
  1345. */
  1346. public function interactivityType($interactivityType)
  1347. {
  1348. return $this->setProperty('interactivityType', $interactivityType);
  1349. }
  1351. /**
  1352. * Used to indicate a specific claim contained, implied, translated or
  1353. * refined from the content of a [[MediaObject]] or other [[CreativeWork]].
  1354. * The interpreting party can be indicated using [[claimInterpreter]].
  1355. *
  1356. * @param \Spatie\SchemaOrg\Contracts\ClaimContract|\Spatie\SchemaOrg\Contracts\ClaimContract[] $interpretedAsClaim
  1357. *
  1358. * @return static
  1359. *
  1360. * @see https://schema.org/interpretedAsClaim
  1361. * @see https://pending.schema.org
  1362. * @link https://github.com/schemaorg/schemaorg/issues/2450
  1363. */
  1364. public function interpretedAsClaim($interpretedAsClaim)
  1365. {
  1366. return $this->setProperty('interpretedAsClaim', $interpretedAsClaim);
  1367. }
  1369. /**
  1370. * A flag to signal that the item, event, or place is accessible for free.
  1371. *
  1372. * @param bool|bool[] $isAccessibleForFree
  1373. *
  1374. * @return static
  1375. *
  1376. * @see https://schema.org/isAccessibleForFree
  1377. */
  1378. public function isAccessibleForFree($isAccessibleForFree)
  1379. {
  1380. return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
  1381. }
  1383. /**
  1384. * A resource from which this work is derived or from which it is a
  1385. * modification or adaptation.
  1386. *
  1387. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|string|string[] $isBasedOn
  1388. *
  1389. * @return static
  1390. *
  1391. * @see https://schema.org/isBasedOn
  1392. */
  1393. public function isBasedOn($isBasedOn)
  1394. {
  1395. return $this->setProperty('isBasedOn', $isBasedOn);
  1396. }
  1398. /**
  1399. * A resource that was used in the creation of this resource. This term can
  1400. * be repeated for multiple sources. For example,
  1401. * http://example.com/great-multiplication-intro.html.
  1402. *
  1403. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|string|string[] $isBasedOnUrl
  1404. *
  1405. * @return static
  1406. *
  1407. * @see https://schema.org/isBasedOnUrl
  1408. */
  1409. public function isBasedOnUrl($isBasedOnUrl)
  1410. {
  1411. return $this->setProperty('isBasedOnUrl', $isBasedOnUrl);
  1412. }
  1414. /**
  1415. * Indicates whether this content is family friendly.
  1416. *
  1417. * @param bool|bool[] $isFamilyFriendly
  1418. *
  1419. * @return static
  1420. *
  1421. * @see https://schema.org/isFamilyFriendly
  1422. */
  1423. public function isFamilyFriendly($isFamilyFriendly)
  1424. {
  1425. return $this->setProperty('isFamilyFriendly', $isFamilyFriendly);
  1426. }
  1428. /**
  1429. * Indicates an item or CreativeWork that this item, or CreativeWork (in
  1430. * some sense), is part of.
  1431. *
  1432. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $isPartOf
  1433. *
  1434. * @return static
  1435. *
  1436. * @see https://schema.org/isPartOf
  1437. */
  1438. public function isPartOf($isPartOf)
  1439. {
  1440. return $this->setProperty('isPartOf', $isPartOf);
  1441. }
  1443. /**
  1444. * Keywords or tags used to describe some item. Multiple textual entries in
  1445. * a keywords list are typically delimited by commas, or by repeating the
  1446. * property.
  1447. *
  1448. * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $keywords
  1449. *
  1450. * @return static
  1451. *
  1452. * @see https://schema.org/keywords
  1453. */
  1454. public function keywords($keywords)
  1455. {
  1456. return $this->setProperty('keywords', $keywords);
  1457. }
  1459. /**
  1460. * The predominant type or kind characterizing the learning resource. For
  1461. * example, 'presentation', 'handout'.
  1462. *
  1463. * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $learningResourceType
  1464. *
  1465. * @return static
  1466. *
  1467. * @see https://schema.org/learningResourceType
  1468. */
  1469. public function learningResourceType($learningResourceType)
  1470. {
  1471. return $this->setProperty('learningResourceType', $learningResourceType);
  1472. }
  1474. /**
  1475. * A license document that applies to this content, typically indicated by
  1476. * URL.
  1477. *
  1478. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $license
  1479. *
  1480. * @return static
  1481. *
  1482. * @see https://schema.org/license
  1483. */
  1484. public function license($license)
  1485. {
  1486. return $this->setProperty('license', $license);
  1487. }
  1489. /**
  1490. * The location where the CreativeWork was created, which may not be the
  1491. * same as the location depicted in the CreativeWork.
  1492. *
  1493. * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $locationCreated
  1494. *
  1495. * @return static
  1496. *
  1497. * @see https://schema.org/locationCreated
  1498. */
  1499. public function locationCreated($locationCreated)
  1500. {
  1501. return $this->setProperty('locationCreated', $locationCreated);
  1502. }
  1504. /**
  1505. * Indicates the primary entity described in some page or other
  1506. * CreativeWork.
  1507. *
  1508. * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $mainEntity
  1509. *
  1510. * @return static
  1511. *
  1512. * @see https://schema.org/mainEntity
  1513. */
  1514. public function mainEntity($mainEntity)
  1515. {
  1516. return $this->setProperty('mainEntity', $mainEntity);
  1517. }
  1519. /**
  1520. * Indicates a page (or other CreativeWork) for which this thing is the main
  1521. * entity being described. See [background
  1522. * notes](/docs/datamodel.html#mainEntityBackground) for details.
  1523. *
  1524. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
  1525. *
  1526. * @return static
  1527. *
  1528. * @see https://schema.org/mainEntityOfPage
  1529. */
  1530. public function mainEntityOfPage($mainEntityOfPage)
  1531. {
  1532. return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
  1533. }
  1535. /**
  1536. * A maintainer of a [[Dataset]], software package
  1537. * ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a
  1538. * [[Person]] or [[Organization]] that manages contributions to, and/or
  1539. * publication of, some (typically complex) artifact. It is common for
  1540. * distributions of software and data to be based on "upstream" sources.
  1541. * When [[maintainer]] is applied to a specific version of something e.g. a
  1542. * particular version or packaging of a [[Dataset]], it is always possible
  1543. * that the upstream source has a different maintainer. The [[isBasedOn]]
  1544. * property can be used to indicate such relationships between datasets to
  1545. * make the different maintenance roles clear. Similarly in the case of
  1546. * software, a package may have dedicated maintainers working on integration
  1547. * into software distributions such as Ubuntu, as well as upstream
  1548. * maintainers of the underlying work.
  1549. *
  1550. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $maintainer
  1551. *
  1552. * @return static
  1553. *
  1554. * @see https://schema.org/maintainer
  1555. * @see https://pending.schema.org
  1556. * @link https://github.com/schemaorg/schemaorg/issues/2311
  1557. */
  1558. public function maintainer($maintainer)
  1559. {
  1560. return $this->setProperty('maintainer', $maintainer);
  1561. }
  1563. /**
  1564. * A material that something is made from, e.g. leather, wool, cotton,
  1565. * paper.
  1566. *
  1567. * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|string|string[] $material
  1568. *
  1569. * @return static
  1570. *
  1571. * @see https://schema.org/material
  1572. */
  1573. public function material($material)
  1574. {
  1575. return $this->setProperty('material', $material);
  1576. }
  1578. /**
  1579. * The quantity of the materials being described or an expression of the
  1580. * physical space they occupy.
  1581. *
  1582. * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|string|string[] $materialExtent
  1583. *
  1584. * @return static
  1585. *
  1586. * @see https://schema.org/materialExtent
  1587. * @see https://pending.schema.org
  1588. * @link https://github.com/schemaorg/schemaorg/issues/1759
  1589. */
  1590. public function materialExtent($materialExtent)
  1591. {
  1592. return $this->setProperty('materialExtent', $materialExtent);
  1593. }
  1595. /**
  1596. * Indicates that the CreativeWork contains a reference to, but is not
  1597. * necessarily about a concept.
  1598. *
  1599. * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $mentions
  1600. *
  1601. * @return static
  1602. *
  1603. * @see https://schema.org/mentions
  1604. */
  1605. public function mentions($mentions)
  1606. {
  1607. return $this->setProperty('mentions', $mentions);
  1608. }
  1610. /**
  1611. * The name of the item.
  1612. *
  1613. * @param string|string[] $name
  1614. *
  1615. * @return static
  1616. *
  1617. * @see https://schema.org/name
  1618. */
  1619. public function name($name)
  1620. {
  1621. return $this->setProperty('name', $name);
  1622. }
  1624. /**
  1625. * An offer to provide this item&#x2014;for example, an offer to sell a
  1626. * product, rent the DVD of a movie, perform a service, or give away tickets
  1627. * to an event. Use [[businessFunction]] to indicate the kind of transaction
  1628. * offered, i.e. sell, lease, etc. This property can also be used to
  1629. * describe a [[Demand]]. While this property is listed as expected on a
  1630. * number of common types, it can be used in others. In that case, using a
  1631. * second type, such as Product or a subtype of Product, can clarify the
  1632. * nature of the offer.
  1633. *
  1634. * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
  1635. *
  1636. * @return static
  1637. *
  1638. * @see https://schema.org/offers
  1639. * @link https://github.com/schemaorg/schemaorg/issues/2289
  1640. */
  1641. public function offers($offers)
  1642. {
  1643. return $this->setProperty('offers', $offers);
  1644. }
  1646. /**
  1647. * A pattern that something has, for example 'polka dot', 'striped',
  1648. * 'Canadian flag'. Values are typically expressed as text, although links
  1649. * to controlled value schemes are also supported.
  1650. *
  1651. * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $pattern
  1652. *
  1653. * @return static
  1654. *
  1655. * @see https://schema.org/pattern
  1656. * @see https://pending.schema.org
  1657. * @link https://github.com/schemaorg/schemaorg/issues/1797
  1658. */
  1659. public function pattern($pattern)
  1660. {
  1661. return $this->setProperty('pattern', $pattern);
  1662. }
  1664. /**
  1665. * Player type required&#x2014;for example, Flash or Silverlight.
  1666. *
  1667. * @param string|string[] $playerType
  1668. *
  1669. * @return static
  1670. *
  1671. * @see https://schema.org/playerType
  1672. */
  1673. public function playerType($playerType)
  1674. {
  1675. return $this->setProperty('playerType', $playerType);
  1676. }
  1678. /**
  1679. * The position of an item in a series or sequence of items.
  1680. *
  1681. * @param int|int[]|string|string[] $position
  1682. *
  1683. * @return static
  1684. *
  1685. * @see https://schema.org/position
  1686. */
  1687. public function position($position)
  1688. {
  1689. return $this->setProperty('position', $position);
  1690. }
  1692. /**
  1693. * Indicates a potential Action, which describes an idealized action in
  1694. * which this thing would play an 'object' role.
  1695. *
  1696. * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
  1697. *
  1698. * @return static
  1699. *
  1700. * @see https://schema.org/potentialAction
  1701. */
  1702. public function potentialAction($potentialAction)
  1703. {
  1704. return $this->setProperty('potentialAction', $potentialAction);
  1705. }
  1707. /**
  1708. * The person or organization who produced the work (e.g. music album,
  1709. * movie, TV/radio series etc.).
  1710. *
  1711. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $producer
  1712. *
  1713. * @return static
  1714. *
  1715. * @see https://schema.org/producer
  1716. */
  1717. public function producer($producer)
  1718. {
  1719. return $this->setProperty('producer', $producer);
  1720. }
  1722. /**
  1723. * The production company or studio responsible for the item, e.g. series,
  1724. * video game, episode etc.
  1725. *
  1726. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $productionCompany
  1727. *
  1728. * @return static
  1729. *
  1730. * @see https://schema.org/productionCompany
  1731. */
  1732. public function productionCompany($productionCompany)
  1733. {
  1734. return $this->setProperty('productionCompany', $productionCompany);
  1735. }
  1737. /**
  1738. * The service provider, service operator, or service performer; the goods
  1739. * producer. Another party (a seller) may offer those services or goods on
  1740. * behalf of the provider. A provider may also serve as the seller.
  1741. *
  1742. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider
  1743. *
  1744. * @return static
  1745. *
  1746. * @see https://schema.org/provider
  1747. * @see https://pending.schema.org
  1748. */
  1749. public function provider($provider)
  1750. {
  1751. return $this->setProperty('provider', $provider);
  1752. }
  1754. /**
  1755. * A publication event associated with the item.
  1756. *
  1757. * @param \Spatie\SchemaOrg\Contracts\PublicationEventContract|\Spatie\SchemaOrg\Contracts\PublicationEventContract[] $publication
  1758. *
  1759. * @return static
  1760. *
  1761. * @see https://schema.org/publication
  1762. */
  1763. public function publication($publication)
  1764. {
  1765. return $this->setProperty('publication', $publication);
  1766. }
  1768. /**
  1769. * The publisher of the creative work.
  1770. *
  1771. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $publisher
  1772. *
  1773. * @return static
  1774. *
  1775. * @see https://schema.org/publisher
  1776. */
  1777. public function publisher($publisher)
  1778. {
  1779. return $this->setProperty('publisher', $publisher);
  1780. }
  1782. /**
  1783. * The publishing division which published the comic.
  1784. *
  1785. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $publisherImprint
  1786. *
  1787. * @return static
  1788. *
  1789. * @see https://schema.org/publisherImprint
  1790. * @see https://bib.schema.org
  1791. */
  1792. public function publisherImprint($publisherImprint)
  1793. {
  1794. return $this->setProperty('publisherImprint', $publisherImprint);
  1795. }
  1797. /**
  1798. * The publishingPrinciples property indicates (typically via [[URL]]) a
  1799. * document describing the editorial principles of an [[Organization]] (or
  1800. * individual, e.g. a [[Person]] writing a blog) that relate to their
  1801. * activities as a publisher, e.g. ethics or diversity policies. When
  1802. * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are
  1803. * those of the party primarily responsible for the creation of the
  1804. * [[CreativeWork]].
  1805. *
  1806. * While such policies are most typically expressed in natural language,
  1807. * sometimes related information (e.g. indicating a [[funder]]) can be
  1808. * expressed using schema.org terminology.
  1809. *
  1810. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $publishingPrinciples
  1811. *
  1812. * @return static
  1813. *
  1814. * @see https://schema.org/publishingPrinciples
  1815. */
  1816. public function publishingPrinciples($publishingPrinciples)
  1817. {
  1818. return $this->setProperty('publishingPrinciples', $publishingPrinciples);
  1819. }
  1821. /**
  1822. * The Event where the CreativeWork was recorded. The CreativeWork may
  1823. * capture all or part of the event.
  1824. *
  1825. * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $recordedAt
  1826. *
  1827. * @return static
  1828. *
  1829. * @see https://schema.org/recordedAt
  1830. */
  1831. public function recordedAt($recordedAt)
  1832. {
  1833. return $this->setProperty('recordedAt', $recordedAt);
  1834. }
  1836. /**
  1837. * The regions where the media is allowed. If not specified, then it's
  1838. * assumed to be allowed everywhere. Specify the countries in [ISO 3166
  1839. * format](http://en.wikipedia.org/wiki/ISO_3166).
  1840. *
  1841. * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $regionsAllowed
  1842. *
  1843. * @return static
  1844. *
  1845. * @see https://schema.org/regionsAllowed
  1846. */
  1847. public function regionsAllowed($regionsAllowed)
  1848. {
  1849. return $this->setProperty('regionsAllowed', $regionsAllowed);
  1850. }
  1852. /**
  1853. * The place and time the release was issued, expressed as a
  1854. * PublicationEvent.
  1855. *
  1856. * @param \Spatie\SchemaOrg\Contracts\PublicationEventContract|\Spatie\SchemaOrg\Contracts\PublicationEventContract[] $releasedEvent
  1857. *
  1858. * @return static
  1859. *
  1860. * @see https://schema.org/releasedEvent
  1861. */
  1862. public function releasedEvent($releasedEvent)
  1863. {
  1864. return $this->setProperty('releasedEvent', $releasedEvent);
  1865. }
  1867. /**
  1868. * Indicates whether this image is representative of the content of the
  1869. * page.
  1870. *
  1871. * @param bool|bool[] $representativeOfPage
  1872. *
  1873. * @return static
  1874. *
  1875. * @see https://schema.org/representativeOfPage
  1876. */
  1877. public function representativeOfPage($representativeOfPage)
  1878. {
  1879. return $this->setProperty('representativeOfPage', $representativeOfPage);
  1880. }
  1882. /**
  1883. * Indicates if use of the media require a subscription (either paid or
  1884. * free). Allowed values are ```true``` or ```false``` (note that an earlier
  1885. * version had 'yes', 'no').
  1886. *
  1887. * @param \Spatie\SchemaOrg\Contracts\MediaSubscriptionContract|\Spatie\SchemaOrg\Contracts\MediaSubscriptionContract[]|bool|bool[] $requiresSubscription
  1888. *
  1889. * @return static
  1890. *
  1891. * @see https://schema.org/requiresSubscription
  1892. * @link https://github.com/schemaorg/schemaorg/issues/1741
  1893. */
  1894. public function requiresSubscription($requiresSubscription)
  1895. {
  1896. return $this->setProperty('requiresSubscription', $requiresSubscription);
  1897. }
  1899. /**
  1900. * A review of the item.
  1901. *
  1902. * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
  1903. *
  1904. * @return static
  1905. *
  1906. * @see https://schema.org/review
  1907. */
  1908. public function review($review)
  1909. {
  1910. return $this->setProperty('review', $review);
  1911. }
  1913. /**
  1914. * Review of the item.
  1915. *
  1916. * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
  1917. *
  1918. * @return static
  1919. *
  1920. * @see https://schema.org/reviews
  1921. */
  1922. public function reviews($reviews)
  1923. {
  1924. return $this->setProperty('reviews', $reviews);
  1925. }
  1927. /**
  1928. * URL of a reference Web page that unambiguously indicates the item's
  1929. * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
  1930. * official website.
  1931. *
  1932. * @param string|string[] $sameAs
  1933. *
  1934. * @return static
  1935. *
  1936. * @see https://schema.org/sameAs
  1937. */
  1938. public function sameAs($sameAs)
  1939. {
  1940. return $this->setProperty('sameAs', $sameAs);
  1941. }
  1943. /**
  1944. * Indicates (by URL or string) a particular version of a schema used in
  1945. * some CreativeWork. This property was created primarily to
  1946. * indicate the use of a specific schema.org release, e.g. ```10.0``` as
  1947. * a simple string, or more explicitly via URL,
  1948. * ```https://schema.org/docs/releases.html#v10.0```. There may be
  1949. * situations in which other schemas might usefully be referenced this way,
  1950. * e.g.
  1951. * ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```
  1952. * but this has not been carefully explored in the community.
  1953. *
  1954. * @param string|string[] $schemaVersion
  1955. *
  1956. * @return static
  1957. *
  1958. * @see https://schema.org/schemaVersion
  1959. */
  1960. public function schemaVersion($schemaVersion)
  1961. {
  1962. return $this->setProperty('schemaVersion', $schemaVersion);
  1963. }
  1965. /**
  1966. * Indicates the date on which the current structured data was generated /
  1967. * published. Typically used alongside [[sdPublisher]].
  1968. *
  1969. * @param \DateTimeInterface|\DateTimeInterface[] $sdDatePublished
  1970. *
  1971. * @return static
  1972. *
  1973. * @see https://schema.org/sdDatePublished
  1974. * @see https://pending.schema.org
  1975. * @link https://github.com/schemaorg/schemaorg/issues/1886
  1976. */
  1977. public function sdDatePublished($sdDatePublished)
  1978. {
  1979. return $this->setProperty('sdDatePublished', $sdDatePublished);
  1980. }
  1982. /**
  1983. * A license document that applies to this structured data, typically
  1984. * indicated by URL.
  1985. *
  1986. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $sdLicense
  1987. *
  1988. * @return static
  1989. *
  1990. * @see https://schema.org/sdLicense
  1991. * @see https://pending.schema.org
  1992. * @link https://github.com/schemaorg/schemaorg/issues/1886
  1993. */
  1994. public function sdLicense($sdLicense)
  1995. {
  1996. return $this->setProperty('sdLicense', $sdLicense);
  1997. }
  1999. /**
  2000. * Indicates the party responsible for generating and publishing the current
  2001. * structured data markup, typically in cases where the structured data is
  2002. * derived automatically from existing published content but published on a
  2003. * different site. For example, student projects and open data initiatives
  2004. * often re-publish existing content with more explicitly structured
  2005. * metadata. The
  2006. * [[sdPublisher]] property helps make such practices more explicit.
  2007. *
  2008. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sdPublisher
  2009. *
  2010. * @return static
  2011. *
  2012. * @see https://schema.org/sdPublisher
  2013. * @see https://pending.schema.org
  2014. * @link https://github.com/schemaorg/schemaorg/issues/1886
  2015. */
  2016. public function sdPublisher($sdPublisher)
  2017. {
  2018. return $this->setProperty('sdPublisher', $sdPublisher);
  2019. }
  2021. /**
  2022. * The [SHA-2](https://en.wikipedia.org/wiki/SHA-2) SHA256 hash of the
  2023. * content of the item. For example, a zero-length input has value
  2024. * 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'.
  2025. *
  2026. * @param string|string[] $sha256
  2027. *
  2028. * @return static
  2029. *
  2030. * @see https://schema.org/sha256
  2031. * @see https://pending.schema.org
  2032. * @link https://github.com/schemaorg/schemaorg/issues/2450
  2033. */
  2034. public function sha256($sha256)
  2035. {
  2036. return $this->setProperty('sha256', $sha256);
  2037. }
  2039. /**
  2040. * A standardized size of a product or creative work, specified either
  2041. * through a simple textual string (for example 'XL', '32Wx34L'), a
  2042. * QuantitativeValue with a unitCode, or a comprehensive and structured
  2043. * [[SizeSpecification]]; in other cases, the [[width]], [[height]],
  2044. * [[depth]] and [[weight]] properties may be more applicable.
  2045. *
  2046. * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|\Spatie\SchemaOrg\Contracts\SizeSpecificationContract|\Spatie\SchemaOrg\Contracts\SizeSpecificationContract[]|string|string[] $size
  2047. *
  2048. * @return static
  2049. *
  2050. * @see https://schema.org/size
  2051. * @see https://pending.schema.org
  2052. * @link https://github.com/schemaorg/schemaorg/issues/1797
  2053. */
  2054. public function size($size)
  2055. {
  2056. return $this->setProperty('size', $size);
  2057. }
  2059. /**
  2060. * The Organization on whose behalf the creator was working.
  2061. *
  2062. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $sourceOrganization
  2063. *
  2064. * @return static
  2065. *
  2066. * @see https://schema.org/sourceOrganization
  2067. */
  2068. public function sourceOrganization($sourceOrganization)
  2069. {
  2070. return $this->setProperty('sourceOrganization', $sourceOrganization);
  2071. }
  2073. /**
  2074. * The "spatial" property can be used in cases when more specific properties
  2075. * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are
  2076. * not known to be appropriate.
  2077. *
  2078. * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $spatial
  2079. *
  2080. * @return static
  2081. *
  2082. * @see https://schema.org/spatial
  2083. */
  2084. public function spatial($spatial)
  2085. {
  2086. return $this->setProperty('spatial', $spatial);
  2087. }
  2089. /**
  2090. * The spatialCoverage of a CreativeWork indicates the place(s) which are
  2091. * the focus of the content. It is a subproperty of
  2092. * contentLocation intended primarily for more technical and detailed
  2093. * materials. For example with a Dataset, it indicates
  2094. * areas that the dataset describes: a dataset of New York weather
  2095. * would have spatialCoverage which was the place: the state of New York.
  2096. *
  2097. * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $spatialCoverage
  2098. *
  2099. * @return static
  2100. *
  2101. * @see https://schema.org/spatialCoverage
  2102. */
  2103. public function spatialCoverage($spatialCoverage)
  2104. {
  2105. return $this->setProperty('spatialCoverage', $spatialCoverage);
  2106. }
  2108. /**
  2109. * A person or organization that supports a thing through a pledge, promise,
  2110. * or financial contribution. E.g. a sponsor of a Medical Study or a
  2111. * corporate sponsor of an event.
  2112. *
  2113. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
  2114. *
  2115. * @return static
  2116. *
  2117. * @see https://schema.org/sponsor
  2118. */
  2119. public function sponsor($sponsor)
  2120. {
  2121. return $this->setProperty('sponsor', $sponsor);
  2122. }
  2124. /**
  2125. * The startTime of something. For a reserved event or service (e.g.
  2126. * FoodEstablishmentReservation), the time that it is expected to start. For
  2127. * actions that span a period of time, when the action was performed. E.g.
  2128. * John wrote a book from *January* to December. For media, including audio
  2129. * and video, it's the time offset of the start of a clip within a larger
  2130. * file.
  2131. *
  2132. * Note that Event uses startDate/endDate instead of startTime/endTime, even
  2133. * when describing dates with times. This situation may be clarified in
  2134. * future revisions.
  2135. *
  2136. * @param \DateTimeInterface|\DateTimeInterface[] $startTime
  2137. *
  2138. * @return static
  2139. *
  2140. * @see https://schema.org/startTime
  2141. * @link https://github.com/schemaorg/schemaorg/issues/2493
  2142. */
  2143. public function startTime($startTime)
  2144. {
  2145. return $this->setProperty('startTime', $startTime);
  2146. }
  2148. /**
  2149. * A CreativeWork or Event about this Thing.
  2150. *
  2151. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
  2152. *
  2153. * @return static
  2154. *
  2155. * @see https://schema.org/subjectOf
  2156. * @link https://github.com/schemaorg/schemaorg/issues/1670
  2157. */
  2158. public function subjectOf($subjectOf)
  2159. {
  2160. return $this->setProperty('subjectOf', $subjectOf);
  2161. }
  2163. /**
  2164. * The item being described is intended to help a person learn the
  2165. * competency or learning outcome defined by the referenced term.
  2166. *
  2167. * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $teaches
  2168. *
  2169. * @return static
  2170. *
  2171. * @see https://schema.org/teaches
  2172. * @see https://pending.schema.org
  2173. * @link https://github.com/schemaorg/schemaorg/issues/2427
  2174. */
  2175. public function teaches($teaches)
  2176. {
  2177. return $this->setProperty('teaches', $teaches);
  2178. }
  2180. /**
  2181. * The "temporal" property can be used in cases where more specific
  2182. * properties
  2183. * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]],
  2184. * [[datePublished]]) are not known to be appropriate.
  2185. *
  2186. * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal
  2187. *
  2188. * @return static
  2189. *
  2190. * @see https://schema.org/temporal
  2191. */
  2192. public function temporal($temporal)
  2193. {
  2194. return $this->setProperty('temporal', $temporal);
  2195. }
  2197. /**
  2198. * The temporalCoverage of a CreativeWork indicates the period that the
  2199. * content applies to, i.e. that it describes, either as a DateTime or as a
  2200. * textual string indicating a time period in [ISO 8601 time interval
  2201. * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In
  2202. * the case of a Dataset it will typically indicate the relevant time
  2203. * period in a precise notation (e.g. for a 2011 census dataset, the year
  2204. * 2011 would be written "2011/2012"). Other forms of content, e.g.
  2205. * ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their
  2206. * temporalCoverage in broader terms - textually or via well-known URL.
  2207. * Written works such as books may sometimes have precise temporal
  2208. * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601
  2209. * interval format format via "1939/1945".
  2210. *
  2211. * Open-ended date ranges can be written with ".." in place of the end date.
  2212. * For example, "2015-11/.." indicates a range beginning in November 2015
  2213. * and with no specified final date. This is tentative and might be updated
  2214. * in future when ISO 8601 is officially updated.
  2215. *
  2216. * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage
  2217. *
  2218. * @return static
  2219. *
  2220. * @see https://schema.org/temporalCoverage
  2221. */
  2222. public function temporalCoverage($temporalCoverage)
  2223. {
  2224. return $this->setProperty('temporalCoverage', $temporalCoverage);
  2225. }
  2227. /**
  2228. * The textual content of this CreativeWork.
  2229. *
  2230. * @param string|string[] $text
  2231. *
  2232. * @return static
  2233. *
  2234. * @see https://schema.org/text
  2235. */
  2236. public function text($text)
  2237. {
  2238. return $this->setProperty('text', $text);
  2239. }
  2241. /**
  2242. * Thumbnail image for an image or video.
  2243. *
  2244. * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[] $thumbnail
  2245. *
  2246. * @return static
  2247. *
  2248. * @see https://schema.org/thumbnail
  2249. */
  2250. public function thumbnail($thumbnail)
  2251. {
  2252. return $this->setProperty('thumbnail', $thumbnail);
  2253. }
  2255. /**
  2256. * A thumbnail image relevant to the Thing.
  2257. *
  2258. * @param string|string[] $thumbnailUrl
  2259. *
  2260. * @return static
  2261. *
  2262. * @see https://schema.org/thumbnailUrl
  2263. */
  2264. public function thumbnailUrl($thumbnailUrl)
  2265. {
  2266. return $this->setProperty('thumbnailUrl', $thumbnailUrl);
  2267. }
  2269. /**
  2270. * Approximate or typical time it usually takes to work with or through the
  2271. * content of this work for the typical or target audience.
  2272. *
  2273. * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $timeRequired
  2274. *
  2275. * @return static
  2276. *
  2277. * @see https://schema.org/timeRequired
  2278. */
  2279. public function timeRequired($timeRequired)
  2280. {
  2281. return $this->setProperty('timeRequired', $timeRequired);
  2282. }
  2284. /**
  2285. * The work that this work has been translated from. E.g. 物种起源 is a
  2286. * translationOf “On the Origin of Species”.
  2287. *
  2288. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $translationOfWork
  2289. *
  2290. * @return static
  2291. *
  2292. * @see https://schema.org/translationOfWork
  2293. * @see https://bib.schema.org
  2294. */
  2295. public function translationOfWork($translationOfWork)
  2296. {
  2297. return $this->setProperty('translationOfWork', $translationOfWork);
  2298. }
  2300. /**
  2301. * Organization or person who adapts a creative work to different languages,
  2302. * regional differences and technical requirements of a target market, or
  2303. * that translates during some event.
  2304. *
  2305. * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
  2306. *
  2307. * @return static
  2308. *
  2309. * @see https://schema.org/translator
  2310. */
  2311. public function translator($translator)
  2312. {
  2313. return $this->setProperty('translator', $translator);
  2314. }
  2316. /**
  2317. * The typical expected age range, e.g. '7-9', '11-'.
  2318. *
  2319. * @param string|string[] $typicalAgeRange
  2320. *
  2321. * @return static
  2322. *
  2323. * @see https://schema.org/typicalAgeRange
  2324. */
  2325. public function typicalAgeRange($typicalAgeRange)
  2326. {
  2327. return $this->setProperty('typicalAgeRange', $typicalAgeRange);
  2328. }
  2330. /**
  2331. * Date (including time if available) when this media object was uploaded to
  2332. * this site.
  2333. *
  2334. * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate
  2335. *
  2336. * @return static
  2337. *
  2338. * @see https://schema.org/uploadDate
  2339. */
  2340. public function uploadDate($uploadDate)
  2341. {
  2342. return $this->setProperty('uploadDate', $uploadDate);
  2343. }
  2345. /**
  2346. * URL of the item.
  2347. *
  2348. * @param string|string[] $url
  2349. *
  2350. * @return static
  2351. *
  2352. * @see https://schema.org/url
  2353. */
  2354. public function url($url)
  2355. {
  2356. return $this->setProperty('url', $url);
  2357. }
  2359. /**
  2360. * The schema.org [[usageInfo]] property indicates further information about
  2361. * a [[CreativeWork]]. This property is applicable both to works that are
  2362. * freely available and to those that require payment or other transactions.
  2363. * It can reference additional information, e.g. community expectations on
  2364. * preferred linking and citation conventions, as well as purchasing
  2365. * details. For something that can be commercially licensed, usageInfo can
  2366. * provide detailed, resource-specific information about licensing options.
  2367. *
  2368. * This property can be used alongside the license property which indicates
  2369. * license(s) applicable to some piece of content. The usageInfo property
  2370. * can provide information about other licensing options, e.g. acquiring
  2371. * commercial usage rights for an image that is also available under
  2372. * non-commercial creative commons licenses.
  2373. *
  2374. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $usageInfo
  2375. *
  2376. * @return static
  2377. *
  2378. * @see https://schema.org/usageInfo
  2379. * @see https://pending.schema.org
  2380. * @link https://github.com/schemaorg/schemaorg/issues/2454
  2381. */
  2382. public function usageInfo($usageInfo)
  2383. {
  2384. return $this->setProperty('usageInfo', $usageInfo);
  2385. }
  2387. /**
  2388. * The version of the CreativeWork embodied by a specified resource.
  2389. *
  2390. * @param float|float[]|int|int[]|string|string[] $version
  2391. *
  2392. * @return static
  2393. *
  2394. * @see https://schema.org/version
  2395. */
  2396. public function version($version)
  2397. {
  2398. return $this->setProperty('version', $version);
  2399. }
  2401. /**
  2402. * An embedded video object.
  2403. *
  2404. * @param \Spatie\SchemaOrg\Contracts\ClipContract|\Spatie\SchemaOrg\Contracts\ClipContract[]|\Spatie\SchemaOrg\Contracts\VideoObjectContract|\Spatie\SchemaOrg\Contracts\VideoObjectContract[] $video
  2405. *
  2406. * @return static
  2407. *
  2408. * @see https://schema.org/video
  2409. */
  2410. public function video($video)
  2411. {
  2412. return $this->setProperty('video', $video);
  2413. }
  2415. /**
  2416. * The width of the item.
  2417. *
  2418. * @param \Spatie\SchemaOrg\Contracts\DistanceContract|\Spatie\SchemaOrg\Contracts\DistanceContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $width
  2419. *
  2420. * @return static
  2421. *
  2422. * @see https://schema.org/width
  2423. */
  2424. public function width($width)
  2425. {
  2426. return $this->setProperty('width', $width);
  2427. }
  2429. /**
  2430. * Example/instance/realization/derivation of the concept of this creative
  2431. * work. E.g. the paperback edition, first edition, or e-book.
  2432. *
  2433. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workExample
  2434. *
  2435. * @return static
  2436. *
  2437. * @see https://schema.org/workExample
  2438. */
  2439. public function workExample($workExample)
  2440. {
  2441. return $this->setProperty('workExample', $workExample);
  2442. }
  2444. /**
  2445. * A work that is a translation of the content of this work. E.g. 西遊記
  2446. * has an English workTranslation “Journey to the West”, a German
  2447. * workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation
  2448. * Tây du ký bình khảo.
  2449. *
  2450. * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workTranslation
  2451. *
  2452. * @return static
  2453. *
  2454. * @see https://schema.org/workTranslation
  2455. * @see https://bib.schema.org
  2456. */
  2457. public function workTranslation($workTranslation)
  2458. {
  2459. return $this->setProperty('workTranslation', $workTranslation);
  2460. }
  2461. }