Completed
Push — master ( 0fb5cf...c0af4f )
by Sebastian
03:59
created

Event::audience()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
1
<?php
2
3
namespace Spatie\SchemaOrg;
4
5
/**
6
 * An event happening at a certain time and location, such as a concert,
7
 * lecture, or festival. Ticketing information may be added via the [[offers]]
8
 * property. Repeated events may be structured as separate Event objects.
9
 *
10
 * @see http://schema.org/Event
11
 */
12
class Event extends Thing
13
{
14
    /**
15
     * The subject matter of the content.
16
     *
17
     * @param \Spatie\SchemaOrg\Thing $about
18
     *
19
     * @return static
20
     *
21
     * @see http://schema.org/about
22
     */
23
    public function about($about)
24
    {
25
        return $this->setProperty('about', $about);
26
    }
27
28
    /**
29
     * An actor, e.g. in tv, radio, movie, video games etc., or in an event.
30
     * Actors can be associated with individual items or with a series, episode,
31
     * clip.
32
     *
33
     * @param \Spatie\SchemaOrg\Person $actor
34
     *
35
     * @return static
36
     *
37
     * @see http://schema.org/actor
38
     */
39
    public function actor($actor)
40
    {
41
        return $this->setProperty('actor', $actor);
42
    }
43
44
    /**
45
     * The overall rating, based on a collection of reviews or ratings, of the
46
     * item.
47
     *
48
     * @param \Spatie\SchemaOrg\AggregateRating $aggregateRating
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/aggregateRating
53
     */
54
    public function aggregateRating($aggregateRating)
55
    {
56
        return $this->setProperty('aggregateRating', $aggregateRating);
57
    }
58
59
    /**
60
     * An organizer of an Event.
61
     *
62
     * @param \Spatie\SchemaOrg\Person|\Spatie\SchemaOrg\Organization $organizer
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/organizer
67
     */
68
    public function organizer($organizer)
69
    {
70
        return $this->setProperty('organizer', $organizer);
71
    }
72
73
    /**
74
     * A person or organization attending the event.
75
     *
76
     * @param \Spatie\SchemaOrg\Organization|\Spatie\SchemaOrg\Person $attendee
77
     *
78
     * @return static
79
     *
80
     * @see http://schema.org/attendee
81
     */
82
    public function attendee($attendee)
83
    {
84
        return $this->setProperty('attendee', $attendee);
85
    }
86
87
    /**
88
     * A person attending the event.
89
     *
90
     * @param \Spatie\SchemaOrg\Organization|\Spatie\SchemaOrg\Person $attendees
91
     *
92
     * @return static
93
     *
94
     * @see http://schema.org/attendees
95
     */
96
    public function attendees($attendees)
97
    {
98
        return $this->setProperty('attendees', $attendees);
99
    }
100
101
    /**
102
     * An intended audience, i.e. a group for whom something was created.
103
     *
104
     * @param \Spatie\SchemaOrg\Audience $audience
105
     *
106
     * @return static
107
     *
108
     * @see http://schema.org/audience
109
     */
110
    public function audience($audience)
111
    {
112
        return $this->setProperty('audience', $audience);
113
    }
114
115
    /**
116
     * A secondary contributor to the CreativeWork or Event.
117
     *
118
     * @param \Spatie\SchemaOrg\Organization|\Spatie\SchemaOrg\Person $contributor
119
     *
120
     * @return static
121
     *
122
     * @see http://schema.org/contributor
123
     */
124
    public function contributor($contributor)
125
    {
126
        return $this->setProperty('contributor', $contributor);
127
    }
128
129
    /**
130
     * A director of e.g. tv, radio, movie, video gaming etc. content, or of an
131
     * event. Directors can be associated with individual items or with a
132
     * series, episode, clip.
133
     *
134
     * @param \Spatie\SchemaOrg\Person $director
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/director
139
     */
140
    public function director($director)
141
    {
142
        return $this->setProperty('director', $director);
143
    }
144
145
    /**
146
     * The time admission will commence.
147
     *
148
     * @param \DateTimeInterface $doorTime
149
     *
150
     * @return static
151
     *
152
     * @see http://schema.org/doorTime
153
     */
154
    public function doorTime($doorTime)
155
    {
156
        return $this->setProperty('doorTime', $doorTime);
157
    }
158
159
    /**
160
     * The duration of the item (movie, audio recording, event, etc.) in [ISO
161
     * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
162
     *
163
     * @param \Spatie\SchemaOrg\Duration $duration
164
     *
165
     * @return static
166
     *
167
     * @see http://schema.org/duration
168
     */
169
    public function duration($duration)
170
    {
171
        return $this->setProperty('duration', $duration);
172
    }
173
174
    /**
175
     * The end date and time of the item (in [ISO 8601 date
176
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
177
     *
178
     * @param \DateTimeInterface $endDate
179
     *
180
     * @return static
181
     *
182
     * @see http://schema.org/endDate
183
     */
184
    public function endDate($endDate)
185
    {
186
        return $this->setProperty('endDate', $endDate);
187
    }
188
189
    /**
190
     * An eventStatus of an event represents its status; particularly useful
191
     * when an event is cancelled or rescheduled.
192
     *
193
     * @param \Spatie\SchemaOrg\EventStatusType $eventStatus
194
     *
195
     * @return static
196
     *
197
     * @see http://schema.org/eventStatus
198
     */
199
    public function eventStatus($eventStatus)
200
    {
201
        return $this->setProperty('eventStatus', $eventStatus);
202
    }
203
204
    /**
205
     * A flag to signal that the publication is accessible for free.
206
     *
207
     * @param bool $isAccessibleForFree
208
     *
209
     * @return static
210
     *
211
     * @see http://schema.org/isAccessibleForFree
212
     */
213
    public function isAccessibleForFree($isAccessibleForFree)
214
    {
215
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
216
    }
217
218
    /**
219
     * The language of the content or performance or used in an action. Please
220
     * use one of the language codes from the [IETF BCP 47
221
     * standard](http://tools.ietf.org/html/bcp47). See also
222
     * [[availableLanguage]].
223
     *
224
     * @param string|\Spatie\SchemaOrg\Language $inLanguage
225
     *
226
     * @return static
227
     *
228
     * @see http://schema.org/inLanguage
229
     */
230
    public function inLanguage($inLanguage)
231
    {
232
        return $this->setProperty('inLanguage', $inLanguage);
233
    }
234
235
    /**
236
     * The location of for example where the event is happening, an organization
237
     * is located, or where an action takes place.
238
     *
239
     * @param \Spatie\SchemaOrg\Place|\Spatie\SchemaOrg\PostalAddress|string $location
240
     *
241
     * @return static
242
     *
243
     * @see http://schema.org/location
244
     */
245
    public function location($location)
246
    {
247
        return $this->setProperty('location', $location);
248
    }
249
250
    /**
251
     * The total number of individuals that may attend an event or venue.
252
     *
253
     * @param int $maximumAttendeeCapacity
254
     *
255
     * @return static
256
     *
257
     * @see http://schema.org/maximumAttendeeCapacity
258
     */
259
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
260
    {
261
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
262
    }
263
264
    /**
265
     * The number of attendee places for an event that remain unallocated.
266
     *
267
     * @param int $remainingAttendeeCapacity
268
     *
269
     * @return static
270
     *
271
     * @see http://schema.org/remainingAttendeeCapacity
272
     */
273
    public function remainingAttendeeCapacity($remainingAttendeeCapacity)
274
    {
275
        return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity);
276
    }
277
278
    /**
279
     * An offer to provide this item&#x2014;for example, an offer to sell a
280
     * product, rent the DVD of a movie, perform a service, or give away tickets
281
     * to an event.
282
     *
283
     * @param \Spatie\SchemaOrg\Offer $offers
284
     *
285
     * @return static
286
     *
287
     * @see http://schema.org/offers
288
     */
289
    public function offers($offers)
290
    {
291
        return $this->setProperty('offers', $offers);
292
    }
293
294
    /**
295
     * A performer at the event&#x2014;for example, a presenter, musician,
296
     * musical group or actor.
297
     *
298
     * @param \Spatie\SchemaOrg\Organization|\Spatie\SchemaOrg\Person $performer
299
     *
300
     * @return static
301
     *
302
     * @see http://schema.org/performer
303
     */
304
    public function performer($performer)
305
    {
306
        return $this->setProperty('performer', $performer);
307
    }
308
309
    /**
310
     * The main performer or performers of the event&#x2014;for example, a
311
     * presenter, musician, or actor.
312
     *
313
     * @param \Spatie\SchemaOrg\Organization|\Spatie\SchemaOrg\Person $performers
314
     *
315
     * @return static
316
     *
317
     * @see http://schema.org/performers
318
     */
319
    public function performers($performers)
320
    {
321
        return $this->setProperty('performers', $performers);
322
    }
323
324
    /**
325
     * Used in conjunction with eventStatus for rescheduled or cancelled events.
326
     * This property contains the previously scheduled start date. For
327
     * rescheduled events, the startDate property should be used for the newly
328
     * scheduled start date. In the (rare) case of an event that has been
329
     * postponed and rescheduled multiple times, this field may be repeated.
330
     *
331
     * @param \DateTimeInterface $previousStartDate
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/previousStartDate
336
     */
337
    public function previousStartDate($previousStartDate)
338
    {
339
        return $this->setProperty('previousStartDate', $previousStartDate);
340
    }
341
342
    /**
343
     * The CreativeWork that captured all or part of this Event.
344
     *
345
     * @param \Spatie\SchemaOrg\CreativeWork $recordedIn
346
     *
347
     * @return static
348
     *
349
     * @see http://schema.org/recordedIn
350
     */
351
    public function recordedIn($recordedIn)
352
    {
353
        return $this->setProperty('recordedIn', $recordedIn);
354
    }
355
356
    /**
357
     * A review of the item.
358
     *
359
     * @param \Spatie\SchemaOrg\Review $review
360
     *
361
     * @return static
362
     *
363
     * @see http://schema.org/review
364
     */
365
    public function review($review)
366
    {
367
        return $this->setProperty('review', $review);
368
    }
369
370
    /**
371
     * A person or organization that supports a thing through a pledge, promise,
372
     * or financial contribution. e.g. a sponsor of a Medical Study or a
373
     * corporate sponsor of an event.
374
     *
375
     * @param \Spatie\SchemaOrg\Organization|\Spatie\SchemaOrg\Person $sponsor
376
     *
377
     * @return static
378
     *
379
     * @see http://schema.org/sponsor
380
     */
381
    public function sponsor($sponsor)
382
    {
383
        return $this->setProperty('sponsor', $sponsor);
384
    }
385
386
    /**
387
     * A person or organization that supports (sponsors) something through some
388
     * kind of financial contribution.
389
     *
390
     * @param \Spatie\SchemaOrg\Organization|\Spatie\SchemaOrg\Person $funder
391
     *
392
     * @return static
393
     *
394
     * @see http://schema.org/funder
395
     */
396
    public function funder($funder)
397
    {
398
        return $this->setProperty('funder', $funder);
399
    }
400
401
    /**
402
     * The start date and time of the item (in [ISO 8601 date
403
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
404
     *
405
     * @param \DateTimeInterface $startDate
406
     *
407
     * @return static
408
     *
409
     * @see http://schema.org/startDate
410
     */
411
    public function startDate($startDate)
412
    {
413
        return $this->setProperty('startDate', $startDate);
414
    }
415
416
    /**
417
     * An Event that is part of this event. For example, a conference event
418
     * includes many presentations, each of which is a subEvent of the
419
     * conference.
420
     *
421
     * @param \Spatie\SchemaOrg\Event $subEvent
422
     *
423
     * @return static
424
     *
425
     * @see http://schema.org/subEvent
426
     */
427
    public function subEvent($subEvent)
428
    {
429
        return $this->setProperty('subEvent', $subEvent);
430
    }
431
432
    /**
433
     * Events that are a part of this event. For example, a conference event
434
     * includes many presentations, each subEvents of the conference.
435
     *
436
     * @param \Spatie\SchemaOrg\Event $subEvents
437
     *
438
     * @return static
439
     *
440
     * @see http://schema.org/subEvents
441
     */
442
    public function subEvents($subEvents)
443
    {
444
        return $this->setProperty('subEvents', $subEvents);
445
    }
446
447
    /**
448
     * An event that this event is a part of. For example, a collection of
449
     * individual music performances might each have a music festival as their
450
     * superEvent.
451
     *
452
     * @param \Spatie\SchemaOrg\Event $superEvent
453
     *
454
     * @return static
455
     *
456
     * @see http://schema.org/superEvent
457
     */
458
    public function superEvent($superEvent)
459
    {
460
        return $this->setProperty('superEvent', $superEvent);
461
    }
462
463
    /**
464
     * The typical expected age range, e.g. '7-9', '11-'.
465
     *
466
     * @param string $typicalAgeRange
467
     *
468
     * @return static
469
     *
470
     * @see http://schema.org/typicalAgeRange
471
     */
472
    public function typicalAgeRange($typicalAgeRange)
473
    {
474
        return $this->setProperty('typicalAgeRange', $typicalAgeRange);
475
    }
476
477
    /**
478
     * A work performed in some event, for example a play performed in a
479
     * TheaterEvent.
480
     *
481
     * @param \Spatie\SchemaOrg\CreativeWork $workPerformed
482
     *
483
     * @return static
484
     *
485
     * @see http://schema.org/workPerformed
486
     */
487
    public function workPerformed($workPerformed)
488
    {
489
        return $this->setProperty('workPerformed', $workPerformed);
490
    }
491
492
    /**
493
     * A work featured in some event, e.g. exhibited in an ExhibitionEvent.
494
     *        Specific subproperties are available for workPerformed (e.g. a
495
     * play), or a workPresented (a Movie at a ScreeningEvent).
496
     *
497
     * @param \Spatie\SchemaOrg\CreativeWork $workFeatured
498
     *
499
     * @return static
500
     *
501
     * @see http://schema.org/workFeatured
502
     */
503
    public function workFeatured($workFeatured)
504
    {
505
        return $this->setProperty('workFeatured', $workFeatured);
506
    }
507
508
    /**
509
     * Organization or person who adapts a creative work to different languages,
510
     * regional differences and technical requirements of a target market, or
511
     * that translates during some event.
512
     *
513
     * @param \Spatie\SchemaOrg\Person|\Spatie\SchemaOrg\Organization $translator
514
     *
515
     * @return static
516
     *
517
     * @see http://schema.org/translator
518
     */
519
    public function translator($translator)
520
    {
521
        return $this->setProperty('translator', $translator);
522
    }
523
524
    /**
525
     * The person or organization who wrote a composition, or who is the
526
     * composer of a work performed at some event.
527
     *
528
     * @param \Spatie\SchemaOrg\Person|\Spatie\SchemaOrg\Organization $composer
529
     *
530
     * @return static
531
     *
532
     * @see http://schema.org/composer
533
     */
534
    public function composer($composer)
535
    {
536
        return $this->setProperty('composer', $composer);
537
    }
538
539
}
540