Completed
Push — master ( fd0635...f2796c )
by Tom
06:08
created

Place::events()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
3
namespace Spatie\SchemaOrg;
4
5
/**
6
 * Entities that have a somewhat fixed, physical extension.
7
 *
8
 * @see http://schema.org/Place
9
 *
10
 * @mixin \Spatie\SchemaOrg\Thing
11
 */
12
class Place extends BaseType
13
{
14
    /**
15
     * A property-value pair representing an additional characteristics of the
16
     * entitity, e.g. a product feature or another characteristic for which
17
     * there is no matching property in schema.org.
18
     * 
19
     * Note: Publishers should be aware that applications designed to use
20
     * specific schema.org properties (e.g. http://schema.org/width,
21
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
22
     * expect such data to be provided using those properties, rather than using
23
     * the generic property/value mechanism.
24
     *
25
     * @param PropertyValue|PropertyValue[] $additionalProperty
26
     *
27
     * @return static
28
     *
29
     * @see http://schema.org/additionalProperty
30
     */
31
    public function additionalProperty($additionalProperty)
32
    {
33
        return $this->setProperty('additionalProperty', $additionalProperty);
34
    }
35
36
    /**
37
     * Physical address of the item.
38
     *
39
     * @param PostalAddress|PostalAddress[]|string|string[] $address
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/address
44
     */
45
    public function address($address)
46
    {
47
        return $this->setProperty('address', $address);
48
    }
49
50
    /**
51
     * The overall rating, based on a collection of reviews or ratings, of the
52
     * item.
53
     *
54
     * @param AggregateRating|AggregateRating[] $aggregateRating
55
     *
56
     * @return static
57
     *
58
     * @see http://schema.org/aggregateRating
59
     */
60
    public function aggregateRating($aggregateRating)
61
    {
62
        return $this->setProperty('aggregateRating', $aggregateRating);
63
    }
64
65
    /**
66
     * An amenity feature (e.g. a characteristic or service) of the
67
     * Accommodation. This generic property does not make a statement about
68
     * whether the feature is included in an offer for the main accommodation or
69
     * available at extra costs.
70
     *
71
     * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/amenityFeature
76
     */
77
    public function amenityFeature($amenityFeature)
78
    {
79
        return $this->setProperty('amenityFeature', $amenityFeature);
80
    }
81
82
    /**
83
     * A short textual code (also called "store code") that uniquely identifies
84
     * a place of business. The code is typically assigned by the
85
     * parentOrganization and used in structured URLs.
86
     * 
87
     * For example, in the URL
88
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
89
     * is a branchCode for a particular branch.
90
     *
91
     * @param string|string[] $branchCode
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/branchCode
96
     */
97
    public function branchCode($branchCode)
98
    {
99
        return $this->setProperty('branchCode', $branchCode);
100
    }
101
102
    /**
103
     * The basic containment relation between a place and one that contains it.
104
     *
105
     * @param Place|Place[] $containedIn
106
     *
107
     * @return static
108
     *
109
     * @see http://schema.org/containedIn
110
     */
111
    public function containedIn($containedIn)
112
    {
113
        return $this->setProperty('containedIn', $containedIn);
114
    }
115
116
    /**
117
     * The basic containment relation between a place and one that contains it.
118
     *
119
     * @param Place|Place[] $containedInPlace
120
     *
121
     * @return static
122
     *
123
     * @see http://schema.org/containedInPlace
124
     */
125
    public function containedInPlace($containedInPlace)
126
    {
127
        return $this->setProperty('containedInPlace', $containedInPlace);
128
    }
129
130
    /**
131
     * The basic containment relation between a place and another that it
132
     * contains.
133
     *
134
     * @param Place|Place[] $containsPlace
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/containsPlace
139
     */
140
    public function containsPlace($containsPlace)
141
    {
142
        return $this->setProperty('containsPlace', $containsPlace);
143
    }
144
145
    /**
146
     * Upcoming or past event associated with this place, organization, or
147
     * action.
148
     *
149
     * @param Event|Event[] $event
150
     *
151
     * @return static
152
     *
153
     * @see http://schema.org/event
154
     */
155
    public function event($event)
156
    {
157
        return $this->setProperty('event', $event);
158
    }
159
160
    /**
161
     * Upcoming or past events associated with this place or organization.
162
     *
163
     * @param Event|Event[] $events
164
     *
165
     * @return static
166
     *
167
     * @see http://schema.org/events
168
     */
169
    public function events($events)
170
    {
171
        return $this->setProperty('events', $events);
172
    }
173
174
    /**
175
     * The fax number.
176
     *
177
     * @param string|string[] $faxNumber
178
     *
179
     * @return static
180
     *
181
     * @see http://schema.org/faxNumber
182
     */
183
    public function faxNumber($faxNumber)
184
    {
185
        return $this->setProperty('faxNumber', $faxNumber);
186
    }
187
188
    /**
189
     * The geo coordinates of the place.
190
     *
191
     * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo
192
     *
193
     * @return static
194
     *
195
     * @see http://schema.org/geo
196
     */
197
    public function geo($geo)
198
    {
199
        return $this->setProperty('geo', $geo);
200
    }
201
202
    /**
203
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
204
     * referred to as International Location Number or ILN) of the respective
205
     * organization, person, or place. The GLN is a 13-digit number used to
206
     * identify parties and physical locations.
207
     *
208
     * @param string|string[] $globalLocationNumber
209
     *
210
     * @return static
211
     *
212
     * @see http://schema.org/globalLocationNumber
213
     */
214
    public function globalLocationNumber($globalLocationNumber)
215
    {
216
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
217
    }
218
219
    /**
220
     * A URL to a map of the place.
221
     *
222
     * @param Map|Map[]|string|string[] $hasMap
223
     *
224
     * @return static
225
     *
226
     * @see http://schema.org/hasMap
227
     */
228
    public function hasMap($hasMap)
229
    {
230
        return $this->setProperty('hasMap', $hasMap);
231
    }
232
233
    /**
234
     * A flag to signal that the item, event, or place is accessible for free.
235
     *
236
     * @param bool|bool[] $isAccessibleForFree
237
     *
238
     * @return static
239
     *
240
     * @see http://schema.org/isAccessibleForFree
241
     */
242
    public function isAccessibleForFree($isAccessibleForFree)
243
    {
244
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
245
    }
246
247
    /**
248
     * The International Standard of Industrial Classification of All Economic
249
     * Activities (ISIC), Revision 4 code for a particular organization,
250
     * business person, or place.
251
     *
252
     * @param string|string[] $isicV4
253
     *
254
     * @return static
255
     *
256
     * @see http://schema.org/isicV4
257
     */
258
    public function isicV4($isicV4)
259
    {
260
        return $this->setProperty('isicV4', $isicV4);
261
    }
262
263
    /**
264
     * An associated logo.
265
     *
266
     * @param ImageObject|ImageObject[]|string|string[] $logo
267
     *
268
     * @return static
269
     *
270
     * @see http://schema.org/logo
271
     */
272
    public function logo($logo)
273
    {
274
        return $this->setProperty('logo', $logo);
275
    }
276
277
    /**
278
     * A URL to a map of the place.
279
     *
280
     * @param string|string[] $map
281
     *
282
     * @return static
283
     *
284
     * @see http://schema.org/map
285
     */
286
    public function map($map)
287
    {
288
        return $this->setProperty('map', $map);
289
    }
290
291
    /**
292
     * A URL to a map of the place.
293
     *
294
     * @param string|string[] $maps
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/maps
299
     */
300
    public function maps($maps)
301
    {
302
        return $this->setProperty('maps', $maps);
303
    }
304
305
    /**
306
     * The total number of individuals that may attend an event or venue.
307
     *
308
     * @param int|int[] $maximumAttendeeCapacity
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/maximumAttendeeCapacity
313
     */
314
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
315
    {
316
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
317
    }
318
319
    /**
320
     * The opening hours of a certain place.
321
     *
322
     * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification
323
     *
324
     * @return static
325
     *
326
     * @see http://schema.org/openingHoursSpecification
327
     */
328
    public function openingHoursSpecification($openingHoursSpecification)
329
    {
330
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
331
    }
332
333
    /**
334
     * A photograph of this place.
335
     *
336
     * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo
337
     *
338
     * @return static
339
     *
340
     * @see http://schema.org/photo
341
     */
342
    public function photo($photo)
343
    {
344
        return $this->setProperty('photo', $photo);
345
    }
346
347
    /**
348
     * Photographs of this place.
349
     *
350
     * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos
351
     *
352
     * @return static
353
     *
354
     * @see http://schema.org/photos
355
     */
356
    public function photos($photos)
357
    {
358
        return $this->setProperty('photos', $photos);
359
    }
360
361
    /**
362
     * A flag to signal that the [[Place]] is open to public visitors.  If this
363
     * property is omitted there is no assumed default boolean value
364
     *
365
     * @param bool|bool[] $publicAccess
366
     *
367
     * @return static
368
     *
369
     * @see http://schema.org/publicAccess
370
     */
371
    public function publicAccess($publicAccess)
372
    {
373
        return $this->setProperty('publicAccess', $publicAccess);
374
    }
375
376
    /**
377
     * A review of the item.
378
     *
379
     * @param Review|Review[] $review
380
     *
381
     * @return static
382
     *
383
     * @see http://schema.org/review
384
     */
385
    public function review($review)
386
    {
387
        return $this->setProperty('review', $review);
388
    }
389
390
    /**
391
     * Review of the item.
392
     *
393
     * @param Review|Review[] $reviews
394
     *
395
     * @return static
396
     *
397
     * @see http://schema.org/reviews
398
     */
399
    public function reviews($reviews)
400
    {
401
        return $this->setProperty('reviews', $reviews);
402
    }
403
404
    /**
405
     * A slogan or motto associated with the item.
406
     *
407
     * @param string|string[] $slogan
408
     *
409
     * @return static
410
     *
411
     * @see http://schema.org/slogan
412
     */
413
    public function slogan($slogan)
414
    {
415
        return $this->setProperty('slogan', $slogan);
416
    }
417
418
    /**
419
     * Indicates whether it is allowed to smoke in the place, e.g. in the
420
     * restaurant, hotel or hotel room.
421
     *
422
     * @param bool|bool[] $smokingAllowed
423
     *
424
     * @return static
425
     *
426
     * @see http://schema.org/smokingAllowed
427
     */
428
    public function smokingAllowed($smokingAllowed)
429
    {
430
        return $this->setProperty('smokingAllowed', $smokingAllowed);
431
    }
432
433
    /**
434
     * The special opening hours of a certain place.
435
     * 
436
     * Use this to explicitly override general opening hours brought in scope by
437
     * [[openingHoursSpecification]] or [[openingHours]].
438
     *
439
     * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification
440
     *
441
     * @return static
442
     *
443
     * @see http://schema.org/specialOpeningHoursSpecification
444
     */
445
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
446
    {
447
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
448
    }
449
450
    /**
451
     * The telephone number.
452
     *
453
     * @param string|string[] $telephone
454
     *
455
     * @return static
456
     *
457
     * @see http://schema.org/telephone
458
     */
459
    public function telephone($telephone)
460
    {
461
        return $this->setProperty('telephone', $telephone);
462
    }
463
464
}
465