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