Code Duplication    Length = 698-728 lines in 59 locations

src/Airport.php 1 location

@@ 16-741 (lines=726) @@
13
 * @see http://schema.org/Airport
14
 *
15
 */
16
class Airport extends BaseType implements AirportContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * IATA identifier for an airline or airport.
303
     *
304
     * @param string|string[] $iataCode
305
     *
306
     * @return static
307
     *
308
     * @see http://schema.org/iataCode
309
     */
310
    public function iataCode($iataCode)
311
    {
312
        return $this->setProperty('iataCode', $iataCode);
313
    }
314
315
    /**
316
     * ICAO identifier for an airport.
317
     *
318
     * @param string|string[] $icaoCode
319
     *
320
     * @return static
321
     *
322
     * @see http://schema.org/icaoCode
323
     */
324
    public function icaoCode($icaoCode)
325
    {
326
        return $this->setProperty('icaoCode', $icaoCode);
327
    }
328
329
    /**
330
     * The identifier property represents any kind of identifier for any kind of
331
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
332
     * dedicated properties for representing many of these, either as textual
333
     * strings or as URL (URI) links. See [background
334
     * notes](/docs/datamodel.html#identifierBg) for more details.
335
     *
336
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
337
     *
338
     * @return static
339
     *
340
     * @see http://schema.org/identifier
341
     */
342
    public function identifier($identifier)
343
    {
344
        return $this->setProperty('identifier', $identifier);
345
    }
346
347
    /**
348
     * An image of the item. This can be a [[URL]] or a fully described
349
     * [[ImageObject]].
350
     *
351
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
352
     *
353
     * @return static
354
     *
355
     * @see http://schema.org/image
356
     */
357
    public function image($image)
358
    {
359
        return $this->setProperty('image', $image);
360
    }
361
362
    /**
363
     * A flag to signal that the item, event, or place is accessible for free.
364
     *
365
     * @param bool|bool[] $isAccessibleForFree
366
     *
367
     * @return static
368
     *
369
     * @see http://schema.org/isAccessibleForFree
370
     */
371
    public function isAccessibleForFree($isAccessibleForFree)
372
    {
373
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
374
    }
375
376
    /**
377
     * The International Standard of Industrial Classification of All Economic
378
     * Activities (ISIC), Revision 4 code for a particular organization,
379
     * business person, or place.
380
     *
381
     * @param string|string[] $isicV4
382
     *
383
     * @return static
384
     *
385
     * @see http://schema.org/isicV4
386
     */
387
    public function isicV4($isicV4)
388
    {
389
        return $this->setProperty('isicV4', $isicV4);
390
    }
391
392
    /**
393
     * The latitude of a location. For example ```37.42242``` ([WGS
394
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
395
     *
396
     * @param float|float[]|int|int[]|string|string[] $latitude
397
     *
398
     * @return static
399
     *
400
     * @see http://schema.org/latitude
401
     */
402
    public function latitude($latitude)
403
    {
404
        return $this->setProperty('latitude', $latitude);
405
    }
406
407
    /**
408
     * An associated logo.
409
     *
410
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
411
     *
412
     * @return static
413
     *
414
     * @see http://schema.org/logo
415
     */
416
    public function logo($logo)
417
    {
418
        return $this->setProperty('logo', $logo);
419
    }
420
421
    /**
422
     * The longitude of a location. For example ```-122.08585``` ([WGS
423
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
424
     *
425
     * @param float|float[]|int|int[]|string|string[] $longitude
426
     *
427
     * @return static
428
     *
429
     * @see http://schema.org/longitude
430
     */
431
    public function longitude($longitude)
432
    {
433
        return $this->setProperty('longitude', $longitude);
434
    }
435
436
    /**
437
     * Indicates a page (or other CreativeWork) for which this thing is the main
438
     * entity being described. See [background
439
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
440
     *
441
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/mainEntityOfPage
446
     */
447
    public function mainEntityOfPage($mainEntityOfPage)
448
    {
449
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
450
    }
451
452
    /**
453
     * A URL to a map of the place.
454
     *
455
     * @param string|string[] $map
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/map
460
     */
461
    public function map($map)
462
    {
463
        return $this->setProperty('map', $map);
464
    }
465
466
    /**
467
     * A URL to a map of the place.
468
     *
469
     * @param string|string[] $maps
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/maps
474
     */
475
    public function maps($maps)
476
    {
477
        return $this->setProperty('maps', $maps);
478
    }
479
480
    /**
481
     * The total number of individuals that may attend an event or venue.
482
     *
483
     * @param int|int[] $maximumAttendeeCapacity
484
     *
485
     * @return static
486
     *
487
     * @see http://schema.org/maximumAttendeeCapacity
488
     */
489
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
490
    {
491
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
492
    }
493
494
    /**
495
     * The name of the item.
496
     *
497
     * @param string|string[] $name
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/name
502
     */
503
    public function name($name)
504
    {
505
        return $this->setProperty('name', $name);
506
    }
507
508
    /**
509
     * The general opening hours for a business. Opening hours can be specified
510
     * as a weekly time range, starting with days, then times per day. Multiple
511
     * days can be listed with commas ',' separating each day. Day or time
512
     * ranges are specified using a hyphen '-'.
513
     * 
514
     * * Days are specified using the following two-letter combinations:
515
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
516
     * * Times are specified using 24:00 time. For example, 3pm is specified as
517
     * ```15:00```. 
518
     * * Here is an example: <code>&lt;time itemprop="openingHours"
519
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
520
     * 4-8pm&lt;/time&gt;</code>.
521
     * * If a business is open 7 days a week, then it can be specified as
522
     * <code>&lt;time itemprop=&quot;openingHours&quot;
523
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
524
     * day&lt;/time&gt;</code>.
525
     *
526
     * @param string|string[] $openingHours
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/openingHours
531
     */
532
    public function openingHours($openingHours)
533
    {
534
        return $this->setProperty('openingHours', $openingHours);
535
    }
536
537
    /**
538
     * The opening hours of a certain place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/openingHoursSpecification
545
     */
546
    public function openingHoursSpecification($openingHoursSpecification)
547
    {
548
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
549
    }
550
551
    /**
552
     * A photograph of this place.
553
     *
554
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
555
     *
556
     * @return static
557
     *
558
     * @see http://schema.org/photo
559
     */
560
    public function photo($photo)
561
    {
562
        return $this->setProperty('photo', $photo);
563
    }
564
565
    /**
566
     * Photographs of this place.
567
     *
568
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
569
     *
570
     * @return static
571
     *
572
     * @see http://schema.org/photos
573
     */
574
    public function photos($photos)
575
    {
576
        return $this->setProperty('photos', $photos);
577
    }
578
579
    /**
580
     * Indicates a potential Action, which describes an idealized action in
581
     * which this thing would play an 'object' role.
582
     *
583
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
584
     *
585
     * @return static
586
     *
587
     * @see http://schema.org/potentialAction
588
     */
589
    public function potentialAction($potentialAction)
590
    {
591
        return $this->setProperty('potentialAction', $potentialAction);
592
    }
593
594
    /**
595
     * A flag to signal that the [[Place]] is open to public visitors.  If this
596
     * property is omitted there is no assumed default boolean value
597
     *
598
     * @param bool|bool[] $publicAccess
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/publicAccess
603
     */
604
    public function publicAccess($publicAccess)
605
    {
606
        return $this->setProperty('publicAccess', $publicAccess);
607
    }
608
609
    /**
610
     * A review of the item.
611
     *
612
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
613
     *
614
     * @return static
615
     *
616
     * @see http://schema.org/review
617
     */
618
    public function review($review)
619
    {
620
        return $this->setProperty('review', $review);
621
    }
622
623
    /**
624
     * Review of the item.
625
     *
626
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
627
     *
628
     * @return static
629
     *
630
     * @see http://schema.org/reviews
631
     */
632
    public function reviews($reviews)
633
    {
634
        return $this->setProperty('reviews', $reviews);
635
    }
636
637
    /**
638
     * URL of a reference Web page that unambiguously indicates the item's
639
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
640
     * official website.
641
     *
642
     * @param string|string[] $sameAs
643
     *
644
     * @return static
645
     *
646
     * @see http://schema.org/sameAs
647
     */
648
    public function sameAs($sameAs)
649
    {
650
        return $this->setProperty('sameAs', $sameAs);
651
    }
652
653
    /**
654
     * A slogan or motto associated with the item.
655
     *
656
     * @param string|string[] $slogan
657
     *
658
     * @return static
659
     *
660
     * @see http://schema.org/slogan
661
     */
662
    public function slogan($slogan)
663
    {
664
        return $this->setProperty('slogan', $slogan);
665
    }
666
667
    /**
668
     * Indicates whether it is allowed to smoke in the place, e.g. in the
669
     * restaurant, hotel or hotel room.
670
     *
671
     * @param bool|bool[] $smokingAllowed
672
     *
673
     * @return static
674
     *
675
     * @see http://schema.org/smokingAllowed
676
     */
677
    public function smokingAllowed($smokingAllowed)
678
    {
679
        return $this->setProperty('smokingAllowed', $smokingAllowed);
680
    }
681
682
    /**
683
     * The special opening hours of a certain place.
684
     * 
685
     * Use this to explicitly override general opening hours brought in scope by
686
     * [[openingHoursSpecification]] or [[openingHours]].
687
     *
688
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/specialOpeningHoursSpecification
693
     */
694
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
695
    {
696
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
697
    }
698
699
    /**
700
     * A CreativeWork or Event about this Thing.
701
     *
702
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/subjectOf
707
     */
708
    public function subjectOf($subjectOf)
709
    {
710
        return $this->setProperty('subjectOf', $subjectOf);
711
    }
712
713
    /**
714
     * The telephone number.
715
     *
716
     * @param string|string[] $telephone
717
     *
718
     * @return static
719
     *
720
     * @see http://schema.org/telephone
721
     */
722
    public function telephone($telephone)
723
    {
724
        return $this->setProperty('telephone', $telephone);
725
    }
726
727
    /**
728
     * URL of the item.
729
     *
730
     * @param string|string[] $url
731
     *
732
     * @return static
733
     *
734
     * @see http://schema.org/url
735
     */
736
    public function url($url)
737
    {
738
        return $this->setProperty('url', $url);
739
    }
740
741
}
742

src/Aquarium.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/Aquarium
14
 *
15
 */
16
class Aquarium extends BaseType implements AquariumContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/Beach.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/Beach
14
 *
15
 */
16
class Beach extends BaseType implements BeachContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/Bridge.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/Bridge
14
 *
15
 */
16
class Bridge extends BaseType implements BridgeContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/BuddhistTemple.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/BuddhistTemple
15
 *
16
 */
17
class BuddhistTemple extends BaseType implements BuddhistTempleContract, CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/BusinessEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/BusinessEvent
13
 *
14
 */
15
class BusinessEvent extends BaseType implements BusinessEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/BusStation.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/BusStation
14
 *
15
 */
16
class BusStation extends BaseType implements BusStationContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/BusStop.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/BusStop
14
 *
15
 */
16
class BusStop extends BaseType implements BusStopContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/Cemetery.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/Cemetery
14
 *
15
 */
16
class Cemetery extends BaseType implements CemeteryContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/ChildrensEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/ChildrensEvent
13
 *
14
 */
15
class ChildrensEvent extends BaseType implements ChildrensEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/Church.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/Church
15
 *
16
 */
17
class Church extends BaseType implements ChurchContract, CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/CityHall.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/CityHall
15
 *
16
 */
17
class CityHall extends BaseType implements CityHallContract, CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/CivicStructure.php 1 location

@@ 15-712 (lines=698) @@
12
 * @see http://schema.org/CivicStructure
13
 *
14
 */
15
class CivicStructure extends BaseType implements CivicStructureContract, PlaceContract, ThingContract
16
{
17
    /**
18
     * A property-value pair representing an additional characteristics of the
19
     * entitity, e.g. a product feature or another characteristic for which
20
     * there is no matching property in schema.org.
21
     * 
22
     * Note: Publishers should be aware that applications designed to use
23
     * specific schema.org properties (e.g. http://schema.org/width,
24
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
25
     * expect such data to be provided using those properties, rather than using
26
     * the generic property/value mechanism.
27
     *
28
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
29
     *
30
     * @return static
31
     *
32
     * @see http://schema.org/additionalProperty
33
     */
34
    public function additionalProperty($additionalProperty)
35
    {
36
        return $this->setProperty('additionalProperty', $additionalProperty);
37
    }
38
39
    /**
40
     * An additional type for the item, typically used for adding more specific
41
     * types from external vocabularies in microdata syntax. This is a
42
     * relationship between something and a class that the thing is in. In RDFa
43
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
44
     * attribute - for multiple types. Schema.org tools may have only weaker
45
     * understanding of extra types, in particular those defined externally.
46
     *
47
     * @param string|string[] $additionalType
48
     *
49
     * @return static
50
     *
51
     * @see http://schema.org/additionalType
52
     */
53
    public function additionalType($additionalType)
54
    {
55
        return $this->setProperty('additionalType', $additionalType);
56
    }
57
58
    /**
59
     * Physical address of the item.
60
     *
61
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
62
     *
63
     * @return static
64
     *
65
     * @see http://schema.org/address
66
     */
67
    public function address($address)
68
    {
69
        return $this->setProperty('address', $address);
70
    }
71
72
    /**
73
     * The overall rating, based on a collection of reviews or ratings, of the
74
     * item.
75
     *
76
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
77
     *
78
     * @return static
79
     *
80
     * @see http://schema.org/aggregateRating
81
     */
82
    public function aggregateRating($aggregateRating)
83
    {
84
        return $this->setProperty('aggregateRating', $aggregateRating);
85
    }
86
87
    /**
88
     * An alias for the item.
89
     *
90
     * @param string|string[] $alternateName
91
     *
92
     * @return static
93
     *
94
     * @see http://schema.org/alternateName
95
     */
96
    public function alternateName($alternateName)
97
    {
98
        return $this->setProperty('alternateName', $alternateName);
99
    }
100
101
    /**
102
     * An amenity feature (e.g. a characteristic or service) of the
103
     * Accommodation. This generic property does not make a statement about
104
     * whether the feature is included in an offer for the main accommodation or
105
     * available at extra costs.
106
     *
107
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
108
     *
109
     * @return static
110
     *
111
     * @see http://schema.org/amenityFeature
112
     */
113
    public function amenityFeature($amenityFeature)
114
    {
115
        return $this->setProperty('amenityFeature', $amenityFeature);
116
    }
117
118
    /**
119
     * A short textual code (also called "store code") that uniquely identifies
120
     * a place of business. The code is typically assigned by the
121
     * parentOrganization and used in structured URLs.
122
     * 
123
     * For example, in the URL
124
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
125
     * is a branchCode for a particular branch.
126
     *
127
     * @param string|string[] $branchCode
128
     *
129
     * @return static
130
     *
131
     * @see http://schema.org/branchCode
132
     */
133
    public function branchCode($branchCode)
134
    {
135
        return $this->setProperty('branchCode', $branchCode);
136
    }
137
138
    /**
139
     * The basic containment relation between a place and one that contains it.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/containedIn
146
     */
147
    public function containedIn($containedIn)
148
    {
149
        return $this->setProperty('containedIn', $containedIn);
150
    }
151
152
    /**
153
     * The basic containment relation between a place and one that contains it.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/containedInPlace
160
     */
161
    public function containedInPlace($containedInPlace)
162
    {
163
        return $this->setProperty('containedInPlace', $containedInPlace);
164
    }
165
166
    /**
167
     * The basic containment relation between a place and another that it
168
     * contains.
169
     *
170
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
171
     *
172
     * @return static
173
     *
174
     * @see http://schema.org/containsPlace
175
     */
176
    public function containsPlace($containsPlace)
177
    {
178
        return $this->setProperty('containsPlace', $containsPlace);
179
    }
180
181
    /**
182
     * A description of the item.
183
     *
184
     * @param string|string[] $description
185
     *
186
     * @return static
187
     *
188
     * @see http://schema.org/description
189
     */
190
    public function description($description)
191
    {
192
        return $this->setProperty('description', $description);
193
    }
194
195
    /**
196
     * A sub property of description. A short description of the item used to
197
     * disambiguate from other, similar items. Information from other properties
198
     * (in particular, name) may be necessary for the description to be useful
199
     * for disambiguation.
200
     *
201
     * @param string|string[] $disambiguatingDescription
202
     *
203
     * @return static
204
     *
205
     * @see http://schema.org/disambiguatingDescription
206
     */
207
    public function disambiguatingDescription($disambiguatingDescription)
208
    {
209
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
210
    }
211
212
    /**
213
     * Upcoming or past event associated with this place, organization, or
214
     * action.
215
     *
216
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/event
221
     */
222
    public function event($event)
223
    {
224
        return $this->setProperty('event', $event);
225
    }
226
227
    /**
228
     * Upcoming or past events associated with this place or organization.
229
     *
230
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
231
     *
232
     * @return static
233
     *
234
     * @see http://schema.org/events
235
     */
236
    public function events($events)
237
    {
238
        return $this->setProperty('events', $events);
239
    }
240
241
    /**
242
     * The fax number.
243
     *
244
     * @param string|string[] $faxNumber
245
     *
246
     * @return static
247
     *
248
     * @see http://schema.org/faxNumber
249
     */
250
    public function faxNumber($faxNumber)
251
    {
252
        return $this->setProperty('faxNumber', $faxNumber);
253
    }
254
255
    /**
256
     * The geo coordinates of the place.
257
     *
258
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
259
     *
260
     * @return static
261
     *
262
     * @see http://schema.org/geo
263
     */
264
    public function geo($geo)
265
    {
266
        return $this->setProperty('geo', $geo);
267
    }
268
269
    /**
270
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
271
     * referred to as International Location Number or ILN) of the respective
272
     * organization, person, or place. The GLN is a 13-digit number used to
273
     * identify parties and physical locations.
274
     *
275
     * @param string|string[] $globalLocationNumber
276
     *
277
     * @return static
278
     *
279
     * @see http://schema.org/globalLocationNumber
280
     */
281
    public function globalLocationNumber($globalLocationNumber)
282
    {
283
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
284
    }
285
286
    /**
287
     * A URL to a map of the place.
288
     *
289
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
290
     *
291
     * @return static
292
     *
293
     * @see http://schema.org/hasMap
294
     */
295
    public function hasMap($hasMap)
296
    {
297
        return $this->setProperty('hasMap', $hasMap);
298
    }
299
300
    /**
301
     * The identifier property represents any kind of identifier for any kind of
302
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
303
     * dedicated properties for representing many of these, either as textual
304
     * strings or as URL (URI) links. See [background
305
     * notes](/docs/datamodel.html#identifierBg) for more details.
306
     *
307
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
308
     *
309
     * @return static
310
     *
311
     * @see http://schema.org/identifier
312
     */
313
    public function identifier($identifier)
314
    {
315
        return $this->setProperty('identifier', $identifier);
316
    }
317
318
    /**
319
     * An image of the item. This can be a [[URL]] or a fully described
320
     * [[ImageObject]].
321
     *
322
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
323
     *
324
     * @return static
325
     *
326
     * @see http://schema.org/image
327
     */
328
    public function image($image)
329
    {
330
        return $this->setProperty('image', $image);
331
    }
332
333
    /**
334
     * A flag to signal that the item, event, or place is accessible for free.
335
     *
336
     * @param bool|bool[] $isAccessibleForFree
337
     *
338
     * @return static
339
     *
340
     * @see http://schema.org/isAccessibleForFree
341
     */
342
    public function isAccessibleForFree($isAccessibleForFree)
343
    {
344
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
345
    }
346
347
    /**
348
     * The International Standard of Industrial Classification of All Economic
349
     * Activities (ISIC), Revision 4 code for a particular organization,
350
     * business person, or place.
351
     *
352
     * @param string|string[] $isicV4
353
     *
354
     * @return static
355
     *
356
     * @see http://schema.org/isicV4
357
     */
358
    public function isicV4($isicV4)
359
    {
360
        return $this->setProperty('isicV4', $isicV4);
361
    }
362
363
    /**
364
     * The latitude of a location. For example ```37.42242``` ([WGS
365
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
366
     *
367
     * @param float|float[]|int|int[]|string|string[] $latitude
368
     *
369
     * @return static
370
     *
371
     * @see http://schema.org/latitude
372
     */
373
    public function latitude($latitude)
374
    {
375
        return $this->setProperty('latitude', $latitude);
376
    }
377
378
    /**
379
     * An associated logo.
380
     *
381
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
382
     *
383
     * @return static
384
     *
385
     * @see http://schema.org/logo
386
     */
387
    public function logo($logo)
388
    {
389
        return $this->setProperty('logo', $logo);
390
    }
391
392
    /**
393
     * The longitude of a location. For example ```-122.08585``` ([WGS
394
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
395
     *
396
     * @param float|float[]|int|int[]|string|string[] $longitude
397
     *
398
     * @return static
399
     *
400
     * @see http://schema.org/longitude
401
     */
402
    public function longitude($longitude)
403
    {
404
        return $this->setProperty('longitude', $longitude);
405
    }
406
407
    /**
408
     * Indicates a page (or other CreativeWork) for which this thing is the main
409
     * entity being described. See [background
410
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
411
     *
412
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
413
     *
414
     * @return static
415
     *
416
     * @see http://schema.org/mainEntityOfPage
417
     */
418
    public function mainEntityOfPage($mainEntityOfPage)
419
    {
420
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
421
    }
422
423
    /**
424
     * A URL to a map of the place.
425
     *
426
     * @param string|string[] $map
427
     *
428
     * @return static
429
     *
430
     * @see http://schema.org/map
431
     */
432
    public function map($map)
433
    {
434
        return $this->setProperty('map', $map);
435
    }
436
437
    /**
438
     * A URL to a map of the place.
439
     *
440
     * @param string|string[] $maps
441
     *
442
     * @return static
443
     *
444
     * @see http://schema.org/maps
445
     */
446
    public function maps($maps)
447
    {
448
        return $this->setProperty('maps', $maps);
449
    }
450
451
    /**
452
     * The total number of individuals that may attend an event or venue.
453
     *
454
     * @param int|int[] $maximumAttendeeCapacity
455
     *
456
     * @return static
457
     *
458
     * @see http://schema.org/maximumAttendeeCapacity
459
     */
460
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
461
    {
462
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
463
    }
464
465
    /**
466
     * The name of the item.
467
     *
468
     * @param string|string[] $name
469
     *
470
     * @return static
471
     *
472
     * @see http://schema.org/name
473
     */
474
    public function name($name)
475
    {
476
        return $this->setProperty('name', $name);
477
    }
478
479
    /**
480
     * The general opening hours for a business. Opening hours can be specified
481
     * as a weekly time range, starting with days, then times per day. Multiple
482
     * days can be listed with commas ',' separating each day. Day or time
483
     * ranges are specified using a hyphen '-'.
484
     * 
485
     * * Days are specified using the following two-letter combinations:
486
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
487
     * * Times are specified using 24:00 time. For example, 3pm is specified as
488
     * ```15:00```. 
489
     * * Here is an example: <code>&lt;time itemprop="openingHours"
490
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
491
     * 4-8pm&lt;/time&gt;</code>.
492
     * * If a business is open 7 days a week, then it can be specified as
493
     * <code>&lt;time itemprop=&quot;openingHours&quot;
494
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
495
     * day&lt;/time&gt;</code>.
496
     *
497
     * @param string|string[] $openingHours
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/openingHours
502
     */
503
    public function openingHours($openingHours)
504
    {
505
        return $this->setProperty('openingHours', $openingHours);
506
    }
507
508
    /**
509
     * The opening hours of a certain place.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/openingHoursSpecification
516
     */
517
    public function openingHoursSpecification($openingHoursSpecification)
518
    {
519
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
520
    }
521
522
    /**
523
     * A photograph of this place.
524
     *
525
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/photo
530
     */
531
    public function photo($photo)
532
    {
533
        return $this->setProperty('photo', $photo);
534
    }
535
536
    /**
537
     * Photographs of this place.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/photos
544
     */
545
    public function photos($photos)
546
    {
547
        return $this->setProperty('photos', $photos);
548
    }
549
550
    /**
551
     * Indicates a potential Action, which describes an idealized action in
552
     * which this thing would play an 'object' role.
553
     *
554
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
555
     *
556
     * @return static
557
     *
558
     * @see http://schema.org/potentialAction
559
     */
560
    public function potentialAction($potentialAction)
561
    {
562
        return $this->setProperty('potentialAction', $potentialAction);
563
    }
564
565
    /**
566
     * A flag to signal that the [[Place]] is open to public visitors.  If this
567
     * property is omitted there is no assumed default boolean value
568
     *
569
     * @param bool|bool[] $publicAccess
570
     *
571
     * @return static
572
     *
573
     * @see http://schema.org/publicAccess
574
     */
575
    public function publicAccess($publicAccess)
576
    {
577
        return $this->setProperty('publicAccess', $publicAccess);
578
    }
579
580
    /**
581
     * A review of the item.
582
     *
583
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
584
     *
585
     * @return static
586
     *
587
     * @see http://schema.org/review
588
     */
589
    public function review($review)
590
    {
591
        return $this->setProperty('review', $review);
592
    }
593
594
    /**
595
     * Review of the item.
596
     *
597
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
598
     *
599
     * @return static
600
     *
601
     * @see http://schema.org/reviews
602
     */
603
    public function reviews($reviews)
604
    {
605
        return $this->setProperty('reviews', $reviews);
606
    }
607
608
    /**
609
     * URL of a reference Web page that unambiguously indicates the item's
610
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
611
     * official website.
612
     *
613
     * @param string|string[] $sameAs
614
     *
615
     * @return static
616
     *
617
     * @see http://schema.org/sameAs
618
     */
619
    public function sameAs($sameAs)
620
    {
621
        return $this->setProperty('sameAs', $sameAs);
622
    }
623
624
    /**
625
     * A slogan or motto associated with the item.
626
     *
627
     * @param string|string[] $slogan
628
     *
629
     * @return static
630
     *
631
     * @see http://schema.org/slogan
632
     */
633
    public function slogan($slogan)
634
    {
635
        return $this->setProperty('slogan', $slogan);
636
    }
637
638
    /**
639
     * Indicates whether it is allowed to smoke in the place, e.g. in the
640
     * restaurant, hotel or hotel room.
641
     *
642
     * @param bool|bool[] $smokingAllowed
643
     *
644
     * @return static
645
     *
646
     * @see http://schema.org/smokingAllowed
647
     */
648
    public function smokingAllowed($smokingAllowed)
649
    {
650
        return $this->setProperty('smokingAllowed', $smokingAllowed);
651
    }
652
653
    /**
654
     * The special opening hours of a certain place.
655
     * 
656
     * Use this to explicitly override general opening hours brought in scope by
657
     * [[openingHoursSpecification]] or [[openingHours]].
658
     *
659
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
660
     *
661
     * @return static
662
     *
663
     * @see http://schema.org/specialOpeningHoursSpecification
664
     */
665
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
666
    {
667
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
668
    }
669
670
    /**
671
     * A CreativeWork or Event about this Thing.
672
     *
673
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
674
     *
675
     * @return static
676
     *
677
     * @see http://schema.org/subjectOf
678
     */
679
    public function subjectOf($subjectOf)
680
    {
681
        return $this->setProperty('subjectOf', $subjectOf);
682
    }
683
684
    /**
685
     * The telephone number.
686
     *
687
     * @param string|string[] $telephone
688
     *
689
     * @return static
690
     *
691
     * @see http://schema.org/telephone
692
     */
693
    public function telephone($telephone)
694
    {
695
        return $this->setProperty('telephone', $telephone);
696
    }
697
698
    /**
699
     * URL of the item.
700
     *
701
     * @param string|string[] $url
702
     *
703
     * @return static
704
     *
705
     * @see http://schema.org/url
706
     */
707
    public function url($url)
708
    {
709
        return $this->setProperty('url', $url);
710
    }
711
712
}
713

src/ComedyEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/ComedyEvent
13
 *
14
 */
15
class ComedyEvent extends BaseType implements ComedyEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/Courthouse.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/Courthouse
15
 *
16
 */
17
class Courthouse extends BaseType implements CourthouseContract, CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/Crematorium.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/Crematorium
14
 *
15
 */
16
class Crematorium extends BaseType implements CrematoriumContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/DanceEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/DanceEvent
13
 *
14
 */
15
class DanceEvent extends BaseType implements DanceEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/DefenceEstablishment.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/DefenceEstablishment
15
 *
16
 */
17
class DefenceEstablishment extends BaseType implements DefenceEstablishmentContract, CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/EducationEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/EducationEvent
13
 *
14
 */
15
class EducationEvent extends BaseType implements EducationEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/Embassy.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/Embassy
15
 *
16
 */
17
class Embassy extends BaseType implements EmbassyContract, CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/Event.php 1 location

@@ 16-734 (lines=719) @@
13
 * @see http://schema.org/Event
14
 *
15
 */
16
class Event extends BaseType implements EventContract, 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 http://schema.org/about
26
     */
27
    public function about($about)
28
    {
29
        return $this->setProperty('about', $about);
30
    }
31
32
    /**
33
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
34
     * Actors can be associated with individual items or with a series, episode,
35
     * clip.
36
     *
37
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
38
     *
39
     * @return static
40
     *
41
     * @see http://schema.org/actor
42
     */
43
    public function actor($actor)
44
    {
45
        return $this->setProperty('actor', $actor);
46
    }
47
48
    /**
49
     * An additional type for the item, typically used for adding more specific
50
     * types from external vocabularies in microdata syntax. This is a
51
     * relationship between something and a class that the thing is in. In RDFa
52
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
53
     * attribute - for multiple types. Schema.org tools may have only weaker
54
     * understanding of extra types, in particular those defined externally.
55
     *
56
     * @param string|string[] $additionalType
57
     *
58
     * @return static
59
     *
60
     * @see http://schema.org/additionalType
61
     */
62
    public function additionalType($additionalType)
63
    {
64
        return $this->setProperty('additionalType', $additionalType);
65
    }
66
67
    /**
68
     * The overall rating, based on a collection of reviews or ratings, of the
69
     * item.
70
     *
71
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/aggregateRating
76
     */
77
    public function aggregateRating($aggregateRating)
78
    {
79
        return $this->setProperty('aggregateRating', $aggregateRating);
80
    }
81
82
    /**
83
     * An alias for the item.
84
     *
85
     * @param string|string[] $alternateName
86
     *
87
     * @return static
88
     *
89
     * @see http://schema.org/alternateName
90
     */
91
    public function alternateName($alternateName)
92
    {
93
        return $this->setProperty('alternateName', $alternateName);
94
    }
95
96
    /**
97
     * A person or organization attending the event.
98
     *
99
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
100
     *
101
     * @return static
102
     *
103
     * @see http://schema.org/attendee
104
     */
105
    public function attendee($attendee)
106
    {
107
        return $this->setProperty('attendee', $attendee);
108
    }
109
110
    /**
111
     * A person attending the event.
112
     *
113
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
114
     *
115
     * @return static
116
     *
117
     * @see http://schema.org/attendees
118
     */
119
    public function attendees($attendees)
120
    {
121
        return $this->setProperty('attendees', $attendees);
122
    }
123
124
    /**
125
     * An intended audience, i.e. a group for whom something was created.
126
     *
127
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
128
     *
129
     * @return static
130
     *
131
     * @see http://schema.org/audience
132
     */
133
    public function audience($audience)
134
    {
135
        return $this->setProperty('audience', $audience);
136
    }
137
138
    /**
139
     * The person or organization who wrote a composition, or who is the
140
     * composer of a work performed at some event.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/composer
147
     */
148
    public function composer($composer)
149
    {
150
        return $this->setProperty('composer', $composer);
151
    }
152
153
    /**
154
     * A secondary contributor to the CreativeWork or Event.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/contributor
161
     */
162
    public function contributor($contributor)
163
    {
164
        return $this->setProperty('contributor', $contributor);
165
    }
166
167
    /**
168
     * A description of the item.
169
     *
170
     * @param string|string[] $description
171
     *
172
     * @return static
173
     *
174
     * @see http://schema.org/description
175
     */
176
    public function description($description)
177
    {
178
        return $this->setProperty('description', $description);
179
    }
180
181
    /**
182
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
183
     * event. Directors can be associated with individual items or with a
184
     * series, episode, clip.
185
     *
186
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/director
191
     */
192
    public function director($director)
193
    {
194
        return $this->setProperty('director', $director);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * The time admission will commence.
216
     *
217
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/doorTime
222
     */
223
    public function doorTime($doorTime)
224
    {
225
        return $this->setProperty('doorTime', $doorTime);
226
    }
227
228
    /**
229
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
230
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/duration
237
     */
238
    public function duration($duration)
239
    {
240
        return $this->setProperty('duration', $duration);
241
    }
242
243
    /**
244
     * The end date and time of the item (in [ISO 8601 date
245
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
246
     *
247
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
248
     *
249
     * @return static
250
     *
251
     * @see http://schema.org/endDate
252
     */
253
    public function endDate($endDate)
254
    {
255
        return $this->setProperty('endDate', $endDate);
256
    }
257
258
    /**
259
     * An eventStatus of an event represents its status; particularly useful
260
     * when an event is cancelled or rescheduled.
261
     *
262
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
263
     *
264
     * @return static
265
     *
266
     * @see http://schema.org/eventStatus
267
     */
268
    public function eventStatus($eventStatus)
269
    {
270
        return $this->setProperty('eventStatus', $eventStatus);
271
    }
272
273
    /**
274
     * A person or organization that supports (sponsors) something through some
275
     * kind of financial contribution.
276
     *
277
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/funder
282
     */
283
    public function funder($funder)
284
    {
285
        return $this->setProperty('funder', $funder);
286
    }
287
288
    /**
289
     * The identifier property represents any kind of identifier for any kind of
290
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
291
     * dedicated properties for representing many of these, either as textual
292
     * strings or as URL (URI) links. See [background
293
     * notes](/docs/datamodel.html#identifierBg) for more details.
294
     *
295
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
296
     *
297
     * @return static
298
     *
299
     * @see http://schema.org/identifier
300
     */
301
    public function identifier($identifier)
302
    {
303
        return $this->setProperty('identifier', $identifier);
304
    }
305
306
    /**
307
     * An image of the item. This can be a [[URL]] or a fully described
308
     * [[ImageObject]].
309
     *
310
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
311
     *
312
     * @return static
313
     *
314
     * @see http://schema.org/image
315
     */
316
    public function image($image)
317
    {
318
        return $this->setProperty('image', $image);
319
    }
320
321
    /**
322
     * The language of the content or performance or used in an action. Please
323
     * use one of the language codes from the [IETF BCP 47
324
     * standard](http://tools.ietf.org/html/bcp47). See also
325
     * [[availableLanguage]].
326
     *
327
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
328
     *
329
     * @return static
330
     *
331
     * @see http://schema.org/inLanguage
332
     */
333
    public function inLanguage($inLanguage)
334
    {
335
        return $this->setProperty('inLanguage', $inLanguage);
336
    }
337
338
    /**
339
     * A flag to signal that the item, event, or place is accessible for free.
340
     *
341
     * @param bool|bool[] $isAccessibleForFree
342
     *
343
     * @return static
344
     *
345
     * @see http://schema.org/isAccessibleForFree
346
     */
347
    public function isAccessibleForFree($isAccessibleForFree)
348
    {
349
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
350
    }
351
352
    /**
353
     * The location of for example where the event is happening, an organization
354
     * is located, or where an action takes place.
355
     *
356
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
357
     *
358
     * @return static
359
     *
360
     * @see http://schema.org/location
361
     */
362
    public function location($location)
363
    {
364
        return $this->setProperty('location', $location);
365
    }
366
367
    /**
368
     * Indicates a page (or other CreativeWork) for which this thing is the main
369
     * entity being described. See [background
370
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
371
     *
372
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
373
     *
374
     * @return static
375
     *
376
     * @see http://schema.org/mainEntityOfPage
377
     */
378
    public function mainEntityOfPage($mainEntityOfPage)
379
    {
380
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
381
    }
382
383
    /**
384
     * The total number of individuals that may attend an event or venue.
385
     *
386
     * @param int|int[] $maximumAttendeeCapacity
387
     *
388
     * @return static
389
     *
390
     * @see http://schema.org/maximumAttendeeCapacity
391
     */
392
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
393
    {
394
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
395
    }
396
397
    /**
398
     * The name of the item.
399
     *
400
     * @param string|string[] $name
401
     *
402
     * @return static
403
     *
404
     * @see http://schema.org/name
405
     */
406
    public function name($name)
407
    {
408
        return $this->setProperty('name', $name);
409
    }
410
411
    /**
412
     * An offer to provide this item&#x2014;for example, an offer to sell a
413
     * product, rent the DVD of a movie, perform a service, or give away tickets
414
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
415
     * offered, i.e. sell, lease, etc. This property can also be used to
416
     * describe a [[Demand]]. While this property is listed as expected on a
417
     * number of common types, it can be used in others. In that case, using a
418
     * second type, such as Product or a subtype of Product, can clarify the
419
     * nature of the offer.
420
     *
421
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
422
     *
423
     * @return static
424
     *
425
     * @see http://schema.org/offers
426
     */
427
    public function offers($offers)
428
    {
429
        return $this->setProperty('offers', $offers);
430
    }
431
432
    /**
433
     * An organizer of an Event.
434
     *
435
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
436
     *
437
     * @return static
438
     *
439
     * @see http://schema.org/organizer
440
     */
441
    public function organizer($organizer)
442
    {
443
        return $this->setProperty('organizer', $organizer);
444
    }
445
446
    /**
447
     * A performer at the event&#x2014;for example, a presenter, musician,
448
     * musical group or actor.
449
     *
450
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
451
     *
452
     * @return static
453
     *
454
     * @see http://schema.org/performer
455
     */
456
    public function performer($performer)
457
    {
458
        return $this->setProperty('performer', $performer);
459
    }
460
461
    /**
462
     * The main performer or performers of the event&#x2014;for example, a
463
     * presenter, musician, or actor.
464
     *
465
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
466
     *
467
     * @return static
468
     *
469
     * @see http://schema.org/performers
470
     */
471
    public function performers($performers)
472
    {
473
        return $this->setProperty('performers', $performers);
474
    }
475
476
    /**
477
     * Indicates a potential Action, which describes an idealized action in
478
     * which this thing would play an 'object' role.
479
     *
480
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
481
     *
482
     * @return static
483
     *
484
     * @see http://schema.org/potentialAction
485
     */
486
    public function potentialAction($potentialAction)
487
    {
488
        return $this->setProperty('potentialAction', $potentialAction);
489
    }
490
491
    /**
492
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
493
     * This property contains the previously scheduled start date. For
494
     * rescheduled events, the startDate property should be used for the newly
495
     * scheduled start date. In the (rare) case of an event that has been
496
     * postponed and rescheduled multiple times, this field may be repeated.
497
     *
498
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/previousStartDate
503
     */
504
    public function previousStartDate($previousStartDate)
505
    {
506
        return $this->setProperty('previousStartDate', $previousStartDate);
507
    }
508
509
    /**
510
     * The CreativeWork that captured all or part of this Event.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/recordedIn
517
     */
518
    public function recordedIn($recordedIn)
519
    {
520
        return $this->setProperty('recordedIn', $recordedIn);
521
    }
522
523
    /**
524
     * The number of attendee places for an event that remain unallocated.
525
     *
526
     * @param int|int[] $remainingAttendeeCapacity
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/remainingAttendeeCapacity
531
     */
532
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
533
    {
534
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
535
    }
536
537
    /**
538
     * A review of the item.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/review
545
     */
546
    public function review($review)
547
    {
548
        return $this->setProperty('review', $review);
549
    }
550
551
    /**
552
     * URL of a reference Web page that unambiguously indicates the item's
553
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
554
     * official website.
555
     *
556
     * @param string|string[] $sameAs
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/sameAs
561
     */
562
    public function sameAs($sameAs)
563
    {
564
        return $this->setProperty('sameAs', $sameAs);
565
    }
566
567
    /**
568
     * A person or organization that supports a thing through a pledge, promise,
569
     * or financial contribution. e.g. a sponsor of a Medical Study or a
570
     * corporate sponsor of an event.
571
     *
572
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
573
     *
574
     * @return static
575
     *
576
     * @see http://schema.org/sponsor
577
     */
578
    public function sponsor($sponsor)
579
    {
580
        return $this->setProperty('sponsor', $sponsor);
581
    }
582
583
    /**
584
     * The start date and time of the item (in [ISO 8601 date
585
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
586
     *
587
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
588
     *
589
     * @return static
590
     *
591
     * @see http://schema.org/startDate
592
     */
593
    public function startDate($startDate)
594
    {
595
        return $this->setProperty('startDate', $startDate);
596
    }
597
598
    /**
599
     * An Event that is part of this event. For example, a conference event
600
     * includes many presentations, each of which is a subEvent of the
601
     * conference.
602
     *
603
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
604
     *
605
     * @return static
606
     *
607
     * @see http://schema.org/subEvent
608
     */
609
    public function subEvent($subEvent)
610
    {
611
        return $this->setProperty('subEvent', $subEvent);
612
    }
613
614
    /**
615
     * Events that are a part of this event. For example, a conference event
616
     * includes many presentations, each subEvents of the conference.
617
     *
618
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
619
     *
620
     * @return static
621
     *
622
     * @see http://schema.org/subEvents
623
     */
624
    public function subEvents($subEvents)
625
    {
626
        return $this->setProperty('subEvents', $subEvents);
627
    }
628
629
    /**
630
     * A CreativeWork or Event about this Thing.
631
     *
632
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
633
     *
634
     * @return static
635
     *
636
     * @see http://schema.org/subjectOf
637
     */
638
    public function subjectOf($subjectOf)
639
    {
640
        return $this->setProperty('subjectOf', $subjectOf);
641
    }
642
643
    /**
644
     * An event that this event is a part of. For example, a collection of
645
     * individual music performances might each have a music festival as their
646
     * superEvent.
647
     *
648
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
649
     *
650
     * @return static
651
     *
652
     * @see http://schema.org/superEvent
653
     */
654
    public function superEvent($superEvent)
655
    {
656
        return $this->setProperty('superEvent', $superEvent);
657
    }
658
659
    /**
660
     * Organization or person who adapts a creative work to different languages,
661
     * regional differences and technical requirements of a target market, or
662
     * that translates during some event.
663
     *
664
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
665
     *
666
     * @return static
667
     *
668
     * @see http://schema.org/translator
669
     */
670
    public function translator($translator)
671
    {
672
        return $this->setProperty('translator', $translator);
673
    }
674
675
    /**
676
     * The typical expected age range, e.g. '7-9', '11-'.
677
     *
678
     * @param string|string[] $typicalAgeRange
679
     *
680
     * @return static
681
     *
682
     * @see http://schema.org/typicalAgeRange
683
     */
684
    public function typicalAgeRange($typicalAgeRange)
685
    {
686
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
687
    }
688
689
    /**
690
     * URL of the item.
691
     *
692
     * @param string|string[] $url
693
     *
694
     * @return static
695
     *
696
     * @see http://schema.org/url
697
     */
698
    public function url($url)
699
    {
700
        return $this->setProperty('url', $url);
701
    }
702
703
    /**
704
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
705
     *        Specific subproperties are available for workPerformed (e.g. a
706
     * play), or a workPresented (a Movie at a ScreeningEvent).
707
     *
708
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
709
     *
710
     * @return static
711
     *
712
     * @see http://schema.org/workFeatured
713
     */
714
    public function workFeatured($workFeatured)
715
    {
716
        return $this->setProperty('workFeatured', $workFeatured);
717
    }
718
719
    /**
720
     * A work performed in some event, for example a play performed in a
721
     * TheaterEvent.
722
     *
723
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
724
     *
725
     * @return static
726
     *
727
     * @see http://schema.org/workPerformed
728
     */
729
    public function workPerformed($workPerformed)
730
    {
731
        return $this->setProperty('workPerformed', $workPerformed);
732
    }
733
734
}
735

src/EventVenue.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/EventVenue
14
 *
15
 */
16
class EventVenue extends BaseType implements EventVenueContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/ExhibitionEvent.php 1 location

@@ 16-734 (lines=719) @@
13
 * @see http://schema.org/ExhibitionEvent
14
 *
15
 */
16
class ExhibitionEvent extends BaseType implements ExhibitionEventContract, EventContract, 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 http://schema.org/about
26
     */
27
    public function about($about)
28
    {
29
        return $this->setProperty('about', $about);
30
    }
31
32
    /**
33
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
34
     * Actors can be associated with individual items or with a series, episode,
35
     * clip.
36
     *
37
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
38
     *
39
     * @return static
40
     *
41
     * @see http://schema.org/actor
42
     */
43
    public function actor($actor)
44
    {
45
        return $this->setProperty('actor', $actor);
46
    }
47
48
    /**
49
     * An additional type for the item, typically used for adding more specific
50
     * types from external vocabularies in microdata syntax. This is a
51
     * relationship between something and a class that the thing is in. In RDFa
52
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
53
     * attribute - for multiple types. Schema.org tools may have only weaker
54
     * understanding of extra types, in particular those defined externally.
55
     *
56
     * @param string|string[] $additionalType
57
     *
58
     * @return static
59
     *
60
     * @see http://schema.org/additionalType
61
     */
62
    public function additionalType($additionalType)
63
    {
64
        return $this->setProperty('additionalType', $additionalType);
65
    }
66
67
    /**
68
     * The overall rating, based on a collection of reviews or ratings, of the
69
     * item.
70
     *
71
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/aggregateRating
76
     */
77
    public function aggregateRating($aggregateRating)
78
    {
79
        return $this->setProperty('aggregateRating', $aggregateRating);
80
    }
81
82
    /**
83
     * An alias for the item.
84
     *
85
     * @param string|string[] $alternateName
86
     *
87
     * @return static
88
     *
89
     * @see http://schema.org/alternateName
90
     */
91
    public function alternateName($alternateName)
92
    {
93
        return $this->setProperty('alternateName', $alternateName);
94
    }
95
96
    /**
97
     * A person or organization attending the event.
98
     *
99
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
100
     *
101
     * @return static
102
     *
103
     * @see http://schema.org/attendee
104
     */
105
    public function attendee($attendee)
106
    {
107
        return $this->setProperty('attendee', $attendee);
108
    }
109
110
    /**
111
     * A person attending the event.
112
     *
113
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
114
     *
115
     * @return static
116
     *
117
     * @see http://schema.org/attendees
118
     */
119
    public function attendees($attendees)
120
    {
121
        return $this->setProperty('attendees', $attendees);
122
    }
123
124
    /**
125
     * An intended audience, i.e. a group for whom something was created.
126
     *
127
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
128
     *
129
     * @return static
130
     *
131
     * @see http://schema.org/audience
132
     */
133
    public function audience($audience)
134
    {
135
        return $this->setProperty('audience', $audience);
136
    }
137
138
    /**
139
     * The person or organization who wrote a composition, or who is the
140
     * composer of a work performed at some event.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/composer
147
     */
148
    public function composer($composer)
149
    {
150
        return $this->setProperty('composer', $composer);
151
    }
152
153
    /**
154
     * A secondary contributor to the CreativeWork or Event.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/contributor
161
     */
162
    public function contributor($contributor)
163
    {
164
        return $this->setProperty('contributor', $contributor);
165
    }
166
167
    /**
168
     * A description of the item.
169
     *
170
     * @param string|string[] $description
171
     *
172
     * @return static
173
     *
174
     * @see http://schema.org/description
175
     */
176
    public function description($description)
177
    {
178
        return $this->setProperty('description', $description);
179
    }
180
181
    /**
182
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
183
     * event. Directors can be associated with individual items or with a
184
     * series, episode, clip.
185
     *
186
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/director
191
     */
192
    public function director($director)
193
    {
194
        return $this->setProperty('director', $director);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * The time admission will commence.
216
     *
217
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/doorTime
222
     */
223
    public function doorTime($doorTime)
224
    {
225
        return $this->setProperty('doorTime', $doorTime);
226
    }
227
228
    /**
229
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
230
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/duration
237
     */
238
    public function duration($duration)
239
    {
240
        return $this->setProperty('duration', $duration);
241
    }
242
243
    /**
244
     * The end date and time of the item (in [ISO 8601 date
245
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
246
     *
247
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
248
     *
249
     * @return static
250
     *
251
     * @see http://schema.org/endDate
252
     */
253
    public function endDate($endDate)
254
    {
255
        return $this->setProperty('endDate', $endDate);
256
    }
257
258
    /**
259
     * An eventStatus of an event represents its status; particularly useful
260
     * when an event is cancelled or rescheduled.
261
     *
262
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
263
     *
264
     * @return static
265
     *
266
     * @see http://schema.org/eventStatus
267
     */
268
    public function eventStatus($eventStatus)
269
    {
270
        return $this->setProperty('eventStatus', $eventStatus);
271
    }
272
273
    /**
274
     * A person or organization that supports (sponsors) something through some
275
     * kind of financial contribution.
276
     *
277
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/funder
282
     */
283
    public function funder($funder)
284
    {
285
        return $this->setProperty('funder', $funder);
286
    }
287
288
    /**
289
     * The identifier property represents any kind of identifier for any kind of
290
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
291
     * dedicated properties for representing many of these, either as textual
292
     * strings or as URL (URI) links. See [background
293
     * notes](/docs/datamodel.html#identifierBg) for more details.
294
     *
295
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
296
     *
297
     * @return static
298
     *
299
     * @see http://schema.org/identifier
300
     */
301
    public function identifier($identifier)
302
    {
303
        return $this->setProperty('identifier', $identifier);
304
    }
305
306
    /**
307
     * An image of the item. This can be a [[URL]] or a fully described
308
     * [[ImageObject]].
309
     *
310
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
311
     *
312
     * @return static
313
     *
314
     * @see http://schema.org/image
315
     */
316
    public function image($image)
317
    {
318
        return $this->setProperty('image', $image);
319
    }
320
321
    /**
322
     * The language of the content or performance or used in an action. Please
323
     * use one of the language codes from the [IETF BCP 47
324
     * standard](http://tools.ietf.org/html/bcp47). See also
325
     * [[availableLanguage]].
326
     *
327
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
328
     *
329
     * @return static
330
     *
331
     * @see http://schema.org/inLanguage
332
     */
333
    public function inLanguage($inLanguage)
334
    {
335
        return $this->setProperty('inLanguage', $inLanguage);
336
    }
337
338
    /**
339
     * A flag to signal that the item, event, or place is accessible for free.
340
     *
341
     * @param bool|bool[] $isAccessibleForFree
342
     *
343
     * @return static
344
     *
345
     * @see http://schema.org/isAccessibleForFree
346
     */
347
    public function isAccessibleForFree($isAccessibleForFree)
348
    {
349
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
350
    }
351
352
    /**
353
     * The location of for example where the event is happening, an organization
354
     * is located, or where an action takes place.
355
     *
356
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
357
     *
358
     * @return static
359
     *
360
     * @see http://schema.org/location
361
     */
362
    public function location($location)
363
    {
364
        return $this->setProperty('location', $location);
365
    }
366
367
    /**
368
     * Indicates a page (or other CreativeWork) for which this thing is the main
369
     * entity being described. See [background
370
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
371
     *
372
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
373
     *
374
     * @return static
375
     *
376
     * @see http://schema.org/mainEntityOfPage
377
     */
378
    public function mainEntityOfPage($mainEntityOfPage)
379
    {
380
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
381
    }
382
383
    /**
384
     * The total number of individuals that may attend an event or venue.
385
     *
386
     * @param int|int[] $maximumAttendeeCapacity
387
     *
388
     * @return static
389
     *
390
     * @see http://schema.org/maximumAttendeeCapacity
391
     */
392
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
393
    {
394
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
395
    }
396
397
    /**
398
     * The name of the item.
399
     *
400
     * @param string|string[] $name
401
     *
402
     * @return static
403
     *
404
     * @see http://schema.org/name
405
     */
406
    public function name($name)
407
    {
408
        return $this->setProperty('name', $name);
409
    }
410
411
    /**
412
     * An offer to provide this item&#x2014;for example, an offer to sell a
413
     * product, rent the DVD of a movie, perform a service, or give away tickets
414
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
415
     * offered, i.e. sell, lease, etc. This property can also be used to
416
     * describe a [[Demand]]. While this property is listed as expected on a
417
     * number of common types, it can be used in others. In that case, using a
418
     * second type, such as Product or a subtype of Product, can clarify the
419
     * nature of the offer.
420
     *
421
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
422
     *
423
     * @return static
424
     *
425
     * @see http://schema.org/offers
426
     */
427
    public function offers($offers)
428
    {
429
        return $this->setProperty('offers', $offers);
430
    }
431
432
    /**
433
     * An organizer of an Event.
434
     *
435
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
436
     *
437
     * @return static
438
     *
439
     * @see http://schema.org/organizer
440
     */
441
    public function organizer($organizer)
442
    {
443
        return $this->setProperty('organizer', $organizer);
444
    }
445
446
    /**
447
     * A performer at the event&#x2014;for example, a presenter, musician,
448
     * musical group or actor.
449
     *
450
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
451
     *
452
     * @return static
453
     *
454
     * @see http://schema.org/performer
455
     */
456
    public function performer($performer)
457
    {
458
        return $this->setProperty('performer', $performer);
459
    }
460
461
    /**
462
     * The main performer or performers of the event&#x2014;for example, a
463
     * presenter, musician, or actor.
464
     *
465
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
466
     *
467
     * @return static
468
     *
469
     * @see http://schema.org/performers
470
     */
471
    public function performers($performers)
472
    {
473
        return $this->setProperty('performers', $performers);
474
    }
475
476
    /**
477
     * Indicates a potential Action, which describes an idealized action in
478
     * which this thing would play an 'object' role.
479
     *
480
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
481
     *
482
     * @return static
483
     *
484
     * @see http://schema.org/potentialAction
485
     */
486
    public function potentialAction($potentialAction)
487
    {
488
        return $this->setProperty('potentialAction', $potentialAction);
489
    }
490
491
    /**
492
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
493
     * This property contains the previously scheduled start date. For
494
     * rescheduled events, the startDate property should be used for the newly
495
     * scheduled start date. In the (rare) case of an event that has been
496
     * postponed and rescheduled multiple times, this field may be repeated.
497
     *
498
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/previousStartDate
503
     */
504
    public function previousStartDate($previousStartDate)
505
    {
506
        return $this->setProperty('previousStartDate', $previousStartDate);
507
    }
508
509
    /**
510
     * The CreativeWork that captured all or part of this Event.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/recordedIn
517
     */
518
    public function recordedIn($recordedIn)
519
    {
520
        return $this->setProperty('recordedIn', $recordedIn);
521
    }
522
523
    /**
524
     * The number of attendee places for an event that remain unallocated.
525
     *
526
     * @param int|int[] $remainingAttendeeCapacity
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/remainingAttendeeCapacity
531
     */
532
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
533
    {
534
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
535
    }
536
537
    /**
538
     * A review of the item.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/review
545
     */
546
    public function review($review)
547
    {
548
        return $this->setProperty('review', $review);
549
    }
550
551
    /**
552
     * URL of a reference Web page that unambiguously indicates the item's
553
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
554
     * official website.
555
     *
556
     * @param string|string[] $sameAs
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/sameAs
561
     */
562
    public function sameAs($sameAs)
563
    {
564
        return $this->setProperty('sameAs', $sameAs);
565
    }
566
567
    /**
568
     * A person or organization that supports a thing through a pledge, promise,
569
     * or financial contribution. e.g. a sponsor of a Medical Study or a
570
     * corporate sponsor of an event.
571
     *
572
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
573
     *
574
     * @return static
575
     *
576
     * @see http://schema.org/sponsor
577
     */
578
    public function sponsor($sponsor)
579
    {
580
        return $this->setProperty('sponsor', $sponsor);
581
    }
582
583
    /**
584
     * The start date and time of the item (in [ISO 8601 date
585
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
586
     *
587
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
588
     *
589
     * @return static
590
     *
591
     * @see http://schema.org/startDate
592
     */
593
    public function startDate($startDate)
594
    {
595
        return $this->setProperty('startDate', $startDate);
596
    }
597
598
    /**
599
     * An Event that is part of this event. For example, a conference event
600
     * includes many presentations, each of which is a subEvent of the
601
     * conference.
602
     *
603
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
604
     *
605
     * @return static
606
     *
607
     * @see http://schema.org/subEvent
608
     */
609
    public function subEvent($subEvent)
610
    {
611
        return $this->setProperty('subEvent', $subEvent);
612
    }
613
614
    /**
615
     * Events that are a part of this event. For example, a conference event
616
     * includes many presentations, each subEvents of the conference.
617
     *
618
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
619
     *
620
     * @return static
621
     *
622
     * @see http://schema.org/subEvents
623
     */
624
    public function subEvents($subEvents)
625
    {
626
        return $this->setProperty('subEvents', $subEvents);
627
    }
628
629
    /**
630
     * A CreativeWork or Event about this Thing.
631
     *
632
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
633
     *
634
     * @return static
635
     *
636
     * @see http://schema.org/subjectOf
637
     */
638
    public function subjectOf($subjectOf)
639
    {
640
        return $this->setProperty('subjectOf', $subjectOf);
641
    }
642
643
    /**
644
     * An event that this event is a part of. For example, a collection of
645
     * individual music performances might each have a music festival as their
646
     * superEvent.
647
     *
648
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
649
     *
650
     * @return static
651
     *
652
     * @see http://schema.org/superEvent
653
     */
654
    public function superEvent($superEvent)
655
    {
656
        return $this->setProperty('superEvent', $superEvent);
657
    }
658
659
    /**
660
     * Organization or person who adapts a creative work to different languages,
661
     * regional differences and technical requirements of a target market, or
662
     * that translates during some event.
663
     *
664
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
665
     *
666
     * @return static
667
     *
668
     * @see http://schema.org/translator
669
     */
670
    public function translator($translator)
671
    {
672
        return $this->setProperty('translator', $translator);
673
    }
674
675
    /**
676
     * The typical expected age range, e.g. '7-9', '11-'.
677
     *
678
     * @param string|string[] $typicalAgeRange
679
     *
680
     * @return static
681
     *
682
     * @see http://schema.org/typicalAgeRange
683
     */
684
    public function typicalAgeRange($typicalAgeRange)
685
    {
686
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
687
    }
688
689
    /**
690
     * URL of the item.
691
     *
692
     * @param string|string[] $url
693
     *
694
     * @return static
695
     *
696
     * @see http://schema.org/url
697
     */
698
    public function url($url)
699
    {
700
        return $this->setProperty('url', $url);
701
    }
702
703
    /**
704
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
705
     *        Specific subproperties are available for workPerformed (e.g. a
706
     * play), or a workPresented (a Movie at a ScreeningEvent).
707
     *
708
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
709
     *
710
     * @return static
711
     *
712
     * @see http://schema.org/workFeatured
713
     */
714
    public function workFeatured($workFeatured)
715
    {
716
        return $this->setProperty('workFeatured', $workFeatured);
717
    }
718
719
    /**
720
     * A work performed in some event, for example a play performed in a
721
     * TheaterEvent.
722
     *
723
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
724
     *
725
     * @return static
726
     *
727
     * @see http://schema.org/workPerformed
728
     */
729
    public function workPerformed($workPerformed)
730
    {
731
        return $this->setProperty('workPerformed', $workPerformed);
732
    }
733
734
}
735

src/Festival.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/Festival
13
 *
14
 */
15
class Festival extends BaseType implements FestivalContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/FoodEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/FoodEvent
13
 *
14
 */
15
class FoodEvent extends BaseType implements FoodEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/GovernmentBuilding.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/GovernmentBuilding
14
 *
15
 */
16
class GovernmentBuilding extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/HinduTemple.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/HinduTemple
15
 *
16
 */
17
class HinduTemple extends BaseType implements HinduTempleContract, CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/LegislativeBuilding.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/LegislativeBuilding
15
 *
16
 */
17
class LegislativeBuilding extends BaseType implements LegislativeBuildingContract, CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/LiteraryEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/LiteraryEvent
13
 *
14
 */
15
class LiteraryEvent extends BaseType implements LiteraryEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/Mosque.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/Mosque
15
 *
16
 */
17
class Mosque extends BaseType implements MosqueContract, CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/Museum.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/Museum
14
 *
15
 */
16
class Museum extends BaseType implements MuseumContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/MusicEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/MusicEvent
13
 *
14
 */
15
class MusicEvent extends BaseType implements MusicEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/MusicVenue.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/MusicVenue
14
 *
15
 */
16
class MusicVenue extends BaseType implements MusicVenueContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/Park.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/Park
14
 *
15
 */
16
class Park extends BaseType implements ParkContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/ParkingFacility.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/ParkingFacility
14
 *
15
 */
16
class ParkingFacility extends BaseType implements ParkingFacilityContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/PerformingArtsTheater.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/PerformingArtsTheater
14
 *
15
 */
16
class PerformingArtsTheater extends BaseType implements PerformingArtsTheaterContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/PlaceOfWorship.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/PlaceOfWorship
14
 *
15
 */
16
class PlaceOfWorship extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/Playground.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/Playground
14
 *
15
 */
16
class Playground extends BaseType implements PlaygroundContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/Product.php 1 location

@@ 16-743 (lines=728) @@
13
 * @see http://schema.org/Product
14
 *
15
 */
16
class Product extends BaseType implements ProductContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * The overall rating, based on a collection of reviews or ratings, of the
61
     * item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/aggregateRating
68
     */
69
    public function aggregateRating($aggregateRating)
70
    {
71
        return $this->setProperty('aggregateRating', $aggregateRating);
72
    }
73
74
    /**
75
     * An alias for the item.
76
     *
77
     * @param string|string[] $alternateName
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/alternateName
82
     */
83
    public function alternateName($alternateName)
84
    {
85
        return $this->setProperty('alternateName', $alternateName);
86
    }
87
88
    /**
89
     * An intended audience, i.e. a group for whom something was created.
90
     *
91
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/audience
96
     */
97
    public function audience($audience)
98
    {
99
        return $this->setProperty('audience', $audience);
100
    }
101
102
    /**
103
     * An award won by or for this item.
104
     *
105
     * @param string|string[] $award
106
     *
107
     * @return static
108
     *
109
     * @see http://schema.org/award
110
     */
111
    public function award($award)
112
    {
113
        return $this->setProperty('award', $award);
114
    }
115
116
    /**
117
     * Awards won by or for this item.
118
     *
119
     * @param string|string[] $awards
120
     *
121
     * @return static
122
     *
123
     * @see http://schema.org/awards
124
     */
125
    public function awards($awards)
126
    {
127
        return $this->setProperty('awards', $awards);
128
    }
129
130
    /**
131
     * The brand(s) associated with a product or service, or the brand(s)
132
     * maintained by an organization or business person.
133
     *
134
     * @param \Spatie\SchemaOrg\Contracts\BrandContract|\Spatie\SchemaOrg\Contracts\BrandContract[]|\Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $brand
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/brand
139
     */
140
    public function brand($brand)
141
    {
142
        return $this->setProperty('brand', $brand);
143
    }
144
145
    /**
146
     * A category for the item. Greater signs or slashes can be used to
147
     * informally indicate a category hierarchy.
148
     *
149
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $category
150
     *
151
     * @return static
152
     *
153
     * @see http://schema.org/category
154
     */
155
    public function category($category)
156
    {
157
        return $this->setProperty('category', $category);
158
    }
159
160
    /**
161
     * The color of the product.
162
     *
163
     * @param string|string[] $color
164
     *
165
     * @return static
166
     *
167
     * @see http://schema.org/color
168
     */
169
    public function color($color)
170
    {
171
        return $this->setProperty('color', $color);
172
    }
173
174
    /**
175
     * The depth of the item.
176
     *
177
     * @param \Spatie\SchemaOrg\Contracts\DistanceContract|\Spatie\SchemaOrg\Contracts\DistanceContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $depth
178
     *
179
     * @return static
180
     *
181
     * @see http://schema.org/depth
182
     */
183
    public function depth($depth)
184
    {
185
        return $this->setProperty('depth', $depth);
186
    }
187
188
    /**
189
     * A description of the item.
190
     *
191
     * @param string|string[] $description
192
     *
193
     * @return static
194
     *
195
     * @see http://schema.org/description
196
     */
197
    public function description($description)
198
    {
199
        return $this->setProperty('description', $description);
200
    }
201
202
    /**
203
     * A sub property of description. A short description of the item used to
204
     * disambiguate from other, similar items. Information from other properties
205
     * (in particular, name) may be necessary for the description to be useful
206
     * for disambiguation.
207
     *
208
     * @param string|string[] $disambiguatingDescription
209
     *
210
     * @return static
211
     *
212
     * @see http://schema.org/disambiguatingDescription
213
     */
214
    public function disambiguatingDescription($disambiguatingDescription)
215
    {
216
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
217
    }
218
219
    /**
220
     * The GTIN-12 code of the product, or the product to which the offer
221
     * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a
222
     * U.P.C. Company Prefix, Item Reference, and Check Digit used to identify
223
     * trade items. See [GS1 GTIN
224
     * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more
225
     * details.
226
     *
227
     * @param string|string[] $gtin12
228
     *
229
     * @return static
230
     *
231
     * @see http://schema.org/gtin12
232
     */
233
    public function gtin12($gtin12)
234
    {
235
        return $this->setProperty('gtin12', $gtin12);
236
    }
237
238
    /**
239
     * The GTIN-13 code of the product, or the product to which the offer
240
     * refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former
241
     * 12-digit UPC codes can be converted into a GTIN-13 code by simply adding
242
     * a preceeding zero. See [GS1 GTIN
243
     * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more
244
     * details.
245
     *
246
     * @param string|string[] $gtin13
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/gtin13
251
     */
252
    public function gtin13($gtin13)
253
    {
254
        return $this->setProperty('gtin13', $gtin13);
255
    }
256
257
    /**
258
     * The GTIN-14 code of the product, or the product to which the offer
259
     * refers. See [GS1 GTIN
260
     * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more
261
     * details.
262
     *
263
     * @param string|string[] $gtin14
264
     *
265
     * @return static
266
     *
267
     * @see http://schema.org/gtin14
268
     */
269
    public function gtin14($gtin14)
270
    {
271
        return $this->setProperty('gtin14', $gtin14);
272
    }
273
274
    /**
275
     * The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of
276
     * the product, or the product to which the offer refers. This code is also
277
     * known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN
278
     * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more
279
     * details.
280
     *
281
     * @param string|string[] $gtin8
282
     *
283
     * @return static
284
     *
285
     * @see http://schema.org/gtin8
286
     */
287
    public function gtin8($gtin8)
288
    {
289
        return $this->setProperty('gtin8', $gtin8);
290
    }
291
292
    /**
293
     * The height of the item.
294
     *
295
     * @param \Spatie\SchemaOrg\Contracts\DistanceContract|\Spatie\SchemaOrg\Contracts\DistanceContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $height
296
     *
297
     * @return static
298
     *
299
     * @see http://schema.org/height
300
     */
301
    public function height($height)
302
    {
303
        return $this->setProperty('height', $height);
304
    }
305
306
    /**
307
     * The identifier property represents any kind of identifier for any kind of
308
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
309
     * dedicated properties for representing many of these, either as textual
310
     * strings or as URL (URI) links. See [background
311
     * notes](/docs/datamodel.html#identifierBg) for more details.
312
     *
313
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
314
     *
315
     * @return static
316
     *
317
     * @see http://schema.org/identifier
318
     */
319
    public function identifier($identifier)
320
    {
321
        return $this->setProperty('identifier', $identifier);
322
    }
323
324
    /**
325
     * An image of the item. This can be a [[URL]] or a fully described
326
     * [[ImageObject]].
327
     *
328
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
329
     *
330
     * @return static
331
     *
332
     * @see http://schema.org/image
333
     */
334
    public function image($image)
335
    {
336
        return $this->setProperty('image', $image);
337
    }
338
339
    /**
340
     * A pointer to another product (or multiple products) for which this
341
     * product is an accessory or spare part.
342
     *
343
     * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[] $isAccessoryOrSparePartFor
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/isAccessoryOrSparePartFor
348
     */
349
    public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor)
350
    {
351
        return $this->setProperty('isAccessoryOrSparePartFor', $isAccessoryOrSparePartFor);
352
    }
353
354
    /**
355
     * A pointer to another product (or multiple products) for which this
356
     * product is a consumable.
357
     *
358
     * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[] $isConsumableFor
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/isConsumableFor
363
     */
364
    public function isConsumableFor($isConsumableFor)
365
    {
366
        return $this->setProperty('isConsumableFor', $isConsumableFor);
367
    }
368
369
    /**
370
     * A pointer to another, somehow related product (or multiple products).
371
     *
372
     * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|\Spatie\SchemaOrg\Contracts\ServiceContract|\Spatie\SchemaOrg\Contracts\ServiceContract[] $isRelatedTo
373
     *
374
     * @return static
375
     *
376
     * @see http://schema.org/isRelatedTo
377
     */
378
    public function isRelatedTo($isRelatedTo)
379
    {
380
        return $this->setProperty('isRelatedTo', $isRelatedTo);
381
    }
382
383
    /**
384
     * A pointer to another, functionally similar product (or multiple
385
     * products).
386
     *
387
     * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|\Spatie\SchemaOrg\Contracts\ServiceContract|\Spatie\SchemaOrg\Contracts\ServiceContract[] $isSimilarTo
388
     *
389
     * @return static
390
     *
391
     * @see http://schema.org/isSimilarTo
392
     */
393
    public function isSimilarTo($isSimilarTo)
394
    {
395
        return $this->setProperty('isSimilarTo', $isSimilarTo);
396
    }
397
398
    /**
399
     * A predefined value from OfferItemCondition or a textual description of
400
     * the condition of the product or service, or the products or services
401
     * included in the offer.
402
     *
403
     * @param \Spatie\SchemaOrg\Contracts\OfferItemConditionContract|\Spatie\SchemaOrg\Contracts\OfferItemConditionContract[] $itemCondition
404
     *
405
     * @return static
406
     *
407
     * @see http://schema.org/itemCondition
408
     */
409
    public function itemCondition($itemCondition)
410
    {
411
        return $this->setProperty('itemCondition', $itemCondition);
412
    }
413
414
    /**
415
     * An associated logo.
416
     *
417
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
418
     *
419
     * @return static
420
     *
421
     * @see http://schema.org/logo
422
     */
423
    public function logo($logo)
424
    {
425
        return $this->setProperty('logo', $logo);
426
    }
427
428
    /**
429
     * Indicates a page (or other CreativeWork) for which this thing is the main
430
     * entity being described. See [background
431
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
432
     *
433
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
434
     *
435
     * @return static
436
     *
437
     * @see http://schema.org/mainEntityOfPage
438
     */
439
    public function mainEntityOfPage($mainEntityOfPage)
440
    {
441
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
442
    }
443
444
    /**
445
     * The manufacturer of the product.
446
     *
447
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $manufacturer
448
     *
449
     * @return static
450
     *
451
     * @see http://schema.org/manufacturer
452
     */
453
    public function manufacturer($manufacturer)
454
    {
455
        return $this->setProperty('manufacturer', $manufacturer);
456
    }
457
458
    /**
459
     * A material that something is made from, e.g. leather, wool, cotton,
460
     * paper.
461
     *
462
     * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|string|string[] $material
463
     *
464
     * @return static
465
     *
466
     * @see http://schema.org/material
467
     */
468
    public function material($material)
469
    {
470
        return $this->setProperty('material', $material);
471
    }
472
473
    /**
474
     * The model of the product. Use with the URL of a ProductModel or a textual
475
     * representation of the model identifier. The URL of the ProductModel can
476
     * be from an external source. It is recommended to additionally provide
477
     * strong product identifiers via the gtin8/gtin13/gtin14 and mpn
478
     * properties.
479
     *
480
     * @param \Spatie\SchemaOrg\Contracts\ProductModelContract|\Spatie\SchemaOrg\Contracts\ProductModelContract[]|string|string[] $model
481
     *
482
     * @return static
483
     *
484
     * @see http://schema.org/model
485
     */
486
    public function model($model)
487
    {
488
        return $this->setProperty('model', $model);
489
    }
490
491
    /**
492
     * The Manufacturer Part Number (MPN) of the product, or the product to
493
     * which the offer refers.
494
     *
495
     * @param string|string[] $mpn
496
     *
497
     * @return static
498
     *
499
     * @see http://schema.org/mpn
500
     */
501
    public function mpn($mpn)
502
    {
503
        return $this->setProperty('mpn', $mpn);
504
    }
505
506
    /**
507
     * The name of the item.
508
     *
509
     * @param string|string[] $name
510
     *
511
     * @return static
512
     *
513
     * @see http://schema.org/name
514
     */
515
    public function name($name)
516
    {
517
        return $this->setProperty('name', $name);
518
    }
519
520
    /**
521
     * An offer to provide this item&#x2014;for example, an offer to sell a
522
     * product, rent the DVD of a movie, perform a service, or give away tickets
523
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
524
     * offered, i.e. sell, lease, etc. This property can also be used to
525
     * describe a [[Demand]]. While this property is listed as expected on a
526
     * number of common types, it can be used in others. In that case, using a
527
     * second type, such as Product or a subtype of Product, can clarify the
528
     * nature of the offer.
529
     *
530
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
531
     *
532
     * @return static
533
     *
534
     * @see http://schema.org/offers
535
     */
536
    public function offers($offers)
537
    {
538
        return $this->setProperty('offers', $offers);
539
    }
540
541
    /**
542
     * Indicates a potential Action, which describes an idealized action in
543
     * which this thing would play an 'object' role.
544
     *
545
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
546
     *
547
     * @return static
548
     *
549
     * @see http://schema.org/potentialAction
550
     */
551
    public function potentialAction($potentialAction)
552
    {
553
        return $this->setProperty('potentialAction', $potentialAction);
554
    }
555
556
    /**
557
     * The product identifier, such as ISBN. For example: ``` meta
558
     * itemprop="productID" content="isbn:123-456-789" ```.
559
     *
560
     * @param string|string[] $productID
561
     *
562
     * @return static
563
     *
564
     * @see http://schema.org/productID
565
     */
566
    public function productID($productID)
567
    {
568
        return $this->setProperty('productID', $productID);
569
    }
570
571
    /**
572
     * The date of production of the item, e.g. vehicle.
573
     *
574
     * @param \DateTimeInterface|\DateTimeInterface[] $productionDate
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/productionDate
579
     */
580
    public function productionDate($productionDate)
581
    {
582
        return $this->setProperty('productionDate', $productionDate);
583
    }
584
585
    /**
586
     * The date the item e.g. vehicle was purchased by the current owner.
587
     *
588
     * @param \DateTimeInterface|\DateTimeInterface[] $purchaseDate
589
     *
590
     * @return static
591
     *
592
     * @see http://schema.org/purchaseDate
593
     */
594
    public function purchaseDate($purchaseDate)
595
    {
596
        return $this->setProperty('purchaseDate', $purchaseDate);
597
    }
598
599
    /**
600
     * The release date of a product or product model. This can be used to
601
     * distinguish the exact variant of a product.
602
     *
603
     * @param \DateTimeInterface|\DateTimeInterface[] $releaseDate
604
     *
605
     * @return static
606
     *
607
     * @see http://schema.org/releaseDate
608
     */
609
    public function releaseDate($releaseDate)
610
    {
611
        return $this->setProperty('releaseDate', $releaseDate);
612
    }
613
614
    /**
615
     * A review of the item.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/review
622
     */
623
    public function review($review)
624
    {
625
        return $this->setProperty('review', $review);
626
    }
627
628
    /**
629
     * Review of the item.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/reviews
636
     */
637
    public function reviews($reviews)
638
    {
639
        return $this->setProperty('reviews', $reviews);
640
    }
641
642
    /**
643
     * URL of a reference Web page that unambiguously indicates the item's
644
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
645
     * official website.
646
     *
647
     * @param string|string[] $sameAs
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/sameAs
652
     */
653
    public function sameAs($sameAs)
654
    {
655
        return $this->setProperty('sameAs', $sameAs);
656
    }
657
658
    /**
659
     * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a
660
     * product or service, or the product to which the offer refers.
661
     *
662
     * @param string|string[] $sku
663
     *
664
     * @return static
665
     *
666
     * @see http://schema.org/sku
667
     */
668
    public function sku($sku)
669
    {
670
        return $this->setProperty('sku', $sku);
671
    }
672
673
    /**
674
     * A slogan or motto associated with the item.
675
     *
676
     * @param string|string[] $slogan
677
     *
678
     * @return static
679
     *
680
     * @see http://schema.org/slogan
681
     */
682
    public function slogan($slogan)
683
    {
684
        return $this->setProperty('slogan', $slogan);
685
    }
686
687
    /**
688
     * A CreativeWork or Event about this Thing.
689
     *
690
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
691
     *
692
     * @return static
693
     *
694
     * @see http://schema.org/subjectOf
695
     */
696
    public function subjectOf($subjectOf)
697
    {
698
        return $this->setProperty('subjectOf', $subjectOf);
699
    }
700
701
    /**
702
     * URL of the item.
703
     *
704
     * @param string|string[] $url
705
     *
706
     * @return static
707
     *
708
     * @see http://schema.org/url
709
     */
710
    public function url($url)
711
    {
712
        return $this->setProperty('url', $url);
713
    }
714
715
    /**
716
     * The weight of the product or person.
717
     *
718
     * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $weight
719
     *
720
     * @return static
721
     *
722
     * @see http://schema.org/weight
723
     */
724
    public function weight($weight)
725
    {
726
        return $this->setProperty('weight', $weight);
727
    }
728
729
    /**
730
     * The width of the item.
731
     *
732
     * @param \Spatie\SchemaOrg\Contracts\DistanceContract|\Spatie\SchemaOrg\Contracts\DistanceContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $width
733
     *
734
     * @return static
735
     *
736
     * @see http://schema.org/width
737
     */
738
    public function width($width)
739
    {
740
        return $this->setProperty('width', $width);
741
    }
742
743
}
744

src/RVPark.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/RVPark
15
 *
16
 */
17
class RVPark extends BaseType implements RVParkContract, CivicStructureContract, PlaceContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/SaleEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/SaleEvent
13
 *
14
 */
15
class SaleEvent extends BaseType implements SaleEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/SocialEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/SocialEvent
13
 *
14
 */
15
class SocialEvent extends BaseType implements SocialEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/SubwayStation.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/SubwayStation
14
 *
15
 */
16
class SubwayStation extends BaseType implements SubwayStationContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/Synagogue.php 1 location

@@ 17-714 (lines=698) @@
14
 * @see http://schema.org/Synagogue
15
 *
16
 */
17
class Synagogue extends BaseType implements SynagogueContract, CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract
18
{
19
    /**
20
     * A property-value pair representing an additional characteristics of the
21
     * entitity, e.g. a product feature or another characteristic for which
22
     * there is no matching property in schema.org.
23
     * 
24
     * Note: Publishers should be aware that applications designed to use
25
     * specific schema.org properties (e.g. http://schema.org/width,
26
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
27
     * expect such data to be provided using those properties, rather than using
28
     * the generic property/value mechanism.
29
     *
30
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
31
     *
32
     * @return static
33
     *
34
     * @see http://schema.org/additionalProperty
35
     */
36
    public function additionalProperty($additionalProperty)
37
    {
38
        return $this->setProperty('additionalProperty', $additionalProperty);
39
    }
40
41
    /**
42
     * An additional type for the item, typically used for adding more specific
43
     * types from external vocabularies in microdata syntax. This is a
44
     * relationship between something and a class that the thing is in. In RDFa
45
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
46
     * attribute - for multiple types. Schema.org tools may have only weaker
47
     * understanding of extra types, in particular those defined externally.
48
     *
49
     * @param string|string[] $additionalType
50
     *
51
     * @return static
52
     *
53
     * @see http://schema.org/additionalType
54
     */
55
    public function additionalType($additionalType)
56
    {
57
        return $this->setProperty('additionalType', $additionalType);
58
    }
59
60
    /**
61
     * Physical address of the item.
62
     *
63
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
64
     *
65
     * @return static
66
     *
67
     * @see http://schema.org/address
68
     */
69
    public function address($address)
70
    {
71
        return $this->setProperty('address', $address);
72
    }
73
74
    /**
75
     * The overall rating, based on a collection of reviews or ratings, of the
76
     * item.
77
     *
78
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
79
     *
80
     * @return static
81
     *
82
     * @see http://schema.org/aggregateRating
83
     */
84
    public function aggregateRating($aggregateRating)
85
    {
86
        return $this->setProperty('aggregateRating', $aggregateRating);
87
    }
88
89
    /**
90
     * An alias for the item.
91
     *
92
     * @param string|string[] $alternateName
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/alternateName
97
     */
98
    public function alternateName($alternateName)
99
    {
100
        return $this->setProperty('alternateName', $alternateName);
101
    }
102
103
    /**
104
     * An amenity feature (e.g. a characteristic or service) of the
105
     * Accommodation. This generic property does not make a statement about
106
     * whether the feature is included in an offer for the main accommodation or
107
     * available at extra costs.
108
     *
109
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
110
     *
111
     * @return static
112
     *
113
     * @see http://schema.org/amenityFeature
114
     */
115
    public function amenityFeature($amenityFeature)
116
    {
117
        return $this->setProperty('amenityFeature', $amenityFeature);
118
    }
119
120
    /**
121
     * A short textual code (also called "store code") that uniquely identifies
122
     * a place of business. The code is typically assigned by the
123
     * parentOrganization and used in structured URLs.
124
     * 
125
     * For example, in the URL
126
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
127
     * is a branchCode for a particular branch.
128
     *
129
     * @param string|string[] $branchCode
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/branchCode
134
     */
135
    public function branchCode($branchCode)
136
    {
137
        return $this->setProperty('branchCode', $branchCode);
138
    }
139
140
    /**
141
     * The basic containment relation between a place and one that contains it.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/containedIn
148
     */
149
    public function containedIn($containedIn)
150
    {
151
        return $this->setProperty('containedIn', $containedIn);
152
    }
153
154
    /**
155
     * The basic containment relation between a place and one that contains it.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/containedInPlace
162
     */
163
    public function containedInPlace($containedInPlace)
164
    {
165
        return $this->setProperty('containedInPlace', $containedInPlace);
166
    }
167
168
    /**
169
     * The basic containment relation between a place and another that it
170
     * contains.
171
     *
172
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/containsPlace
177
     */
178
    public function containsPlace($containsPlace)
179
    {
180
        return $this->setProperty('containsPlace', $containsPlace);
181
    }
182
183
    /**
184
     * A description of the item.
185
     *
186
     * @param string|string[] $description
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/description
191
     */
192
    public function description($description)
193
    {
194
        return $this->setProperty('description', $description);
195
    }
196
197
    /**
198
     * A sub property of description. A short description of the item used to
199
     * disambiguate from other, similar items. Information from other properties
200
     * (in particular, name) may be necessary for the description to be useful
201
     * for disambiguation.
202
     *
203
     * @param string|string[] $disambiguatingDescription
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/disambiguatingDescription
208
     */
209
    public function disambiguatingDescription($disambiguatingDescription)
210
    {
211
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
212
    }
213
214
    /**
215
     * Upcoming or past event associated with this place, organization, or
216
     * action.
217
     *
218
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/event
223
     */
224
    public function event($event)
225
    {
226
        return $this->setProperty('event', $event);
227
    }
228
229
    /**
230
     * Upcoming or past events associated with this place or organization.
231
     *
232
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/events
237
     */
238
    public function events($events)
239
    {
240
        return $this->setProperty('events', $events);
241
    }
242
243
    /**
244
     * The fax number.
245
     *
246
     * @param string|string[] $faxNumber
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/faxNumber
251
     */
252
    public function faxNumber($faxNumber)
253
    {
254
        return $this->setProperty('faxNumber', $faxNumber);
255
    }
256
257
    /**
258
     * The geo coordinates of the place.
259
     *
260
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
261
     *
262
     * @return static
263
     *
264
     * @see http://schema.org/geo
265
     */
266
    public function geo($geo)
267
    {
268
        return $this->setProperty('geo', $geo);
269
    }
270
271
    /**
272
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
273
     * referred to as International Location Number or ILN) of the respective
274
     * organization, person, or place. The GLN is a 13-digit number used to
275
     * identify parties and physical locations.
276
     *
277
     * @param string|string[] $globalLocationNumber
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/globalLocationNumber
282
     */
283
    public function globalLocationNumber($globalLocationNumber)
284
    {
285
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
286
    }
287
288
    /**
289
     * A URL to a map of the place.
290
     *
291
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
292
     *
293
     * @return static
294
     *
295
     * @see http://schema.org/hasMap
296
     */
297
    public function hasMap($hasMap)
298
    {
299
        return $this->setProperty('hasMap', $hasMap);
300
    }
301
302
    /**
303
     * The identifier property represents any kind of identifier for any kind of
304
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
305
     * dedicated properties for representing many of these, either as textual
306
     * strings or as URL (URI) links. See [background
307
     * notes](/docs/datamodel.html#identifierBg) for more details.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/identifier
314
     */
315
    public function identifier($identifier)
316
    {
317
        return $this->setProperty('identifier', $identifier);
318
    }
319
320
    /**
321
     * An image of the item. This can be a [[URL]] or a fully described
322
     * [[ImageObject]].
323
     *
324
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/image
329
     */
330
    public function image($image)
331
    {
332
        return $this->setProperty('image', $image);
333
    }
334
335
    /**
336
     * A flag to signal that the item, event, or place is accessible for free.
337
     *
338
     * @param bool|bool[] $isAccessibleForFree
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/isAccessibleForFree
343
     */
344
    public function isAccessibleForFree($isAccessibleForFree)
345
    {
346
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
347
    }
348
349
    /**
350
     * The International Standard of Industrial Classification of All Economic
351
     * Activities (ISIC), Revision 4 code for a particular organization,
352
     * business person, or place.
353
     *
354
     * @param string|string[] $isicV4
355
     *
356
     * @return static
357
     *
358
     * @see http://schema.org/isicV4
359
     */
360
    public function isicV4($isicV4)
361
    {
362
        return $this->setProperty('isicV4', $isicV4);
363
    }
364
365
    /**
366
     * The latitude of a location. For example ```37.42242``` ([WGS
367
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
368
     *
369
     * @param float|float[]|int|int[]|string|string[] $latitude
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/latitude
374
     */
375
    public function latitude($latitude)
376
    {
377
        return $this->setProperty('latitude', $latitude);
378
    }
379
380
    /**
381
     * An associated logo.
382
     *
383
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/logo
388
     */
389
    public function logo($logo)
390
    {
391
        return $this->setProperty('logo', $logo);
392
    }
393
394
    /**
395
     * The longitude of a location. For example ```-122.08585``` ([WGS
396
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
397
     *
398
     * @param float|float[]|int|int[]|string|string[] $longitude
399
     *
400
     * @return static
401
     *
402
     * @see http://schema.org/longitude
403
     */
404
    public function longitude($longitude)
405
    {
406
        return $this->setProperty('longitude', $longitude);
407
    }
408
409
    /**
410
     * Indicates a page (or other CreativeWork) for which this thing is the main
411
     * entity being described. See [background
412
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
413
     *
414
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
415
     *
416
     * @return static
417
     *
418
     * @see http://schema.org/mainEntityOfPage
419
     */
420
    public function mainEntityOfPage($mainEntityOfPage)
421
    {
422
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
423
    }
424
425
    /**
426
     * A URL to a map of the place.
427
     *
428
     * @param string|string[] $map
429
     *
430
     * @return static
431
     *
432
     * @see http://schema.org/map
433
     */
434
    public function map($map)
435
    {
436
        return $this->setProperty('map', $map);
437
    }
438
439
    /**
440
     * A URL to a map of the place.
441
     *
442
     * @param string|string[] $maps
443
     *
444
     * @return static
445
     *
446
     * @see http://schema.org/maps
447
     */
448
    public function maps($maps)
449
    {
450
        return $this->setProperty('maps', $maps);
451
    }
452
453
    /**
454
     * The total number of individuals that may attend an event or venue.
455
     *
456
     * @param int|int[] $maximumAttendeeCapacity
457
     *
458
     * @return static
459
     *
460
     * @see http://schema.org/maximumAttendeeCapacity
461
     */
462
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
463
    {
464
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
465
    }
466
467
    /**
468
     * The name of the item.
469
     *
470
     * @param string|string[] $name
471
     *
472
     * @return static
473
     *
474
     * @see http://schema.org/name
475
     */
476
    public function name($name)
477
    {
478
        return $this->setProperty('name', $name);
479
    }
480
481
    /**
482
     * The general opening hours for a business. Opening hours can be specified
483
     * as a weekly time range, starting with days, then times per day. Multiple
484
     * days can be listed with commas ',' separating each day. Day or time
485
     * ranges are specified using a hyphen '-'.
486
     * 
487
     * * Days are specified using the following two-letter combinations:
488
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
489
     * * Times are specified using 24:00 time. For example, 3pm is specified as
490
     * ```15:00```. 
491
     * * Here is an example: <code>&lt;time itemprop="openingHours"
492
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
493
     * 4-8pm&lt;/time&gt;</code>.
494
     * * If a business is open 7 days a week, then it can be specified as
495
     * <code>&lt;time itemprop=&quot;openingHours&quot;
496
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
497
     * day&lt;/time&gt;</code>.
498
     *
499
     * @param string|string[] $openingHours
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/openingHours
504
     */
505
    public function openingHours($openingHours)
506
    {
507
        return $this->setProperty('openingHours', $openingHours);
508
    }
509
510
    /**
511
     * The opening hours of a certain place.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/openingHoursSpecification
518
     */
519
    public function openingHoursSpecification($openingHoursSpecification)
520
    {
521
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
522
    }
523
524
    /**
525
     * A photograph of this place.
526
     *
527
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/photo
532
     */
533
    public function photo($photo)
534
    {
535
        return $this->setProperty('photo', $photo);
536
    }
537
538
    /**
539
     * Photographs of this place.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/photos
546
     */
547
    public function photos($photos)
548
    {
549
        return $this->setProperty('photos', $photos);
550
    }
551
552
    /**
553
     * Indicates a potential Action, which describes an idealized action in
554
     * which this thing would play an 'object' role.
555
     *
556
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
557
     *
558
     * @return static
559
     *
560
     * @see http://schema.org/potentialAction
561
     */
562
    public function potentialAction($potentialAction)
563
    {
564
        return $this->setProperty('potentialAction', $potentialAction);
565
    }
566
567
    /**
568
     * A flag to signal that the [[Place]] is open to public visitors.  If this
569
     * property is omitted there is no assumed default boolean value
570
     *
571
     * @param bool|bool[] $publicAccess
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/publicAccess
576
     */
577
    public function publicAccess($publicAccess)
578
    {
579
        return $this->setProperty('publicAccess', $publicAccess);
580
    }
581
582
    /**
583
     * A review of the item.
584
     *
585
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
586
     *
587
     * @return static
588
     *
589
     * @see http://schema.org/review
590
     */
591
    public function review($review)
592
    {
593
        return $this->setProperty('review', $review);
594
    }
595
596
    /**
597
     * Review of the item.
598
     *
599
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
600
     *
601
     * @return static
602
     *
603
     * @see http://schema.org/reviews
604
     */
605
    public function reviews($reviews)
606
    {
607
        return $this->setProperty('reviews', $reviews);
608
    }
609
610
    /**
611
     * URL of a reference Web page that unambiguously indicates the item's
612
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
613
     * official website.
614
     *
615
     * @param string|string[] $sameAs
616
     *
617
     * @return static
618
     *
619
     * @see http://schema.org/sameAs
620
     */
621
    public function sameAs($sameAs)
622
    {
623
        return $this->setProperty('sameAs', $sameAs);
624
    }
625
626
    /**
627
     * A slogan or motto associated with the item.
628
     *
629
     * @param string|string[] $slogan
630
     *
631
     * @return static
632
     *
633
     * @see http://schema.org/slogan
634
     */
635
    public function slogan($slogan)
636
    {
637
        return $this->setProperty('slogan', $slogan);
638
    }
639
640
    /**
641
     * Indicates whether it is allowed to smoke in the place, e.g. in the
642
     * restaurant, hotel or hotel room.
643
     *
644
     * @param bool|bool[] $smokingAllowed
645
     *
646
     * @return static
647
     *
648
     * @see http://schema.org/smokingAllowed
649
     */
650
    public function smokingAllowed($smokingAllowed)
651
    {
652
        return $this->setProperty('smokingAllowed', $smokingAllowed);
653
    }
654
655
    /**
656
     * The special opening hours of a certain place.
657
     * 
658
     * Use this to explicitly override general opening hours brought in scope by
659
     * [[openingHoursSpecification]] or [[openingHours]].
660
     *
661
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
662
     *
663
     * @return static
664
     *
665
     * @see http://schema.org/specialOpeningHoursSpecification
666
     */
667
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
668
    {
669
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
670
    }
671
672
    /**
673
     * A CreativeWork or Event about this Thing.
674
     *
675
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
676
     *
677
     * @return static
678
     *
679
     * @see http://schema.org/subjectOf
680
     */
681
    public function subjectOf($subjectOf)
682
    {
683
        return $this->setProperty('subjectOf', $subjectOf);
684
    }
685
686
    /**
687
     * The telephone number.
688
     *
689
     * @param string|string[] $telephone
690
     *
691
     * @return static
692
     *
693
     * @see http://schema.org/telephone
694
     */
695
    public function telephone($telephone)
696
    {
697
        return $this->setProperty('telephone', $telephone);
698
    }
699
700
    /**
701
     * URL of the item.
702
     *
703
     * @param string|string[] $url
704
     *
705
     * @return static
706
     *
707
     * @see http://schema.org/url
708
     */
709
    public function url($url)
710
    {
711
        return $this->setProperty('url', $url);
712
    }
713
714
}
715

src/TaxiStand.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/TaxiStand
14
 *
15
 */
16
class TaxiStand extends BaseType implements TaxiStandContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/TheaterEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/TheaterEvent
13
 *
14
 */
15
class TheaterEvent extends BaseType implements TheaterEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/TouristAttraction.php 1 location

@@ 19-718 (lines=700) @@
16
 * @see http://schema.org/TouristAttraction
17
 *
18
 */
19
class TouristAttraction extends BaseType implements TouristAttractionContract, PlaceContract, ThingContract
20
{
21
    /**
22
     * A property-value pair representing an additional characteristics of the
23
     * entitity, e.g. a product feature or another characteristic for which
24
     * there is no matching property in schema.org.
25
     * 
26
     * Note: Publishers should be aware that applications designed to use
27
     * specific schema.org properties (e.g. http://schema.org/width,
28
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
29
     * expect such data to be provided using those properties, rather than using
30
     * the generic property/value mechanism.
31
     *
32
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
33
     *
34
     * @return static
35
     *
36
     * @see http://schema.org/additionalProperty
37
     */
38
    public function additionalProperty($additionalProperty)
39
    {
40
        return $this->setProperty('additionalProperty', $additionalProperty);
41
    }
42
43
    /**
44
     * An additional type for the item, typically used for adding more specific
45
     * types from external vocabularies in microdata syntax. This is a
46
     * relationship between something and a class that the thing is in. In RDFa
47
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
48
     * attribute - for multiple types. Schema.org tools may have only weaker
49
     * understanding of extra types, in particular those defined externally.
50
     *
51
     * @param string|string[] $additionalType
52
     *
53
     * @return static
54
     *
55
     * @see http://schema.org/additionalType
56
     */
57
    public function additionalType($additionalType)
58
    {
59
        return $this->setProperty('additionalType', $additionalType);
60
    }
61
62
    /**
63
     * Physical address of the item.
64
     *
65
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
66
     *
67
     * @return static
68
     *
69
     * @see http://schema.org/address
70
     */
71
    public function address($address)
72
    {
73
        return $this->setProperty('address', $address);
74
    }
75
76
    /**
77
     * The overall rating, based on a collection of reviews or ratings, of the
78
     * item.
79
     *
80
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
81
     *
82
     * @return static
83
     *
84
     * @see http://schema.org/aggregateRating
85
     */
86
    public function aggregateRating($aggregateRating)
87
    {
88
        return $this->setProperty('aggregateRating', $aggregateRating);
89
    }
90
91
    /**
92
     * An alias for the item.
93
     *
94
     * @param string|string[] $alternateName
95
     *
96
     * @return static
97
     *
98
     * @see http://schema.org/alternateName
99
     */
100
    public function alternateName($alternateName)
101
    {
102
        return $this->setProperty('alternateName', $alternateName);
103
    }
104
105
    /**
106
     * An amenity feature (e.g. a characteristic or service) of the
107
     * Accommodation. This generic property does not make a statement about
108
     * whether the feature is included in an offer for the main accommodation or
109
     * available at extra costs.
110
     *
111
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
112
     *
113
     * @return static
114
     *
115
     * @see http://schema.org/amenityFeature
116
     */
117
    public function amenityFeature($amenityFeature)
118
    {
119
        return $this->setProperty('amenityFeature', $amenityFeature);
120
    }
121
122
    /**
123
     * A language someone may use with or at the item, service or place. Please
124
     * use one of the language codes from the [IETF BCP 47
125
     * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]]
126
     *
127
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $availableLanguage
128
     *
129
     * @return static
130
     *
131
     * @see http://schema.org/availableLanguage
132
     */
133
    public function availableLanguage($availableLanguage)
134
    {
135
        return $this->setProperty('availableLanguage', $availableLanguage);
136
    }
137
138
    /**
139
     * A short textual code (also called "store code") that uniquely identifies
140
     * a place of business. The code is typically assigned by the
141
     * parentOrganization and used in structured URLs.
142
     * 
143
     * For example, in the URL
144
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
145
     * is a branchCode for a particular branch.
146
     *
147
     * @param string|string[] $branchCode
148
     *
149
     * @return static
150
     *
151
     * @see http://schema.org/branchCode
152
     */
153
    public function branchCode($branchCode)
154
    {
155
        return $this->setProperty('branchCode', $branchCode);
156
    }
157
158
    /**
159
     * The basic containment relation between a place and one that contains it.
160
     *
161
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
162
     *
163
     * @return static
164
     *
165
     * @see http://schema.org/containedIn
166
     */
167
    public function containedIn($containedIn)
168
    {
169
        return $this->setProperty('containedIn', $containedIn);
170
    }
171
172
    /**
173
     * The basic containment relation between a place and one that contains it.
174
     *
175
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
176
     *
177
     * @return static
178
     *
179
     * @see http://schema.org/containedInPlace
180
     */
181
    public function containedInPlace($containedInPlace)
182
    {
183
        return $this->setProperty('containedInPlace', $containedInPlace);
184
    }
185
186
    /**
187
     * The basic containment relation between a place and another that it
188
     * contains.
189
     *
190
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
191
     *
192
     * @return static
193
     *
194
     * @see http://schema.org/containsPlace
195
     */
196
    public function containsPlace($containsPlace)
197
    {
198
        return $this->setProperty('containsPlace', $containsPlace);
199
    }
200
201
    /**
202
     * A description of the item.
203
     *
204
     * @param string|string[] $description
205
     *
206
     * @return static
207
     *
208
     * @see http://schema.org/description
209
     */
210
    public function description($description)
211
    {
212
        return $this->setProperty('description', $description);
213
    }
214
215
    /**
216
     * A sub property of description. A short description of the item used to
217
     * disambiguate from other, similar items. Information from other properties
218
     * (in particular, name) may be necessary for the description to be useful
219
     * for disambiguation.
220
     *
221
     * @param string|string[] $disambiguatingDescription
222
     *
223
     * @return static
224
     *
225
     * @see http://schema.org/disambiguatingDescription
226
     */
227
    public function disambiguatingDescription($disambiguatingDescription)
228
    {
229
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
230
    }
231
232
    /**
233
     * Upcoming or past event associated with this place, organization, or
234
     * action.
235
     *
236
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
237
     *
238
     * @return static
239
     *
240
     * @see http://schema.org/event
241
     */
242
    public function event($event)
243
    {
244
        return $this->setProperty('event', $event);
245
    }
246
247
    /**
248
     * Upcoming or past events associated with this place or organization.
249
     *
250
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
251
     *
252
     * @return static
253
     *
254
     * @see http://schema.org/events
255
     */
256
    public function events($events)
257
    {
258
        return $this->setProperty('events', $events);
259
    }
260
261
    /**
262
     * The fax number.
263
     *
264
     * @param string|string[] $faxNumber
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/faxNumber
269
     */
270
    public function faxNumber($faxNumber)
271
    {
272
        return $this->setProperty('faxNumber', $faxNumber);
273
    }
274
275
    /**
276
     * The geo coordinates of the place.
277
     *
278
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
279
     *
280
     * @return static
281
     *
282
     * @see http://schema.org/geo
283
     */
284
    public function geo($geo)
285
    {
286
        return $this->setProperty('geo', $geo);
287
    }
288
289
    /**
290
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
291
     * referred to as International Location Number or ILN) of the respective
292
     * organization, person, or place. The GLN is a 13-digit number used to
293
     * identify parties and physical locations.
294
     *
295
     * @param string|string[] $globalLocationNumber
296
     *
297
     * @return static
298
     *
299
     * @see http://schema.org/globalLocationNumber
300
     */
301
    public function globalLocationNumber($globalLocationNumber)
302
    {
303
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
304
    }
305
306
    /**
307
     * A URL to a map of the place.
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/hasMap
314
     */
315
    public function hasMap($hasMap)
316
    {
317
        return $this->setProperty('hasMap', $hasMap);
318
    }
319
320
    /**
321
     * The identifier property represents any kind of identifier for any kind of
322
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
323
     * dedicated properties for representing many of these, either as textual
324
     * strings or as URL (URI) links. See [background
325
     * notes](/docs/datamodel.html#identifierBg) for more details.
326
     *
327
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
328
     *
329
     * @return static
330
     *
331
     * @see http://schema.org/identifier
332
     */
333
    public function identifier($identifier)
334
    {
335
        return $this->setProperty('identifier', $identifier);
336
    }
337
338
    /**
339
     * An image of the item. This can be a [[URL]] or a fully described
340
     * [[ImageObject]].
341
     *
342
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
343
     *
344
     * @return static
345
     *
346
     * @see http://schema.org/image
347
     */
348
    public function image($image)
349
    {
350
        return $this->setProperty('image', $image);
351
    }
352
353
    /**
354
     * A flag to signal that the item, event, or place is accessible for free.
355
     *
356
     * @param bool|bool[] $isAccessibleForFree
357
     *
358
     * @return static
359
     *
360
     * @see http://schema.org/isAccessibleForFree
361
     */
362
    public function isAccessibleForFree($isAccessibleForFree)
363
    {
364
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
365
    }
366
367
    /**
368
     * The International Standard of Industrial Classification of All Economic
369
     * Activities (ISIC), Revision 4 code for a particular organization,
370
     * business person, or place.
371
     *
372
     * @param string|string[] $isicV4
373
     *
374
     * @return static
375
     *
376
     * @see http://schema.org/isicV4
377
     */
378
    public function isicV4($isicV4)
379
    {
380
        return $this->setProperty('isicV4', $isicV4);
381
    }
382
383
    /**
384
     * The latitude of a location. For example ```37.42242``` ([WGS
385
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
386
     *
387
     * @param float|float[]|int|int[]|string|string[] $latitude
388
     *
389
     * @return static
390
     *
391
     * @see http://schema.org/latitude
392
     */
393
    public function latitude($latitude)
394
    {
395
        return $this->setProperty('latitude', $latitude);
396
    }
397
398
    /**
399
     * An associated logo.
400
     *
401
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
402
     *
403
     * @return static
404
     *
405
     * @see http://schema.org/logo
406
     */
407
    public function logo($logo)
408
    {
409
        return $this->setProperty('logo', $logo);
410
    }
411
412
    /**
413
     * The longitude of a location. For example ```-122.08585``` ([WGS
414
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
415
     *
416
     * @param float|float[]|int|int[]|string|string[] $longitude
417
     *
418
     * @return static
419
     *
420
     * @see http://schema.org/longitude
421
     */
422
    public function longitude($longitude)
423
    {
424
        return $this->setProperty('longitude', $longitude);
425
    }
426
427
    /**
428
     * Indicates a page (or other CreativeWork) for which this thing is the main
429
     * entity being described. See [background
430
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
431
     *
432
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
433
     *
434
     * @return static
435
     *
436
     * @see http://schema.org/mainEntityOfPage
437
     */
438
    public function mainEntityOfPage($mainEntityOfPage)
439
    {
440
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
441
    }
442
443
    /**
444
     * A URL to a map of the place.
445
     *
446
     * @param string|string[] $map
447
     *
448
     * @return static
449
     *
450
     * @see http://schema.org/map
451
     */
452
    public function map($map)
453
    {
454
        return $this->setProperty('map', $map);
455
    }
456
457
    /**
458
     * A URL to a map of the place.
459
     *
460
     * @param string|string[] $maps
461
     *
462
     * @return static
463
     *
464
     * @see http://schema.org/maps
465
     */
466
    public function maps($maps)
467
    {
468
        return $this->setProperty('maps', $maps);
469
    }
470
471
    /**
472
     * The total number of individuals that may attend an event or venue.
473
     *
474
     * @param int|int[] $maximumAttendeeCapacity
475
     *
476
     * @return static
477
     *
478
     * @see http://schema.org/maximumAttendeeCapacity
479
     */
480
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
481
    {
482
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
483
    }
484
485
    /**
486
     * The name of the item.
487
     *
488
     * @param string|string[] $name
489
     *
490
     * @return static
491
     *
492
     * @see http://schema.org/name
493
     */
494
    public function name($name)
495
    {
496
        return $this->setProperty('name', $name);
497
    }
498
499
    /**
500
     * The opening hours of a certain place.
501
     *
502
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
503
     *
504
     * @return static
505
     *
506
     * @see http://schema.org/openingHoursSpecification
507
     */
508
    public function openingHoursSpecification($openingHoursSpecification)
509
    {
510
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
511
    }
512
513
    /**
514
     * A photograph of this place.
515
     *
516
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
517
     *
518
     * @return static
519
     *
520
     * @see http://schema.org/photo
521
     */
522
    public function photo($photo)
523
    {
524
        return $this->setProperty('photo', $photo);
525
    }
526
527
    /**
528
     * Photographs of this place.
529
     *
530
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
531
     *
532
     * @return static
533
     *
534
     * @see http://schema.org/photos
535
     */
536
    public function photos($photos)
537
    {
538
        return $this->setProperty('photos', $photos);
539
    }
540
541
    /**
542
     * Indicates a potential Action, which describes an idealized action in
543
     * which this thing would play an 'object' role.
544
     *
545
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
546
     *
547
     * @return static
548
     *
549
     * @see http://schema.org/potentialAction
550
     */
551
    public function potentialAction($potentialAction)
552
    {
553
        return $this->setProperty('potentialAction', $potentialAction);
554
    }
555
556
    /**
557
     * A flag to signal that the [[Place]] is open to public visitors.  If this
558
     * property is omitted there is no assumed default boolean value
559
     *
560
     * @param bool|bool[] $publicAccess
561
     *
562
     * @return static
563
     *
564
     * @see http://schema.org/publicAccess
565
     */
566
    public function publicAccess($publicAccess)
567
    {
568
        return $this->setProperty('publicAccess', $publicAccess);
569
    }
570
571
    /**
572
     * A review of the item.
573
     *
574
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/review
579
     */
580
    public function review($review)
581
    {
582
        return $this->setProperty('review', $review);
583
    }
584
585
    /**
586
     * Review of the item.
587
     *
588
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
589
     *
590
     * @return static
591
     *
592
     * @see http://schema.org/reviews
593
     */
594
    public function reviews($reviews)
595
    {
596
        return $this->setProperty('reviews', $reviews);
597
    }
598
599
    /**
600
     * URL of a reference Web page that unambiguously indicates the item's
601
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
602
     * official website.
603
     *
604
     * @param string|string[] $sameAs
605
     *
606
     * @return static
607
     *
608
     * @see http://schema.org/sameAs
609
     */
610
    public function sameAs($sameAs)
611
    {
612
        return $this->setProperty('sameAs', $sameAs);
613
    }
614
615
    /**
616
     * A slogan or motto associated with the item.
617
     *
618
     * @param string|string[] $slogan
619
     *
620
     * @return static
621
     *
622
     * @see http://schema.org/slogan
623
     */
624
    public function slogan($slogan)
625
    {
626
        return $this->setProperty('slogan', $slogan);
627
    }
628
629
    /**
630
     * Indicates whether it is allowed to smoke in the place, e.g. in the
631
     * restaurant, hotel or hotel room.
632
     *
633
     * @param bool|bool[] $smokingAllowed
634
     *
635
     * @return static
636
     *
637
     * @see http://schema.org/smokingAllowed
638
     */
639
    public function smokingAllowed($smokingAllowed)
640
    {
641
        return $this->setProperty('smokingAllowed', $smokingAllowed);
642
    }
643
644
    /**
645
     * The special opening hours of a certain place.
646
     * 
647
     * Use this to explicitly override general opening hours brought in scope by
648
     * [[openingHoursSpecification]] or [[openingHours]].
649
     *
650
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
651
     *
652
     * @return static
653
     *
654
     * @see http://schema.org/specialOpeningHoursSpecification
655
     */
656
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
657
    {
658
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
659
    }
660
661
    /**
662
     * A CreativeWork or Event about this Thing.
663
     *
664
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
665
     *
666
     * @return static
667
     *
668
     * @see http://schema.org/subjectOf
669
     */
670
    public function subjectOf($subjectOf)
671
    {
672
        return $this->setProperty('subjectOf', $subjectOf);
673
    }
674
675
    /**
676
     * The telephone number.
677
     *
678
     * @param string|string[] $telephone
679
     *
680
     * @return static
681
     *
682
     * @see http://schema.org/telephone
683
     */
684
    public function telephone($telephone)
685
    {
686
        return $this->setProperty('telephone', $telephone);
687
    }
688
689
    /**
690
     * Attraction suitable for type(s) of tourist. eg. Children, visitors from a
691
     * particular country, etc.
692
     *
693
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[]|string|string[] $touristType
694
     *
695
     * @return static
696
     *
697
     * @see http://schema.org/touristType
698
     */
699
    public function touristType($touristType)
700
    {
701
        return $this->setProperty('touristType', $touristType);
702
    }
703
704
    /**
705
     * URL of the item.
706
     *
707
     * @param string|string[] $url
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/url
712
     */
713
    public function url($url)
714
    {
715
        return $this->setProperty('url', $url);
716
    }
717
718
}
719

src/TrainStation.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/TrainStation
14
 *
15
 */
16
class TrainStation extends BaseType implements TrainStationContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714

src/UserBlocks.php 1 location

@@ 18-736 (lines=719) @@
15
 * @see http://schema.org/UserBlocks
16
 *
17
 */
18
class UserBlocks extends BaseType implements UserBlocksContract, EventContract, ThingContract, UserInteractionContract
19
{
20
    /**
21
     * The subject matter of the content.
22
     *
23
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
24
     *
25
     * @return static
26
     *
27
     * @see http://schema.org/about
28
     */
29
    public function about($about)
30
    {
31
        return $this->setProperty('about', $about);
32
    }
33
34
    /**
35
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
36
     * Actors can be associated with individual items or with a series, episode,
37
     * clip.
38
     *
39
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/actor
44
     */
45
    public function actor($actor)
46
    {
47
        return $this->setProperty('actor', $actor);
48
    }
49
50
    /**
51
     * An additional type for the item, typically used for adding more specific
52
     * types from external vocabularies in microdata syntax. This is a
53
     * relationship between something and a class that the thing is in. In RDFa
54
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
55
     * attribute - for multiple types. Schema.org tools may have only weaker
56
     * understanding of extra types, in particular those defined externally.
57
     *
58
     * @param string|string[] $additionalType
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/additionalType
63
     */
64
    public function additionalType($additionalType)
65
    {
66
        return $this->setProperty('additionalType', $additionalType);
67
    }
68
69
    /**
70
     * The overall rating, based on a collection of reviews or ratings, of the
71
     * item.
72
     *
73
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
74
     *
75
     * @return static
76
     *
77
     * @see http://schema.org/aggregateRating
78
     */
79
    public function aggregateRating($aggregateRating)
80
    {
81
        return $this->setProperty('aggregateRating', $aggregateRating);
82
    }
83
84
    /**
85
     * An alias for the item.
86
     *
87
     * @param string|string[] $alternateName
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/alternateName
92
     */
93
    public function alternateName($alternateName)
94
    {
95
        return $this->setProperty('alternateName', $alternateName);
96
    }
97
98
    /**
99
     * A person or organization attending the event.
100
     *
101
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/attendee
106
     */
107
    public function attendee($attendee)
108
    {
109
        return $this->setProperty('attendee', $attendee);
110
    }
111
112
    /**
113
     * A person attending the event.
114
     *
115
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/attendees
120
     */
121
    public function attendees($attendees)
122
    {
123
        return $this->setProperty('attendees', $attendees);
124
    }
125
126
    /**
127
     * An intended audience, i.e. a group for whom something was created.
128
     *
129
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/audience
134
     */
135
    public function audience($audience)
136
    {
137
        return $this->setProperty('audience', $audience);
138
    }
139
140
    /**
141
     * The person or organization who wrote a composition, or who is the
142
     * composer of a work performed at some event.
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/composer
149
     */
150
    public function composer($composer)
151
    {
152
        return $this->setProperty('composer', $composer);
153
    }
154
155
    /**
156
     * A secondary contributor to the CreativeWork or Event.
157
     *
158
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
159
     *
160
     * @return static
161
     *
162
     * @see http://schema.org/contributor
163
     */
164
    public function contributor($contributor)
165
    {
166
        return $this->setProperty('contributor', $contributor);
167
    }
168
169
    /**
170
     * A description of the item.
171
     *
172
     * @param string|string[] $description
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/description
177
     */
178
    public function description($description)
179
    {
180
        return $this->setProperty('description', $description);
181
    }
182
183
    /**
184
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
185
     * event. Directors can be associated with individual items or with a
186
     * series, episode, clip.
187
     *
188
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/director
193
     */
194
    public function director($director)
195
    {
196
        return $this->setProperty('director', $director);
197
    }
198
199
    /**
200
     * A sub property of description. A short description of the item used to
201
     * disambiguate from other, similar items. Information from other properties
202
     * (in particular, name) may be necessary for the description to be useful
203
     * for disambiguation.
204
     *
205
     * @param string|string[] $disambiguatingDescription
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/disambiguatingDescription
210
     */
211
    public function disambiguatingDescription($disambiguatingDescription)
212
    {
213
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
214
    }
215
216
    /**
217
     * The time admission will commence.
218
     *
219
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/doorTime
224
     */
225
    public function doorTime($doorTime)
226
    {
227
        return $this->setProperty('doorTime', $doorTime);
228
    }
229
230
    /**
231
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
232
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
233
     *
234
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/duration
239
     */
240
    public function duration($duration)
241
    {
242
        return $this->setProperty('duration', $duration);
243
    }
244
245
    /**
246
     * The end date and time of the item (in [ISO 8601 date
247
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
248
     *
249
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/endDate
254
     */
255
    public function endDate($endDate)
256
    {
257
        return $this->setProperty('endDate', $endDate);
258
    }
259
260
    /**
261
     * An eventStatus of an event represents its status; particularly useful
262
     * when an event is cancelled or rescheduled.
263
     *
264
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/eventStatus
269
     */
270
    public function eventStatus($eventStatus)
271
    {
272
        return $this->setProperty('eventStatus', $eventStatus);
273
    }
274
275
    /**
276
     * A person or organization that supports (sponsors) something through some
277
     * kind of financial contribution.
278
     *
279
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
280
     *
281
     * @return static
282
     *
283
     * @see http://schema.org/funder
284
     */
285
    public function funder($funder)
286
    {
287
        return $this->setProperty('funder', $funder);
288
    }
289
290
    /**
291
     * The identifier property represents any kind of identifier for any kind of
292
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
293
     * dedicated properties for representing many of these, either as textual
294
     * strings or as URL (URI) links. See [background
295
     * notes](/docs/datamodel.html#identifierBg) for more details.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/identifier
302
     */
303
    public function identifier($identifier)
304
    {
305
        return $this->setProperty('identifier', $identifier);
306
    }
307
308
    /**
309
     * An image of the item. This can be a [[URL]] or a fully described
310
     * [[ImageObject]].
311
     *
312
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
313
     *
314
     * @return static
315
     *
316
     * @see http://schema.org/image
317
     */
318
    public function image($image)
319
    {
320
        return $this->setProperty('image', $image);
321
    }
322
323
    /**
324
     * The language of the content or performance or used in an action. Please
325
     * use one of the language codes from the [IETF BCP 47
326
     * standard](http://tools.ietf.org/html/bcp47). See also
327
     * [[availableLanguage]].
328
     *
329
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/inLanguage
334
     */
335
    public function inLanguage($inLanguage)
336
    {
337
        return $this->setProperty('inLanguage', $inLanguage);
338
    }
339
340
    /**
341
     * A flag to signal that the item, event, or place is accessible for free.
342
     *
343
     * @param bool|bool[] $isAccessibleForFree
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/isAccessibleForFree
348
     */
349
    public function isAccessibleForFree($isAccessibleForFree)
350
    {
351
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
352
    }
353
354
    /**
355
     * The location of for example where the event is happening, an organization
356
     * is located, or where an action takes place.
357
     *
358
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/location
363
     */
364
    public function location($location)
365
    {
366
        return $this->setProperty('location', $location);
367
    }
368
369
    /**
370
     * Indicates a page (or other CreativeWork) for which this thing is the main
371
     * entity being described. See [background
372
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
373
     *
374
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
375
     *
376
     * @return static
377
     *
378
     * @see http://schema.org/mainEntityOfPage
379
     */
380
    public function mainEntityOfPage($mainEntityOfPage)
381
    {
382
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
383
    }
384
385
    /**
386
     * The total number of individuals that may attend an event or venue.
387
     *
388
     * @param int|int[] $maximumAttendeeCapacity
389
     *
390
     * @return static
391
     *
392
     * @see http://schema.org/maximumAttendeeCapacity
393
     */
394
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
395
    {
396
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
397
    }
398
399
    /**
400
     * The name of the item.
401
     *
402
     * @param string|string[] $name
403
     *
404
     * @return static
405
     *
406
     * @see http://schema.org/name
407
     */
408
    public function name($name)
409
    {
410
        return $this->setProperty('name', $name);
411
    }
412
413
    /**
414
     * An offer to provide this item&#x2014;for example, an offer to sell a
415
     * product, rent the DVD of a movie, perform a service, or give away tickets
416
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
417
     * offered, i.e. sell, lease, etc. This property can also be used to
418
     * describe a [[Demand]]. While this property is listed as expected on a
419
     * number of common types, it can be used in others. In that case, using a
420
     * second type, such as Product or a subtype of Product, can clarify the
421
     * nature of the offer.
422
     *
423
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
424
     *
425
     * @return static
426
     *
427
     * @see http://schema.org/offers
428
     */
429
    public function offers($offers)
430
    {
431
        return $this->setProperty('offers', $offers);
432
    }
433
434
    /**
435
     * An organizer of an Event.
436
     *
437
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
438
     *
439
     * @return static
440
     *
441
     * @see http://schema.org/organizer
442
     */
443
    public function organizer($organizer)
444
    {
445
        return $this->setProperty('organizer', $organizer);
446
    }
447
448
    /**
449
     * A performer at the event&#x2014;for example, a presenter, musician,
450
     * musical group or actor.
451
     *
452
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
453
     *
454
     * @return static
455
     *
456
     * @see http://schema.org/performer
457
     */
458
    public function performer($performer)
459
    {
460
        return $this->setProperty('performer', $performer);
461
    }
462
463
    /**
464
     * The main performer or performers of the event&#x2014;for example, a
465
     * presenter, musician, or actor.
466
     *
467
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
468
     *
469
     * @return static
470
     *
471
     * @see http://schema.org/performers
472
     */
473
    public function performers($performers)
474
    {
475
        return $this->setProperty('performers', $performers);
476
    }
477
478
    /**
479
     * Indicates a potential Action, which describes an idealized action in
480
     * which this thing would play an 'object' role.
481
     *
482
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
483
     *
484
     * @return static
485
     *
486
     * @see http://schema.org/potentialAction
487
     */
488
    public function potentialAction($potentialAction)
489
    {
490
        return $this->setProperty('potentialAction', $potentialAction);
491
    }
492
493
    /**
494
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
495
     * This property contains the previously scheduled start date. For
496
     * rescheduled events, the startDate property should be used for the newly
497
     * scheduled start date. In the (rare) case of an event that has been
498
     * postponed and rescheduled multiple times, this field may be repeated.
499
     *
500
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
501
     *
502
     * @return static
503
     *
504
     * @see http://schema.org/previousStartDate
505
     */
506
    public function previousStartDate($previousStartDate)
507
    {
508
        return $this->setProperty('previousStartDate', $previousStartDate);
509
    }
510
511
    /**
512
     * The CreativeWork that captured all or part of this Event.
513
     *
514
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
515
     *
516
     * @return static
517
     *
518
     * @see http://schema.org/recordedIn
519
     */
520
    public function recordedIn($recordedIn)
521
    {
522
        return $this->setProperty('recordedIn', $recordedIn);
523
    }
524
525
    /**
526
     * The number of attendee places for an event that remain unallocated.
527
     *
528
     * @param int|int[] $remainingAttendeeCapacity
529
     *
530
     * @return static
531
     *
532
     * @see http://schema.org/remainingAttendeeCapacity
533
     */
534
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
535
    {
536
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
537
    }
538
539
    /**
540
     * A review of the item.
541
     *
542
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
543
     *
544
     * @return static
545
     *
546
     * @see http://schema.org/review
547
     */
548
    public function review($review)
549
    {
550
        return $this->setProperty('review', $review);
551
    }
552
553
    /**
554
     * URL of a reference Web page that unambiguously indicates the item's
555
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
556
     * official website.
557
     *
558
     * @param string|string[] $sameAs
559
     *
560
     * @return static
561
     *
562
     * @see http://schema.org/sameAs
563
     */
564
    public function sameAs($sameAs)
565
    {
566
        return $this->setProperty('sameAs', $sameAs);
567
    }
568
569
    /**
570
     * A person or organization that supports a thing through a pledge, promise,
571
     * or financial contribution. e.g. a sponsor of a Medical Study or a
572
     * corporate sponsor of an event.
573
     *
574
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/sponsor
579
     */
580
    public function sponsor($sponsor)
581
    {
582
        return $this->setProperty('sponsor', $sponsor);
583
    }
584
585
    /**
586
     * The start date and time of the item (in [ISO 8601 date
587
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
588
     *
589
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
590
     *
591
     * @return static
592
     *
593
     * @see http://schema.org/startDate
594
     */
595
    public function startDate($startDate)
596
    {
597
        return $this->setProperty('startDate', $startDate);
598
    }
599
600
    /**
601
     * An Event that is part of this event. For example, a conference event
602
     * includes many presentations, each of which is a subEvent of the
603
     * conference.
604
     *
605
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
606
     *
607
     * @return static
608
     *
609
     * @see http://schema.org/subEvent
610
     */
611
    public function subEvent($subEvent)
612
    {
613
        return $this->setProperty('subEvent', $subEvent);
614
    }
615
616
    /**
617
     * Events that are a part of this event. For example, a conference event
618
     * includes many presentations, each subEvents of the conference.
619
     *
620
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
621
     *
622
     * @return static
623
     *
624
     * @see http://schema.org/subEvents
625
     */
626
    public function subEvents($subEvents)
627
    {
628
        return $this->setProperty('subEvents', $subEvents);
629
    }
630
631
    /**
632
     * A CreativeWork or Event about this Thing.
633
     *
634
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
635
     *
636
     * @return static
637
     *
638
     * @see http://schema.org/subjectOf
639
     */
640
    public function subjectOf($subjectOf)
641
    {
642
        return $this->setProperty('subjectOf', $subjectOf);
643
    }
644
645
    /**
646
     * An event that this event is a part of. For example, a collection of
647
     * individual music performances might each have a music festival as their
648
     * superEvent.
649
     *
650
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
651
     *
652
     * @return static
653
     *
654
     * @see http://schema.org/superEvent
655
     */
656
    public function superEvent($superEvent)
657
    {
658
        return $this->setProperty('superEvent', $superEvent);
659
    }
660
661
    /**
662
     * Organization or person who adapts a creative work to different languages,
663
     * regional differences and technical requirements of a target market, or
664
     * that translates during some event.
665
     *
666
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
667
     *
668
     * @return static
669
     *
670
     * @see http://schema.org/translator
671
     */
672
    public function translator($translator)
673
    {
674
        return $this->setProperty('translator', $translator);
675
    }
676
677
    /**
678
     * The typical expected age range, e.g. '7-9', '11-'.
679
     *
680
     * @param string|string[] $typicalAgeRange
681
     *
682
     * @return static
683
     *
684
     * @see http://schema.org/typicalAgeRange
685
     */
686
    public function typicalAgeRange($typicalAgeRange)
687
    {
688
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
689
    }
690
691
    /**
692
     * URL of the item.
693
     *
694
     * @param string|string[] $url
695
     *
696
     * @return static
697
     *
698
     * @see http://schema.org/url
699
     */
700
    public function url($url)
701
    {
702
        return $this->setProperty('url', $url);
703
    }
704
705
    /**
706
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
707
     *        Specific subproperties are available for workPerformed (e.g. a
708
     * play), or a workPresented (a Movie at a ScreeningEvent).
709
     *
710
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
711
     *
712
     * @return static
713
     *
714
     * @see http://schema.org/workFeatured
715
     */
716
    public function workFeatured($workFeatured)
717
    {
718
        return $this->setProperty('workFeatured', $workFeatured);
719
    }
720
721
    /**
722
     * A work performed in some event, for example a play performed in a
723
     * TheaterEvent.
724
     *
725
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
726
     *
727
     * @return static
728
     *
729
     * @see http://schema.org/workPerformed
730
     */
731
    public function workPerformed($workPerformed)
732
    {
733
        return $this->setProperty('workPerformed', $workPerformed);
734
    }
735
736
}
737

src/UserCheckins.php 1 location

@@ 18-736 (lines=719) @@
15
 * @see http://schema.org/UserCheckins
16
 *
17
 */
18
class UserCheckins extends BaseType implements UserCheckinsContract, EventContract, ThingContract, UserInteractionContract
19
{
20
    /**
21
     * The subject matter of the content.
22
     *
23
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
24
     *
25
     * @return static
26
     *
27
     * @see http://schema.org/about
28
     */
29
    public function about($about)
30
    {
31
        return $this->setProperty('about', $about);
32
    }
33
34
    /**
35
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
36
     * Actors can be associated with individual items or with a series, episode,
37
     * clip.
38
     *
39
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/actor
44
     */
45
    public function actor($actor)
46
    {
47
        return $this->setProperty('actor', $actor);
48
    }
49
50
    /**
51
     * An additional type for the item, typically used for adding more specific
52
     * types from external vocabularies in microdata syntax. This is a
53
     * relationship between something and a class that the thing is in. In RDFa
54
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
55
     * attribute - for multiple types. Schema.org tools may have only weaker
56
     * understanding of extra types, in particular those defined externally.
57
     *
58
     * @param string|string[] $additionalType
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/additionalType
63
     */
64
    public function additionalType($additionalType)
65
    {
66
        return $this->setProperty('additionalType', $additionalType);
67
    }
68
69
    /**
70
     * The overall rating, based on a collection of reviews or ratings, of the
71
     * item.
72
     *
73
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
74
     *
75
     * @return static
76
     *
77
     * @see http://schema.org/aggregateRating
78
     */
79
    public function aggregateRating($aggregateRating)
80
    {
81
        return $this->setProperty('aggregateRating', $aggregateRating);
82
    }
83
84
    /**
85
     * An alias for the item.
86
     *
87
     * @param string|string[] $alternateName
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/alternateName
92
     */
93
    public function alternateName($alternateName)
94
    {
95
        return $this->setProperty('alternateName', $alternateName);
96
    }
97
98
    /**
99
     * A person or organization attending the event.
100
     *
101
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/attendee
106
     */
107
    public function attendee($attendee)
108
    {
109
        return $this->setProperty('attendee', $attendee);
110
    }
111
112
    /**
113
     * A person attending the event.
114
     *
115
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/attendees
120
     */
121
    public function attendees($attendees)
122
    {
123
        return $this->setProperty('attendees', $attendees);
124
    }
125
126
    /**
127
     * An intended audience, i.e. a group for whom something was created.
128
     *
129
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/audience
134
     */
135
    public function audience($audience)
136
    {
137
        return $this->setProperty('audience', $audience);
138
    }
139
140
    /**
141
     * The person or organization who wrote a composition, or who is the
142
     * composer of a work performed at some event.
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/composer
149
     */
150
    public function composer($composer)
151
    {
152
        return $this->setProperty('composer', $composer);
153
    }
154
155
    /**
156
     * A secondary contributor to the CreativeWork or Event.
157
     *
158
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
159
     *
160
     * @return static
161
     *
162
     * @see http://schema.org/contributor
163
     */
164
    public function contributor($contributor)
165
    {
166
        return $this->setProperty('contributor', $contributor);
167
    }
168
169
    /**
170
     * A description of the item.
171
     *
172
     * @param string|string[] $description
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/description
177
     */
178
    public function description($description)
179
    {
180
        return $this->setProperty('description', $description);
181
    }
182
183
    /**
184
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
185
     * event. Directors can be associated with individual items or with a
186
     * series, episode, clip.
187
     *
188
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/director
193
     */
194
    public function director($director)
195
    {
196
        return $this->setProperty('director', $director);
197
    }
198
199
    /**
200
     * A sub property of description. A short description of the item used to
201
     * disambiguate from other, similar items. Information from other properties
202
     * (in particular, name) may be necessary for the description to be useful
203
     * for disambiguation.
204
     *
205
     * @param string|string[] $disambiguatingDescription
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/disambiguatingDescription
210
     */
211
    public function disambiguatingDescription($disambiguatingDescription)
212
    {
213
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
214
    }
215
216
    /**
217
     * The time admission will commence.
218
     *
219
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/doorTime
224
     */
225
    public function doorTime($doorTime)
226
    {
227
        return $this->setProperty('doorTime', $doorTime);
228
    }
229
230
    /**
231
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
232
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
233
     *
234
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/duration
239
     */
240
    public function duration($duration)
241
    {
242
        return $this->setProperty('duration', $duration);
243
    }
244
245
    /**
246
     * The end date and time of the item (in [ISO 8601 date
247
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
248
     *
249
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/endDate
254
     */
255
    public function endDate($endDate)
256
    {
257
        return $this->setProperty('endDate', $endDate);
258
    }
259
260
    /**
261
     * An eventStatus of an event represents its status; particularly useful
262
     * when an event is cancelled or rescheduled.
263
     *
264
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/eventStatus
269
     */
270
    public function eventStatus($eventStatus)
271
    {
272
        return $this->setProperty('eventStatus', $eventStatus);
273
    }
274
275
    /**
276
     * A person or organization that supports (sponsors) something through some
277
     * kind of financial contribution.
278
     *
279
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
280
     *
281
     * @return static
282
     *
283
     * @see http://schema.org/funder
284
     */
285
    public function funder($funder)
286
    {
287
        return $this->setProperty('funder', $funder);
288
    }
289
290
    /**
291
     * The identifier property represents any kind of identifier for any kind of
292
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
293
     * dedicated properties for representing many of these, either as textual
294
     * strings or as URL (URI) links. See [background
295
     * notes](/docs/datamodel.html#identifierBg) for more details.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/identifier
302
     */
303
    public function identifier($identifier)
304
    {
305
        return $this->setProperty('identifier', $identifier);
306
    }
307
308
    /**
309
     * An image of the item. This can be a [[URL]] or a fully described
310
     * [[ImageObject]].
311
     *
312
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
313
     *
314
     * @return static
315
     *
316
     * @see http://schema.org/image
317
     */
318
    public function image($image)
319
    {
320
        return $this->setProperty('image', $image);
321
    }
322
323
    /**
324
     * The language of the content or performance or used in an action. Please
325
     * use one of the language codes from the [IETF BCP 47
326
     * standard](http://tools.ietf.org/html/bcp47). See also
327
     * [[availableLanguage]].
328
     *
329
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/inLanguage
334
     */
335
    public function inLanguage($inLanguage)
336
    {
337
        return $this->setProperty('inLanguage', $inLanguage);
338
    }
339
340
    /**
341
     * A flag to signal that the item, event, or place is accessible for free.
342
     *
343
     * @param bool|bool[] $isAccessibleForFree
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/isAccessibleForFree
348
     */
349
    public function isAccessibleForFree($isAccessibleForFree)
350
    {
351
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
352
    }
353
354
    /**
355
     * The location of for example where the event is happening, an organization
356
     * is located, or where an action takes place.
357
     *
358
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/location
363
     */
364
    public function location($location)
365
    {
366
        return $this->setProperty('location', $location);
367
    }
368
369
    /**
370
     * Indicates a page (or other CreativeWork) for which this thing is the main
371
     * entity being described. See [background
372
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
373
     *
374
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
375
     *
376
     * @return static
377
     *
378
     * @see http://schema.org/mainEntityOfPage
379
     */
380
    public function mainEntityOfPage($mainEntityOfPage)
381
    {
382
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
383
    }
384
385
    /**
386
     * The total number of individuals that may attend an event or venue.
387
     *
388
     * @param int|int[] $maximumAttendeeCapacity
389
     *
390
     * @return static
391
     *
392
     * @see http://schema.org/maximumAttendeeCapacity
393
     */
394
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
395
    {
396
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
397
    }
398
399
    /**
400
     * The name of the item.
401
     *
402
     * @param string|string[] $name
403
     *
404
     * @return static
405
     *
406
     * @see http://schema.org/name
407
     */
408
    public function name($name)
409
    {
410
        return $this->setProperty('name', $name);
411
    }
412
413
    /**
414
     * An offer to provide this item&#x2014;for example, an offer to sell a
415
     * product, rent the DVD of a movie, perform a service, or give away tickets
416
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
417
     * offered, i.e. sell, lease, etc. This property can also be used to
418
     * describe a [[Demand]]. While this property is listed as expected on a
419
     * number of common types, it can be used in others. In that case, using a
420
     * second type, such as Product or a subtype of Product, can clarify the
421
     * nature of the offer.
422
     *
423
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
424
     *
425
     * @return static
426
     *
427
     * @see http://schema.org/offers
428
     */
429
    public function offers($offers)
430
    {
431
        return $this->setProperty('offers', $offers);
432
    }
433
434
    /**
435
     * An organizer of an Event.
436
     *
437
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
438
     *
439
     * @return static
440
     *
441
     * @see http://schema.org/organizer
442
     */
443
    public function organizer($organizer)
444
    {
445
        return $this->setProperty('organizer', $organizer);
446
    }
447
448
    /**
449
     * A performer at the event&#x2014;for example, a presenter, musician,
450
     * musical group or actor.
451
     *
452
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
453
     *
454
     * @return static
455
     *
456
     * @see http://schema.org/performer
457
     */
458
    public function performer($performer)
459
    {
460
        return $this->setProperty('performer', $performer);
461
    }
462
463
    /**
464
     * The main performer or performers of the event&#x2014;for example, a
465
     * presenter, musician, or actor.
466
     *
467
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
468
     *
469
     * @return static
470
     *
471
     * @see http://schema.org/performers
472
     */
473
    public function performers($performers)
474
    {
475
        return $this->setProperty('performers', $performers);
476
    }
477
478
    /**
479
     * Indicates a potential Action, which describes an idealized action in
480
     * which this thing would play an 'object' role.
481
     *
482
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
483
     *
484
     * @return static
485
     *
486
     * @see http://schema.org/potentialAction
487
     */
488
    public function potentialAction($potentialAction)
489
    {
490
        return $this->setProperty('potentialAction', $potentialAction);
491
    }
492
493
    /**
494
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
495
     * This property contains the previously scheduled start date. For
496
     * rescheduled events, the startDate property should be used for the newly
497
     * scheduled start date. In the (rare) case of an event that has been
498
     * postponed and rescheduled multiple times, this field may be repeated.
499
     *
500
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
501
     *
502
     * @return static
503
     *
504
     * @see http://schema.org/previousStartDate
505
     */
506
    public function previousStartDate($previousStartDate)
507
    {
508
        return $this->setProperty('previousStartDate', $previousStartDate);
509
    }
510
511
    /**
512
     * The CreativeWork that captured all or part of this Event.
513
     *
514
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
515
     *
516
     * @return static
517
     *
518
     * @see http://schema.org/recordedIn
519
     */
520
    public function recordedIn($recordedIn)
521
    {
522
        return $this->setProperty('recordedIn', $recordedIn);
523
    }
524
525
    /**
526
     * The number of attendee places for an event that remain unallocated.
527
     *
528
     * @param int|int[] $remainingAttendeeCapacity
529
     *
530
     * @return static
531
     *
532
     * @see http://schema.org/remainingAttendeeCapacity
533
     */
534
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
535
    {
536
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
537
    }
538
539
    /**
540
     * A review of the item.
541
     *
542
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
543
     *
544
     * @return static
545
     *
546
     * @see http://schema.org/review
547
     */
548
    public function review($review)
549
    {
550
        return $this->setProperty('review', $review);
551
    }
552
553
    /**
554
     * URL of a reference Web page that unambiguously indicates the item's
555
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
556
     * official website.
557
     *
558
     * @param string|string[] $sameAs
559
     *
560
     * @return static
561
     *
562
     * @see http://schema.org/sameAs
563
     */
564
    public function sameAs($sameAs)
565
    {
566
        return $this->setProperty('sameAs', $sameAs);
567
    }
568
569
    /**
570
     * A person or organization that supports a thing through a pledge, promise,
571
     * or financial contribution. e.g. a sponsor of a Medical Study or a
572
     * corporate sponsor of an event.
573
     *
574
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/sponsor
579
     */
580
    public function sponsor($sponsor)
581
    {
582
        return $this->setProperty('sponsor', $sponsor);
583
    }
584
585
    /**
586
     * The start date and time of the item (in [ISO 8601 date
587
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
588
     *
589
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
590
     *
591
     * @return static
592
     *
593
     * @see http://schema.org/startDate
594
     */
595
    public function startDate($startDate)
596
    {
597
        return $this->setProperty('startDate', $startDate);
598
    }
599
600
    /**
601
     * An Event that is part of this event. For example, a conference event
602
     * includes many presentations, each of which is a subEvent of the
603
     * conference.
604
     *
605
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
606
     *
607
     * @return static
608
     *
609
     * @see http://schema.org/subEvent
610
     */
611
    public function subEvent($subEvent)
612
    {
613
        return $this->setProperty('subEvent', $subEvent);
614
    }
615
616
    /**
617
     * Events that are a part of this event. For example, a conference event
618
     * includes many presentations, each subEvents of the conference.
619
     *
620
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
621
     *
622
     * @return static
623
     *
624
     * @see http://schema.org/subEvents
625
     */
626
    public function subEvents($subEvents)
627
    {
628
        return $this->setProperty('subEvents', $subEvents);
629
    }
630
631
    /**
632
     * A CreativeWork or Event about this Thing.
633
     *
634
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
635
     *
636
     * @return static
637
     *
638
     * @see http://schema.org/subjectOf
639
     */
640
    public function subjectOf($subjectOf)
641
    {
642
        return $this->setProperty('subjectOf', $subjectOf);
643
    }
644
645
    /**
646
     * An event that this event is a part of. For example, a collection of
647
     * individual music performances might each have a music festival as their
648
     * superEvent.
649
     *
650
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
651
     *
652
     * @return static
653
     *
654
     * @see http://schema.org/superEvent
655
     */
656
    public function superEvent($superEvent)
657
    {
658
        return $this->setProperty('superEvent', $superEvent);
659
    }
660
661
    /**
662
     * Organization or person who adapts a creative work to different languages,
663
     * regional differences and technical requirements of a target market, or
664
     * that translates during some event.
665
     *
666
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
667
     *
668
     * @return static
669
     *
670
     * @see http://schema.org/translator
671
     */
672
    public function translator($translator)
673
    {
674
        return $this->setProperty('translator', $translator);
675
    }
676
677
    /**
678
     * The typical expected age range, e.g. '7-9', '11-'.
679
     *
680
     * @param string|string[] $typicalAgeRange
681
     *
682
     * @return static
683
     *
684
     * @see http://schema.org/typicalAgeRange
685
     */
686
    public function typicalAgeRange($typicalAgeRange)
687
    {
688
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
689
    }
690
691
    /**
692
     * URL of the item.
693
     *
694
     * @param string|string[] $url
695
     *
696
     * @return static
697
     *
698
     * @see http://schema.org/url
699
     */
700
    public function url($url)
701
    {
702
        return $this->setProperty('url', $url);
703
    }
704
705
    /**
706
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
707
     *        Specific subproperties are available for workPerformed (e.g. a
708
     * play), or a workPresented (a Movie at a ScreeningEvent).
709
     *
710
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
711
     *
712
     * @return static
713
     *
714
     * @see http://schema.org/workFeatured
715
     */
716
    public function workFeatured($workFeatured)
717
    {
718
        return $this->setProperty('workFeatured', $workFeatured);
719
    }
720
721
    /**
722
     * A work performed in some event, for example a play performed in a
723
     * TheaterEvent.
724
     *
725
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
726
     *
727
     * @return static
728
     *
729
     * @see http://schema.org/workPerformed
730
     */
731
    public function workPerformed($workPerformed)
732
    {
733
        return $this->setProperty('workPerformed', $workPerformed);
734
    }
735
736
}
737

src/UserDownloads.php 1 location

@@ 18-736 (lines=719) @@
15
 * @see http://schema.org/UserDownloads
16
 *
17
 */
18
class UserDownloads extends BaseType implements UserDownloadsContract, EventContract, ThingContract, UserInteractionContract
19
{
20
    /**
21
     * The subject matter of the content.
22
     *
23
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
24
     *
25
     * @return static
26
     *
27
     * @see http://schema.org/about
28
     */
29
    public function about($about)
30
    {
31
        return $this->setProperty('about', $about);
32
    }
33
34
    /**
35
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
36
     * Actors can be associated with individual items or with a series, episode,
37
     * clip.
38
     *
39
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/actor
44
     */
45
    public function actor($actor)
46
    {
47
        return $this->setProperty('actor', $actor);
48
    }
49
50
    /**
51
     * An additional type for the item, typically used for adding more specific
52
     * types from external vocabularies in microdata syntax. This is a
53
     * relationship between something and a class that the thing is in. In RDFa
54
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
55
     * attribute - for multiple types. Schema.org tools may have only weaker
56
     * understanding of extra types, in particular those defined externally.
57
     *
58
     * @param string|string[] $additionalType
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/additionalType
63
     */
64
    public function additionalType($additionalType)
65
    {
66
        return $this->setProperty('additionalType', $additionalType);
67
    }
68
69
    /**
70
     * The overall rating, based on a collection of reviews or ratings, of the
71
     * item.
72
     *
73
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
74
     *
75
     * @return static
76
     *
77
     * @see http://schema.org/aggregateRating
78
     */
79
    public function aggregateRating($aggregateRating)
80
    {
81
        return $this->setProperty('aggregateRating', $aggregateRating);
82
    }
83
84
    /**
85
     * An alias for the item.
86
     *
87
     * @param string|string[] $alternateName
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/alternateName
92
     */
93
    public function alternateName($alternateName)
94
    {
95
        return $this->setProperty('alternateName', $alternateName);
96
    }
97
98
    /**
99
     * A person or organization attending the event.
100
     *
101
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/attendee
106
     */
107
    public function attendee($attendee)
108
    {
109
        return $this->setProperty('attendee', $attendee);
110
    }
111
112
    /**
113
     * A person attending the event.
114
     *
115
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/attendees
120
     */
121
    public function attendees($attendees)
122
    {
123
        return $this->setProperty('attendees', $attendees);
124
    }
125
126
    /**
127
     * An intended audience, i.e. a group for whom something was created.
128
     *
129
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/audience
134
     */
135
    public function audience($audience)
136
    {
137
        return $this->setProperty('audience', $audience);
138
    }
139
140
    /**
141
     * The person or organization who wrote a composition, or who is the
142
     * composer of a work performed at some event.
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/composer
149
     */
150
    public function composer($composer)
151
    {
152
        return $this->setProperty('composer', $composer);
153
    }
154
155
    /**
156
     * A secondary contributor to the CreativeWork or Event.
157
     *
158
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
159
     *
160
     * @return static
161
     *
162
     * @see http://schema.org/contributor
163
     */
164
    public function contributor($contributor)
165
    {
166
        return $this->setProperty('contributor', $contributor);
167
    }
168
169
    /**
170
     * A description of the item.
171
     *
172
     * @param string|string[] $description
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/description
177
     */
178
    public function description($description)
179
    {
180
        return $this->setProperty('description', $description);
181
    }
182
183
    /**
184
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
185
     * event. Directors can be associated with individual items or with a
186
     * series, episode, clip.
187
     *
188
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/director
193
     */
194
    public function director($director)
195
    {
196
        return $this->setProperty('director', $director);
197
    }
198
199
    /**
200
     * A sub property of description. A short description of the item used to
201
     * disambiguate from other, similar items. Information from other properties
202
     * (in particular, name) may be necessary for the description to be useful
203
     * for disambiguation.
204
     *
205
     * @param string|string[] $disambiguatingDescription
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/disambiguatingDescription
210
     */
211
    public function disambiguatingDescription($disambiguatingDescription)
212
    {
213
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
214
    }
215
216
    /**
217
     * The time admission will commence.
218
     *
219
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/doorTime
224
     */
225
    public function doorTime($doorTime)
226
    {
227
        return $this->setProperty('doorTime', $doorTime);
228
    }
229
230
    /**
231
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
232
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
233
     *
234
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/duration
239
     */
240
    public function duration($duration)
241
    {
242
        return $this->setProperty('duration', $duration);
243
    }
244
245
    /**
246
     * The end date and time of the item (in [ISO 8601 date
247
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
248
     *
249
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/endDate
254
     */
255
    public function endDate($endDate)
256
    {
257
        return $this->setProperty('endDate', $endDate);
258
    }
259
260
    /**
261
     * An eventStatus of an event represents its status; particularly useful
262
     * when an event is cancelled or rescheduled.
263
     *
264
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/eventStatus
269
     */
270
    public function eventStatus($eventStatus)
271
    {
272
        return $this->setProperty('eventStatus', $eventStatus);
273
    }
274
275
    /**
276
     * A person or organization that supports (sponsors) something through some
277
     * kind of financial contribution.
278
     *
279
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
280
     *
281
     * @return static
282
     *
283
     * @see http://schema.org/funder
284
     */
285
    public function funder($funder)
286
    {
287
        return $this->setProperty('funder', $funder);
288
    }
289
290
    /**
291
     * The identifier property represents any kind of identifier for any kind of
292
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
293
     * dedicated properties for representing many of these, either as textual
294
     * strings or as URL (URI) links. See [background
295
     * notes](/docs/datamodel.html#identifierBg) for more details.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/identifier
302
     */
303
    public function identifier($identifier)
304
    {
305
        return $this->setProperty('identifier', $identifier);
306
    }
307
308
    /**
309
     * An image of the item. This can be a [[URL]] or a fully described
310
     * [[ImageObject]].
311
     *
312
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
313
     *
314
     * @return static
315
     *
316
     * @see http://schema.org/image
317
     */
318
    public function image($image)
319
    {
320
        return $this->setProperty('image', $image);
321
    }
322
323
    /**
324
     * The language of the content or performance or used in an action. Please
325
     * use one of the language codes from the [IETF BCP 47
326
     * standard](http://tools.ietf.org/html/bcp47). See also
327
     * [[availableLanguage]].
328
     *
329
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/inLanguage
334
     */
335
    public function inLanguage($inLanguage)
336
    {
337
        return $this->setProperty('inLanguage', $inLanguage);
338
    }
339
340
    /**
341
     * A flag to signal that the item, event, or place is accessible for free.
342
     *
343
     * @param bool|bool[] $isAccessibleForFree
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/isAccessibleForFree
348
     */
349
    public function isAccessibleForFree($isAccessibleForFree)
350
    {
351
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
352
    }
353
354
    /**
355
     * The location of for example where the event is happening, an organization
356
     * is located, or where an action takes place.
357
     *
358
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/location
363
     */
364
    public function location($location)
365
    {
366
        return $this->setProperty('location', $location);
367
    }
368
369
    /**
370
     * Indicates a page (or other CreativeWork) for which this thing is the main
371
     * entity being described. See [background
372
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
373
     *
374
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
375
     *
376
     * @return static
377
     *
378
     * @see http://schema.org/mainEntityOfPage
379
     */
380
    public function mainEntityOfPage($mainEntityOfPage)
381
    {
382
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
383
    }
384
385
    /**
386
     * The total number of individuals that may attend an event or venue.
387
     *
388
     * @param int|int[] $maximumAttendeeCapacity
389
     *
390
     * @return static
391
     *
392
     * @see http://schema.org/maximumAttendeeCapacity
393
     */
394
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
395
    {
396
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
397
    }
398
399
    /**
400
     * The name of the item.
401
     *
402
     * @param string|string[] $name
403
     *
404
     * @return static
405
     *
406
     * @see http://schema.org/name
407
     */
408
    public function name($name)
409
    {
410
        return $this->setProperty('name', $name);
411
    }
412
413
    /**
414
     * An offer to provide this item&#x2014;for example, an offer to sell a
415
     * product, rent the DVD of a movie, perform a service, or give away tickets
416
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
417
     * offered, i.e. sell, lease, etc. This property can also be used to
418
     * describe a [[Demand]]. While this property is listed as expected on a
419
     * number of common types, it can be used in others. In that case, using a
420
     * second type, such as Product or a subtype of Product, can clarify the
421
     * nature of the offer.
422
     *
423
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
424
     *
425
     * @return static
426
     *
427
     * @see http://schema.org/offers
428
     */
429
    public function offers($offers)
430
    {
431
        return $this->setProperty('offers', $offers);
432
    }
433
434
    /**
435
     * An organizer of an Event.
436
     *
437
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
438
     *
439
     * @return static
440
     *
441
     * @see http://schema.org/organizer
442
     */
443
    public function organizer($organizer)
444
    {
445
        return $this->setProperty('organizer', $organizer);
446
    }
447
448
    /**
449
     * A performer at the event&#x2014;for example, a presenter, musician,
450
     * musical group or actor.
451
     *
452
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
453
     *
454
     * @return static
455
     *
456
     * @see http://schema.org/performer
457
     */
458
    public function performer($performer)
459
    {
460
        return $this->setProperty('performer', $performer);
461
    }
462
463
    /**
464
     * The main performer or performers of the event&#x2014;for example, a
465
     * presenter, musician, or actor.
466
     *
467
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
468
     *
469
     * @return static
470
     *
471
     * @see http://schema.org/performers
472
     */
473
    public function performers($performers)
474
    {
475
        return $this->setProperty('performers', $performers);
476
    }
477
478
    /**
479
     * Indicates a potential Action, which describes an idealized action in
480
     * which this thing would play an 'object' role.
481
     *
482
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
483
     *
484
     * @return static
485
     *
486
     * @see http://schema.org/potentialAction
487
     */
488
    public function potentialAction($potentialAction)
489
    {
490
        return $this->setProperty('potentialAction', $potentialAction);
491
    }
492
493
    /**
494
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
495
     * This property contains the previously scheduled start date. For
496
     * rescheduled events, the startDate property should be used for the newly
497
     * scheduled start date. In the (rare) case of an event that has been
498
     * postponed and rescheduled multiple times, this field may be repeated.
499
     *
500
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
501
     *
502
     * @return static
503
     *
504
     * @see http://schema.org/previousStartDate
505
     */
506
    public function previousStartDate($previousStartDate)
507
    {
508
        return $this->setProperty('previousStartDate', $previousStartDate);
509
    }
510
511
    /**
512
     * The CreativeWork that captured all or part of this Event.
513
     *
514
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
515
     *
516
     * @return static
517
     *
518
     * @see http://schema.org/recordedIn
519
     */
520
    public function recordedIn($recordedIn)
521
    {
522
        return $this->setProperty('recordedIn', $recordedIn);
523
    }
524
525
    /**
526
     * The number of attendee places for an event that remain unallocated.
527
     *
528
     * @param int|int[] $remainingAttendeeCapacity
529
     *
530
     * @return static
531
     *
532
     * @see http://schema.org/remainingAttendeeCapacity
533
     */
534
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
535
    {
536
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
537
    }
538
539
    /**
540
     * A review of the item.
541
     *
542
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
543
     *
544
     * @return static
545
     *
546
     * @see http://schema.org/review
547
     */
548
    public function review($review)
549
    {
550
        return $this->setProperty('review', $review);
551
    }
552
553
    /**
554
     * URL of a reference Web page that unambiguously indicates the item's
555
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
556
     * official website.
557
     *
558
     * @param string|string[] $sameAs
559
     *
560
     * @return static
561
     *
562
     * @see http://schema.org/sameAs
563
     */
564
    public function sameAs($sameAs)
565
    {
566
        return $this->setProperty('sameAs', $sameAs);
567
    }
568
569
    /**
570
     * A person or organization that supports a thing through a pledge, promise,
571
     * or financial contribution. e.g. a sponsor of a Medical Study or a
572
     * corporate sponsor of an event.
573
     *
574
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/sponsor
579
     */
580
    public function sponsor($sponsor)
581
    {
582
        return $this->setProperty('sponsor', $sponsor);
583
    }
584
585
    /**
586
     * The start date and time of the item (in [ISO 8601 date
587
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
588
     *
589
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
590
     *
591
     * @return static
592
     *
593
     * @see http://schema.org/startDate
594
     */
595
    public function startDate($startDate)
596
    {
597
        return $this->setProperty('startDate', $startDate);
598
    }
599
600
    /**
601
     * An Event that is part of this event. For example, a conference event
602
     * includes many presentations, each of which is a subEvent of the
603
     * conference.
604
     *
605
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
606
     *
607
     * @return static
608
     *
609
     * @see http://schema.org/subEvent
610
     */
611
    public function subEvent($subEvent)
612
    {
613
        return $this->setProperty('subEvent', $subEvent);
614
    }
615
616
    /**
617
     * Events that are a part of this event. For example, a conference event
618
     * includes many presentations, each subEvents of the conference.
619
     *
620
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
621
     *
622
     * @return static
623
     *
624
     * @see http://schema.org/subEvents
625
     */
626
    public function subEvents($subEvents)
627
    {
628
        return $this->setProperty('subEvents', $subEvents);
629
    }
630
631
    /**
632
     * A CreativeWork or Event about this Thing.
633
     *
634
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
635
     *
636
     * @return static
637
     *
638
     * @see http://schema.org/subjectOf
639
     */
640
    public function subjectOf($subjectOf)
641
    {
642
        return $this->setProperty('subjectOf', $subjectOf);
643
    }
644
645
    /**
646
     * An event that this event is a part of. For example, a collection of
647
     * individual music performances might each have a music festival as their
648
     * superEvent.
649
     *
650
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
651
     *
652
     * @return static
653
     *
654
     * @see http://schema.org/superEvent
655
     */
656
    public function superEvent($superEvent)
657
    {
658
        return $this->setProperty('superEvent', $superEvent);
659
    }
660
661
    /**
662
     * Organization or person who adapts a creative work to different languages,
663
     * regional differences and technical requirements of a target market, or
664
     * that translates during some event.
665
     *
666
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
667
     *
668
     * @return static
669
     *
670
     * @see http://schema.org/translator
671
     */
672
    public function translator($translator)
673
    {
674
        return $this->setProperty('translator', $translator);
675
    }
676
677
    /**
678
     * The typical expected age range, e.g. '7-9', '11-'.
679
     *
680
     * @param string|string[] $typicalAgeRange
681
     *
682
     * @return static
683
     *
684
     * @see http://schema.org/typicalAgeRange
685
     */
686
    public function typicalAgeRange($typicalAgeRange)
687
    {
688
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
689
    }
690
691
    /**
692
     * URL of the item.
693
     *
694
     * @param string|string[] $url
695
     *
696
     * @return static
697
     *
698
     * @see http://schema.org/url
699
     */
700
    public function url($url)
701
    {
702
        return $this->setProperty('url', $url);
703
    }
704
705
    /**
706
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
707
     *        Specific subproperties are available for workPerformed (e.g. a
708
     * play), or a workPresented (a Movie at a ScreeningEvent).
709
     *
710
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
711
     *
712
     * @return static
713
     *
714
     * @see http://schema.org/workFeatured
715
     */
716
    public function workFeatured($workFeatured)
717
    {
718
        return $this->setProperty('workFeatured', $workFeatured);
719
    }
720
721
    /**
722
     * A work performed in some event, for example a play performed in a
723
     * TheaterEvent.
724
     *
725
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
726
     *
727
     * @return static
728
     *
729
     * @see http://schema.org/workPerformed
730
     */
731
    public function workPerformed($workPerformed)
732
    {
733
        return $this->setProperty('workPerformed', $workPerformed);
734
    }
735
736
}
737

src/UserInteraction.php 1 location

@@ 17-735 (lines=719) @@
14
 * @see http://schema.org/UserInteraction
15
 *
16
 */
17
class UserInteraction extends BaseType implements UserInteractionContract, EventContract, ThingContract
18
{
19
    /**
20
     * The subject matter of the content.
21
     *
22
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
23
     *
24
     * @return static
25
     *
26
     * @see http://schema.org/about
27
     */
28
    public function about($about)
29
    {
30
        return $this->setProperty('about', $about);
31
    }
32
33
    /**
34
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
35
     * Actors can be associated with individual items or with a series, episode,
36
     * clip.
37
     *
38
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
39
     *
40
     * @return static
41
     *
42
     * @see http://schema.org/actor
43
     */
44
    public function actor($actor)
45
    {
46
        return $this->setProperty('actor', $actor);
47
    }
48
49
    /**
50
     * An additional type for the item, typically used for adding more specific
51
     * types from external vocabularies in microdata syntax. This is a
52
     * relationship between something and a class that the thing is in. In RDFa
53
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
54
     * attribute - for multiple types. Schema.org tools may have only weaker
55
     * understanding of extra types, in particular those defined externally.
56
     *
57
     * @param string|string[] $additionalType
58
     *
59
     * @return static
60
     *
61
     * @see http://schema.org/additionalType
62
     */
63
    public function additionalType($additionalType)
64
    {
65
        return $this->setProperty('additionalType', $additionalType);
66
    }
67
68
    /**
69
     * The overall rating, based on a collection of reviews or ratings, of the
70
     * item.
71
     *
72
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
73
     *
74
     * @return static
75
     *
76
     * @see http://schema.org/aggregateRating
77
     */
78
    public function aggregateRating($aggregateRating)
79
    {
80
        return $this->setProperty('aggregateRating', $aggregateRating);
81
    }
82
83
    /**
84
     * An alias for the item.
85
     *
86
     * @param string|string[] $alternateName
87
     *
88
     * @return static
89
     *
90
     * @see http://schema.org/alternateName
91
     */
92
    public function alternateName($alternateName)
93
    {
94
        return $this->setProperty('alternateName', $alternateName);
95
    }
96
97
    /**
98
     * A person or organization attending the event.
99
     *
100
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
101
     *
102
     * @return static
103
     *
104
     * @see http://schema.org/attendee
105
     */
106
    public function attendee($attendee)
107
    {
108
        return $this->setProperty('attendee', $attendee);
109
    }
110
111
    /**
112
     * A person attending the event.
113
     *
114
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
115
     *
116
     * @return static
117
     *
118
     * @see http://schema.org/attendees
119
     */
120
    public function attendees($attendees)
121
    {
122
        return $this->setProperty('attendees', $attendees);
123
    }
124
125
    /**
126
     * An intended audience, i.e. a group for whom something was created.
127
     *
128
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/audience
133
     */
134
    public function audience($audience)
135
    {
136
        return $this->setProperty('audience', $audience);
137
    }
138
139
    /**
140
     * The person or organization who wrote a composition, or who is the
141
     * composer of a work performed at some event.
142
     *
143
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
144
     *
145
     * @return static
146
     *
147
     * @see http://schema.org/composer
148
     */
149
    public function composer($composer)
150
    {
151
        return $this->setProperty('composer', $composer);
152
    }
153
154
    /**
155
     * A secondary contributor to the CreativeWork or Event.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/contributor
162
     */
163
    public function contributor($contributor)
164
    {
165
        return $this->setProperty('contributor', $contributor);
166
    }
167
168
    /**
169
     * A description of the item.
170
     *
171
     * @param string|string[] $description
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/description
176
     */
177
    public function description($description)
178
    {
179
        return $this->setProperty('description', $description);
180
    }
181
182
    /**
183
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
184
     * event. Directors can be associated with individual items or with a
185
     * series, episode, clip.
186
     *
187
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
188
     *
189
     * @return static
190
     *
191
     * @see http://schema.org/director
192
     */
193
    public function director($director)
194
    {
195
        return $this->setProperty('director', $director);
196
    }
197
198
    /**
199
     * A sub property of description. A short description of the item used to
200
     * disambiguate from other, similar items. Information from other properties
201
     * (in particular, name) may be necessary for the description to be useful
202
     * for disambiguation.
203
     *
204
     * @param string|string[] $disambiguatingDescription
205
     *
206
     * @return static
207
     *
208
     * @see http://schema.org/disambiguatingDescription
209
     */
210
    public function disambiguatingDescription($disambiguatingDescription)
211
    {
212
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
213
    }
214
215
    /**
216
     * The time admission will commence.
217
     *
218
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/doorTime
223
     */
224
    public function doorTime($doorTime)
225
    {
226
        return $this->setProperty('doorTime', $doorTime);
227
    }
228
229
    /**
230
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
231
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
232
     *
233
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
234
     *
235
     * @return static
236
     *
237
     * @see http://schema.org/duration
238
     */
239
    public function duration($duration)
240
    {
241
        return $this->setProperty('duration', $duration);
242
    }
243
244
    /**
245
     * The end date and time of the item (in [ISO 8601 date
246
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
247
     *
248
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
249
     *
250
     * @return static
251
     *
252
     * @see http://schema.org/endDate
253
     */
254
    public function endDate($endDate)
255
    {
256
        return $this->setProperty('endDate', $endDate);
257
    }
258
259
    /**
260
     * An eventStatus of an event represents its status; particularly useful
261
     * when an event is cancelled or rescheduled.
262
     *
263
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
264
     *
265
     * @return static
266
     *
267
     * @see http://schema.org/eventStatus
268
     */
269
    public function eventStatus($eventStatus)
270
    {
271
        return $this->setProperty('eventStatus', $eventStatus);
272
    }
273
274
    /**
275
     * A person or organization that supports (sponsors) something through some
276
     * kind of financial contribution.
277
     *
278
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
279
     *
280
     * @return static
281
     *
282
     * @see http://schema.org/funder
283
     */
284
    public function funder($funder)
285
    {
286
        return $this->setProperty('funder', $funder);
287
    }
288
289
    /**
290
     * The identifier property represents any kind of identifier for any kind of
291
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
292
     * dedicated properties for representing many of these, either as textual
293
     * strings or as URL (URI) links. See [background
294
     * notes](/docs/datamodel.html#identifierBg) for more details.
295
     *
296
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
297
     *
298
     * @return static
299
     *
300
     * @see http://schema.org/identifier
301
     */
302
    public function identifier($identifier)
303
    {
304
        return $this->setProperty('identifier', $identifier);
305
    }
306
307
    /**
308
     * An image of the item. This can be a [[URL]] or a fully described
309
     * [[ImageObject]].
310
     *
311
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
312
     *
313
     * @return static
314
     *
315
     * @see http://schema.org/image
316
     */
317
    public function image($image)
318
    {
319
        return $this->setProperty('image', $image);
320
    }
321
322
    /**
323
     * The language of the content or performance or used in an action. Please
324
     * use one of the language codes from the [IETF BCP 47
325
     * standard](http://tools.ietf.org/html/bcp47). See also
326
     * [[availableLanguage]].
327
     *
328
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
329
     *
330
     * @return static
331
     *
332
     * @see http://schema.org/inLanguage
333
     */
334
    public function inLanguage($inLanguage)
335
    {
336
        return $this->setProperty('inLanguage', $inLanguage);
337
    }
338
339
    /**
340
     * A flag to signal that the item, event, or place is accessible for free.
341
     *
342
     * @param bool|bool[] $isAccessibleForFree
343
     *
344
     * @return static
345
     *
346
     * @see http://schema.org/isAccessibleForFree
347
     */
348
    public function isAccessibleForFree($isAccessibleForFree)
349
    {
350
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
351
    }
352
353
    /**
354
     * The location of for example where the event is happening, an organization
355
     * is located, or where an action takes place.
356
     *
357
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
358
     *
359
     * @return static
360
     *
361
     * @see http://schema.org/location
362
     */
363
    public function location($location)
364
    {
365
        return $this->setProperty('location', $location);
366
    }
367
368
    /**
369
     * Indicates a page (or other CreativeWork) for which this thing is the main
370
     * entity being described. See [background
371
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
372
     *
373
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/mainEntityOfPage
378
     */
379
    public function mainEntityOfPage($mainEntityOfPage)
380
    {
381
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
382
    }
383
384
    /**
385
     * The total number of individuals that may attend an event or venue.
386
     *
387
     * @param int|int[] $maximumAttendeeCapacity
388
     *
389
     * @return static
390
     *
391
     * @see http://schema.org/maximumAttendeeCapacity
392
     */
393
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
394
    {
395
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
396
    }
397
398
    /**
399
     * The name of the item.
400
     *
401
     * @param string|string[] $name
402
     *
403
     * @return static
404
     *
405
     * @see http://schema.org/name
406
     */
407
    public function name($name)
408
    {
409
        return $this->setProperty('name', $name);
410
    }
411
412
    /**
413
     * An offer to provide this item&#x2014;for example, an offer to sell a
414
     * product, rent the DVD of a movie, perform a service, or give away tickets
415
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
416
     * offered, i.e. sell, lease, etc. This property can also be used to
417
     * describe a [[Demand]]. While this property is listed as expected on a
418
     * number of common types, it can be used in others. In that case, using a
419
     * second type, such as Product or a subtype of Product, can clarify the
420
     * nature of the offer.
421
     *
422
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
423
     *
424
     * @return static
425
     *
426
     * @see http://schema.org/offers
427
     */
428
    public function offers($offers)
429
    {
430
        return $this->setProperty('offers', $offers);
431
    }
432
433
    /**
434
     * An organizer of an Event.
435
     *
436
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
437
     *
438
     * @return static
439
     *
440
     * @see http://schema.org/organizer
441
     */
442
    public function organizer($organizer)
443
    {
444
        return $this->setProperty('organizer', $organizer);
445
    }
446
447
    /**
448
     * A performer at the event&#x2014;for example, a presenter, musician,
449
     * musical group or actor.
450
     *
451
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
452
     *
453
     * @return static
454
     *
455
     * @see http://schema.org/performer
456
     */
457
    public function performer($performer)
458
    {
459
        return $this->setProperty('performer', $performer);
460
    }
461
462
    /**
463
     * The main performer or performers of the event&#x2014;for example, a
464
     * presenter, musician, or actor.
465
     *
466
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
467
     *
468
     * @return static
469
     *
470
     * @see http://schema.org/performers
471
     */
472
    public function performers($performers)
473
    {
474
        return $this->setProperty('performers', $performers);
475
    }
476
477
    /**
478
     * Indicates a potential Action, which describes an idealized action in
479
     * which this thing would play an 'object' role.
480
     *
481
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
482
     *
483
     * @return static
484
     *
485
     * @see http://schema.org/potentialAction
486
     */
487
    public function potentialAction($potentialAction)
488
    {
489
        return $this->setProperty('potentialAction', $potentialAction);
490
    }
491
492
    /**
493
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
494
     * This property contains the previously scheduled start date. For
495
     * rescheduled events, the startDate property should be used for the newly
496
     * scheduled start date. In the (rare) case of an event that has been
497
     * postponed and rescheduled multiple times, this field may be repeated.
498
     *
499
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
500
     *
501
     * @return static
502
     *
503
     * @see http://schema.org/previousStartDate
504
     */
505
    public function previousStartDate($previousStartDate)
506
    {
507
        return $this->setProperty('previousStartDate', $previousStartDate);
508
    }
509
510
    /**
511
     * The CreativeWork that captured all or part of this Event.
512
     *
513
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/recordedIn
518
     */
519
    public function recordedIn($recordedIn)
520
    {
521
        return $this->setProperty('recordedIn', $recordedIn);
522
    }
523
524
    /**
525
     * The number of attendee places for an event that remain unallocated.
526
     *
527
     * @param int|int[] $remainingAttendeeCapacity
528
     *
529
     * @return static
530
     *
531
     * @see http://schema.org/remainingAttendeeCapacity
532
     */
533
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
534
    {
535
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
536
    }
537
538
    /**
539
     * A review of the item.
540
     *
541
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
542
     *
543
     * @return static
544
     *
545
     * @see http://schema.org/review
546
     */
547
    public function review($review)
548
    {
549
        return $this->setProperty('review', $review);
550
    }
551
552
    /**
553
     * URL of a reference Web page that unambiguously indicates the item's
554
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
555
     * official website.
556
     *
557
     * @param string|string[] $sameAs
558
     *
559
     * @return static
560
     *
561
     * @see http://schema.org/sameAs
562
     */
563
    public function sameAs($sameAs)
564
    {
565
        return $this->setProperty('sameAs', $sameAs);
566
    }
567
568
    /**
569
     * A person or organization that supports a thing through a pledge, promise,
570
     * or financial contribution. e.g. a sponsor of a Medical Study or a
571
     * corporate sponsor of an event.
572
     *
573
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
574
     *
575
     * @return static
576
     *
577
     * @see http://schema.org/sponsor
578
     */
579
    public function sponsor($sponsor)
580
    {
581
        return $this->setProperty('sponsor', $sponsor);
582
    }
583
584
    /**
585
     * The start date and time of the item (in [ISO 8601 date
586
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
587
     *
588
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
589
     *
590
     * @return static
591
     *
592
     * @see http://schema.org/startDate
593
     */
594
    public function startDate($startDate)
595
    {
596
        return $this->setProperty('startDate', $startDate);
597
    }
598
599
    /**
600
     * An Event that is part of this event. For example, a conference event
601
     * includes many presentations, each of which is a subEvent of the
602
     * conference.
603
     *
604
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
605
     *
606
     * @return static
607
     *
608
     * @see http://schema.org/subEvent
609
     */
610
    public function subEvent($subEvent)
611
    {
612
        return $this->setProperty('subEvent', $subEvent);
613
    }
614
615
    /**
616
     * Events that are a part of this event. For example, a conference event
617
     * includes many presentations, each subEvents of the conference.
618
     *
619
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
620
     *
621
     * @return static
622
     *
623
     * @see http://schema.org/subEvents
624
     */
625
    public function subEvents($subEvents)
626
    {
627
        return $this->setProperty('subEvents', $subEvents);
628
    }
629
630
    /**
631
     * A CreativeWork or Event about this Thing.
632
     *
633
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
634
     *
635
     * @return static
636
     *
637
     * @see http://schema.org/subjectOf
638
     */
639
    public function subjectOf($subjectOf)
640
    {
641
        return $this->setProperty('subjectOf', $subjectOf);
642
    }
643
644
    /**
645
     * An event that this event is a part of. For example, a collection of
646
     * individual music performances might each have a music festival as their
647
     * superEvent.
648
     *
649
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
650
     *
651
     * @return static
652
     *
653
     * @see http://schema.org/superEvent
654
     */
655
    public function superEvent($superEvent)
656
    {
657
        return $this->setProperty('superEvent', $superEvent);
658
    }
659
660
    /**
661
     * Organization or person who adapts a creative work to different languages,
662
     * regional differences and technical requirements of a target market, or
663
     * that translates during some event.
664
     *
665
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
666
     *
667
     * @return static
668
     *
669
     * @see http://schema.org/translator
670
     */
671
    public function translator($translator)
672
    {
673
        return $this->setProperty('translator', $translator);
674
    }
675
676
    /**
677
     * The typical expected age range, e.g. '7-9', '11-'.
678
     *
679
     * @param string|string[] $typicalAgeRange
680
     *
681
     * @return static
682
     *
683
     * @see http://schema.org/typicalAgeRange
684
     */
685
    public function typicalAgeRange($typicalAgeRange)
686
    {
687
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
688
    }
689
690
    /**
691
     * URL of the item.
692
     *
693
     * @param string|string[] $url
694
     *
695
     * @return static
696
     *
697
     * @see http://schema.org/url
698
     */
699
    public function url($url)
700
    {
701
        return $this->setProperty('url', $url);
702
    }
703
704
    /**
705
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
706
     *        Specific subproperties are available for workPerformed (e.g. a
707
     * play), or a workPresented (a Movie at a ScreeningEvent).
708
     *
709
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
710
     *
711
     * @return static
712
     *
713
     * @see http://schema.org/workFeatured
714
     */
715
    public function workFeatured($workFeatured)
716
    {
717
        return $this->setProperty('workFeatured', $workFeatured);
718
    }
719
720
    /**
721
     * A work performed in some event, for example a play performed in a
722
     * TheaterEvent.
723
     *
724
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
725
     *
726
     * @return static
727
     *
728
     * @see http://schema.org/workPerformed
729
     */
730
    public function workPerformed($workPerformed)
731
    {
732
        return $this->setProperty('workPerformed', $workPerformed);
733
    }
734
735
}
736

src/UserLikes.php 1 location

@@ 18-736 (lines=719) @@
15
 * @see http://schema.org/UserLikes
16
 *
17
 */
18
class UserLikes extends BaseType implements UserLikesContract, EventContract, ThingContract, UserInteractionContract
19
{
20
    /**
21
     * The subject matter of the content.
22
     *
23
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
24
     *
25
     * @return static
26
     *
27
     * @see http://schema.org/about
28
     */
29
    public function about($about)
30
    {
31
        return $this->setProperty('about', $about);
32
    }
33
34
    /**
35
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
36
     * Actors can be associated with individual items or with a series, episode,
37
     * clip.
38
     *
39
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/actor
44
     */
45
    public function actor($actor)
46
    {
47
        return $this->setProperty('actor', $actor);
48
    }
49
50
    /**
51
     * An additional type for the item, typically used for adding more specific
52
     * types from external vocabularies in microdata syntax. This is a
53
     * relationship between something and a class that the thing is in. In RDFa
54
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
55
     * attribute - for multiple types. Schema.org tools may have only weaker
56
     * understanding of extra types, in particular those defined externally.
57
     *
58
     * @param string|string[] $additionalType
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/additionalType
63
     */
64
    public function additionalType($additionalType)
65
    {
66
        return $this->setProperty('additionalType', $additionalType);
67
    }
68
69
    /**
70
     * The overall rating, based on a collection of reviews or ratings, of the
71
     * item.
72
     *
73
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
74
     *
75
     * @return static
76
     *
77
     * @see http://schema.org/aggregateRating
78
     */
79
    public function aggregateRating($aggregateRating)
80
    {
81
        return $this->setProperty('aggregateRating', $aggregateRating);
82
    }
83
84
    /**
85
     * An alias for the item.
86
     *
87
     * @param string|string[] $alternateName
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/alternateName
92
     */
93
    public function alternateName($alternateName)
94
    {
95
        return $this->setProperty('alternateName', $alternateName);
96
    }
97
98
    /**
99
     * A person or organization attending the event.
100
     *
101
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/attendee
106
     */
107
    public function attendee($attendee)
108
    {
109
        return $this->setProperty('attendee', $attendee);
110
    }
111
112
    /**
113
     * A person attending the event.
114
     *
115
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/attendees
120
     */
121
    public function attendees($attendees)
122
    {
123
        return $this->setProperty('attendees', $attendees);
124
    }
125
126
    /**
127
     * An intended audience, i.e. a group for whom something was created.
128
     *
129
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/audience
134
     */
135
    public function audience($audience)
136
    {
137
        return $this->setProperty('audience', $audience);
138
    }
139
140
    /**
141
     * The person or organization who wrote a composition, or who is the
142
     * composer of a work performed at some event.
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/composer
149
     */
150
    public function composer($composer)
151
    {
152
        return $this->setProperty('composer', $composer);
153
    }
154
155
    /**
156
     * A secondary contributor to the CreativeWork or Event.
157
     *
158
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
159
     *
160
     * @return static
161
     *
162
     * @see http://schema.org/contributor
163
     */
164
    public function contributor($contributor)
165
    {
166
        return $this->setProperty('contributor', $contributor);
167
    }
168
169
    /**
170
     * A description of the item.
171
     *
172
     * @param string|string[] $description
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/description
177
     */
178
    public function description($description)
179
    {
180
        return $this->setProperty('description', $description);
181
    }
182
183
    /**
184
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
185
     * event. Directors can be associated with individual items or with a
186
     * series, episode, clip.
187
     *
188
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/director
193
     */
194
    public function director($director)
195
    {
196
        return $this->setProperty('director', $director);
197
    }
198
199
    /**
200
     * A sub property of description. A short description of the item used to
201
     * disambiguate from other, similar items. Information from other properties
202
     * (in particular, name) may be necessary for the description to be useful
203
     * for disambiguation.
204
     *
205
     * @param string|string[] $disambiguatingDescription
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/disambiguatingDescription
210
     */
211
    public function disambiguatingDescription($disambiguatingDescription)
212
    {
213
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
214
    }
215
216
    /**
217
     * The time admission will commence.
218
     *
219
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/doorTime
224
     */
225
    public function doorTime($doorTime)
226
    {
227
        return $this->setProperty('doorTime', $doorTime);
228
    }
229
230
    /**
231
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
232
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
233
     *
234
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/duration
239
     */
240
    public function duration($duration)
241
    {
242
        return $this->setProperty('duration', $duration);
243
    }
244
245
    /**
246
     * The end date and time of the item (in [ISO 8601 date
247
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
248
     *
249
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/endDate
254
     */
255
    public function endDate($endDate)
256
    {
257
        return $this->setProperty('endDate', $endDate);
258
    }
259
260
    /**
261
     * An eventStatus of an event represents its status; particularly useful
262
     * when an event is cancelled or rescheduled.
263
     *
264
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/eventStatus
269
     */
270
    public function eventStatus($eventStatus)
271
    {
272
        return $this->setProperty('eventStatus', $eventStatus);
273
    }
274
275
    /**
276
     * A person or organization that supports (sponsors) something through some
277
     * kind of financial contribution.
278
     *
279
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
280
     *
281
     * @return static
282
     *
283
     * @see http://schema.org/funder
284
     */
285
    public function funder($funder)
286
    {
287
        return $this->setProperty('funder', $funder);
288
    }
289
290
    /**
291
     * The identifier property represents any kind of identifier for any kind of
292
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
293
     * dedicated properties for representing many of these, either as textual
294
     * strings or as URL (URI) links. See [background
295
     * notes](/docs/datamodel.html#identifierBg) for more details.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/identifier
302
     */
303
    public function identifier($identifier)
304
    {
305
        return $this->setProperty('identifier', $identifier);
306
    }
307
308
    /**
309
     * An image of the item. This can be a [[URL]] or a fully described
310
     * [[ImageObject]].
311
     *
312
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
313
     *
314
     * @return static
315
     *
316
     * @see http://schema.org/image
317
     */
318
    public function image($image)
319
    {
320
        return $this->setProperty('image', $image);
321
    }
322
323
    /**
324
     * The language of the content or performance or used in an action. Please
325
     * use one of the language codes from the [IETF BCP 47
326
     * standard](http://tools.ietf.org/html/bcp47). See also
327
     * [[availableLanguage]].
328
     *
329
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/inLanguage
334
     */
335
    public function inLanguage($inLanguage)
336
    {
337
        return $this->setProperty('inLanguage', $inLanguage);
338
    }
339
340
    /**
341
     * A flag to signal that the item, event, or place is accessible for free.
342
     *
343
     * @param bool|bool[] $isAccessibleForFree
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/isAccessibleForFree
348
     */
349
    public function isAccessibleForFree($isAccessibleForFree)
350
    {
351
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
352
    }
353
354
    /**
355
     * The location of for example where the event is happening, an organization
356
     * is located, or where an action takes place.
357
     *
358
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/location
363
     */
364
    public function location($location)
365
    {
366
        return $this->setProperty('location', $location);
367
    }
368
369
    /**
370
     * Indicates a page (or other CreativeWork) for which this thing is the main
371
     * entity being described. See [background
372
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
373
     *
374
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
375
     *
376
     * @return static
377
     *
378
     * @see http://schema.org/mainEntityOfPage
379
     */
380
    public function mainEntityOfPage($mainEntityOfPage)
381
    {
382
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
383
    }
384
385
    /**
386
     * The total number of individuals that may attend an event or venue.
387
     *
388
     * @param int|int[] $maximumAttendeeCapacity
389
     *
390
     * @return static
391
     *
392
     * @see http://schema.org/maximumAttendeeCapacity
393
     */
394
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
395
    {
396
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
397
    }
398
399
    /**
400
     * The name of the item.
401
     *
402
     * @param string|string[] $name
403
     *
404
     * @return static
405
     *
406
     * @see http://schema.org/name
407
     */
408
    public function name($name)
409
    {
410
        return $this->setProperty('name', $name);
411
    }
412
413
    /**
414
     * An offer to provide this item&#x2014;for example, an offer to sell a
415
     * product, rent the DVD of a movie, perform a service, or give away tickets
416
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
417
     * offered, i.e. sell, lease, etc. This property can also be used to
418
     * describe a [[Demand]]. While this property is listed as expected on a
419
     * number of common types, it can be used in others. In that case, using a
420
     * second type, such as Product or a subtype of Product, can clarify the
421
     * nature of the offer.
422
     *
423
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
424
     *
425
     * @return static
426
     *
427
     * @see http://schema.org/offers
428
     */
429
    public function offers($offers)
430
    {
431
        return $this->setProperty('offers', $offers);
432
    }
433
434
    /**
435
     * An organizer of an Event.
436
     *
437
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
438
     *
439
     * @return static
440
     *
441
     * @see http://schema.org/organizer
442
     */
443
    public function organizer($organizer)
444
    {
445
        return $this->setProperty('organizer', $organizer);
446
    }
447
448
    /**
449
     * A performer at the event&#x2014;for example, a presenter, musician,
450
     * musical group or actor.
451
     *
452
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
453
     *
454
     * @return static
455
     *
456
     * @see http://schema.org/performer
457
     */
458
    public function performer($performer)
459
    {
460
        return $this->setProperty('performer', $performer);
461
    }
462
463
    /**
464
     * The main performer or performers of the event&#x2014;for example, a
465
     * presenter, musician, or actor.
466
     *
467
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
468
     *
469
     * @return static
470
     *
471
     * @see http://schema.org/performers
472
     */
473
    public function performers($performers)
474
    {
475
        return $this->setProperty('performers', $performers);
476
    }
477
478
    /**
479
     * Indicates a potential Action, which describes an idealized action in
480
     * which this thing would play an 'object' role.
481
     *
482
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
483
     *
484
     * @return static
485
     *
486
     * @see http://schema.org/potentialAction
487
     */
488
    public function potentialAction($potentialAction)
489
    {
490
        return $this->setProperty('potentialAction', $potentialAction);
491
    }
492
493
    /**
494
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
495
     * This property contains the previously scheduled start date. For
496
     * rescheduled events, the startDate property should be used for the newly
497
     * scheduled start date. In the (rare) case of an event that has been
498
     * postponed and rescheduled multiple times, this field may be repeated.
499
     *
500
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
501
     *
502
     * @return static
503
     *
504
     * @see http://schema.org/previousStartDate
505
     */
506
    public function previousStartDate($previousStartDate)
507
    {
508
        return $this->setProperty('previousStartDate', $previousStartDate);
509
    }
510
511
    /**
512
     * The CreativeWork that captured all or part of this Event.
513
     *
514
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
515
     *
516
     * @return static
517
     *
518
     * @see http://schema.org/recordedIn
519
     */
520
    public function recordedIn($recordedIn)
521
    {
522
        return $this->setProperty('recordedIn', $recordedIn);
523
    }
524
525
    /**
526
     * The number of attendee places for an event that remain unallocated.
527
     *
528
     * @param int|int[] $remainingAttendeeCapacity
529
     *
530
     * @return static
531
     *
532
     * @see http://schema.org/remainingAttendeeCapacity
533
     */
534
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
535
    {
536
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
537
    }
538
539
    /**
540
     * A review of the item.
541
     *
542
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
543
     *
544
     * @return static
545
     *
546
     * @see http://schema.org/review
547
     */
548
    public function review($review)
549
    {
550
        return $this->setProperty('review', $review);
551
    }
552
553
    /**
554
     * URL of a reference Web page that unambiguously indicates the item's
555
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
556
     * official website.
557
     *
558
     * @param string|string[] $sameAs
559
     *
560
     * @return static
561
     *
562
     * @see http://schema.org/sameAs
563
     */
564
    public function sameAs($sameAs)
565
    {
566
        return $this->setProperty('sameAs', $sameAs);
567
    }
568
569
    /**
570
     * A person or organization that supports a thing through a pledge, promise,
571
     * or financial contribution. e.g. a sponsor of a Medical Study or a
572
     * corporate sponsor of an event.
573
     *
574
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/sponsor
579
     */
580
    public function sponsor($sponsor)
581
    {
582
        return $this->setProperty('sponsor', $sponsor);
583
    }
584
585
    /**
586
     * The start date and time of the item (in [ISO 8601 date
587
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
588
     *
589
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
590
     *
591
     * @return static
592
     *
593
     * @see http://schema.org/startDate
594
     */
595
    public function startDate($startDate)
596
    {
597
        return $this->setProperty('startDate', $startDate);
598
    }
599
600
    /**
601
     * An Event that is part of this event. For example, a conference event
602
     * includes many presentations, each of which is a subEvent of the
603
     * conference.
604
     *
605
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
606
     *
607
     * @return static
608
     *
609
     * @see http://schema.org/subEvent
610
     */
611
    public function subEvent($subEvent)
612
    {
613
        return $this->setProperty('subEvent', $subEvent);
614
    }
615
616
    /**
617
     * Events that are a part of this event. For example, a conference event
618
     * includes many presentations, each subEvents of the conference.
619
     *
620
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
621
     *
622
     * @return static
623
     *
624
     * @see http://schema.org/subEvents
625
     */
626
    public function subEvents($subEvents)
627
    {
628
        return $this->setProperty('subEvents', $subEvents);
629
    }
630
631
    /**
632
     * A CreativeWork or Event about this Thing.
633
     *
634
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
635
     *
636
     * @return static
637
     *
638
     * @see http://schema.org/subjectOf
639
     */
640
    public function subjectOf($subjectOf)
641
    {
642
        return $this->setProperty('subjectOf', $subjectOf);
643
    }
644
645
    /**
646
     * An event that this event is a part of. For example, a collection of
647
     * individual music performances might each have a music festival as their
648
     * superEvent.
649
     *
650
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
651
     *
652
     * @return static
653
     *
654
     * @see http://schema.org/superEvent
655
     */
656
    public function superEvent($superEvent)
657
    {
658
        return $this->setProperty('superEvent', $superEvent);
659
    }
660
661
    /**
662
     * Organization or person who adapts a creative work to different languages,
663
     * regional differences and technical requirements of a target market, or
664
     * that translates during some event.
665
     *
666
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
667
     *
668
     * @return static
669
     *
670
     * @see http://schema.org/translator
671
     */
672
    public function translator($translator)
673
    {
674
        return $this->setProperty('translator', $translator);
675
    }
676
677
    /**
678
     * The typical expected age range, e.g. '7-9', '11-'.
679
     *
680
     * @param string|string[] $typicalAgeRange
681
     *
682
     * @return static
683
     *
684
     * @see http://schema.org/typicalAgeRange
685
     */
686
    public function typicalAgeRange($typicalAgeRange)
687
    {
688
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
689
    }
690
691
    /**
692
     * URL of the item.
693
     *
694
     * @param string|string[] $url
695
     *
696
     * @return static
697
     *
698
     * @see http://schema.org/url
699
     */
700
    public function url($url)
701
    {
702
        return $this->setProperty('url', $url);
703
    }
704
705
    /**
706
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
707
     *        Specific subproperties are available for workPerformed (e.g. a
708
     * play), or a workPresented (a Movie at a ScreeningEvent).
709
     *
710
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
711
     *
712
     * @return static
713
     *
714
     * @see http://schema.org/workFeatured
715
     */
716
    public function workFeatured($workFeatured)
717
    {
718
        return $this->setProperty('workFeatured', $workFeatured);
719
    }
720
721
    /**
722
     * A work performed in some event, for example a play performed in a
723
     * TheaterEvent.
724
     *
725
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
726
     *
727
     * @return static
728
     *
729
     * @see http://schema.org/workPerformed
730
     */
731
    public function workPerformed($workPerformed)
732
    {
733
        return $this->setProperty('workPerformed', $workPerformed);
734
    }
735
736
}
737

src/UserPageVisits.php 1 location

@@ 18-736 (lines=719) @@
15
 * @see http://schema.org/UserPageVisits
16
 *
17
 */
18
class UserPageVisits extends BaseType implements UserPageVisitsContract, EventContract, ThingContract, UserInteractionContract
19
{
20
    /**
21
     * The subject matter of the content.
22
     *
23
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
24
     *
25
     * @return static
26
     *
27
     * @see http://schema.org/about
28
     */
29
    public function about($about)
30
    {
31
        return $this->setProperty('about', $about);
32
    }
33
34
    /**
35
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
36
     * Actors can be associated with individual items or with a series, episode,
37
     * clip.
38
     *
39
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/actor
44
     */
45
    public function actor($actor)
46
    {
47
        return $this->setProperty('actor', $actor);
48
    }
49
50
    /**
51
     * An additional type for the item, typically used for adding more specific
52
     * types from external vocabularies in microdata syntax. This is a
53
     * relationship between something and a class that the thing is in. In RDFa
54
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
55
     * attribute - for multiple types. Schema.org tools may have only weaker
56
     * understanding of extra types, in particular those defined externally.
57
     *
58
     * @param string|string[] $additionalType
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/additionalType
63
     */
64
    public function additionalType($additionalType)
65
    {
66
        return $this->setProperty('additionalType', $additionalType);
67
    }
68
69
    /**
70
     * The overall rating, based on a collection of reviews or ratings, of the
71
     * item.
72
     *
73
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
74
     *
75
     * @return static
76
     *
77
     * @see http://schema.org/aggregateRating
78
     */
79
    public function aggregateRating($aggregateRating)
80
    {
81
        return $this->setProperty('aggregateRating', $aggregateRating);
82
    }
83
84
    /**
85
     * An alias for the item.
86
     *
87
     * @param string|string[] $alternateName
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/alternateName
92
     */
93
    public function alternateName($alternateName)
94
    {
95
        return $this->setProperty('alternateName', $alternateName);
96
    }
97
98
    /**
99
     * A person or organization attending the event.
100
     *
101
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/attendee
106
     */
107
    public function attendee($attendee)
108
    {
109
        return $this->setProperty('attendee', $attendee);
110
    }
111
112
    /**
113
     * A person attending the event.
114
     *
115
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/attendees
120
     */
121
    public function attendees($attendees)
122
    {
123
        return $this->setProperty('attendees', $attendees);
124
    }
125
126
    /**
127
     * An intended audience, i.e. a group for whom something was created.
128
     *
129
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/audience
134
     */
135
    public function audience($audience)
136
    {
137
        return $this->setProperty('audience', $audience);
138
    }
139
140
    /**
141
     * The person or organization who wrote a composition, or who is the
142
     * composer of a work performed at some event.
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/composer
149
     */
150
    public function composer($composer)
151
    {
152
        return $this->setProperty('composer', $composer);
153
    }
154
155
    /**
156
     * A secondary contributor to the CreativeWork or Event.
157
     *
158
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
159
     *
160
     * @return static
161
     *
162
     * @see http://schema.org/contributor
163
     */
164
    public function contributor($contributor)
165
    {
166
        return $this->setProperty('contributor', $contributor);
167
    }
168
169
    /**
170
     * A description of the item.
171
     *
172
     * @param string|string[] $description
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/description
177
     */
178
    public function description($description)
179
    {
180
        return $this->setProperty('description', $description);
181
    }
182
183
    /**
184
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
185
     * event. Directors can be associated with individual items or with a
186
     * series, episode, clip.
187
     *
188
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/director
193
     */
194
    public function director($director)
195
    {
196
        return $this->setProperty('director', $director);
197
    }
198
199
    /**
200
     * A sub property of description. A short description of the item used to
201
     * disambiguate from other, similar items. Information from other properties
202
     * (in particular, name) may be necessary for the description to be useful
203
     * for disambiguation.
204
     *
205
     * @param string|string[] $disambiguatingDescription
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/disambiguatingDescription
210
     */
211
    public function disambiguatingDescription($disambiguatingDescription)
212
    {
213
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
214
    }
215
216
    /**
217
     * The time admission will commence.
218
     *
219
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/doorTime
224
     */
225
    public function doorTime($doorTime)
226
    {
227
        return $this->setProperty('doorTime', $doorTime);
228
    }
229
230
    /**
231
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
232
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
233
     *
234
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/duration
239
     */
240
    public function duration($duration)
241
    {
242
        return $this->setProperty('duration', $duration);
243
    }
244
245
    /**
246
     * The end date and time of the item (in [ISO 8601 date
247
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
248
     *
249
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/endDate
254
     */
255
    public function endDate($endDate)
256
    {
257
        return $this->setProperty('endDate', $endDate);
258
    }
259
260
    /**
261
     * An eventStatus of an event represents its status; particularly useful
262
     * when an event is cancelled or rescheduled.
263
     *
264
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/eventStatus
269
     */
270
    public function eventStatus($eventStatus)
271
    {
272
        return $this->setProperty('eventStatus', $eventStatus);
273
    }
274
275
    /**
276
     * A person or organization that supports (sponsors) something through some
277
     * kind of financial contribution.
278
     *
279
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
280
     *
281
     * @return static
282
     *
283
     * @see http://schema.org/funder
284
     */
285
    public function funder($funder)
286
    {
287
        return $this->setProperty('funder', $funder);
288
    }
289
290
    /**
291
     * The identifier property represents any kind of identifier for any kind of
292
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
293
     * dedicated properties for representing many of these, either as textual
294
     * strings or as URL (URI) links. See [background
295
     * notes](/docs/datamodel.html#identifierBg) for more details.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/identifier
302
     */
303
    public function identifier($identifier)
304
    {
305
        return $this->setProperty('identifier', $identifier);
306
    }
307
308
    /**
309
     * An image of the item. This can be a [[URL]] or a fully described
310
     * [[ImageObject]].
311
     *
312
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
313
     *
314
     * @return static
315
     *
316
     * @see http://schema.org/image
317
     */
318
    public function image($image)
319
    {
320
        return $this->setProperty('image', $image);
321
    }
322
323
    /**
324
     * The language of the content or performance or used in an action. Please
325
     * use one of the language codes from the [IETF BCP 47
326
     * standard](http://tools.ietf.org/html/bcp47). See also
327
     * [[availableLanguage]].
328
     *
329
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/inLanguage
334
     */
335
    public function inLanguage($inLanguage)
336
    {
337
        return $this->setProperty('inLanguage', $inLanguage);
338
    }
339
340
    /**
341
     * A flag to signal that the item, event, or place is accessible for free.
342
     *
343
     * @param bool|bool[] $isAccessibleForFree
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/isAccessibleForFree
348
     */
349
    public function isAccessibleForFree($isAccessibleForFree)
350
    {
351
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
352
    }
353
354
    /**
355
     * The location of for example where the event is happening, an organization
356
     * is located, or where an action takes place.
357
     *
358
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/location
363
     */
364
    public function location($location)
365
    {
366
        return $this->setProperty('location', $location);
367
    }
368
369
    /**
370
     * Indicates a page (or other CreativeWork) for which this thing is the main
371
     * entity being described. See [background
372
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
373
     *
374
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
375
     *
376
     * @return static
377
     *
378
     * @see http://schema.org/mainEntityOfPage
379
     */
380
    public function mainEntityOfPage($mainEntityOfPage)
381
    {
382
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
383
    }
384
385
    /**
386
     * The total number of individuals that may attend an event or venue.
387
     *
388
     * @param int|int[] $maximumAttendeeCapacity
389
     *
390
     * @return static
391
     *
392
     * @see http://schema.org/maximumAttendeeCapacity
393
     */
394
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
395
    {
396
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
397
    }
398
399
    /**
400
     * The name of the item.
401
     *
402
     * @param string|string[] $name
403
     *
404
     * @return static
405
     *
406
     * @see http://schema.org/name
407
     */
408
    public function name($name)
409
    {
410
        return $this->setProperty('name', $name);
411
    }
412
413
    /**
414
     * An offer to provide this item&#x2014;for example, an offer to sell a
415
     * product, rent the DVD of a movie, perform a service, or give away tickets
416
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
417
     * offered, i.e. sell, lease, etc. This property can also be used to
418
     * describe a [[Demand]]. While this property is listed as expected on a
419
     * number of common types, it can be used in others. In that case, using a
420
     * second type, such as Product or a subtype of Product, can clarify the
421
     * nature of the offer.
422
     *
423
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
424
     *
425
     * @return static
426
     *
427
     * @see http://schema.org/offers
428
     */
429
    public function offers($offers)
430
    {
431
        return $this->setProperty('offers', $offers);
432
    }
433
434
    /**
435
     * An organizer of an Event.
436
     *
437
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
438
     *
439
     * @return static
440
     *
441
     * @see http://schema.org/organizer
442
     */
443
    public function organizer($organizer)
444
    {
445
        return $this->setProperty('organizer', $organizer);
446
    }
447
448
    /**
449
     * A performer at the event&#x2014;for example, a presenter, musician,
450
     * musical group or actor.
451
     *
452
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
453
     *
454
     * @return static
455
     *
456
     * @see http://schema.org/performer
457
     */
458
    public function performer($performer)
459
    {
460
        return $this->setProperty('performer', $performer);
461
    }
462
463
    /**
464
     * The main performer or performers of the event&#x2014;for example, a
465
     * presenter, musician, or actor.
466
     *
467
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
468
     *
469
     * @return static
470
     *
471
     * @see http://schema.org/performers
472
     */
473
    public function performers($performers)
474
    {
475
        return $this->setProperty('performers', $performers);
476
    }
477
478
    /**
479
     * Indicates a potential Action, which describes an idealized action in
480
     * which this thing would play an 'object' role.
481
     *
482
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
483
     *
484
     * @return static
485
     *
486
     * @see http://schema.org/potentialAction
487
     */
488
    public function potentialAction($potentialAction)
489
    {
490
        return $this->setProperty('potentialAction', $potentialAction);
491
    }
492
493
    /**
494
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
495
     * This property contains the previously scheduled start date. For
496
     * rescheduled events, the startDate property should be used for the newly
497
     * scheduled start date. In the (rare) case of an event that has been
498
     * postponed and rescheduled multiple times, this field may be repeated.
499
     *
500
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
501
     *
502
     * @return static
503
     *
504
     * @see http://schema.org/previousStartDate
505
     */
506
    public function previousStartDate($previousStartDate)
507
    {
508
        return $this->setProperty('previousStartDate', $previousStartDate);
509
    }
510
511
    /**
512
     * The CreativeWork that captured all or part of this Event.
513
     *
514
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
515
     *
516
     * @return static
517
     *
518
     * @see http://schema.org/recordedIn
519
     */
520
    public function recordedIn($recordedIn)
521
    {
522
        return $this->setProperty('recordedIn', $recordedIn);
523
    }
524
525
    /**
526
     * The number of attendee places for an event that remain unallocated.
527
     *
528
     * @param int|int[] $remainingAttendeeCapacity
529
     *
530
     * @return static
531
     *
532
     * @see http://schema.org/remainingAttendeeCapacity
533
     */
534
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
535
    {
536
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
537
    }
538
539
    /**
540
     * A review of the item.
541
     *
542
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
543
     *
544
     * @return static
545
     *
546
     * @see http://schema.org/review
547
     */
548
    public function review($review)
549
    {
550
        return $this->setProperty('review', $review);
551
    }
552
553
    /**
554
     * URL of a reference Web page that unambiguously indicates the item's
555
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
556
     * official website.
557
     *
558
     * @param string|string[] $sameAs
559
     *
560
     * @return static
561
     *
562
     * @see http://schema.org/sameAs
563
     */
564
    public function sameAs($sameAs)
565
    {
566
        return $this->setProperty('sameAs', $sameAs);
567
    }
568
569
    /**
570
     * A person or organization that supports a thing through a pledge, promise,
571
     * or financial contribution. e.g. a sponsor of a Medical Study or a
572
     * corporate sponsor of an event.
573
     *
574
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/sponsor
579
     */
580
    public function sponsor($sponsor)
581
    {
582
        return $this->setProperty('sponsor', $sponsor);
583
    }
584
585
    /**
586
     * The start date and time of the item (in [ISO 8601 date
587
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
588
     *
589
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
590
     *
591
     * @return static
592
     *
593
     * @see http://schema.org/startDate
594
     */
595
    public function startDate($startDate)
596
    {
597
        return $this->setProperty('startDate', $startDate);
598
    }
599
600
    /**
601
     * An Event that is part of this event. For example, a conference event
602
     * includes many presentations, each of which is a subEvent of the
603
     * conference.
604
     *
605
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
606
     *
607
     * @return static
608
     *
609
     * @see http://schema.org/subEvent
610
     */
611
    public function subEvent($subEvent)
612
    {
613
        return $this->setProperty('subEvent', $subEvent);
614
    }
615
616
    /**
617
     * Events that are a part of this event. For example, a conference event
618
     * includes many presentations, each subEvents of the conference.
619
     *
620
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
621
     *
622
     * @return static
623
     *
624
     * @see http://schema.org/subEvents
625
     */
626
    public function subEvents($subEvents)
627
    {
628
        return $this->setProperty('subEvents', $subEvents);
629
    }
630
631
    /**
632
     * A CreativeWork or Event about this Thing.
633
     *
634
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
635
     *
636
     * @return static
637
     *
638
     * @see http://schema.org/subjectOf
639
     */
640
    public function subjectOf($subjectOf)
641
    {
642
        return $this->setProperty('subjectOf', $subjectOf);
643
    }
644
645
    /**
646
     * An event that this event is a part of. For example, a collection of
647
     * individual music performances might each have a music festival as their
648
     * superEvent.
649
     *
650
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
651
     *
652
     * @return static
653
     *
654
     * @see http://schema.org/superEvent
655
     */
656
    public function superEvent($superEvent)
657
    {
658
        return $this->setProperty('superEvent', $superEvent);
659
    }
660
661
    /**
662
     * Organization or person who adapts a creative work to different languages,
663
     * regional differences and technical requirements of a target market, or
664
     * that translates during some event.
665
     *
666
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
667
     *
668
     * @return static
669
     *
670
     * @see http://schema.org/translator
671
     */
672
    public function translator($translator)
673
    {
674
        return $this->setProperty('translator', $translator);
675
    }
676
677
    /**
678
     * The typical expected age range, e.g. '7-9', '11-'.
679
     *
680
     * @param string|string[] $typicalAgeRange
681
     *
682
     * @return static
683
     *
684
     * @see http://schema.org/typicalAgeRange
685
     */
686
    public function typicalAgeRange($typicalAgeRange)
687
    {
688
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
689
    }
690
691
    /**
692
     * URL of the item.
693
     *
694
     * @param string|string[] $url
695
     *
696
     * @return static
697
     *
698
     * @see http://schema.org/url
699
     */
700
    public function url($url)
701
    {
702
        return $this->setProperty('url', $url);
703
    }
704
705
    /**
706
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
707
     *        Specific subproperties are available for workPerformed (e.g. a
708
     * play), or a workPresented (a Movie at a ScreeningEvent).
709
     *
710
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
711
     *
712
     * @return static
713
     *
714
     * @see http://schema.org/workFeatured
715
     */
716
    public function workFeatured($workFeatured)
717
    {
718
        return $this->setProperty('workFeatured', $workFeatured);
719
    }
720
721
    /**
722
     * A work performed in some event, for example a play performed in a
723
     * TheaterEvent.
724
     *
725
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
726
     *
727
     * @return static
728
     *
729
     * @see http://schema.org/workPerformed
730
     */
731
    public function workPerformed($workPerformed)
732
    {
733
        return $this->setProperty('workPerformed', $workPerformed);
734
    }
735
736
}
737

src/UserPlays.php 1 location

@@ 18-736 (lines=719) @@
15
 * @see http://schema.org/UserPlays
16
 *
17
 */
18
class UserPlays extends BaseType implements UserPlaysContract, EventContract, ThingContract, UserInteractionContract
19
{
20
    /**
21
     * The subject matter of the content.
22
     *
23
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
24
     *
25
     * @return static
26
     *
27
     * @see http://schema.org/about
28
     */
29
    public function about($about)
30
    {
31
        return $this->setProperty('about', $about);
32
    }
33
34
    /**
35
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
36
     * Actors can be associated with individual items or with a series, episode,
37
     * clip.
38
     *
39
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/actor
44
     */
45
    public function actor($actor)
46
    {
47
        return $this->setProperty('actor', $actor);
48
    }
49
50
    /**
51
     * An additional type for the item, typically used for adding more specific
52
     * types from external vocabularies in microdata syntax. This is a
53
     * relationship between something and a class that the thing is in. In RDFa
54
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
55
     * attribute - for multiple types. Schema.org tools may have only weaker
56
     * understanding of extra types, in particular those defined externally.
57
     *
58
     * @param string|string[] $additionalType
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/additionalType
63
     */
64
    public function additionalType($additionalType)
65
    {
66
        return $this->setProperty('additionalType', $additionalType);
67
    }
68
69
    /**
70
     * The overall rating, based on a collection of reviews or ratings, of the
71
     * item.
72
     *
73
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
74
     *
75
     * @return static
76
     *
77
     * @see http://schema.org/aggregateRating
78
     */
79
    public function aggregateRating($aggregateRating)
80
    {
81
        return $this->setProperty('aggregateRating', $aggregateRating);
82
    }
83
84
    /**
85
     * An alias for the item.
86
     *
87
     * @param string|string[] $alternateName
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/alternateName
92
     */
93
    public function alternateName($alternateName)
94
    {
95
        return $this->setProperty('alternateName', $alternateName);
96
    }
97
98
    /**
99
     * A person or organization attending the event.
100
     *
101
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/attendee
106
     */
107
    public function attendee($attendee)
108
    {
109
        return $this->setProperty('attendee', $attendee);
110
    }
111
112
    /**
113
     * A person attending the event.
114
     *
115
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/attendees
120
     */
121
    public function attendees($attendees)
122
    {
123
        return $this->setProperty('attendees', $attendees);
124
    }
125
126
    /**
127
     * An intended audience, i.e. a group for whom something was created.
128
     *
129
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/audience
134
     */
135
    public function audience($audience)
136
    {
137
        return $this->setProperty('audience', $audience);
138
    }
139
140
    /**
141
     * The person or organization who wrote a composition, or who is the
142
     * composer of a work performed at some event.
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/composer
149
     */
150
    public function composer($composer)
151
    {
152
        return $this->setProperty('composer', $composer);
153
    }
154
155
    /**
156
     * A secondary contributor to the CreativeWork or Event.
157
     *
158
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
159
     *
160
     * @return static
161
     *
162
     * @see http://schema.org/contributor
163
     */
164
    public function contributor($contributor)
165
    {
166
        return $this->setProperty('contributor', $contributor);
167
    }
168
169
    /**
170
     * A description of the item.
171
     *
172
     * @param string|string[] $description
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/description
177
     */
178
    public function description($description)
179
    {
180
        return $this->setProperty('description', $description);
181
    }
182
183
    /**
184
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
185
     * event. Directors can be associated with individual items or with a
186
     * series, episode, clip.
187
     *
188
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/director
193
     */
194
    public function director($director)
195
    {
196
        return $this->setProperty('director', $director);
197
    }
198
199
    /**
200
     * A sub property of description. A short description of the item used to
201
     * disambiguate from other, similar items. Information from other properties
202
     * (in particular, name) may be necessary for the description to be useful
203
     * for disambiguation.
204
     *
205
     * @param string|string[] $disambiguatingDescription
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/disambiguatingDescription
210
     */
211
    public function disambiguatingDescription($disambiguatingDescription)
212
    {
213
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
214
    }
215
216
    /**
217
     * The time admission will commence.
218
     *
219
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/doorTime
224
     */
225
    public function doorTime($doorTime)
226
    {
227
        return $this->setProperty('doorTime', $doorTime);
228
    }
229
230
    /**
231
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
232
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
233
     *
234
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/duration
239
     */
240
    public function duration($duration)
241
    {
242
        return $this->setProperty('duration', $duration);
243
    }
244
245
    /**
246
     * The end date and time of the item (in [ISO 8601 date
247
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
248
     *
249
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/endDate
254
     */
255
    public function endDate($endDate)
256
    {
257
        return $this->setProperty('endDate', $endDate);
258
    }
259
260
    /**
261
     * An eventStatus of an event represents its status; particularly useful
262
     * when an event is cancelled or rescheduled.
263
     *
264
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/eventStatus
269
     */
270
    public function eventStatus($eventStatus)
271
    {
272
        return $this->setProperty('eventStatus', $eventStatus);
273
    }
274
275
    /**
276
     * A person or organization that supports (sponsors) something through some
277
     * kind of financial contribution.
278
     *
279
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
280
     *
281
     * @return static
282
     *
283
     * @see http://schema.org/funder
284
     */
285
    public function funder($funder)
286
    {
287
        return $this->setProperty('funder', $funder);
288
    }
289
290
    /**
291
     * The identifier property represents any kind of identifier for any kind of
292
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
293
     * dedicated properties for representing many of these, either as textual
294
     * strings or as URL (URI) links. See [background
295
     * notes](/docs/datamodel.html#identifierBg) for more details.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/identifier
302
     */
303
    public function identifier($identifier)
304
    {
305
        return $this->setProperty('identifier', $identifier);
306
    }
307
308
    /**
309
     * An image of the item. This can be a [[URL]] or a fully described
310
     * [[ImageObject]].
311
     *
312
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
313
     *
314
     * @return static
315
     *
316
     * @see http://schema.org/image
317
     */
318
    public function image($image)
319
    {
320
        return $this->setProperty('image', $image);
321
    }
322
323
    /**
324
     * The language of the content or performance or used in an action. Please
325
     * use one of the language codes from the [IETF BCP 47
326
     * standard](http://tools.ietf.org/html/bcp47). See also
327
     * [[availableLanguage]].
328
     *
329
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/inLanguage
334
     */
335
    public function inLanguage($inLanguage)
336
    {
337
        return $this->setProperty('inLanguage', $inLanguage);
338
    }
339
340
    /**
341
     * A flag to signal that the item, event, or place is accessible for free.
342
     *
343
     * @param bool|bool[] $isAccessibleForFree
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/isAccessibleForFree
348
     */
349
    public function isAccessibleForFree($isAccessibleForFree)
350
    {
351
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
352
    }
353
354
    /**
355
     * The location of for example where the event is happening, an organization
356
     * is located, or where an action takes place.
357
     *
358
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/location
363
     */
364
    public function location($location)
365
    {
366
        return $this->setProperty('location', $location);
367
    }
368
369
    /**
370
     * Indicates a page (or other CreativeWork) for which this thing is the main
371
     * entity being described. See [background
372
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
373
     *
374
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
375
     *
376
     * @return static
377
     *
378
     * @see http://schema.org/mainEntityOfPage
379
     */
380
    public function mainEntityOfPage($mainEntityOfPage)
381
    {
382
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
383
    }
384
385
    /**
386
     * The total number of individuals that may attend an event or venue.
387
     *
388
     * @param int|int[] $maximumAttendeeCapacity
389
     *
390
     * @return static
391
     *
392
     * @see http://schema.org/maximumAttendeeCapacity
393
     */
394
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
395
    {
396
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
397
    }
398
399
    /**
400
     * The name of the item.
401
     *
402
     * @param string|string[] $name
403
     *
404
     * @return static
405
     *
406
     * @see http://schema.org/name
407
     */
408
    public function name($name)
409
    {
410
        return $this->setProperty('name', $name);
411
    }
412
413
    /**
414
     * An offer to provide this item&#x2014;for example, an offer to sell a
415
     * product, rent the DVD of a movie, perform a service, or give away tickets
416
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
417
     * offered, i.e. sell, lease, etc. This property can also be used to
418
     * describe a [[Demand]]. While this property is listed as expected on a
419
     * number of common types, it can be used in others. In that case, using a
420
     * second type, such as Product or a subtype of Product, can clarify the
421
     * nature of the offer.
422
     *
423
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
424
     *
425
     * @return static
426
     *
427
     * @see http://schema.org/offers
428
     */
429
    public function offers($offers)
430
    {
431
        return $this->setProperty('offers', $offers);
432
    }
433
434
    /**
435
     * An organizer of an Event.
436
     *
437
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
438
     *
439
     * @return static
440
     *
441
     * @see http://schema.org/organizer
442
     */
443
    public function organizer($organizer)
444
    {
445
        return $this->setProperty('organizer', $organizer);
446
    }
447
448
    /**
449
     * A performer at the event&#x2014;for example, a presenter, musician,
450
     * musical group or actor.
451
     *
452
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
453
     *
454
     * @return static
455
     *
456
     * @see http://schema.org/performer
457
     */
458
    public function performer($performer)
459
    {
460
        return $this->setProperty('performer', $performer);
461
    }
462
463
    /**
464
     * The main performer or performers of the event&#x2014;for example, a
465
     * presenter, musician, or actor.
466
     *
467
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
468
     *
469
     * @return static
470
     *
471
     * @see http://schema.org/performers
472
     */
473
    public function performers($performers)
474
    {
475
        return $this->setProperty('performers', $performers);
476
    }
477
478
    /**
479
     * Indicates a potential Action, which describes an idealized action in
480
     * which this thing would play an 'object' role.
481
     *
482
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
483
     *
484
     * @return static
485
     *
486
     * @see http://schema.org/potentialAction
487
     */
488
    public function potentialAction($potentialAction)
489
    {
490
        return $this->setProperty('potentialAction', $potentialAction);
491
    }
492
493
    /**
494
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
495
     * This property contains the previously scheduled start date. For
496
     * rescheduled events, the startDate property should be used for the newly
497
     * scheduled start date. In the (rare) case of an event that has been
498
     * postponed and rescheduled multiple times, this field may be repeated.
499
     *
500
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
501
     *
502
     * @return static
503
     *
504
     * @see http://schema.org/previousStartDate
505
     */
506
    public function previousStartDate($previousStartDate)
507
    {
508
        return $this->setProperty('previousStartDate', $previousStartDate);
509
    }
510
511
    /**
512
     * The CreativeWork that captured all or part of this Event.
513
     *
514
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
515
     *
516
     * @return static
517
     *
518
     * @see http://schema.org/recordedIn
519
     */
520
    public function recordedIn($recordedIn)
521
    {
522
        return $this->setProperty('recordedIn', $recordedIn);
523
    }
524
525
    /**
526
     * The number of attendee places for an event that remain unallocated.
527
     *
528
     * @param int|int[] $remainingAttendeeCapacity
529
     *
530
     * @return static
531
     *
532
     * @see http://schema.org/remainingAttendeeCapacity
533
     */
534
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
535
    {
536
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
537
    }
538
539
    /**
540
     * A review of the item.
541
     *
542
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
543
     *
544
     * @return static
545
     *
546
     * @see http://schema.org/review
547
     */
548
    public function review($review)
549
    {
550
        return $this->setProperty('review', $review);
551
    }
552
553
    /**
554
     * URL of a reference Web page that unambiguously indicates the item's
555
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
556
     * official website.
557
     *
558
     * @param string|string[] $sameAs
559
     *
560
     * @return static
561
     *
562
     * @see http://schema.org/sameAs
563
     */
564
    public function sameAs($sameAs)
565
    {
566
        return $this->setProperty('sameAs', $sameAs);
567
    }
568
569
    /**
570
     * A person or organization that supports a thing through a pledge, promise,
571
     * or financial contribution. e.g. a sponsor of a Medical Study or a
572
     * corporate sponsor of an event.
573
     *
574
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/sponsor
579
     */
580
    public function sponsor($sponsor)
581
    {
582
        return $this->setProperty('sponsor', $sponsor);
583
    }
584
585
    /**
586
     * The start date and time of the item (in [ISO 8601 date
587
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
588
     *
589
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
590
     *
591
     * @return static
592
     *
593
     * @see http://schema.org/startDate
594
     */
595
    public function startDate($startDate)
596
    {
597
        return $this->setProperty('startDate', $startDate);
598
    }
599
600
    /**
601
     * An Event that is part of this event. For example, a conference event
602
     * includes many presentations, each of which is a subEvent of the
603
     * conference.
604
     *
605
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
606
     *
607
     * @return static
608
     *
609
     * @see http://schema.org/subEvent
610
     */
611
    public function subEvent($subEvent)
612
    {
613
        return $this->setProperty('subEvent', $subEvent);
614
    }
615
616
    /**
617
     * Events that are a part of this event. For example, a conference event
618
     * includes many presentations, each subEvents of the conference.
619
     *
620
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
621
     *
622
     * @return static
623
     *
624
     * @see http://schema.org/subEvents
625
     */
626
    public function subEvents($subEvents)
627
    {
628
        return $this->setProperty('subEvents', $subEvents);
629
    }
630
631
    /**
632
     * A CreativeWork or Event about this Thing.
633
     *
634
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
635
     *
636
     * @return static
637
     *
638
     * @see http://schema.org/subjectOf
639
     */
640
    public function subjectOf($subjectOf)
641
    {
642
        return $this->setProperty('subjectOf', $subjectOf);
643
    }
644
645
    /**
646
     * An event that this event is a part of. For example, a collection of
647
     * individual music performances might each have a music festival as their
648
     * superEvent.
649
     *
650
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
651
     *
652
     * @return static
653
     *
654
     * @see http://schema.org/superEvent
655
     */
656
    public function superEvent($superEvent)
657
    {
658
        return $this->setProperty('superEvent', $superEvent);
659
    }
660
661
    /**
662
     * Organization or person who adapts a creative work to different languages,
663
     * regional differences and technical requirements of a target market, or
664
     * that translates during some event.
665
     *
666
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
667
     *
668
     * @return static
669
     *
670
     * @see http://schema.org/translator
671
     */
672
    public function translator($translator)
673
    {
674
        return $this->setProperty('translator', $translator);
675
    }
676
677
    /**
678
     * The typical expected age range, e.g. '7-9', '11-'.
679
     *
680
     * @param string|string[] $typicalAgeRange
681
     *
682
     * @return static
683
     *
684
     * @see http://schema.org/typicalAgeRange
685
     */
686
    public function typicalAgeRange($typicalAgeRange)
687
    {
688
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
689
    }
690
691
    /**
692
     * URL of the item.
693
     *
694
     * @param string|string[] $url
695
     *
696
     * @return static
697
     *
698
     * @see http://schema.org/url
699
     */
700
    public function url($url)
701
    {
702
        return $this->setProperty('url', $url);
703
    }
704
705
    /**
706
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
707
     *        Specific subproperties are available for workPerformed (e.g. a
708
     * play), or a workPresented (a Movie at a ScreeningEvent).
709
     *
710
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
711
     *
712
     * @return static
713
     *
714
     * @see http://schema.org/workFeatured
715
     */
716
    public function workFeatured($workFeatured)
717
    {
718
        return $this->setProperty('workFeatured', $workFeatured);
719
    }
720
721
    /**
722
     * A work performed in some event, for example a play performed in a
723
     * TheaterEvent.
724
     *
725
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
726
     *
727
     * @return static
728
     *
729
     * @see http://schema.org/workPerformed
730
     */
731
    public function workPerformed($workPerformed)
732
    {
733
        return $this->setProperty('workPerformed', $workPerformed);
734
    }
735
736
}
737

src/UserPlusOnes.php 1 location

@@ 18-736 (lines=719) @@
15
 * @see http://schema.org/UserPlusOnes
16
 *
17
 */
18
class UserPlusOnes extends BaseType implements UserPlusOnesContract, EventContract, ThingContract, UserInteractionContract
19
{
20
    /**
21
     * The subject matter of the content.
22
     *
23
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
24
     *
25
     * @return static
26
     *
27
     * @see http://schema.org/about
28
     */
29
    public function about($about)
30
    {
31
        return $this->setProperty('about', $about);
32
    }
33
34
    /**
35
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
36
     * Actors can be associated with individual items or with a series, episode,
37
     * clip.
38
     *
39
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/actor
44
     */
45
    public function actor($actor)
46
    {
47
        return $this->setProperty('actor', $actor);
48
    }
49
50
    /**
51
     * An additional type for the item, typically used for adding more specific
52
     * types from external vocabularies in microdata syntax. This is a
53
     * relationship between something and a class that the thing is in. In RDFa
54
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
55
     * attribute - for multiple types. Schema.org tools may have only weaker
56
     * understanding of extra types, in particular those defined externally.
57
     *
58
     * @param string|string[] $additionalType
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/additionalType
63
     */
64
    public function additionalType($additionalType)
65
    {
66
        return $this->setProperty('additionalType', $additionalType);
67
    }
68
69
    /**
70
     * The overall rating, based on a collection of reviews or ratings, of the
71
     * item.
72
     *
73
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
74
     *
75
     * @return static
76
     *
77
     * @see http://schema.org/aggregateRating
78
     */
79
    public function aggregateRating($aggregateRating)
80
    {
81
        return $this->setProperty('aggregateRating', $aggregateRating);
82
    }
83
84
    /**
85
     * An alias for the item.
86
     *
87
     * @param string|string[] $alternateName
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/alternateName
92
     */
93
    public function alternateName($alternateName)
94
    {
95
        return $this->setProperty('alternateName', $alternateName);
96
    }
97
98
    /**
99
     * A person or organization attending the event.
100
     *
101
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/attendee
106
     */
107
    public function attendee($attendee)
108
    {
109
        return $this->setProperty('attendee', $attendee);
110
    }
111
112
    /**
113
     * A person attending the event.
114
     *
115
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/attendees
120
     */
121
    public function attendees($attendees)
122
    {
123
        return $this->setProperty('attendees', $attendees);
124
    }
125
126
    /**
127
     * An intended audience, i.e. a group for whom something was created.
128
     *
129
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/audience
134
     */
135
    public function audience($audience)
136
    {
137
        return $this->setProperty('audience', $audience);
138
    }
139
140
    /**
141
     * The person or organization who wrote a composition, or who is the
142
     * composer of a work performed at some event.
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/composer
149
     */
150
    public function composer($composer)
151
    {
152
        return $this->setProperty('composer', $composer);
153
    }
154
155
    /**
156
     * A secondary contributor to the CreativeWork or Event.
157
     *
158
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
159
     *
160
     * @return static
161
     *
162
     * @see http://schema.org/contributor
163
     */
164
    public function contributor($contributor)
165
    {
166
        return $this->setProperty('contributor', $contributor);
167
    }
168
169
    /**
170
     * A description of the item.
171
     *
172
     * @param string|string[] $description
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/description
177
     */
178
    public function description($description)
179
    {
180
        return $this->setProperty('description', $description);
181
    }
182
183
    /**
184
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
185
     * event. Directors can be associated with individual items or with a
186
     * series, episode, clip.
187
     *
188
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/director
193
     */
194
    public function director($director)
195
    {
196
        return $this->setProperty('director', $director);
197
    }
198
199
    /**
200
     * A sub property of description. A short description of the item used to
201
     * disambiguate from other, similar items. Information from other properties
202
     * (in particular, name) may be necessary for the description to be useful
203
     * for disambiguation.
204
     *
205
     * @param string|string[] $disambiguatingDescription
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/disambiguatingDescription
210
     */
211
    public function disambiguatingDescription($disambiguatingDescription)
212
    {
213
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
214
    }
215
216
    /**
217
     * The time admission will commence.
218
     *
219
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/doorTime
224
     */
225
    public function doorTime($doorTime)
226
    {
227
        return $this->setProperty('doorTime', $doorTime);
228
    }
229
230
    /**
231
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
232
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
233
     *
234
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/duration
239
     */
240
    public function duration($duration)
241
    {
242
        return $this->setProperty('duration', $duration);
243
    }
244
245
    /**
246
     * The end date and time of the item (in [ISO 8601 date
247
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
248
     *
249
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/endDate
254
     */
255
    public function endDate($endDate)
256
    {
257
        return $this->setProperty('endDate', $endDate);
258
    }
259
260
    /**
261
     * An eventStatus of an event represents its status; particularly useful
262
     * when an event is cancelled or rescheduled.
263
     *
264
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/eventStatus
269
     */
270
    public function eventStatus($eventStatus)
271
    {
272
        return $this->setProperty('eventStatus', $eventStatus);
273
    }
274
275
    /**
276
     * A person or organization that supports (sponsors) something through some
277
     * kind of financial contribution.
278
     *
279
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
280
     *
281
     * @return static
282
     *
283
     * @see http://schema.org/funder
284
     */
285
    public function funder($funder)
286
    {
287
        return $this->setProperty('funder', $funder);
288
    }
289
290
    /**
291
     * The identifier property represents any kind of identifier for any kind of
292
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
293
     * dedicated properties for representing many of these, either as textual
294
     * strings or as URL (URI) links. See [background
295
     * notes](/docs/datamodel.html#identifierBg) for more details.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/identifier
302
     */
303
    public function identifier($identifier)
304
    {
305
        return $this->setProperty('identifier', $identifier);
306
    }
307
308
    /**
309
     * An image of the item. This can be a [[URL]] or a fully described
310
     * [[ImageObject]].
311
     *
312
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
313
     *
314
     * @return static
315
     *
316
     * @see http://schema.org/image
317
     */
318
    public function image($image)
319
    {
320
        return $this->setProperty('image', $image);
321
    }
322
323
    /**
324
     * The language of the content or performance or used in an action. Please
325
     * use one of the language codes from the [IETF BCP 47
326
     * standard](http://tools.ietf.org/html/bcp47). See also
327
     * [[availableLanguage]].
328
     *
329
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/inLanguage
334
     */
335
    public function inLanguage($inLanguage)
336
    {
337
        return $this->setProperty('inLanguage', $inLanguage);
338
    }
339
340
    /**
341
     * A flag to signal that the item, event, or place is accessible for free.
342
     *
343
     * @param bool|bool[] $isAccessibleForFree
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/isAccessibleForFree
348
     */
349
    public function isAccessibleForFree($isAccessibleForFree)
350
    {
351
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
352
    }
353
354
    /**
355
     * The location of for example where the event is happening, an organization
356
     * is located, or where an action takes place.
357
     *
358
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/location
363
     */
364
    public function location($location)
365
    {
366
        return $this->setProperty('location', $location);
367
    }
368
369
    /**
370
     * Indicates a page (or other CreativeWork) for which this thing is the main
371
     * entity being described. See [background
372
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
373
     *
374
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
375
     *
376
     * @return static
377
     *
378
     * @see http://schema.org/mainEntityOfPage
379
     */
380
    public function mainEntityOfPage($mainEntityOfPage)
381
    {
382
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
383
    }
384
385
    /**
386
     * The total number of individuals that may attend an event or venue.
387
     *
388
     * @param int|int[] $maximumAttendeeCapacity
389
     *
390
     * @return static
391
     *
392
     * @see http://schema.org/maximumAttendeeCapacity
393
     */
394
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
395
    {
396
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
397
    }
398
399
    /**
400
     * The name of the item.
401
     *
402
     * @param string|string[] $name
403
     *
404
     * @return static
405
     *
406
     * @see http://schema.org/name
407
     */
408
    public function name($name)
409
    {
410
        return $this->setProperty('name', $name);
411
    }
412
413
    /**
414
     * An offer to provide this item&#x2014;for example, an offer to sell a
415
     * product, rent the DVD of a movie, perform a service, or give away tickets
416
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
417
     * offered, i.e. sell, lease, etc. This property can also be used to
418
     * describe a [[Demand]]. While this property is listed as expected on a
419
     * number of common types, it can be used in others. In that case, using a
420
     * second type, such as Product or a subtype of Product, can clarify the
421
     * nature of the offer.
422
     *
423
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
424
     *
425
     * @return static
426
     *
427
     * @see http://schema.org/offers
428
     */
429
    public function offers($offers)
430
    {
431
        return $this->setProperty('offers', $offers);
432
    }
433
434
    /**
435
     * An organizer of an Event.
436
     *
437
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
438
     *
439
     * @return static
440
     *
441
     * @see http://schema.org/organizer
442
     */
443
    public function organizer($organizer)
444
    {
445
        return $this->setProperty('organizer', $organizer);
446
    }
447
448
    /**
449
     * A performer at the event&#x2014;for example, a presenter, musician,
450
     * musical group or actor.
451
     *
452
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
453
     *
454
     * @return static
455
     *
456
     * @see http://schema.org/performer
457
     */
458
    public function performer($performer)
459
    {
460
        return $this->setProperty('performer', $performer);
461
    }
462
463
    /**
464
     * The main performer or performers of the event&#x2014;for example, a
465
     * presenter, musician, or actor.
466
     *
467
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
468
     *
469
     * @return static
470
     *
471
     * @see http://schema.org/performers
472
     */
473
    public function performers($performers)
474
    {
475
        return $this->setProperty('performers', $performers);
476
    }
477
478
    /**
479
     * Indicates a potential Action, which describes an idealized action in
480
     * which this thing would play an 'object' role.
481
     *
482
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
483
     *
484
     * @return static
485
     *
486
     * @see http://schema.org/potentialAction
487
     */
488
    public function potentialAction($potentialAction)
489
    {
490
        return $this->setProperty('potentialAction', $potentialAction);
491
    }
492
493
    /**
494
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
495
     * This property contains the previously scheduled start date. For
496
     * rescheduled events, the startDate property should be used for the newly
497
     * scheduled start date. In the (rare) case of an event that has been
498
     * postponed and rescheduled multiple times, this field may be repeated.
499
     *
500
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
501
     *
502
     * @return static
503
     *
504
     * @see http://schema.org/previousStartDate
505
     */
506
    public function previousStartDate($previousStartDate)
507
    {
508
        return $this->setProperty('previousStartDate', $previousStartDate);
509
    }
510
511
    /**
512
     * The CreativeWork that captured all or part of this Event.
513
     *
514
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
515
     *
516
     * @return static
517
     *
518
     * @see http://schema.org/recordedIn
519
     */
520
    public function recordedIn($recordedIn)
521
    {
522
        return $this->setProperty('recordedIn', $recordedIn);
523
    }
524
525
    /**
526
     * The number of attendee places for an event that remain unallocated.
527
     *
528
     * @param int|int[] $remainingAttendeeCapacity
529
     *
530
     * @return static
531
     *
532
     * @see http://schema.org/remainingAttendeeCapacity
533
     */
534
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
535
    {
536
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
537
    }
538
539
    /**
540
     * A review of the item.
541
     *
542
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
543
     *
544
     * @return static
545
     *
546
     * @see http://schema.org/review
547
     */
548
    public function review($review)
549
    {
550
        return $this->setProperty('review', $review);
551
    }
552
553
    /**
554
     * URL of a reference Web page that unambiguously indicates the item's
555
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
556
     * official website.
557
     *
558
     * @param string|string[] $sameAs
559
     *
560
     * @return static
561
     *
562
     * @see http://schema.org/sameAs
563
     */
564
    public function sameAs($sameAs)
565
    {
566
        return $this->setProperty('sameAs', $sameAs);
567
    }
568
569
    /**
570
     * A person or organization that supports a thing through a pledge, promise,
571
     * or financial contribution. e.g. a sponsor of a Medical Study or a
572
     * corporate sponsor of an event.
573
     *
574
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/sponsor
579
     */
580
    public function sponsor($sponsor)
581
    {
582
        return $this->setProperty('sponsor', $sponsor);
583
    }
584
585
    /**
586
     * The start date and time of the item (in [ISO 8601 date
587
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
588
     *
589
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
590
     *
591
     * @return static
592
     *
593
     * @see http://schema.org/startDate
594
     */
595
    public function startDate($startDate)
596
    {
597
        return $this->setProperty('startDate', $startDate);
598
    }
599
600
    /**
601
     * An Event that is part of this event. For example, a conference event
602
     * includes many presentations, each of which is a subEvent of the
603
     * conference.
604
     *
605
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
606
     *
607
     * @return static
608
     *
609
     * @see http://schema.org/subEvent
610
     */
611
    public function subEvent($subEvent)
612
    {
613
        return $this->setProperty('subEvent', $subEvent);
614
    }
615
616
    /**
617
     * Events that are a part of this event. For example, a conference event
618
     * includes many presentations, each subEvents of the conference.
619
     *
620
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
621
     *
622
     * @return static
623
     *
624
     * @see http://schema.org/subEvents
625
     */
626
    public function subEvents($subEvents)
627
    {
628
        return $this->setProperty('subEvents', $subEvents);
629
    }
630
631
    /**
632
     * A CreativeWork or Event about this Thing.
633
     *
634
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
635
     *
636
     * @return static
637
     *
638
     * @see http://schema.org/subjectOf
639
     */
640
    public function subjectOf($subjectOf)
641
    {
642
        return $this->setProperty('subjectOf', $subjectOf);
643
    }
644
645
    /**
646
     * An event that this event is a part of. For example, a collection of
647
     * individual music performances might each have a music festival as their
648
     * superEvent.
649
     *
650
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
651
     *
652
     * @return static
653
     *
654
     * @see http://schema.org/superEvent
655
     */
656
    public function superEvent($superEvent)
657
    {
658
        return $this->setProperty('superEvent', $superEvent);
659
    }
660
661
    /**
662
     * Organization or person who adapts a creative work to different languages,
663
     * regional differences and technical requirements of a target market, or
664
     * that translates during some event.
665
     *
666
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
667
     *
668
     * @return static
669
     *
670
     * @see http://schema.org/translator
671
     */
672
    public function translator($translator)
673
    {
674
        return $this->setProperty('translator', $translator);
675
    }
676
677
    /**
678
     * The typical expected age range, e.g. '7-9', '11-'.
679
     *
680
     * @param string|string[] $typicalAgeRange
681
     *
682
     * @return static
683
     *
684
     * @see http://schema.org/typicalAgeRange
685
     */
686
    public function typicalAgeRange($typicalAgeRange)
687
    {
688
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
689
    }
690
691
    /**
692
     * URL of the item.
693
     *
694
     * @param string|string[] $url
695
     *
696
     * @return static
697
     *
698
     * @see http://schema.org/url
699
     */
700
    public function url($url)
701
    {
702
        return $this->setProperty('url', $url);
703
    }
704
705
    /**
706
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
707
     *        Specific subproperties are available for workPerformed (e.g. a
708
     * play), or a workPresented (a Movie at a ScreeningEvent).
709
     *
710
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
711
     *
712
     * @return static
713
     *
714
     * @see http://schema.org/workFeatured
715
     */
716
    public function workFeatured($workFeatured)
717
    {
718
        return $this->setProperty('workFeatured', $workFeatured);
719
    }
720
721
    /**
722
     * A work performed in some event, for example a play performed in a
723
     * TheaterEvent.
724
     *
725
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
726
     *
727
     * @return static
728
     *
729
     * @see http://schema.org/workPerformed
730
     */
731
    public function workPerformed($workPerformed)
732
    {
733
        return $this->setProperty('workPerformed', $workPerformed);
734
    }
735
736
}
737

src/UserTweets.php 1 location

@@ 18-736 (lines=719) @@
15
 * @see http://schema.org/UserTweets
16
 *
17
 */
18
class UserTweets extends BaseType implements UserTweetsContract, EventContract, ThingContract, UserInteractionContract
19
{
20
    /**
21
     * The subject matter of the content.
22
     *
23
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
24
     *
25
     * @return static
26
     *
27
     * @see http://schema.org/about
28
     */
29
    public function about($about)
30
    {
31
        return $this->setProperty('about', $about);
32
    }
33
34
    /**
35
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
36
     * Actors can be associated with individual items or with a series, episode,
37
     * clip.
38
     *
39
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/actor
44
     */
45
    public function actor($actor)
46
    {
47
        return $this->setProperty('actor', $actor);
48
    }
49
50
    /**
51
     * An additional type for the item, typically used for adding more specific
52
     * types from external vocabularies in microdata syntax. This is a
53
     * relationship between something and a class that the thing is in. In RDFa
54
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
55
     * attribute - for multiple types. Schema.org tools may have only weaker
56
     * understanding of extra types, in particular those defined externally.
57
     *
58
     * @param string|string[] $additionalType
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/additionalType
63
     */
64
    public function additionalType($additionalType)
65
    {
66
        return $this->setProperty('additionalType', $additionalType);
67
    }
68
69
    /**
70
     * The overall rating, based on a collection of reviews or ratings, of the
71
     * item.
72
     *
73
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
74
     *
75
     * @return static
76
     *
77
     * @see http://schema.org/aggregateRating
78
     */
79
    public function aggregateRating($aggregateRating)
80
    {
81
        return $this->setProperty('aggregateRating', $aggregateRating);
82
    }
83
84
    /**
85
     * An alias for the item.
86
     *
87
     * @param string|string[] $alternateName
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/alternateName
92
     */
93
    public function alternateName($alternateName)
94
    {
95
        return $this->setProperty('alternateName', $alternateName);
96
    }
97
98
    /**
99
     * A person or organization attending the event.
100
     *
101
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/attendee
106
     */
107
    public function attendee($attendee)
108
    {
109
        return $this->setProperty('attendee', $attendee);
110
    }
111
112
    /**
113
     * A person attending the event.
114
     *
115
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/attendees
120
     */
121
    public function attendees($attendees)
122
    {
123
        return $this->setProperty('attendees', $attendees);
124
    }
125
126
    /**
127
     * An intended audience, i.e. a group for whom something was created.
128
     *
129
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
130
     *
131
     * @return static
132
     *
133
     * @see http://schema.org/audience
134
     */
135
    public function audience($audience)
136
    {
137
        return $this->setProperty('audience', $audience);
138
    }
139
140
    /**
141
     * The person or organization who wrote a composition, or who is the
142
     * composer of a work performed at some event.
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/composer
149
     */
150
    public function composer($composer)
151
    {
152
        return $this->setProperty('composer', $composer);
153
    }
154
155
    /**
156
     * A secondary contributor to the CreativeWork or Event.
157
     *
158
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
159
     *
160
     * @return static
161
     *
162
     * @see http://schema.org/contributor
163
     */
164
    public function contributor($contributor)
165
    {
166
        return $this->setProperty('contributor', $contributor);
167
    }
168
169
    /**
170
     * A description of the item.
171
     *
172
     * @param string|string[] $description
173
     *
174
     * @return static
175
     *
176
     * @see http://schema.org/description
177
     */
178
    public function description($description)
179
    {
180
        return $this->setProperty('description', $description);
181
    }
182
183
    /**
184
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
185
     * event. Directors can be associated with individual items or with a
186
     * series, episode, clip.
187
     *
188
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/director
193
     */
194
    public function director($director)
195
    {
196
        return $this->setProperty('director', $director);
197
    }
198
199
    /**
200
     * A sub property of description. A short description of the item used to
201
     * disambiguate from other, similar items. Information from other properties
202
     * (in particular, name) may be necessary for the description to be useful
203
     * for disambiguation.
204
     *
205
     * @param string|string[] $disambiguatingDescription
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/disambiguatingDescription
210
     */
211
    public function disambiguatingDescription($disambiguatingDescription)
212
    {
213
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
214
    }
215
216
    /**
217
     * The time admission will commence.
218
     *
219
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/doorTime
224
     */
225
    public function doorTime($doorTime)
226
    {
227
        return $this->setProperty('doorTime', $doorTime);
228
    }
229
230
    /**
231
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
232
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
233
     *
234
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/duration
239
     */
240
    public function duration($duration)
241
    {
242
        return $this->setProperty('duration', $duration);
243
    }
244
245
    /**
246
     * The end date and time of the item (in [ISO 8601 date
247
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
248
     *
249
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/endDate
254
     */
255
    public function endDate($endDate)
256
    {
257
        return $this->setProperty('endDate', $endDate);
258
    }
259
260
    /**
261
     * An eventStatus of an event represents its status; particularly useful
262
     * when an event is cancelled or rescheduled.
263
     *
264
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/eventStatus
269
     */
270
    public function eventStatus($eventStatus)
271
    {
272
        return $this->setProperty('eventStatus', $eventStatus);
273
    }
274
275
    /**
276
     * A person or organization that supports (sponsors) something through some
277
     * kind of financial contribution.
278
     *
279
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
280
     *
281
     * @return static
282
     *
283
     * @see http://schema.org/funder
284
     */
285
    public function funder($funder)
286
    {
287
        return $this->setProperty('funder', $funder);
288
    }
289
290
    /**
291
     * The identifier property represents any kind of identifier for any kind of
292
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
293
     * dedicated properties for representing many of these, either as textual
294
     * strings or as URL (URI) links. See [background
295
     * notes](/docs/datamodel.html#identifierBg) for more details.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/identifier
302
     */
303
    public function identifier($identifier)
304
    {
305
        return $this->setProperty('identifier', $identifier);
306
    }
307
308
    /**
309
     * An image of the item. This can be a [[URL]] or a fully described
310
     * [[ImageObject]].
311
     *
312
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
313
     *
314
     * @return static
315
     *
316
     * @see http://schema.org/image
317
     */
318
    public function image($image)
319
    {
320
        return $this->setProperty('image', $image);
321
    }
322
323
    /**
324
     * The language of the content or performance or used in an action. Please
325
     * use one of the language codes from the [IETF BCP 47
326
     * standard](http://tools.ietf.org/html/bcp47). See also
327
     * [[availableLanguage]].
328
     *
329
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/inLanguage
334
     */
335
    public function inLanguage($inLanguage)
336
    {
337
        return $this->setProperty('inLanguage', $inLanguage);
338
    }
339
340
    /**
341
     * A flag to signal that the item, event, or place is accessible for free.
342
     *
343
     * @param bool|bool[] $isAccessibleForFree
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/isAccessibleForFree
348
     */
349
    public function isAccessibleForFree($isAccessibleForFree)
350
    {
351
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
352
    }
353
354
    /**
355
     * The location of for example where the event is happening, an organization
356
     * is located, or where an action takes place.
357
     *
358
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/location
363
     */
364
    public function location($location)
365
    {
366
        return $this->setProperty('location', $location);
367
    }
368
369
    /**
370
     * Indicates a page (or other CreativeWork) for which this thing is the main
371
     * entity being described. See [background
372
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
373
     *
374
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
375
     *
376
     * @return static
377
     *
378
     * @see http://schema.org/mainEntityOfPage
379
     */
380
    public function mainEntityOfPage($mainEntityOfPage)
381
    {
382
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
383
    }
384
385
    /**
386
     * The total number of individuals that may attend an event or venue.
387
     *
388
     * @param int|int[] $maximumAttendeeCapacity
389
     *
390
     * @return static
391
     *
392
     * @see http://schema.org/maximumAttendeeCapacity
393
     */
394
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
395
    {
396
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
397
    }
398
399
    /**
400
     * The name of the item.
401
     *
402
     * @param string|string[] $name
403
     *
404
     * @return static
405
     *
406
     * @see http://schema.org/name
407
     */
408
    public function name($name)
409
    {
410
        return $this->setProperty('name', $name);
411
    }
412
413
    /**
414
     * An offer to provide this item&#x2014;for example, an offer to sell a
415
     * product, rent the DVD of a movie, perform a service, or give away tickets
416
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
417
     * offered, i.e. sell, lease, etc. This property can also be used to
418
     * describe a [[Demand]]. While this property is listed as expected on a
419
     * number of common types, it can be used in others. In that case, using a
420
     * second type, such as Product or a subtype of Product, can clarify the
421
     * nature of the offer.
422
     *
423
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
424
     *
425
     * @return static
426
     *
427
     * @see http://schema.org/offers
428
     */
429
    public function offers($offers)
430
    {
431
        return $this->setProperty('offers', $offers);
432
    }
433
434
    /**
435
     * An organizer of an Event.
436
     *
437
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
438
     *
439
     * @return static
440
     *
441
     * @see http://schema.org/organizer
442
     */
443
    public function organizer($organizer)
444
    {
445
        return $this->setProperty('organizer', $organizer);
446
    }
447
448
    /**
449
     * A performer at the event&#x2014;for example, a presenter, musician,
450
     * musical group or actor.
451
     *
452
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
453
     *
454
     * @return static
455
     *
456
     * @see http://schema.org/performer
457
     */
458
    public function performer($performer)
459
    {
460
        return $this->setProperty('performer', $performer);
461
    }
462
463
    /**
464
     * The main performer or performers of the event&#x2014;for example, a
465
     * presenter, musician, or actor.
466
     *
467
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
468
     *
469
     * @return static
470
     *
471
     * @see http://schema.org/performers
472
     */
473
    public function performers($performers)
474
    {
475
        return $this->setProperty('performers', $performers);
476
    }
477
478
    /**
479
     * Indicates a potential Action, which describes an idealized action in
480
     * which this thing would play an 'object' role.
481
     *
482
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
483
     *
484
     * @return static
485
     *
486
     * @see http://schema.org/potentialAction
487
     */
488
    public function potentialAction($potentialAction)
489
    {
490
        return $this->setProperty('potentialAction', $potentialAction);
491
    }
492
493
    /**
494
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
495
     * This property contains the previously scheduled start date. For
496
     * rescheduled events, the startDate property should be used for the newly
497
     * scheduled start date. In the (rare) case of an event that has been
498
     * postponed and rescheduled multiple times, this field may be repeated.
499
     *
500
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
501
     *
502
     * @return static
503
     *
504
     * @see http://schema.org/previousStartDate
505
     */
506
    public function previousStartDate($previousStartDate)
507
    {
508
        return $this->setProperty('previousStartDate', $previousStartDate);
509
    }
510
511
    /**
512
     * The CreativeWork that captured all or part of this Event.
513
     *
514
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
515
     *
516
     * @return static
517
     *
518
     * @see http://schema.org/recordedIn
519
     */
520
    public function recordedIn($recordedIn)
521
    {
522
        return $this->setProperty('recordedIn', $recordedIn);
523
    }
524
525
    /**
526
     * The number of attendee places for an event that remain unallocated.
527
     *
528
     * @param int|int[] $remainingAttendeeCapacity
529
     *
530
     * @return static
531
     *
532
     * @see http://schema.org/remainingAttendeeCapacity
533
     */
534
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
535
    {
536
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
537
    }
538
539
    /**
540
     * A review of the item.
541
     *
542
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
543
     *
544
     * @return static
545
     *
546
     * @see http://schema.org/review
547
     */
548
    public function review($review)
549
    {
550
        return $this->setProperty('review', $review);
551
    }
552
553
    /**
554
     * URL of a reference Web page that unambiguously indicates the item's
555
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
556
     * official website.
557
     *
558
     * @param string|string[] $sameAs
559
     *
560
     * @return static
561
     *
562
     * @see http://schema.org/sameAs
563
     */
564
    public function sameAs($sameAs)
565
    {
566
        return $this->setProperty('sameAs', $sameAs);
567
    }
568
569
    /**
570
     * A person or organization that supports a thing through a pledge, promise,
571
     * or financial contribution. e.g. a sponsor of a Medical Study or a
572
     * corporate sponsor of an event.
573
     *
574
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
575
     *
576
     * @return static
577
     *
578
     * @see http://schema.org/sponsor
579
     */
580
    public function sponsor($sponsor)
581
    {
582
        return $this->setProperty('sponsor', $sponsor);
583
    }
584
585
    /**
586
     * The start date and time of the item (in [ISO 8601 date
587
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
588
     *
589
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
590
     *
591
     * @return static
592
     *
593
     * @see http://schema.org/startDate
594
     */
595
    public function startDate($startDate)
596
    {
597
        return $this->setProperty('startDate', $startDate);
598
    }
599
600
    /**
601
     * An Event that is part of this event. For example, a conference event
602
     * includes many presentations, each of which is a subEvent of the
603
     * conference.
604
     *
605
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
606
     *
607
     * @return static
608
     *
609
     * @see http://schema.org/subEvent
610
     */
611
    public function subEvent($subEvent)
612
    {
613
        return $this->setProperty('subEvent', $subEvent);
614
    }
615
616
    /**
617
     * Events that are a part of this event. For example, a conference event
618
     * includes many presentations, each subEvents of the conference.
619
     *
620
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
621
     *
622
     * @return static
623
     *
624
     * @see http://schema.org/subEvents
625
     */
626
    public function subEvents($subEvents)
627
    {
628
        return $this->setProperty('subEvents', $subEvents);
629
    }
630
631
    /**
632
     * A CreativeWork or Event about this Thing.
633
     *
634
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
635
     *
636
     * @return static
637
     *
638
     * @see http://schema.org/subjectOf
639
     */
640
    public function subjectOf($subjectOf)
641
    {
642
        return $this->setProperty('subjectOf', $subjectOf);
643
    }
644
645
    /**
646
     * An event that this event is a part of. For example, a collection of
647
     * individual music performances might each have a music festival as their
648
     * superEvent.
649
     *
650
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
651
     *
652
     * @return static
653
     *
654
     * @see http://schema.org/superEvent
655
     */
656
    public function superEvent($superEvent)
657
    {
658
        return $this->setProperty('superEvent', $superEvent);
659
    }
660
661
    /**
662
     * Organization or person who adapts a creative work to different languages,
663
     * regional differences and technical requirements of a target market, or
664
     * that translates during some event.
665
     *
666
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
667
     *
668
     * @return static
669
     *
670
     * @see http://schema.org/translator
671
     */
672
    public function translator($translator)
673
    {
674
        return $this->setProperty('translator', $translator);
675
    }
676
677
    /**
678
     * The typical expected age range, e.g. '7-9', '11-'.
679
     *
680
     * @param string|string[] $typicalAgeRange
681
     *
682
     * @return static
683
     *
684
     * @see http://schema.org/typicalAgeRange
685
     */
686
    public function typicalAgeRange($typicalAgeRange)
687
    {
688
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
689
    }
690
691
    /**
692
     * URL of the item.
693
     *
694
     * @param string|string[] $url
695
     *
696
     * @return static
697
     *
698
     * @see http://schema.org/url
699
     */
700
    public function url($url)
701
    {
702
        return $this->setProperty('url', $url);
703
    }
704
705
    /**
706
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
707
     *        Specific subproperties are available for workPerformed (e.g. a
708
     * play), or a workPresented (a Movie at a ScreeningEvent).
709
     *
710
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
711
     *
712
     * @return static
713
     *
714
     * @see http://schema.org/workFeatured
715
     */
716
    public function workFeatured($workFeatured)
717
    {
718
        return $this->setProperty('workFeatured', $workFeatured);
719
    }
720
721
    /**
722
     * A work performed in some event, for example a play performed in a
723
     * TheaterEvent.
724
     *
725
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
726
     *
727
     * @return static
728
     *
729
     * @see http://schema.org/workPerformed
730
     */
731
    public function workPerformed($workPerformed)
732
    {
733
        return $this->setProperty('workPerformed', $workPerformed);
734
    }
735
736
}
737

src/VisualArtsEvent.php 1 location

@@ 15-733 (lines=719) @@
12
 * @see http://schema.org/VisualArtsEvent
13
 *
14
 */
15
class VisualArtsEvent extends BaseType implements VisualArtsEventContract, EventContract, ThingContract
16
{
17
    /**
18
     * The subject matter of the content.
19
     *
20
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $about
21
     *
22
     * @return static
23
     *
24
     * @see http://schema.org/about
25
     */
26
    public function about($about)
27
    {
28
        return $this->setProperty('about', $about);
29
    }
30
31
    /**
32
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
33
     * Actors can be associated with individual items or with a series, episode,
34
     * clip.
35
     *
36
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $actor
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/actor
41
     */
42
    public function actor($actor)
43
    {
44
        return $this->setProperty('actor', $actor);
45
    }
46
47
    /**
48
     * An additional type for the item, typically used for adding more specific
49
     * types from external vocabularies in microdata syntax. This is a
50
     * relationship between something and a class that the thing is in. In RDFa
51
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
52
     * attribute - for multiple types. Schema.org tools may have only weaker
53
     * understanding of extra types, in particular those defined externally.
54
     *
55
     * @param string|string[] $additionalType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/additionalType
60
     */
61
    public function additionalType($additionalType)
62
    {
63
        return $this->setProperty('additionalType', $additionalType);
64
    }
65
66
    /**
67
     * The overall rating, based on a collection of reviews or ratings, of the
68
     * item.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/aggregateRating
75
     */
76
    public function aggregateRating($aggregateRating)
77
    {
78
        return $this->setProperty('aggregateRating', $aggregateRating);
79
    }
80
81
    /**
82
     * An alias for the item.
83
     *
84
     * @param string|string[] $alternateName
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/alternateName
89
     */
90
    public function alternateName($alternateName)
91
    {
92
        return $this->setProperty('alternateName', $alternateName);
93
    }
94
95
    /**
96
     * A person or organization attending the event.
97
     *
98
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendee
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/attendee
103
     */
104
    public function attendee($attendee)
105
    {
106
        return $this->setProperty('attendee', $attendee);
107
    }
108
109
    /**
110
     * A person attending the event.
111
     *
112
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $attendees
113
     *
114
     * @return static
115
     *
116
     * @see http://schema.org/attendees
117
     */
118
    public function attendees($attendees)
119
    {
120
        return $this->setProperty('attendees', $attendees);
121
    }
122
123
    /**
124
     * An intended audience, i.e. a group for whom something was created.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/audience
131
     */
132
    public function audience($audience)
133
    {
134
        return $this->setProperty('audience', $audience);
135
    }
136
137
    /**
138
     * The person or organization who wrote a composition, or who is the
139
     * composer of a work performed at some event.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $composer
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/composer
146
     */
147
    public function composer($composer)
148
    {
149
        return $this->setProperty('composer', $composer);
150
    }
151
152
    /**
153
     * A secondary contributor to the CreativeWork or Event.
154
     *
155
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $contributor
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/contributor
160
     */
161
    public function contributor($contributor)
162
    {
163
        return $this->setProperty('contributor', $contributor);
164
    }
165
166
    /**
167
     * A description of the item.
168
     *
169
     * @param string|string[] $description
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/description
174
     */
175
    public function description($description)
176
    {
177
        return $this->setProperty('description', $description);
178
    }
179
180
    /**
181
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
182
     * event. Directors can be associated with individual items or with a
183
     * series, episode, clip.
184
     *
185
     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $director
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/director
190
     */
191
    public function director($director)
192
    {
193
        return $this->setProperty('director', $director);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * The time admission will commence.
215
     *
216
     * @param \DateTimeInterface|\DateTimeInterface[] $doorTime
217
     *
218
     * @return static
219
     *
220
     * @see http://schema.org/doorTime
221
     */
222
    public function doorTime($doorTime)
223
    {
224
        return $this->setProperty('doorTime', $doorTime);
225
    }
226
227
    /**
228
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
229
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[] $duration
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/duration
236
     */
237
    public function duration($duration)
238
    {
239
        return $this->setProperty('duration', $duration);
240
    }
241
242
    /**
243
     * The end date and time of the item (in [ISO 8601 date
244
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
245
     *
246
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/endDate
251
     */
252
    public function endDate($endDate)
253
    {
254
        return $this->setProperty('endDate', $endDate);
255
    }
256
257
    /**
258
     * An eventStatus of an event represents its status; particularly useful
259
     * when an event is cancelled or rescheduled.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[] $eventStatus
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/eventStatus
266
     */
267
    public function eventStatus($eventStatus)
268
    {
269
        return $this->setProperty('eventStatus', $eventStatus);
270
    }
271
272
    /**
273
     * A person or organization that supports (sponsors) something through some
274
     * kind of financial contribution.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $funder
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/funder
281
     */
282
    public function funder($funder)
283
    {
284
        return $this->setProperty('funder', $funder);
285
    }
286
287
    /**
288
     * The identifier property represents any kind of identifier for any kind of
289
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
290
     * dedicated properties for representing many of these, either as textual
291
     * strings or as URL (URI) links. See [background
292
     * notes](/docs/datamodel.html#identifierBg) for more details.
293
     *
294
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/identifier
299
     */
300
    public function identifier($identifier)
301
    {
302
        return $this->setProperty('identifier', $identifier);
303
    }
304
305
    /**
306
     * An image of the item. This can be a [[URL]] or a fully described
307
     * [[ImageObject]].
308
     *
309
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
310
     *
311
     * @return static
312
     *
313
     * @see http://schema.org/image
314
     */
315
    public function image($image)
316
    {
317
        return $this->setProperty('image', $image);
318
    }
319
320
    /**
321
     * The language of the content or performance or used in an action. Please
322
     * use one of the language codes from the [IETF BCP 47
323
     * standard](http://tools.ietf.org/html/bcp47). See also
324
     * [[availableLanguage]].
325
     *
326
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage
327
     *
328
     * @return static
329
     *
330
     * @see http://schema.org/inLanguage
331
     */
332
    public function inLanguage($inLanguage)
333
    {
334
        return $this->setProperty('inLanguage', $inLanguage);
335
    }
336
337
    /**
338
     * A flag to signal that the item, event, or place is accessible for free.
339
     *
340
     * @param bool|bool[] $isAccessibleForFree
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/isAccessibleForFree
345
     */
346
    public function isAccessibleForFree($isAccessibleForFree)
347
    {
348
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
349
    }
350
351
    /**
352
     * The location of for example where the event is happening, an organization
353
     * is located, or where an action takes place.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/location
360
     */
361
    public function location($location)
362
    {
363
        return $this->setProperty('location', $location);
364
    }
365
366
    /**
367
     * Indicates a page (or other CreativeWork) for which this thing is the main
368
     * entity being described. See [background
369
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
370
     *
371
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/mainEntityOfPage
376
     */
377
    public function mainEntityOfPage($mainEntityOfPage)
378
    {
379
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
380
    }
381
382
    /**
383
     * The total number of individuals that may attend an event or venue.
384
     *
385
     * @param int|int[] $maximumAttendeeCapacity
386
     *
387
     * @return static
388
     *
389
     * @see http://schema.org/maximumAttendeeCapacity
390
     */
391
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
392
    {
393
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
394
    }
395
396
    /**
397
     * The name of the item.
398
     *
399
     * @param string|string[] $name
400
     *
401
     * @return static
402
     *
403
     * @see http://schema.org/name
404
     */
405
    public function name($name)
406
    {
407
        return $this->setProperty('name', $name);
408
    }
409
410
    /**
411
     * An offer to provide this item&#x2014;for example, an offer to sell a
412
     * product, rent the DVD of a movie, perform a service, or give away tickets
413
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
414
     * offered, i.e. sell, lease, etc. This property can also be used to
415
     * describe a [[Demand]]. While this property is listed as expected on a
416
     * number of common types, it can be used in others. In that case, using a
417
     * second type, such as Product or a subtype of Product, can clarify the
418
     * nature of the offer.
419
     *
420
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
421
     *
422
     * @return static
423
     *
424
     * @see http://schema.org/offers
425
     */
426
    public function offers($offers)
427
    {
428
        return $this->setProperty('offers', $offers);
429
    }
430
431
    /**
432
     * An organizer of an Event.
433
     *
434
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $organizer
435
     *
436
     * @return static
437
     *
438
     * @see http://schema.org/organizer
439
     */
440
    public function organizer($organizer)
441
    {
442
        return $this->setProperty('organizer', $organizer);
443
    }
444
445
    /**
446
     * A performer at the event&#x2014;for example, a presenter, musician,
447
     * musical group or actor.
448
     *
449
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performer
450
     *
451
     * @return static
452
     *
453
     * @see http://schema.org/performer
454
     */
455
    public function performer($performer)
456
    {
457
        return $this->setProperty('performer', $performer);
458
    }
459
460
    /**
461
     * The main performer or performers of the event&#x2014;for example, a
462
     * presenter, musician, or actor.
463
     *
464
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $performers
465
     *
466
     * @return static
467
     *
468
     * @see http://schema.org/performers
469
     */
470
    public function performers($performers)
471
    {
472
        return $this->setProperty('performers', $performers);
473
    }
474
475
    /**
476
     * Indicates a potential Action, which describes an idealized action in
477
     * which this thing would play an 'object' role.
478
     *
479
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
480
     *
481
     * @return static
482
     *
483
     * @see http://schema.org/potentialAction
484
     */
485
    public function potentialAction($potentialAction)
486
    {
487
        return $this->setProperty('potentialAction', $potentialAction);
488
    }
489
490
    /**
491
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
492
     * This property contains the previously scheduled start date. For
493
     * rescheduled events, the startDate property should be used for the newly
494
     * scheduled start date. In the (rare) case of an event that has been
495
     * postponed and rescheduled multiple times, this field may be repeated.
496
     *
497
     * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/previousStartDate
502
     */
503
    public function previousStartDate($previousStartDate)
504
    {
505
        return $this->setProperty('previousStartDate', $previousStartDate);
506
    }
507
508
    /**
509
     * The CreativeWork that captured all or part of this Event.
510
     *
511
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $recordedIn
512
     *
513
     * @return static
514
     *
515
     * @see http://schema.org/recordedIn
516
     */
517
    public function recordedIn($recordedIn)
518
    {
519
        return $this->setProperty('recordedIn', $recordedIn);
520
    }
521
522
    /**
523
     * The number of attendee places for an event that remain unallocated.
524
     *
525
     * @param int|int[] $remainingAttendeeCapacity
526
     *
527
     * @return static
528
     *
529
     * @see http://schema.org/remainingAttendeeCapacity
530
     */
531
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
532
    {
533
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
534
    }
535
536
    /**
537
     * A review of the item.
538
     *
539
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
540
     *
541
     * @return static
542
     *
543
     * @see http://schema.org/review
544
     */
545
    public function review($review)
546
    {
547
        return $this->setProperty('review', $review);
548
    }
549
550
    /**
551
     * URL of a reference Web page that unambiguously indicates the item's
552
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
553
     * official website.
554
     *
555
     * @param string|string[] $sameAs
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/sameAs
560
     */
561
    public function sameAs($sameAs)
562
    {
563
        return $this->setProperty('sameAs', $sameAs);
564
    }
565
566
    /**
567
     * A person or organization that supports a thing through a pledge, promise,
568
     * or financial contribution. e.g. a sponsor of a Medical Study or a
569
     * corporate sponsor of an event.
570
     *
571
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
572
     *
573
     * @return static
574
     *
575
     * @see http://schema.org/sponsor
576
     */
577
    public function sponsor($sponsor)
578
    {
579
        return $this->setProperty('sponsor', $sponsor);
580
    }
581
582
    /**
583
     * The start date and time of the item (in [ISO 8601 date
584
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
585
     *
586
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
587
     *
588
     * @return static
589
     *
590
     * @see http://schema.org/startDate
591
     */
592
    public function startDate($startDate)
593
    {
594
        return $this->setProperty('startDate', $startDate);
595
    }
596
597
    /**
598
     * An Event that is part of this event. For example, a conference event
599
     * includes many presentations, each of which is a subEvent of the
600
     * conference.
601
     *
602
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvent
603
     *
604
     * @return static
605
     *
606
     * @see http://schema.org/subEvent
607
     */
608
    public function subEvent($subEvent)
609
    {
610
        return $this->setProperty('subEvent', $subEvent);
611
    }
612
613
    /**
614
     * Events that are a part of this event. For example, a conference event
615
     * includes many presentations, each subEvents of the conference.
616
     *
617
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subEvents
618
     *
619
     * @return static
620
     *
621
     * @see http://schema.org/subEvents
622
     */
623
    public function subEvents($subEvents)
624
    {
625
        return $this->setProperty('subEvents', $subEvents);
626
    }
627
628
    /**
629
     * A CreativeWork or Event about this Thing.
630
     *
631
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
632
     *
633
     * @return static
634
     *
635
     * @see http://schema.org/subjectOf
636
     */
637
    public function subjectOf($subjectOf)
638
    {
639
        return $this->setProperty('subjectOf', $subjectOf);
640
    }
641
642
    /**
643
     * An event that this event is a part of. For example, a collection of
644
     * individual music performances might each have a music festival as their
645
     * superEvent.
646
     *
647
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $superEvent
648
     *
649
     * @return static
650
     *
651
     * @see http://schema.org/superEvent
652
     */
653
    public function superEvent($superEvent)
654
    {
655
        return $this->setProperty('superEvent', $superEvent);
656
    }
657
658
    /**
659
     * Organization or person who adapts a creative work to different languages,
660
     * regional differences and technical requirements of a target market, or
661
     * that translates during some event.
662
     *
663
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $translator
664
     *
665
     * @return static
666
     *
667
     * @see http://schema.org/translator
668
     */
669
    public function translator($translator)
670
    {
671
        return $this->setProperty('translator', $translator);
672
    }
673
674
    /**
675
     * The typical expected age range, e.g. '7-9', '11-'.
676
     *
677
     * @param string|string[] $typicalAgeRange
678
     *
679
     * @return static
680
     *
681
     * @see http://schema.org/typicalAgeRange
682
     */
683
    public function typicalAgeRange($typicalAgeRange)
684
    {
685
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
686
    }
687
688
    /**
689
     * URL of the item.
690
     *
691
     * @param string|string[] $url
692
     *
693
     * @return static
694
     *
695
     * @see http://schema.org/url
696
     */
697
    public function url($url)
698
    {
699
        return $this->setProperty('url', $url);
700
    }
701
702
    /**
703
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
704
     *        Specific subproperties are available for workPerformed (e.g. a
705
     * play), or a workPresented (a Movie at a ScreeningEvent).
706
     *
707
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workFeatured
708
     *
709
     * @return static
710
     *
711
     * @see http://schema.org/workFeatured
712
     */
713
    public function workFeatured($workFeatured)
714
    {
715
        return $this->setProperty('workFeatured', $workFeatured);
716
    }
717
718
    /**
719
     * A work performed in some event, for example a play performed in a
720
     * TheaterEvent.
721
     *
722
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $workPerformed
723
     *
724
     * @return static
725
     *
726
     * @see http://schema.org/workPerformed
727
     */
728
    public function workPerformed($workPerformed)
729
    {
730
        return $this->setProperty('workPerformed', $workPerformed);
731
    }
732
733
}
734

src/Zoo.php 1 location

@@ 16-713 (lines=698) @@
13
 * @see http://schema.org/Zoo
14
 *
15
 */
16
class Zoo extends BaseType implements ZooContract, CivicStructureContract, PlaceContract, ThingContract
17
{
18
    /**
19
     * A property-value pair representing an additional characteristics of the
20
     * entitity, e.g. a product feature or another characteristic for which
21
     * there is no matching property in schema.org.
22
     * 
23
     * Note: Publishers should be aware that applications designed to use
24
     * specific schema.org properties (e.g. http://schema.org/width,
25
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
26
     * expect such data to be provided using those properties, rather than using
27
     * the generic property/value mechanism.
28
     *
29
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[] $additionalProperty
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalProperty
34
     */
35
    public function additionalProperty($additionalProperty)
36
    {
37
        return $this->setProperty('additionalProperty', $additionalProperty);
38
    }
39
40
    /**
41
     * An additional type for the item, typically used for adding more specific
42
     * types from external vocabularies in microdata syntax. This is a
43
     * relationship between something and a class that the thing is in. In RDFa
44
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
45
     * attribute - for multiple types. Schema.org tools may have only weaker
46
     * understanding of extra types, in particular those defined externally.
47
     *
48
     * @param string|string[] $additionalType
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/additionalType
53
     */
54
    public function additionalType($additionalType)
55
    {
56
        return $this->setProperty('additionalType', $additionalType);
57
    }
58
59
    /**
60
     * Physical address of the item.
61
     *
62
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/address
67
     */
68
    public function address($address)
69
    {
70
        return $this->setProperty('address', $address);
71
    }
72
73
    /**
74
     * The overall rating, based on a collection of reviews or ratings, of the
75
     * item.
76
     *
77
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/aggregateRating
82
     */
83
    public function aggregateRating($aggregateRating)
84
    {
85
        return $this->setProperty('aggregateRating', $aggregateRating);
86
    }
87
88
    /**
89
     * An alias for the item.
90
     *
91
     * @param string|string[] $alternateName
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/alternateName
96
     */
97
    public function alternateName($alternateName)
98
    {
99
        return $this->setProperty('alternateName', $alternateName);
100
    }
101
102
    /**
103
     * An amenity feature (e.g. a characteristic or service) of the
104
     * Accommodation. This generic property does not make a statement about
105
     * whether the feature is included in an offer for the main accommodation or
106
     * available at extra costs.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract|\Spatie\SchemaOrg\Contracts\LocationFeatureSpecificationContract[] $amenityFeature
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/amenityFeature
113
     */
114
    public function amenityFeature($amenityFeature)
115
    {
116
        return $this->setProperty('amenityFeature', $amenityFeature);
117
    }
118
119
    /**
120
     * A short textual code (also called "store code") that uniquely identifies
121
     * a place of business. The code is typically assigned by the
122
     * parentOrganization and used in structured URLs.
123
     * 
124
     * For example, in the URL
125
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
126
     * is a branchCode for a particular branch.
127
     *
128
     * @param string|string[] $branchCode
129
     *
130
     * @return static
131
     *
132
     * @see http://schema.org/branchCode
133
     */
134
    public function branchCode($branchCode)
135
    {
136
        return $this->setProperty('branchCode', $branchCode);
137
    }
138
139
    /**
140
     * The basic containment relation between a place and one that contains it.
141
     *
142
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
143
     *
144
     * @return static
145
     *
146
     * @see http://schema.org/containedIn
147
     */
148
    public function containedIn($containedIn)
149
    {
150
        return $this->setProperty('containedIn', $containedIn);
151
    }
152
153
    /**
154
     * The basic containment relation between a place and one that contains it.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/containedInPlace
161
     */
162
    public function containedInPlace($containedInPlace)
163
    {
164
        return $this->setProperty('containedInPlace', $containedInPlace);
165
    }
166
167
    /**
168
     * The basic containment relation between a place and another that it
169
     * contains.
170
     *
171
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/containsPlace
176
     */
177
    public function containsPlace($containsPlace)
178
    {
179
        return $this->setProperty('containsPlace', $containsPlace);
180
    }
181
182
    /**
183
     * A description of the item.
184
     *
185
     * @param string|string[] $description
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/description
190
     */
191
    public function description($description)
192
    {
193
        return $this->setProperty('description', $description);
194
    }
195
196
    /**
197
     * A sub property of description. A short description of the item used to
198
     * disambiguate from other, similar items. Information from other properties
199
     * (in particular, name) may be necessary for the description to be useful
200
     * for disambiguation.
201
     *
202
     * @param string|string[] $disambiguatingDescription
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/disambiguatingDescription
207
     */
208
    public function disambiguatingDescription($disambiguatingDescription)
209
    {
210
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
211
    }
212
213
    /**
214
     * Upcoming or past event associated with this place, organization, or
215
     * action.
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/event
222
     */
223
    public function event($event)
224
    {
225
        return $this->setProperty('event', $event);
226
    }
227
228
    /**
229
     * Upcoming or past events associated with this place or organization.
230
     *
231
     * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/events
236
     */
237
    public function events($events)
238
    {
239
        return $this->setProperty('events', $events);
240
    }
241
242
    /**
243
     * The fax number.
244
     *
245
     * @param string|string[] $faxNumber
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/faxNumber
250
     */
251
    public function faxNumber($faxNumber)
252
    {
253
        return $this->setProperty('faxNumber', $faxNumber);
254
    }
255
256
    /**
257
     * The geo coordinates of the place.
258
     *
259
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/geo
264
     */
265
    public function geo($geo)
266
    {
267
        return $this->setProperty('geo', $geo);
268
    }
269
270
    /**
271
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
272
     * referred to as International Location Number or ILN) of the respective
273
     * organization, person, or place. The GLN is a 13-digit number used to
274
     * identify parties and physical locations.
275
     *
276
     * @param string|string[] $globalLocationNumber
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/globalLocationNumber
281
     */
282
    public function globalLocationNumber($globalLocationNumber)
283
    {
284
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
285
    }
286
287
    /**
288
     * A URL to a map of the place.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\MapContract|\Spatie\SchemaOrg\Contracts\MapContract[]|string|string[] $hasMap
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/hasMap
295
     */
296
    public function hasMap($hasMap)
297
    {
298
        return $this->setProperty('hasMap', $hasMap);
299
    }
300
301
    /**
302
     * The identifier property represents any kind of identifier for any kind of
303
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
304
     * dedicated properties for representing many of these, either as textual
305
     * strings or as URL (URI) links. See [background
306
     * notes](/docs/datamodel.html#identifierBg) for more details.
307
     *
308
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/identifier
313
     */
314
    public function identifier($identifier)
315
    {
316
        return $this->setProperty('identifier', $identifier);
317
    }
318
319
    /**
320
     * An image of the item. This can be a [[URL]] or a fully described
321
     * [[ImageObject]].
322
     *
323
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/image
328
     */
329
    public function image($image)
330
    {
331
        return $this->setProperty('image', $image);
332
    }
333
334
    /**
335
     * A flag to signal that the item, event, or place is accessible for free.
336
     *
337
     * @param bool|bool[] $isAccessibleForFree
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/isAccessibleForFree
342
     */
343
    public function isAccessibleForFree($isAccessibleForFree)
344
    {
345
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
346
    }
347
348
    /**
349
     * The International Standard of Industrial Classification of All Economic
350
     * Activities (ISIC), Revision 4 code for a particular organization,
351
     * business person, or place.
352
     *
353
     * @param string|string[] $isicV4
354
     *
355
     * @return static
356
     *
357
     * @see http://schema.org/isicV4
358
     */
359
    public function isicV4($isicV4)
360
    {
361
        return $this->setProperty('isicV4', $isicV4);
362
    }
363
364
    /**
365
     * The latitude of a location. For example ```37.42242``` ([WGS
366
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
367
     *
368
     * @param float|float[]|int|int[]|string|string[] $latitude
369
     *
370
     * @return static
371
     *
372
     * @see http://schema.org/latitude
373
     */
374
    public function latitude($latitude)
375
    {
376
        return $this->setProperty('latitude', $latitude);
377
    }
378
379
    /**
380
     * An associated logo.
381
     *
382
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
383
     *
384
     * @return static
385
     *
386
     * @see http://schema.org/logo
387
     */
388
    public function logo($logo)
389
    {
390
        return $this->setProperty('logo', $logo);
391
    }
392
393
    /**
394
     * The longitude of a location. For example ```-122.08585``` ([WGS
395
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
396
     *
397
     * @param float|float[]|int|int[]|string|string[] $longitude
398
     *
399
     * @return static
400
     *
401
     * @see http://schema.org/longitude
402
     */
403
    public function longitude($longitude)
404
    {
405
        return $this->setProperty('longitude', $longitude);
406
    }
407
408
    /**
409
     * Indicates a page (or other CreativeWork) for which this thing is the main
410
     * entity being described. See [background
411
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
412
     *
413
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
414
     *
415
     * @return static
416
     *
417
     * @see http://schema.org/mainEntityOfPage
418
     */
419
    public function mainEntityOfPage($mainEntityOfPage)
420
    {
421
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
422
    }
423
424
    /**
425
     * A URL to a map of the place.
426
     *
427
     * @param string|string[] $map
428
     *
429
     * @return static
430
     *
431
     * @see http://schema.org/map
432
     */
433
    public function map($map)
434
    {
435
        return $this->setProperty('map', $map);
436
    }
437
438
    /**
439
     * A URL to a map of the place.
440
     *
441
     * @param string|string[] $maps
442
     *
443
     * @return static
444
     *
445
     * @see http://schema.org/maps
446
     */
447
    public function maps($maps)
448
    {
449
        return $this->setProperty('maps', $maps);
450
    }
451
452
    /**
453
     * The total number of individuals that may attend an event or venue.
454
     *
455
     * @param int|int[] $maximumAttendeeCapacity
456
     *
457
     * @return static
458
     *
459
     * @see http://schema.org/maximumAttendeeCapacity
460
     */
461
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
462
    {
463
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
464
    }
465
466
    /**
467
     * The name of the item.
468
     *
469
     * @param string|string[] $name
470
     *
471
     * @return static
472
     *
473
     * @see http://schema.org/name
474
     */
475
    public function name($name)
476
    {
477
        return $this->setProperty('name', $name);
478
    }
479
480
    /**
481
     * The general opening hours for a business. Opening hours can be specified
482
     * as a weekly time range, starting with days, then times per day. Multiple
483
     * days can be listed with commas ',' separating each day. Day or time
484
     * ranges are specified using a hyphen '-'.
485
     * 
486
     * * Days are specified using the following two-letter combinations:
487
     * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
488
     * * Times are specified using 24:00 time. For example, 3pm is specified as
489
     * ```15:00```. 
490
     * * Here is an example: <code>&lt;time itemprop="openingHours"
491
     * datetime=&quot;Tu,Th 16:00-20:00&quot;&gt;Tuesdays and Thursdays
492
     * 4-8pm&lt;/time&gt;</code>.
493
     * * If a business is open 7 days a week, then it can be specified as
494
     * <code>&lt;time itemprop=&quot;openingHours&quot;
495
     * datetime=&quot;Mo-Su&quot;&gt;Monday through Sunday, all
496
     * day&lt;/time&gt;</code>.
497
     *
498
     * @param string|string[] $openingHours
499
     *
500
     * @return static
501
     *
502
     * @see http://schema.org/openingHours
503
     */
504
    public function openingHours($openingHours)
505
    {
506
        return $this->setProperty('openingHours', $openingHours);
507
    }
508
509
    /**
510
     * The opening hours of a certain place.
511
     *
512
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
513
     *
514
     * @return static
515
     *
516
     * @see http://schema.org/openingHoursSpecification
517
     */
518
    public function openingHoursSpecification($openingHoursSpecification)
519
    {
520
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
521
    }
522
523
    /**
524
     * A photograph of this place.
525
     *
526
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photo
527
     *
528
     * @return static
529
     *
530
     * @see http://schema.org/photo
531
     */
532
    public function photo($photo)
533
    {
534
        return $this->setProperty('photo', $photo);
535
    }
536
537
    /**
538
     * Photographs of this place.
539
     *
540
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|\Spatie\SchemaOrg\Contracts\PhotographContract|\Spatie\SchemaOrg\Contracts\PhotographContract[] $photos
541
     *
542
     * @return static
543
     *
544
     * @see http://schema.org/photos
545
     */
546
    public function photos($photos)
547
    {
548
        return $this->setProperty('photos', $photos);
549
    }
550
551
    /**
552
     * Indicates a potential Action, which describes an idealized action in
553
     * which this thing would play an 'object' role.
554
     *
555
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
556
     *
557
     * @return static
558
     *
559
     * @see http://schema.org/potentialAction
560
     */
561
    public function potentialAction($potentialAction)
562
    {
563
        return $this->setProperty('potentialAction', $potentialAction);
564
    }
565
566
    /**
567
     * A flag to signal that the [[Place]] is open to public visitors.  If this
568
     * property is omitted there is no assumed default boolean value
569
     *
570
     * @param bool|bool[] $publicAccess
571
     *
572
     * @return static
573
     *
574
     * @see http://schema.org/publicAccess
575
     */
576
    public function publicAccess($publicAccess)
577
    {
578
        return $this->setProperty('publicAccess', $publicAccess);
579
    }
580
581
    /**
582
     * A review of the item.
583
     *
584
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
585
     *
586
     * @return static
587
     *
588
     * @see http://schema.org/review
589
     */
590
    public function review($review)
591
    {
592
        return $this->setProperty('review', $review);
593
    }
594
595
    /**
596
     * Review of the item.
597
     *
598
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $reviews
599
     *
600
     * @return static
601
     *
602
     * @see http://schema.org/reviews
603
     */
604
    public function reviews($reviews)
605
    {
606
        return $this->setProperty('reviews', $reviews);
607
    }
608
609
    /**
610
     * URL of a reference Web page that unambiguously indicates the item's
611
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
612
     * official website.
613
     *
614
     * @param string|string[] $sameAs
615
     *
616
     * @return static
617
     *
618
     * @see http://schema.org/sameAs
619
     */
620
    public function sameAs($sameAs)
621
    {
622
        return $this->setProperty('sameAs', $sameAs);
623
    }
624
625
    /**
626
     * A slogan or motto associated with the item.
627
     *
628
     * @param string|string[] $slogan
629
     *
630
     * @return static
631
     *
632
     * @see http://schema.org/slogan
633
     */
634
    public function slogan($slogan)
635
    {
636
        return $this->setProperty('slogan', $slogan);
637
    }
638
639
    /**
640
     * Indicates whether it is allowed to smoke in the place, e.g. in the
641
     * restaurant, hotel or hotel room.
642
     *
643
     * @param bool|bool[] $smokingAllowed
644
     *
645
     * @return static
646
     *
647
     * @see http://schema.org/smokingAllowed
648
     */
649
    public function smokingAllowed($smokingAllowed)
650
    {
651
        return $this->setProperty('smokingAllowed', $smokingAllowed);
652
    }
653
654
    /**
655
     * The special opening hours of a certain place.
656
     * 
657
     * Use this to explicitly override general opening hours brought in scope by
658
     * [[openingHoursSpecification]] or [[openingHours]].
659
     *
660
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $specialOpeningHoursSpecification
661
     *
662
     * @return static
663
     *
664
     * @see http://schema.org/specialOpeningHoursSpecification
665
     */
666
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
667
    {
668
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
669
    }
670
671
    /**
672
     * A CreativeWork or Event about this Thing.
673
     *
674
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
675
     *
676
     * @return static
677
     *
678
     * @see http://schema.org/subjectOf
679
     */
680
    public function subjectOf($subjectOf)
681
    {
682
        return $this->setProperty('subjectOf', $subjectOf);
683
    }
684
685
    /**
686
     * The telephone number.
687
     *
688
     * @param string|string[] $telephone
689
     *
690
     * @return static
691
     *
692
     * @see http://schema.org/telephone
693
     */
694
    public function telephone($telephone)
695
    {
696
        return $this->setProperty('telephone', $telephone);
697
    }
698
699
    /**
700
     * URL of the item.
701
     *
702
     * @param string|string[] $url
703
     *
704
     * @return static
705
     *
706
     * @see http://schema.org/url
707
     */
708
    public function url($url)
709
    {
710
        return $this->setProperty('url', $url);
711
    }
712
713
}
714