forked from spatie/schema-org
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AdvertiserContentArticle.php
2101 lines (1972 loc) · 68.7 KB
/
AdvertiserContentArticle.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
namespace Spatie\SchemaOrg;
use \Spatie\SchemaOrg\Contracts\AdvertiserContentArticleContract;
use \Spatie\SchemaOrg\Contracts\ArticleContract;
use \Spatie\SchemaOrg\Contracts\CreativeWorkContract;
use \Spatie\SchemaOrg\Contracts\ThingContract;
/**
* An [[Article]] that an external entity has paid to place or to produce to its
* specifications. Includes
* [advertorials](https://en.wikipedia.org/wiki/Advertorial), sponsored content,
* native advertising and other paid content.
*
* @see https://schema.org/AdvertiserContentArticle
* @see http://pending.schema.org
*
*/
class AdvertiserContentArticle extends BaseType implements AdvertiserContentArticleContract, ArticleContract, CreativeWorkContract, ThingContract
{
/**
* The subject matter of the content.
*
* @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
*
* @return static
*
* @see https://schema.org/about
* @link https://github.com/schemaorg/schemaorg/issues/1670
*/
public function about($about)
{
return $this->setProperty('about', $about);
}
/**
* An abstract is a short description that summarizes a [[CreativeWork]].
*
* @param string|string[] $abstract
*
* @return static
*
* @see https://schema.org/abstract
* @see http://pending.schema.org
* @link https://github.com/schemaorg/schemaorg/issues/276
*/
public function abstract($abstract)
{
return $this->setProperty('abstract', $abstract);
}
/**
* The human sensory perceptual system or cognitive faculty through which a
* person may process or perceive information. Expected values include:
* auditory, tactile, textual, visual, colorDependent, chartOnVisual,
* chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual.
*
* @param string|string[] $accessMode
*
* @return static
*
* @see https://schema.org/accessMode
* @link https://github.com/schemaorg/schemaorg/issues/1100
*/
public function accessMode($accessMode)
{
return $this->setProperty('accessMode', $accessMode);
}
/**
* A list of single or combined accessModes that are sufficient to
* understand all the intellectual content of a resource. Expected values
* include: auditory, tactile, textual, visual.
*
* @param \Spatie\SchemaOrg\Contracts\ItemListContract|\Spatie\SchemaOrg\Contracts\ItemListContract[] $accessModeSufficient
*
* @return static
*
* @see https://schema.org/accessModeSufficient
* @link https://github.com/schemaorg/schemaorg/issues/1100
*/
public function accessModeSufficient($accessModeSufficient)
{
return $this->setProperty('accessModeSufficient', $accessModeSufficient);
}
/**
* Indicates that the resource is compatible with the referenced
* accessibility API ([WebSchemas wiki lists possible
* values](http://www.w3.org/wiki/WebSchemas/Accessibility)).
*
* @param string|string[] $accessibilityAPI
*
* @return static
*
* @see https://schema.org/accessibilityAPI
*/
public function accessibilityAPI($accessibilityAPI)
{
return $this->setProperty('accessibilityAPI', $accessibilityAPI);
}
/**
* Identifies input methods that are sufficient to fully control the
* described resource ([WebSchemas wiki lists possible
* values](http://www.w3.org/wiki/WebSchemas/Accessibility)).
*
* @param string|string[] $accessibilityControl
*
* @return static
*
* @see https://schema.org/accessibilityControl
*/
public function accessibilityControl($accessibilityControl)
{
return $this->setProperty('accessibilityControl', $accessibilityControl);
}
/**
* Content features of the resource, such as accessible media, alternatives
* and supported enhancements for accessibility ([WebSchemas wiki lists
* possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)).
*
* @param string|string[] $accessibilityFeature
*
* @return static
*
* @see https://schema.org/accessibilityFeature
*/
public function accessibilityFeature($accessibilityFeature)
{
return $this->setProperty('accessibilityFeature', $accessibilityFeature);
}
/**
* A characteristic of the described resource that is physiologically
* dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas
* wiki lists possible
* values](http://www.w3.org/wiki/WebSchemas/Accessibility)).
*
* @param string|string[] $accessibilityHazard
*
* @return static
*
* @see https://schema.org/accessibilityHazard
*/
public function accessibilityHazard($accessibilityHazard)
{
return $this->setProperty('accessibilityHazard', $accessibilityHazard);
}
/**
* A human-readable summary of specific accessibility features or
* deficiencies, consistent with the other accessibility metadata but
* expressing subtleties such as "short descriptions are present but long
* descriptions will be needed for non-visual users" or "short descriptions
* are present and no long descriptions are needed."
*
* @param string|string[] $accessibilitySummary
*
* @return static
*
* @see https://schema.org/accessibilitySummary
* @link https://github.com/schemaorg/schemaorg/issues/1100
*/
public function accessibilitySummary($accessibilitySummary)
{
return $this->setProperty('accessibilitySummary', $accessibilitySummary);
}
/**
* Specifies the Person that is legally accountable for the CreativeWork.
*
* @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $accountablePerson
*
* @return static
*
* @see https://schema.org/accountablePerson
*/
public function accountablePerson($accountablePerson)
{
return $this->setProperty('accountablePerson', $accountablePerson);
}
/**
* Indicates a page documenting how licenses can be purchased or otherwise
* acquired, for the current item.
*
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $acquireLicensePage
*
* @return static
*
* @see https://schema.org/acquireLicensePage
* @see http://pending.schema.org
* @link https://github.com/schemaorg/schemaorg/issues/2454
*/
public function acquireLicensePage($acquireLicensePage)
{
return $this->setProperty('acquireLicensePage', $acquireLicensePage);
}
/**
* An additional type for the item, typically used for adding more specific
* types from external vocabularies in microdata syntax. This is a
* relationship between something and a class that the thing is in. In RDFa
* syntax, it is better to use the native RDFa syntax - the 'typeof'
* attribute - for multiple types. Schema.org tools may have only weaker
* understanding of extra types, in particular those defined externally.
*
* @param string|string[] $additionalType
*
* @return static
*
* @see https://schema.org/additionalType
*/
public function additionalType($additionalType)
{
return $this->setProperty('additionalType', $additionalType);
}
/**
* The overall rating, based on a collection of reviews or ratings, of the
* item.
*
* @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
*
* @return static
*
* @see https://schema.org/aggregateRating
*/
public function aggregateRating($aggregateRating)
{
return $this->setProperty('aggregateRating', $aggregateRating);
}
/**
* An alias for the item.
*
* @param string|string[] $alternateName
*
* @return static
*
* @see https://schema.org/alternateName
*/
public function alternateName($alternateName)
{
return $this->setProperty('alternateName', $alternateName);
}
/**
* A secondary title of the CreativeWork.
*
* @param string|string[] $alternativeHeadline
*
* @return static
*
* @see https://schema.org/alternativeHeadline
*/
public function alternativeHeadline($alternativeHeadline)
{
return $this->setProperty('alternativeHeadline', $alternativeHeadline);
}
/**
* The actual body of the article.
*
* @param string|string[] $articleBody
*
* @return static
*
* @see https://schema.org/articleBody
*/
public function articleBody($articleBody)
{
return $this->setProperty('articleBody', $articleBody);
}
/**
* Articles may belong to one or more 'sections' in a magazine or newspaper,
* such as Sports, Lifestyle, etc.
*
* @param string|string[] $articleSection
*
* @return static
*
* @see https://schema.org/articleSection
*/
public function articleSection($articleSection)
{
return $this->setProperty('articleSection', $articleSection);
}
/**
* The item being described is intended to assess the competency or learning
* outcome defined by the referenced term.
*
* @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $assesses
*
* @return static
*
* @see https://schema.org/assesses
* @see http://pending.schema.org
* @link https://github.com/schemaorg/schemaorg/issues/2427
*/
public function assesses($assesses)
{
return $this->setProperty('assesses', $assesses);
}
/**
* A media object that encodes this CreativeWork. This property is a synonym
* for encoding.
*
* @param \Spatie\SchemaOrg\Contracts\MediaObjectContract|\Spatie\SchemaOrg\Contracts\MediaObjectContract[] $associatedMedia
*
* @return static
*
* @see https://schema.org/associatedMedia
*/
public function associatedMedia($associatedMedia)
{
return $this->setProperty('associatedMedia', $associatedMedia);
}
/**
* An intended audience, i.e. a group for whom something was created.
*
* @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
*
* @return static
*
* @see https://schema.org/audience
*/
public function audience($audience)
{
return $this->setProperty('audience', $audience);
}
/**
* An embedded audio object.
*
* @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
*
* @return static
*
* @see https://schema.org/audio
* @link https://github.com/schemaorg/schemaorg/issues/2420
*/
public function audio($audio)
{
return $this->setProperty('audio', $audio);
}
/**
* The author of this content or rating. Please note that author is special
* in that HTML 5 provides a special mechanism for indicating authorship via
* the rel tag. That is equivalent to this and may be used interchangeably.
*
* @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $author
*
* @return static
*
* @see https://schema.org/author
*/
public function author($author)
{
return $this->setProperty('author', $author);
}
/**
* An award won by or for this item.
*
* @param string|string[] $award
*
* @return static
*
* @see https://schema.org/award
*/
public function award($award)
{
return $this->setProperty('award', $award);
}
/**
* Awards won by or for this item.
*
* @param string|string[] $awards
*
* @return static
*
* @see https://schema.org/awards
*/
public function awards($awards)
{
return $this->setProperty('awards', $awards);
}
/**
* For an [[Article]], typically a [[NewsArticle]], the backstory property
* provides a textual summary giving a brief explanation of why and how an
* article was created. In a journalistic setting this could include
* information about reporting process, methods, interviews, data sources,
* etc.
*
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $backstory
*
* @return static
*
* @see https://schema.org/backstory
* @see http://pending.schema.org
*/
public function backstory($backstory)
{
return $this->setProperty('backstory', $backstory);
}
/**
* Fictional person connected with a creative work.
*
* @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $character
*
* @return static
*
* @see https://schema.org/character
*/
public function character($character)
{
return $this->setProperty('character', $character);
}
/**
* A citation or reference to another creative work, such as another
* publication, web page, scholarly article, etc.
*
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $citation
*
* @return static
*
* @see https://schema.org/citation
*/
public function citation($citation)
{
return $this->setProperty('citation', $citation);
}
/**
* Comments, typically from users.
*
* @param \Spatie\SchemaOrg\Contracts\CommentContract|\Spatie\SchemaOrg\Contracts\CommentContract[] $comment
*
* @return static
*
* @see https://schema.org/comment
*/
public function comment($comment)
{
return $this->setProperty('comment', $comment);
}
/**
* The number of comments this CreativeWork (e.g. Article, Question or
* Answer) has received. This is most applicable to works published in Web
* sites with commenting system; additional comments may exist elsewhere.
*
* @param int|int[] $commentCount
*
* @return static
*
* @see https://schema.org/commentCount
*/
public function commentCount($commentCount)
{
return $this->setProperty('commentCount', $commentCount);
}
/**
* Conditions that affect the availability of, or method(s) of access to, an
* item. Typically used for real world items such as an [[ArchiveComponent]]
* held by an [[ArchiveOrganization]]. This property is not suitable for use
* as a general Web access control mechanism. It is expressed only in
* natural language.
*
* For example "Available by appointment from the Reading Room" or
* "Accessible only from logged-in accounts ".
*
* @param string|string[] $conditionsOfAccess
*
* @return static
*
* @see https://schema.org/conditionsOfAccess
* @see http://pending.schema.org
* @link https://github.com/schemaorg/schemaorg/issues/2173
*/
public function conditionsOfAccess($conditionsOfAccess)
{
return $this->setProperty('conditionsOfAccess', $conditionsOfAccess);
}
/**
* The location depicted or described in the content. For example, the
* location in a photograph or painting.
*
* @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $contentLocation
*
* @return static
*
* @see https://schema.org/contentLocation
*/
public function contentLocation($contentLocation)
{
return $this->setProperty('contentLocation', $contentLocation);
}
/**
* Official rating of a piece of content—for example,'MPAA PG-13'.
*
* @param \Spatie\SchemaOrg\Contracts\RatingContract|\Spatie\SchemaOrg\Contracts\RatingContract[]|string|string[] $contentRating
*
* @return static
*
* @see https://schema.org/contentRating
*/
public function contentRating($contentRating)
{
return $this->setProperty('contentRating', $contentRating);
}
/**
* The specific time described by a creative work, for works (e.g. articles,
* video objects etc.) that emphasise a particular moment within an Event.
*
* @param \DateTimeInterface|\DateTimeInterface[] $contentReferenceTime
*
* @return static
*
* @see https://schema.org/contentReferenceTime
* @see http://pending.schema.org
* @link https://github.com/schemaorg/schemaorg/issues/1050
*/
public function contentReferenceTime($contentReferenceTime)
{
return $this->setProperty('contentReferenceTime', $contentReferenceTime);
}
/**
* A secondary contributor to the CreativeWork or Event.
*
* @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
*
* @return static
*
* @see https://schema.org/contributor
*/
public function contributor($contributor)
{
return $this->setProperty('contributor', $contributor);
}
/**
* The party holding the legal copyright to the CreativeWork.
*
* @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $copyrightHolder
*
* @return static
*
* @see https://schema.org/copyrightHolder
*/
public function copyrightHolder($copyrightHolder)
{
return $this->setProperty('copyrightHolder', $copyrightHolder);
}
/**
* The year during which the claimed copyright for the CreativeWork was
* first asserted.
*
* @param float|float[]|int|int[] $copyrightYear
*
* @return static
*
* @see https://schema.org/copyrightYear
*/
public function copyrightYear($copyrightYear)
{
return $this->setProperty('copyrightYear', $copyrightYear);
}
/**
* Indicates a correction to a [[CreativeWork]], either via a
* [[CorrectionComment]], textually or in another document.
*
* @param \Spatie\SchemaOrg\Contracts\CorrectionCommentContract|\Spatie\SchemaOrg\Contracts\CorrectionCommentContract[]|string|string[] $correction
*
* @return static
*
* @see https://schema.org/correction
* @see http://pending.schema.org
*/
public function correction($correction)
{
return $this->setProperty('correction', $correction);
}
/**
* The status of a creative work in terms of its stage in a lifecycle.
* Example terms include Incomplete, Draft, Published, Obsolete. Some
* organizations define a set of terms for the stages of their publication
* lifecycle.
*
* @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $creativeWorkStatus
*
* @return static
*
* @see https://schema.org/creativeWorkStatus
* @see http://pending.schema.org
* @link https://github.com/schemaorg/schemaorg/issues/987
*/
public function creativeWorkStatus($creativeWorkStatus)
{
return $this->setProperty('creativeWorkStatus', $creativeWorkStatus);
}
/**
* The creator/author of this CreativeWork. This is the same as the Author
* property for CreativeWork.
*
* @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $creator
*
* @return static
*
* @see https://schema.org/creator
*/
public function creator($creator)
{
return $this->setProperty('creator', $creator);
}
/**
* The date on which the CreativeWork was created or the item was added to a
* DataFeed.
*
* @param \DateTimeInterface|\DateTimeInterface[] $dateCreated
*
* @return static
*
* @see https://schema.org/dateCreated
*/
public function dateCreated($dateCreated)
{
return $this->setProperty('dateCreated', $dateCreated);
}
/**
* The date on which the CreativeWork was most recently modified or when the
* item's entry was modified within a DataFeed.
*
* @param \DateTimeInterface|\DateTimeInterface[] $dateModified
*
* @return static
*
* @see https://schema.org/dateModified
*/
public function dateModified($dateModified)
{
return $this->setProperty('dateModified', $dateModified);
}
/**
* Date of first broadcast/publication.
*
* @param \DateTimeInterface|\DateTimeInterface[] $datePublished
*
* @return static
*
* @see https://schema.org/datePublished
*/
public function datePublished($datePublished)
{
return $this->setProperty('datePublished', $datePublished);
}
/**
* A description of the item.
*
* @param string|string[] $description
*
* @return static
*
* @see https://schema.org/description
*/
public function description($description)
{
return $this->setProperty('description', $description);
}
/**
* A sub property of description. A short description of the item used to
* disambiguate from other, similar items. Information from other properties
* (in particular, name) may be necessary for the description to be useful
* for disambiguation.
*
* @param string|string[] $disambiguatingDescription
*
* @return static
*
* @see https://schema.org/disambiguatingDescription
*/
public function disambiguatingDescription($disambiguatingDescription)
{
return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
}
/**
* A link to the page containing the comments of the CreativeWork.
*
* @param string|string[] $discussionUrl
*
* @return static
*
* @see https://schema.org/discussionUrl
*/
public function discussionUrl($discussionUrl)
{
return $this->setProperty('discussionUrl', $discussionUrl);
}
/**
* An [EIDR](https://eidr.org/) (Entertainment Identifier Registry)
* [[identifier]] representing a specific edit / edition for a work of film
* or television.
*
* For example, the motion picture known as "Ghostbusters" whose
* [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J", has several edits
* e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and
* "10.5240/8A35-3BEE-6497-5D12-9E4F-3".
*
* Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for
* both works and their multiple expressions, it is possible to use
* [[titleEIDR]] alone (for a general description), or alongside
* [[editEIDR]] for a more edit-specific description.
*
* @param string|string[] $editEIDR
*
* @return static
*
* @see https://schema.org/editEIDR
* @see http://pending.schema.org
* @link https://github.com/schemaorg/schemaorg/issues/2469
*/
public function editEIDR($editEIDR)
{
return $this->setProperty('editEIDR', $editEIDR);
}
/**
* Specifies the Person who edited the CreativeWork.
*
* @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $editor
*
* @return static
*
* @see https://schema.org/editor
*/
public function editor($editor)
{
return $this->setProperty('editor', $editor);
}
/**
* An alignment to an established educational framework.
*
* This property should not be used where the nature of the alignment can be
* described using a simple property, for example to express that a resource
* [[teaches]] or [[assesses]] a competency.
*
* @param \Spatie\SchemaOrg\Contracts\AlignmentObjectContract|\Spatie\SchemaOrg\Contracts\AlignmentObjectContract[] $educationalAlignment
*
* @return static
*
* @see https://schema.org/educationalAlignment
*/
public function educationalAlignment($educationalAlignment)
{
return $this->setProperty('educationalAlignment', $educationalAlignment);
}
/**
* The level in terms of progression through an educational or training
* context. Examples of educational levels include 'beginner',
* 'intermediate' or 'advanced', and formal sets of level indicators.
*
* @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $educationalLevel
*
* @return static
*
* @see https://schema.org/educationalLevel
* @see http://pending.schema.org
* @link https://github.com/schemaorg/schemaorg/issues/1779
*/
public function educationalLevel($educationalLevel)
{
return $this->setProperty('educationalLevel', $educationalLevel);
}
/**
* The purpose of a work in the context of education; for example,
* 'assignment', 'group work'.
*
* @param string|string[] $educationalUse
*
* @return static
*
* @see https://schema.org/educationalUse
*/
public function educationalUse($educationalUse)
{
return $this->setProperty('educationalUse', $educationalUse);
}
/**
* A media object that encodes this CreativeWork. This property is a synonym
* for associatedMedia.
*
* @param \Spatie\SchemaOrg\Contracts\MediaObjectContract|\Spatie\SchemaOrg\Contracts\MediaObjectContract[] $encoding
*
* @return static
*
* @see https://schema.org/encoding
*/
public function encoding($encoding)
{
return $this->setProperty('encoding', $encoding);
}
/**
* Media type typically expressed using a MIME format (see [IANA
* site](http://www.iana.org/assignments/media-types/media-types.xhtml) and
* [MDN
* reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types))
* e.g. application/zip for a SoftwareApplication binary, audio/mpeg for
* .mp3 etc.).
*
* In cases where a [[CreativeWork]] has several media type representations,
* [[encoding]] can be used to indicate each [[MediaObject]] alongside
* particular [[encodingFormat]] information.
*
* Unregistered or niche encoding and file formats can be indicated instead
* via the most appropriate URL, e.g. defining Web page or a
* Wikipedia/Wikidata entry.
*
* @param string|string[] $encodingFormat
*
* @return static
*
* @see https://schema.org/encodingFormat
*/
public function encodingFormat($encodingFormat)
{
return $this->setProperty('encodingFormat', $encodingFormat);
}
/**
* A media object that encodes this CreativeWork.
*
* @param \Spatie\SchemaOrg\Contracts\MediaObjectContract|\Spatie\SchemaOrg\Contracts\MediaObjectContract[] $encodings
*
* @return static
*
* @see https://schema.org/encodings
*/
public function encodings($encodings)
{
return $this->setProperty('encodings', $encodings);
}
/**
* A creative work that this work is an
* example/instance/realization/derivation of.
*
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $exampleOfWork
*
* @return static
*
* @see https://schema.org/exampleOfWork
* @link http://www.w3.org/wiki/WebSchemas/SchemaDotOrgSources#source_bibex
*/
public function exampleOfWork($exampleOfWork)
{
return $this->setProperty('exampleOfWork', $exampleOfWork);
}
/**
* Date the content expires and is no longer useful or available. For
* example a [[VideoObject]] or [[NewsArticle]] whose availability or
* relevance is time-limited, or a [[ClaimReview]] fact check whose
* publisher wants to indicate that it may no longer be relevant (or helpful
* to highlight) after some date.
*
* @param \DateTimeInterface|\DateTimeInterface[] $expires
*
* @return static
*
* @see https://schema.org/expires
*/
public function expires($expires)
{
return $this->setProperty('expires', $expires);
}
/**
* Media type, typically MIME format (see [IANA
* site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of
* the content e.g. application/zip of a SoftwareApplication binary. In
* cases where a CreativeWork has several media type representations,
* 'encoding' can be used to indicate each MediaObject alongside particular
* fileFormat information. Unregistered or niche file formats can be
* indicated instead via the most appropriate URL, e.g. defining Web page or
* a Wikipedia entry.
*
* @param string|string[] $fileFormat
*
* @return static
*
* @see https://schema.org/fileFormat
*/
public function fileFormat($fileFormat)
{
return $this->setProperty('fileFormat', $fileFormat);
}
/**
* A person or organization that supports (sponsors) something through some
* kind of financial contribution.
*
* @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
*
* @return static
*
* @see https://schema.org/funder
*/
public function funder($funder)
{
return $this->setProperty('funder', $funder);
}
/**
* Genre of the creative work, broadcast channel or group.
*
* @param string|string[] $genre
*
* @return static
*
* @see https://schema.org/genre
*/
public function genre($genre)
{
return $this->setProperty('genre', $genre);
}
/**
* Indicates an item or CreativeWork that is part of this item, or
* CreativeWork (in some sense).
*
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $hasPart
*
* @return static
*
* @see https://schema.org/hasPart
* @link http://www.w3.org/wiki/WebSchemas/SchemaDotOrgSources#source_bibex
*/
public function hasPart($hasPart)
{
return $this->setProperty('hasPart', $hasPart);
}
/**
* Headline of the article.
*
* @param string|string[] $headline
*
* @return static
*
* @see https://schema.org/headline
*/
public function headline($headline)
{
return $this->setProperty('headline', $headline);
}
/**
* The identifier property represents any kind of identifier for any kind of
* [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
* dedicated properties for representing many of these, either as textual
* strings or as URL (URI) links. See [background
* notes](/docs/datamodel.html#identifierBg) for more details.
*
* @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
*
* @return static