Oihana PHP System

Accommodation extends Place

An accommodation is a place that can accommodate human beings, e.g. a hotel room, a camping pitch, or a meeting room. Many accommodations are for overnight stays, but this is not a mandatory requirement.

For more specific types of accommodations not defined in schema.org, one can use additionalType with external vocabularies.

Tags
see
https://schema.org/Accommodation

Table of Contents

Constants

CONTEXT  = 'https://schema.org'
JSON-LD @context declaration for Schema.org.

Properties

$_from  : string|null
The metadata to indicates the edge 'from' identifier.
$_id  : null|string
The metadata identifier of the item.
$_key  : null|string
The metadata unique key identifier of the thing.
$_rev  : null|string
The metadata revision value of the thing.
$_to  : string|null
The metadata to indicates the edge 'to' identifier.
$accommodationCategory  : string|null
Category of an Accommodation, following real estate conventions, e.g. RESO (see PropertySubType, and PropertyType fields for suggested values).
$accommodationFloorPlan  : object|array<string|int, mixed>|null
A floor plan of some Accommodation.
$active  : bool|null
The active flag.
$additional  : object|string|null
The additional description of the place.
$additionalType  : array<string|int, mixed>|string|null|object
An additionalType for the item.
$address  : PostalAddress|string|null
Physical address of the item (PostalAddress or any object to describe it).
$aggregateRating  : array<string|int, mixed>|AggregateRating|null
The overall rating, based on a collection of reviews or ratings, of the item.
$alternateName  : string|object|null
An alias for the item.
$amenityFeature  : array<string|int, mixed>|LocationFeatureSpecification|null
An amenity feature (e.g. a characteristic or service) of the Accommodation.
$bed  : object|array<string|int, mixed>|null
The type of bed or beds included in the accommodation.
$branchCode  : string|null
A short textual code (also called "store code") that uniquely identifies a place of business.
$containedInsPlace  : array<string|int, mixed>|Place|null
The basic containment relation between a place and another that it contains.
$containsPlace  : array<string|int, mixed>|Place|null
The basic containment relation between a place and another that it contains.
$created  : null|string|DateTime
Date of creation of the resource.
$description  : string|null
A short description of the item.
$disambiguatingDescription  : string|null
A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
$email  : null|string|PropertyValue|array<string|int, mixed>
The Email address.
$event  : null|array<string|int, mixed>|Event
Upcoming or past events associated with this place or organization (legacy spelling; see singular form, event).
$faxNumber  : string|null|array<string|int, mixed>|PropertyValue
The fax number.
$floorLevel  : string|null
The floor level for an Accommodation in a multi-storey building.
$floorSize  : QuantitativeValue|null
The size of the accommodation, e.g. in square meter or squarefoot. Typical unit code(s): MTK for square meter, FTK for square foot, or YDK for square yard.
$geo  : null|GeoCoordinates|GeoShape
The geo coordinates of the place (GeoShape or GeoCoordinates).
$hasCertification  : array<string|int, mixed>|Certification|null
Certification information about a product, organization, service, place, or person.
$hasDriveThroughService  : bool|null
Indicates whether some facility (e.g. FoodEstablishment, CovidTestingFacility) offers a service that can be used by driving through in a car. In the case of CovidTestingFacility such facilities could potentially help with social distancing from other potentially-infected users.
$hasMap  : string|Map|null
A URL to a map of the place.
$hasPart  : string|Thing|array<string|int, mixed>|null
Indicates an item that this part of this item.
$id  : null|int|string
The unique identifier of the item.
$identifier  : string|null
The identifier of the item.
$image  : string|object|null
The image reference of this resource.
$images  : array<string|int, mixed>|null
Photographs of this place (legacy spelling; see singular form, photo).
$isAccessibleForFree  : bool|null
A flag to signal that the item, event, or place is accessible for free.
$isicV4  : string|null
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
$isPartOf  : string|Thing|array<string|int, mixed>|null
Indicates an item that this item is part of.
$keywords  : string|DefinedTerm|array<string|int, mixed>|null
Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
$latitude  : null|int|float
The latitude of a location. For example 37.42242 (WGS 84).
$leaseLength  : QuantitativeValue|Duration|null
Length of the lease for some Accommodation, either particular to some Offer or in some cases intrinsic to the property.
$license  : string|object|null
A legal document giving official permission to do something with the resource.
$logo  : null|string|ImageObject
An associated logo.
$longitude  : null|int|float
The longitude of a location. For example -122.08585 (WGS 84).
$maximumAttendeeCapacity  : null|int|string
The total number of individuals that may attend an event or venue.
$modified  : null|string|DateTime
Date on which the resource was changed.
$name  : int|string|null
The name of the item.
$numberOfBathroomsTotal  : int|null
The total integer number of bathrooms in some Accommodation.
$numberOfBedrooms  : int|QuantitativeValue|null
The total integer number of bedrooms in a some Accommodation, ApartmentComplex or FloorPlan.
$numberOfFullBathrooms  : int|null
Number of full bathrooms - The total number of full and ¾ bathrooms in an Accommodation. This corresponds to the BathroomsFull field in RESO.
$numberOfPartialBathrooms  : int|null
Number of partial bathrooms - The total number of half and ¼ bathrooms in an Accommodation. This corresponds to the BathroomsPartial field in RESO.
$occupancy  : QuantitativeValue|int|null
The allowed total occupancy for the accommodation in persons (including infants etc).
$offers  : array<string|int, mixed>|Offer|null|Demand
An offer to provide this item.
$openingHoursSpecification  : null|array<string|int, mixed>|OpeningHoursSpecification
The opening hours of a certain place.
$permittedUsage  : string|null
Indications regarding the permitted usage of the accommodation.
$petsAllowed  : string|bool|null
Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value.
$photo  : null|array<string|int, mixed>|ImageObject|Photograph
Photographs of this place (legacy spelling; see singular form, photo).
$publicAccess  : bool|null
A flag to signal that the Place is open to public visitors. If this property is omitted there is no assumed default boolean value.
$publisher  : string|array<string|int, mixed>|Person|Organization|null
The publisher of the resource.
$remainingAttendee  : int|null
The number of the remaining attendee.
$review  : array<string|int, mixed>|Review|null
A review of the item.
$service  : null|array<string|int, mixed>|Service
The services provided by a place.
$slogan  : string|object|null
A slogan or motto associated with the item.
$smokingAllowed  : bool|null
Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
$specialOpeningHoursSpecification  : null|array<string|int, mixed>|OpeningHoursSpecification
The special opening hours of a certain place.
$telephone  : string|null|array<string|int, mixed>|PropertyValue
The telephone number.
$tourBookingPage  : string|null
A page providing information on how to book a tour of some Place, such as an Accommodation or ApartmentComplex in a real estate setting, as well as other kinds of tours as appropriate.
$url  : int|string|null
URL of the item.
$website  : array<string|int, mixed>|null|string|Website
The collection of all websites of this place.
$yearBuilt  : int|null
The year an Accommodation was constructed. This corresponds to the YearBuilt field in RESO.

Methods

__construct()  : mixed
Constructor to hydrate public properties from an array or stdClass.
jsonSerialize()  : array<string|int, mixed>
Serializes the current object into a JSON-LD array.

Constants

CONTEXT

JSON-LD @context declaration for Schema.org.

public mixed CONTEXT = 'https://schema.org'

Properties

$_from

The metadata to indicates the edge 'from' identifier.

public string|null $_from

$_id

The metadata identifier of the item.

public null|string $_id

$_key

The metadata unique key identifier of the thing.

public null|string $_key

$_rev

The metadata revision value of the thing.

public null|string $_rev

$_to

The metadata to indicates the edge 'to' identifier.

public string|null $_to

$accommodationCategory

Category of an Accommodation, following real estate conventions, e.g. RESO (see PropertySubType, and PropertyType fields for suggested values).

public string|null $accommodationCategory = null

$accommodationFloorPlan

A floor plan of some Accommodation.

public object|array<string|int, mixed>|null $accommodationFloorPlan

$active

The active flag.

public bool|null $active

$additional

The additional description of the place.

public object|string|null $additional

Note : this property is a custom attribute of the original Place class defined in http://schema.org/Place.

$additionalType

An additionalType for the item.

public array<string|int, mixed>|string|null|object $additionalType

$address

Physical address of the item (PostalAddress or any object to describe it).

public PostalAddress|string|null $address = null

$aggregateRating

The overall rating, based on a collection of reviews or ratings, of the item.

public array<string|int, mixed>|AggregateRating|null $aggregateRating

$alternateName

An alias for the item.

public string|object|null $alternateName

$amenityFeature

An amenity feature (e.g. a characteristic or service) of the Accommodation.

public array<string|int, mixed>|LocationFeatureSpecification|null $amenityFeature

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.

$bed

The type of bed or beds included in the accommodation.

public object|array<string|int, mixed>|null $bed

$branchCode

A short textual code (also called "store code") that uniquely identifies a place of business.

public string|null $branchCode

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.

$containedInsPlace

The basic containment relation between a place and another that it contains.

public array<string|int, mixed>|Place|null $containedInsPlace

$containsPlace

The basic containment relation between a place and another that it contains.

public array<string|int, mixed>|Place|null $containsPlace

$created

Date of creation of the resource.

public null|string|DateTime $created

$description

A short description of the item.

public string|null $description

$disambiguatingDescription

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

public string|null $disambiguatingDescription

$event

Upcoming or past events associated with this place or organization (legacy spelling; see singular form, event).

public null|array<string|int, mixed>|Event $event

$floorLevel

The floor level for an Accommodation in a multi-storey building.

public string|null $floorLevel

Since counting systems vary internationally, the local system should be used where possible.

$floorSize

The size of the accommodation, e.g. in square meter or squarefoot. Typical unit code(s): MTK for square meter, FTK for square foot, or YDK for square yard.

public QuantitativeValue|null $floorSize

$hasCertification

Certification information about a product, organization, service, place, or person.

public array<string|int, mixed>|Certification|null $hasCertification

$hasDriveThroughService

Indicates whether some facility (e.g. FoodEstablishment, CovidTestingFacility) offers a service that can be used by driving through in a car. In the case of CovidTestingFacility such facilities could potentially help with social distancing from other potentially-infected users.

public bool|null $hasDriveThroughService

$hasMap

A URL to a map of the place.

public string|Map|null $hasMap

$hasPart

Indicates an item that this part of this item.

public string|Thing|array<string|int, mixed>|null $hasPart

$id

The unique identifier of the item.

public null|int|string $id

$identifier

The identifier of the item.

public string|null $identifier

$image

The image reference of this resource.

public string|object|null $image

$images

Photographs of this place (legacy spelling; see singular form, photo).

public array<string|int, mixed>|null $images

$isAccessibleForFree

A flag to signal that the item, event, or place is accessible for free.

public bool|null $isAccessibleForFree

$isicV4

The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.

public string|null $isicV4

$isPartOf

Indicates an item that this item is part of.

public string|Thing|array<string|int, mixed>|null $isPartOf

$keywords

Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.

public string|DefinedTerm|array<string|int, mixed>|null $keywords

$license

A legal document giving official permission to do something with the resource.

public string|object|null $license

$maximumAttendeeCapacity

The total number of individuals that may attend an event or venue.

public null|int|string $maximumAttendeeCapacity

Supersedes capacity

$modified

Date on which the resource was changed.

public null|string|DateTime $modified

$name

The name of the item.

public int|string|null $name

$numberOfBathroomsTotal

The total integer number of bathrooms in some Accommodation.

public int|null $numberOfBathroomsTotal

$numberOfBedrooms

The total integer number of bedrooms in a some Accommodation, ApartmentComplex or FloorPlan.

public int|QuantitativeValue|null $numberOfBedrooms

$numberOfFullBathrooms

Number of full bathrooms - The total number of full and ¾ bathrooms in an Accommodation. This corresponds to the BathroomsFull field in RESO.

public int|null $numberOfFullBathrooms

$numberOfPartialBathrooms

Number of partial bathrooms - The total number of half and ¼ bathrooms in an Accommodation. This corresponds to the BathroomsPartial field in RESO.

public int|null $numberOfPartialBathrooms

$occupancy

The allowed total occupancy for the accommodation in persons (including infants etc).

public QuantitativeValue|int|null $occupancy

For individual accommodations, this is not necessarily the legal maximum but defines the permitted usage as per the contractual agreement (e.g. a double room used by a single person). Typical unit code(s): C62 for person.

$permittedUsage

Indications regarding the permitted usage of the accommodation.

public string|null $permittedUsage

$petsAllowed

Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value.

public string|bool|null $petsAllowed

$photo

Photographs of this place (legacy spelling; see singular form, photo).

public null|array<string|int, mixed>|ImageObject|Photograph $photo

A photograph of this place.

$publicAccess

A flag to signal that the Place is open to public visitors. If this property is omitted there is no assumed default boolean value.

public bool|null $publicAccess

$remainingAttendee

The number of the remaining attendee.

public int|null $remainingAttendee

$review

A review of the item.

public array<string|int, mixed>|Review|null $review

$service

The services provided by a place.

public null|array<string|int, mixed>|Service $service

$slogan

A slogan or motto associated with the item.

public string|object|null $slogan

$smokingAllowed

Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.

public bool|null $smokingAllowed

$specialOpeningHoursSpecification

The special opening hours of a certain place.

public null|array<string|int, mixed>|OpeningHoursSpecification $specialOpeningHoursSpecification

$tourBookingPage

A page providing information on how to book a tour of some Place, such as an Accommodation or ApartmentComplex in a real estate setting, as well as other kinds of tours as appropriate.

public string|null $tourBookingPage

$url

URL of the item.

public int|string|null $url

$website

The collection of all websites of this place.

public array<string|int, mixed>|null|string|Website $website

$yearBuilt

The year an Accommodation was constructed. This corresponds to the YearBuilt field in RESO.

public int|null $yearBuilt

Methods

__construct()

Constructor to hydrate public properties from an array or stdClass.

public __construct([array<string|int, mixed>|object|null $init = null ]) : mixed

This allows objects to be quickly populated with associative data without manually setting each property.

Parameters
$init : array<string|int, mixed>|object|null = null

A data array or object used to initialize the instance. Keys must match public property names.

Tags
example
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person
([
    Prop::NAME => 'Jane Doe',
    Prop::URL  => 'https://example.com/janedoe'
]);

echo $person->name; // Outputs: Jane Doe

jsonSerialize()

Serializes the current object into a JSON-LD array.

public jsonSerialize() : array<string|int, mixed>

This method will include all public properties, the schema.org @context, and the inferred @type based on the class name.

Null values will be automatically removed using compress().

Tags
throws
ReflectionException

If reflection fails when accessing properties.

example
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person([
    Prop::NAME => 'John Smith',
    Prop::ID   => 'jsmith-001'
]);

echo json_encode($person, JSON_PRETTY_PRINT);

Output:

{
  "@type": "Person",
  "@context": "https://schema.org",
  "id": "jsmith-001",
  "name": "John Smith"
}
Return values
array<string|int, mixed>

A JSON-LD array representation of the object.


        
On this page

Search results