Place::containsPlace() - Code Metrics - Inspection of "Merge pull request #100 from spatie/gen-2019-09-25" - spatie/schema-org - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 51e94c...5315a5 )

by Tom

created 2019-09-25 12:42 UTC

Place::containsPlace() A

↳ Parent: Place

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Spatie\SchemaOrg;

/**
 * Entities that have a somewhat fixed, physical extension.
 *
 * @see http://schema.org/Place
 *
 * @mixin \Spatie\SchemaOrg\Thing
 */
class Place extends BaseType
{
    /**
     * A property-value pair representing an additional characteristics of the
     * entitity, e.g. a product feature or another characteristic for which
     * there is no matching property in schema.org.
     * 
     * Note: Publishers should be aware that applications designed to use
     * specific schema.org properties (e.g. http://schema.org/width,
     * http://schema.org/color, http://schema.org/gtin13, ...) will typically
     * expect such data to be provided using those properties, rather than using
     * the generic property/value mechanism.
     *
     * @param PropertyValue|PropertyValue[] $additionalProperty
     *
     * @return static
     *
     * @see http://schema.org/additionalProperty
     */
    public function additionalProperty($additionalProperty)
    {
        return $this->setProperty('additionalProperty', $additionalProperty);
    }

    /**
     * Physical address of the item.
     *
     * @param PostalAddress|PostalAddress[]|string|string[] $address
     *
     * @return static
     *
     * @see http://schema.org/address
     */
    public function address($address)
    {
        return $this->setProperty('address', $address);
    }

    /**
     * The overall rating, based on a collection of reviews or ratings, of the
     * item.
     *
     * @param AggregateRating|AggregateRating[] $aggregateRating
     *
     * @return static
     *
     * @see http://schema.org/aggregateRating
     */
    public function aggregateRating($aggregateRating)
    {
        return $this->setProperty('aggregateRating', $aggregateRating);
    }

    /**
     * An amenity feature (e.g. a characteristic or service) of the
     * Accommodation. This generic property does not make a statement about
     * whether the feature is included in an offer for the main accommodation or
     * available at extra costs.
     *
     * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature
     *
     * @return static
     *
     * @see http://schema.org/amenityFeature
     */
    public function amenityFeature($amenityFeature)
    {
        return $this->setProperty('amenityFeature', $amenityFeature);
    }

    /**
     * A short textual code (also called "store code") that uniquely identifies
     * a place of business. The code is typically assigned by the
     * parentOrganization and used in structured URLs.
     * 
     * For example, in the URL
     * http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047"
     * is a branchCode for a particular branch.
     *
     * @param string|string[] $branchCode
     *
     * @return static
     *
     * @see http://schema.org/branchCode
     */
    public function branchCode($branchCode)
    {
        return $this->setProperty('branchCode', $branchCode);
    }

    /**
     * The basic containment relation between a place and one that contains it.
     *
     * @param Place|Place[] $containedIn
     *
     * @return static
     *
     * @see http://schema.org/containedIn
     */
    public function containedIn($containedIn)
    {
        return $this->setProperty('containedIn', $containedIn);
    }

    /**
     * The basic containment relation between a place and one that contains it.
     *
     * @param Place|Place[] $containedInPlace
     *
     * @return static
     *
     * @see http://schema.org/containedInPlace
     */
    public function containedInPlace($containedInPlace)
    {
        return $this->setProperty('containedInPlace', $containedInPlace);
    }

    /**
     * The basic containment relation between a place and another that it
     * contains.
     *
     * @param Place|Place[] $containsPlace
     *
     * @return static
     *
     * @see http://schema.org/containsPlace
     */
    public function containsPlace($containsPlace)
    {
        return $this->setProperty('containsPlace', $containsPlace);
    }

    /**
     * Upcoming or past event associated with this place, organization, or
     * action.
     *
     * @param Event|Event[] $event
     *
     * @return static
     *
     * @see http://schema.org/event
     */
    public function event($event)
    {
        return $this->setProperty('event', $event);
    }

    /**
     * Upcoming or past events associated with this place or organization.
     *
     * @param Event|Event[] $events
     *
     * @return static
     *
     * @see http://schema.org/events
     */
    public function events($events)
    {
        return $this->setProperty('events', $events);
    }

    /**
     * The fax number.
     *
     * @param string|string[] $faxNumber
     *
     * @return static
     *
     * @see http://schema.org/faxNumber
     */
    public function faxNumber($faxNumber)
    {
        return $this->setProperty('faxNumber', $faxNumber);
    }

    /**
     * The geo coordinates of the place.
     *
     * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo
     *
     * @return static
     *
     * @see http://schema.org/geo
     */
    public function geo($geo)
    {
        return $this->setProperty('geo', $geo);
    }

    /**
     * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also
     * referred to as International Location Number or ILN) of the respective
     * organization, person, or place. The GLN is a 13-digit number used to
     * identify parties and physical locations.
     *
     * @param string|string[] $globalLocationNumber
     *
     * @return static
     *
     * @see http://schema.org/globalLocationNumber
     */
    public function globalLocationNumber($globalLocationNumber)
    {
        return $this->setProperty('globalLocationNumber', $globalLocationNumber);
    }

    /**
     * A URL to a map of the place.
     *
     * @param Map|Map[]|string|string[] $hasMap
     *
     * @return static
     *
     * @see http://schema.org/hasMap
     */
    public function hasMap($hasMap)
    {
        return $this->setProperty('hasMap', $hasMap);
    }

    /**
     * A flag to signal that the item, event, or place is accessible for free.
     *
     * @param bool|bool[] $isAccessibleForFree
     *
     * @return static
     *
     * @see http://schema.org/isAccessibleForFree
     */
    public function isAccessibleForFree($isAccessibleForFree)
    {
        return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
    }

    /**
     * The International Standard of Industrial Classification of All Economic
     * Activities (ISIC), Revision 4 code for a particular organization,
     * business person, or place.
     *
     * @param string|string[] $isicV4
     *
     * @return static
     *
     * @see http://schema.org/isicV4
     */
    public function isicV4($isicV4)
    {
        return $this->setProperty('isicV4', $isicV4);
    }

    /**
     * The latitude of a location. For example ```37.42242``` ([WGS
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
     *
     * @param float|float[]|int|int[]|string|string[] $latitude
     *
     * @return static
     *
     * @see http://schema.org/latitude
     */
    public function latitude($latitude)
    {
        return $this->setProperty('latitude', $latitude);
    }

    /**
     * An associated logo.
     *
     * @param ImageObject|ImageObject[]|string|string[] $logo
     *
     * @return static
     *
     * @see http://schema.org/logo
     */
    public function logo($logo)
    {
        return $this->setProperty('logo', $logo);
    }

    /**
     * The longitude of a location. For example ```-122.08585``` ([WGS
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
     *
     * @param float|float[]|int|int[]|string|string[] $longitude
     *
     * @return static
     *
     * @see http://schema.org/longitude
     */
    public function longitude($longitude)
    {
        return $this->setProperty('longitude', $longitude);
    }

    /**
     * A URL to a map of the place.
     *
     * @param string|string[] $map
     *
     * @return static
     *
     * @see http://schema.org/map
     */
    public function map($map)
    {
        return $this->setProperty('map', $map);
    }

    /**
     * A URL to a map of the place.
     *
     * @param string|string[] $maps
     *
     * @return static
     *
     * @see http://schema.org/maps
     */
    public function maps($maps)
    {
        return $this->setProperty('maps', $maps);
    }

    /**
     * The total number of individuals that may attend an event or venue.
     *
     * @param int|int[] $maximumAttendeeCapacity
     *
     * @return static
     *
     * @see http://schema.org/maximumAttendeeCapacity
     */
    public function maximumAttendeeCapacity($maximumAttendeeCapacity)
    {
        return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
    }

    /**
     * The opening hours of a certain place.
     *
     * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification
     *
     * @return static
     *
     * @see http://schema.org/openingHoursSpecification
     */
    public function openingHoursSpecification($openingHoursSpecification)
    {
        return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
    }

    /**
     * A photograph of this place.
     *
     * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo
     *
     * @return static
     *
     * @see http://schema.org/photo
     */
    public function photo($photo)
    {
        return $this->setProperty('photo', $photo);
    }

    /**
     * Photographs of this place.
     *
     * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos
     *
     * @return static
     *
     * @see http://schema.org/photos
     */
    public function photos($photos)
    {
        return $this->setProperty('photos', $photos);
    }

    /**
     * A flag to signal that the [[Place]] is open to public visitors.  If this
     * property is omitted there is no assumed default boolean value
     *
     * @param bool|bool[] $publicAccess
     *
     * @return static
     *
     * @see http://schema.org/publicAccess
     */
    public function publicAccess($publicAccess)
    {
        return $this->setProperty('publicAccess', $publicAccess);
    }

    /**
     * A review of the item.
     *
     * @param Review|Review[] $review
     *
     * @return static
     *
     * @see http://schema.org/review
     */
    public function review($review)
    {
        return $this->setProperty('review', $review);
    }

    /**
     * Review of the item.
     *
     * @param Review|Review[] $reviews
     *
     * @return static
     *
     * @see http://schema.org/reviews
     */
    public function reviews($reviews)
    {
        return $this->setProperty('reviews', $reviews);
    }

    /**
     * A slogan or motto associated with the item.
     *
     * @param string|string[] $slogan
     *
     * @return static
     *
     * @see http://schema.org/slogan
     */
    public function slogan($slogan)
    {
        return $this->setProperty('slogan', $slogan);
    }

    /**
     * Indicates whether it is allowed to smoke in the place, e.g. in the
     * restaurant, hotel or hotel room.
     *
     * @param bool|bool[] $smokingAllowed
     *
     * @return static
     *
     * @see http://schema.org/smokingAllowed
     */
    public function smokingAllowed($smokingAllowed)
    {
        return $this->setProperty('smokingAllowed', $smokingAllowed);
    }

    /**
     * The special opening hours of a certain place.
     * 
     * Use this to explicitly override general opening hours brought in scope by
     * [[openingHoursSpecification]] or [[openingHours]].
     *
     * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification
     *
     * @return static
     *
     * @see http://schema.org/specialOpeningHoursSpecification
     */
    public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
    {
        return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
    }

    /**
     * The telephone number.
     *
     * @param string|string[] $telephone
     *
     * @return static
     *
     * @see http://schema.org/telephone
     */
    public function telephone($telephone)
    {
        return $this->setProperty('telephone', $telephone);
    }

}


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			* The latitude of a location. For example ```37.42242``` ([WGS
265			* 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
266			*
267			* @param float\|float[]\|int\|int[]\|string\|string[] $latitude
268			*
269			* @return static
270			*
271			* @see http://schema.org/latitude
272			*/
273			public function latitude($latitude)
274			{
275			return $this->setProperty('latitude', $latitude);
276			}
277
278			/**
279			* An associated logo.
280			*
281			* @param ImageObject\|ImageObject[]\|string\|string[] $logo
282			*
283			* @return static
284			*
285			* @see http://schema.org/logo
286			*/
287			public function logo($logo)
288			{
289			return $this->setProperty('logo', $logo);
290			}
291
292			/**
293			* The longitude of a location. For example ```-122.08585``` ([WGS
294			* 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
295			*
296			* @param float\|float[]\|int\|int[]\|string\|string[] $longitude
297			*
298			* @return static
299			*
300			* @see http://schema.org/longitude
301			*/
302			public function longitude($longitude)
303			{
304			return $this->setProperty('longitude', $longitude);
305			}
306
307			/**
308			* A URL to a map of the place.
309			*
310			* @param string\|string[] $map
311			*
312			* @return static
313			*
314			* @see http://schema.org/map
315			*/
316			public function map($map)
317			{
318			return $this->setProperty('map', $map);
319			}
320
321			/**
322			* A URL to a map of the place.
323			*
324			* @param string\|string[] $maps
325			*
326			* @return static
327			*
328			* @see http://schema.org/maps
329			*/
330			public function maps($maps)
331			{
332			return $this->setProperty('maps', $maps);
333			}
334
335			/**
336			* The total number of individuals that may attend an event or venue.
337			*
338			* @param int\|int[] $maximumAttendeeCapacity
339			*
340			* @return static
341			*
342			* @see http://schema.org/maximumAttendeeCapacity
343			*/
344			public function maximumAttendeeCapacity($maximumAttendeeCapacity)
345			{
346			return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
347			}
348
349			/**
350			* The opening hours of a certain place.
351			*
352			* @param OpeningHoursSpecification\|OpeningHoursSpecification[] $openingHoursSpecification
353			*
354			* @return static
355			*
356			* @see http://schema.org/openingHoursSpecification
357			*/
358			public function openingHoursSpecification($openingHoursSpecification)
359			{
360			return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
361			}
362
363			/**
364			* A photograph of this place.
365			*
366			* @param ImageObject\|ImageObject[]\|Photograph\|Photograph[] $photo
367			*
368			* @return static
369			*
370			* @see http://schema.org/photo
371			*/
372			public function photo($photo)
373			{
374			return $this->setProperty('photo', $photo);
375			}
376
377			/**
378			* Photographs of this place.
379			*
380			* @param ImageObject\|ImageObject[]\|Photograph\|Photograph[] $photos
381			*
382			* @return static
383			*
384			* @see http://schema.org/photos
385			*/
386			public function photos($photos)
387			{
388			return $this->setProperty('photos', $photos);
389			}
390
391			/**
392			* A flag to signal that the [[Place]] is open to public visitors. If this
393			* property is omitted there is no assumed default boolean value
394			*
395			* @param bool\|bool[] $publicAccess
396			*
397			* @return static
398			*
399			* @see http://schema.org/publicAccess
400			*/
401			public function publicAccess($publicAccess)
402			{
403			return $this->setProperty('publicAccess', $publicAccess);
404			}
405
406			/**
407			* A review of the item.
408			*
409			* @param Review\|Review[] $review
410			*
411			* @return static
412			*
413			* @see http://schema.org/review
414			*/
415			public function review($review)
416			{
417			return $this->setProperty('review', $review);
418			}
419
420			/**
421			* Review of the item.
422			*
423			* @param Review\|Review[] $reviews
424			*
425			* @return static
426			*
427			* @see http://schema.org/reviews
428			*/
429			public function reviews($reviews)
430			{
431			return $this->setProperty('reviews', $reviews);
432			}
433
434			/**
435			* A slogan or motto associated with the item.
436			*
437			* @param string\|string[] $slogan
438			*
439			* @return static
440			*
441			* @see http://schema.org/slogan
442			*/
443			public function slogan($slogan)
444			{
445			return $this->setProperty('slogan', $slogan);
446			}
447
448			/**
449			* Indicates whether it is allowed to smoke in the place, e.g. in the
450			* restaurant, hotel or hotel room.
451			*
452			* @param bool\|bool[] $smokingAllowed
453			*
454			* @return static
455			*
456			* @see http://schema.org/smokingAllowed
457			*/
458			public function smokingAllowed($smokingAllowed)
459			{
460			return $this->setProperty('smokingAllowed', $smokingAllowed);
461			}
462
463			/**
464			* The special opening hours of a certain place.
465			*
466			* Use this to explicitly override general opening hours brought in scope by
467			* [[openingHoursSpecification]] or [[openingHours]].
468			*
469			* @param OpeningHoursSpecification\|OpeningHoursSpecification[] $specialOpeningHoursSpecification
470			*
471			* @return static
472			*
473			* @see http://schema.org/specialOpeningHoursSpecification
474			*/
475			public function specialOpeningHoursSpecification($specialOpeningHoursSpecification)
476			{
477			return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification);
478			}
479
480			/**
481			* The telephone number.
482			*
483			* @param string\|string[] $telephone
484			*
485			* @return static
486			*
487			* @see http://schema.org/telephone
488			*/
489			public function telephone($telephone)
490			{
491			return $this->setProperty('telephone', $telephone);
492			}
493
494			}
495

spatie / schema-org

Push — master ( 51e94c...5315a5 )

Place::containsPlace() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like