code
stringlengths 17
296k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function bed($bed)
{
return $this->setProperty('bed', $bed);
} | The type of bed or beds included in the accommodation. For the single
case of just one bed of a certain type, you use bed directly with a text.
If you want to indicate the quantity of a certain kind of bed, use
an instance of BedDetails. For more detailed information, use the
amenityFeature property.
@param \Spatie\SchemaOrg\Contracts\BedDetailsContract|\Spatie\SchemaOrg\Contracts\BedDetailsContract[]|\Spatie\SchemaOrg\Contracts\BedTypeContract|\Spatie\SchemaOrg\Contracts\BedTypeContract[]|string|string[] $bed
@return static
@see https://schema.org/bed | bed | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function branchCode($branchCode)
{
return $this->setProperty('branchCode', $branchCode);
} | 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 https://schema.org/branchCode | branchCode | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function containedIn($containedIn)
{
return $this->setProperty('containedIn', $containedIn);
} | The basic containment relation between a place and one that contains it.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedIn
@return static
@see https://schema.org/containedIn | containedIn | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function containedInPlace($containedInPlace)
{
return $this->setProperty('containedInPlace', $containedInPlace);
} | The basic containment relation between a place and one that contains it.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containedInPlace
@return static
@see https://schema.org/containedInPlace | containedInPlace | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function containsPlace($containsPlace)
{
return $this->setProperty('containsPlace', $containsPlace);
} | The basic containment relation between a place and another that it
contains.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $containsPlace
@return static
@see https://schema.org/containsPlace | containsPlace | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function disambiguatingDescription($disambiguatingDescription)
{
return $this->setProperty('disambiguatingDescription', $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.
@param string|string[] $disambiguatingDescription
@return static
@see https://schema.org/disambiguatingDescription | disambiguatingDescription | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function event($event)
{
return $this->setProperty('event', $event);
} | Upcoming or past event associated with this place, organization, or
action.
@param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event
@return static
@see https://schema.org/event | event | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function events($events)
{
return $this->setProperty('events', $events);
} | Upcoming or past events associated with this place or organization.
@param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $events
@return static
@see https://schema.org/events | events | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function floorLevel($floorLevel)
{
return $this->setProperty('floorLevel', $floorLevel);
} | The floor level for an [[Accommodation]] in a multi-storey building.
Since counting
systems [vary
internationally](https://en.wikipedia.org/wiki/Storey#Consecutive_number_floor_designations),
the local system should be used where possible.
@param string|string[] $floorLevel
@return static
@see https://schema.org/floorLevel
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | floorLevel | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function floorSize($floorSize)
{
return $this->setProperty('floorSize', $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.
@param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $floorSize
@return static
@see https://schema.org/floorSize | floorSize | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geo($geo)
{
return $this->setProperty('geo', $geo);
} | The geo coordinates of the place.
@param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[] $geo
@return static
@see https://schema.org/geo | geo | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoContains($geoContains)
{
return $this->setProperty('geoContains', $geoContains);
} | Represents a relationship between two geometries (or the places they
represent), relating a containing geometry to a contained geometry. "a
contains b iff no points of b lie in the exterior of a, and at least one
point of the interior of b lies in the interior of a". As defined in
[DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoContains
@return static
@see https://schema.org/geoContains | geoContains | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoCoveredBy($geoCoveredBy)
{
return $this->setProperty('geoCoveredBy', $geoCoveredBy);
} | Represents a relationship between two geometries (or the places they
represent), relating a geometry to another that covers it. As defined in
[DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoCoveredBy
@return static
@see https://schema.org/geoCoveredBy | geoCoveredBy | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoCovers($geoCovers)
{
return $this->setProperty('geoCovers', $geoCovers);
} | Represents a relationship between two geometries (or the places they
represent), relating a covering geometry to a covered geometry. "Every
point of b is a point of (the interior or boundary of) a". As defined in
[DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoCovers
@return static
@see https://schema.org/geoCovers | geoCovers | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoCrosses($geoCrosses)
{
return $this->setProperty('geoCrosses', $geoCrosses);
} | Represents a relationship between two geometries (or the places they
represent), relating a geometry to another that crosses it: "a crosses b:
they have some but not all interior points in common, and the dimension
of the intersection is less than that of at least one of them". As
defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoCrosses
@return static
@see https://schema.org/geoCrosses | geoCrosses | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoDisjoint($geoDisjoint)
{
return $this->setProperty('geoDisjoint', $geoDisjoint);
} | Represents spatial relations in which two geometries (or the places they
represent) are topologically disjoint: "they have no point in common.
They form a set of disconnected geometries." (A symmetric relationship,
as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoDisjoint
@return static
@see https://schema.org/geoDisjoint | geoDisjoint | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoEquals($geoEquals)
{
return $this->setProperty('geoEquals', $geoEquals);
} | Represents spatial relations in which two geometries (or the places they
represent) are topologically equal, as defined in
[DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are
topologically equal if their interiors intersect and no part of the
interior or boundary of one geometry intersects the exterior of the
other" (a symmetric relationship).
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoEquals
@return static
@see https://schema.org/geoEquals | geoEquals | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoIntersects($geoIntersects)
{
return $this->setProperty('geoIntersects', $geoIntersects);
} | Represents spatial relations in which two geometries (or the places they
represent) have at least one point in common. As defined in
[DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoIntersects
@return static
@see https://schema.org/geoIntersects | geoIntersects | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoOverlaps($geoOverlaps)
{
return $this->setProperty('geoOverlaps', $geoOverlaps);
} | Represents a relationship between two geometries (or the places they
represent), relating a geometry to another that geospatially overlaps it,
i.e. they have some but not all points in common. As defined in
[DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoOverlaps
@return static
@see https://schema.org/geoOverlaps | geoOverlaps | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoTouches($geoTouches)
{
return $this->setProperty('geoTouches', $geoTouches);
} | Represents spatial relations in which two geometries (or the places they
represent) touch: "they have at least one boundary point in common, but
no interior points." (A symmetric relationship, as defined in
[DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoTouches
@return static
@see https://schema.org/geoTouches | geoTouches | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function geoWithin($geoWithin)
{
return $this->setProperty('geoWithin', $geoWithin);
} | Represents a relationship between two geometries (or the places they
represent), relating a geometry to one that contains it, i.e. it is
inside (i.e. within) its interior. As defined in
[DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
@param \Spatie\SchemaOrg\Contracts\GeospatialGeometryContract|\Spatie\SchemaOrg\Contracts\GeospatialGeometryContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $geoWithin
@return static
@see https://schema.org/geoWithin | geoWithin | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function globalLocationNumber($globalLocationNumber)
{
return $this->setProperty('globalLocationNumber', $globalLocationNumber);
} | 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 https://schema.org/globalLocationNumber | globalLocationNumber | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function hasCertification($hasCertification)
{
return $this->setProperty('hasCertification', $hasCertification);
} | Certification information about a product, organization, service, place,
or person.
@param \Spatie\SchemaOrg\Contracts\CertificationContract|\Spatie\SchemaOrg\Contracts\CertificationContract[] $hasCertification
@return static
@see https://schema.org/hasCertification
@link https://github.com/schemaorg/schemaorg/issues/3230 | hasCertification | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function hasDriveThroughService($hasDriveThroughService)
{
return $this->setProperty('hasDriveThroughService', $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.
@param bool|bool[] $hasDriveThroughService
@return static
@see https://schema.org/hasDriveThroughService
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2490 | hasDriveThroughService | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function hasGS1DigitalLink($hasGS1DigitalLink)
{
return $this->setProperty('hasGS1DigitalLink', $hasGS1DigitalLink);
} | The [GS1 digital link](https://www.gs1.org/standards/gs1-digital-link)
associated with the object. This URL should conform to the particular
requirements of digital links. The link should only contain the
Application Identifiers (AIs) that are relevant for the entity being
annotated, for instance a [[Product]] or an [[Organization]], and for the
correct granularity. In particular, for products:<ul>* A Digital Link
that contains a serial number (AI ```21```) should only be present on
instances of [[IndividualProduct]]* A Digital Link that contains a lot
number (AI ```10```) should be annotated as [[SomeProduct]] if only
products from that lot are sold, or [[IndividualProduct]] if there is
only a specific product.* A Digital Link that contains a global model
number (AI ```8013```) should be attached to a [[Product]] or a
[[ProductModel]]. Other item types should be adapted similarly.
@param string|string[] $hasGS1DigitalLink
@return static
@see https://schema.org/hasGS1DigitalLink
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/3475 | hasGS1DigitalLink | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function identifier($identifier)
{
return $this->setProperty('identifier', $identifier);
} | The identifier property represents any kind of identifier for any kind of
[[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
dedicated properties for representing many of these, either as textual
strings or as URL (URI) links. See [background
notes](/docs/datamodel.html#identifierBg) for more details.
@param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
@return static
@see https://schema.org/identifier | identifier | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function image($image)
{
return $this->setProperty('image', $image);
} | An image of the item. This can be a [[URL]] or a fully described
[[ImageObject]].
@param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
@return static
@see https://schema.org/image | image | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function isAccessibleForFree($isAccessibleForFree)
{
return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
} | A flag to signal that the item, event, or place is accessible for free.
@param bool|bool[] $isAccessibleForFree
@return static
@see https://schema.org/isAccessibleForFree | isAccessibleForFree | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function isicV4($isicV4)
{
return $this->setProperty('isicV4', $isicV4);
} | 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 https://schema.org/isicV4 | isicV4 | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function keywords($keywords)
{
return $this->setProperty('keywords', $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.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $keywords
@return static
@see https://schema.org/keywords | keywords | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function latitude($latitude)
{
return $this->setProperty('latitude', $latitude);
} | 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 https://schema.org/latitude | latitude | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function leaseLength($leaseLength)
{
return $this->setProperty('leaseLength', $leaseLength);
} | Length of the lease for some [[Accommodation]], either particular to some
[[Offer]] or in some cases intrinsic to the property.
@param \Spatie\SchemaOrg\Contracts\DurationContract|\Spatie\SchemaOrg\Contracts\DurationContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $leaseLength
@return static
@see https://schema.org/leaseLength
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | leaseLength | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function longitude($longitude)
{
return $this->setProperty('longitude', $longitude);
} | 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 https://schema.org/longitude | longitude | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function mainEntityOfPage($mainEntityOfPage)
{
return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
} | Indicates a page (or other CreativeWork) for which this thing is the main
entity being described. See [background
notes](/docs/datamodel.html#mainEntityBackground) for details.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
@return static
@see https://schema.org/mainEntityOfPage | mainEntityOfPage | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function maximumAttendeeCapacity($maximumAttendeeCapacity)
{
return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
} | The total number of individuals that may attend an event or venue.
@param int|int[] $maximumAttendeeCapacity
@return static
@see https://schema.org/maximumAttendeeCapacity | maximumAttendeeCapacity | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function numberOfBathroomsTotal($numberOfBathroomsTotal)
{
return $this->setProperty('numberOfBathroomsTotal', $numberOfBathroomsTotal);
} | The total integer number of bathrooms in some [[Accommodation]],
following real estate conventions as [documented in
RESO](https://ddwiki.reso.org/display/DDW17/BathroomsTotalInteger+Field):
"The simple sum of the number of bathrooms. For example for a property
with two Full Bathrooms and one Half Bathroom, the Bathrooms Total
Integer will be 3.". See also [[numberOfRooms]].
@param int|int[] $numberOfBathroomsTotal
@return static
@see https://schema.org/numberOfBathroomsTotal
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | numberOfBathroomsTotal | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function numberOfBedrooms($numberOfBedrooms)
{
return $this->setProperty('numberOfBedrooms', $numberOfBedrooms);
} | The total integer number of bedrooms in a some [[Accommodation]],
[[ApartmentComplex]] or [[FloorPlan]].
@param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|float|float[]|int|int[] $numberOfBedrooms
@return static
@see https://schema.org/numberOfBedrooms
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | numberOfBedrooms | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function numberOfFullBathrooms($numberOfFullBathrooms)
{
return $this->setProperty('numberOfFullBathrooms', $numberOfFullBathrooms);
} | Number of full bathrooms - The total number of full and ¾ bathrooms in
an [[Accommodation]]. This corresponds to the [BathroomsFull field in
RESO](https://ddwiki.reso.org/display/DDW17/BathroomsFull+Field).
@param float|float[]|int|int[] $numberOfFullBathrooms
@return static
@see https://schema.org/numberOfFullBathrooms
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | numberOfFullBathrooms | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function numberOfPartialBathrooms($numberOfPartialBathrooms)
{
return $this->setProperty('numberOfPartialBathrooms', $numberOfPartialBathrooms);
} | Number of partial bathrooms - The total number of half and ¼ bathrooms
in an [[Accommodation]]. This corresponds to the [BathroomsPartial field
in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsPartial+Field).
@param float|float[]|int|int[] $numberOfPartialBathrooms
@return static
@see https://schema.org/numberOfPartialBathrooms
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | numberOfPartialBathrooms | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function numberOfRooms($numberOfRooms)
{
return $this->setProperty('numberOfRooms', $numberOfRooms);
} | The number of rooms (excluding bathrooms and closets) of the
accommodation or lodging business.
Typical unit code(s): ROM for room or C62 for no unit. The type of room
can be put in the unitText property of the QuantitativeValue.
@param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|float|float[]|int|int[] $numberOfRooms
@return static
@see https://schema.org/numberOfRooms | numberOfRooms | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function occupancy($occupancy)
{
return $this->setProperty('occupancy', $occupancy);
} | The allowed total occupancy for the accommodation in persons (including
infants etc). 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.
@param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $occupancy
@return static
@see https://schema.org/occupancy | occupancy | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function openingHoursSpecification($openingHoursSpecification)
{
return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
} | The opening hours of a certain place.
@param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
@return static
@see https://schema.org/openingHoursSpecification | openingHoursSpecification | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function permittedUsage($permittedUsage)
{
return $this->setProperty('permittedUsage', $permittedUsage);
} | Indications regarding the permitted usage of the accommodation.
@param string|string[] $permittedUsage
@return static
@see https://schema.org/permittedUsage | permittedUsage | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function petsAllowed($petsAllowed)
{
return $this->setProperty('petsAllowed', $petsAllowed);
} | Indicates whether pets are allowed to enter the accommodation or lodging
business. More detailed information can be put in a text value.
@param bool|bool[]|string|string[] $petsAllowed
@return static
@see https://schema.org/petsAllowed | petsAllowed | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function potentialAction($potentialAction)
{
return $this->setProperty('potentialAction', $potentialAction);
} | Indicates a potential Action, which describes an idealized action in
which this thing would play an 'object' role.
@param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
@return static
@see https://schema.org/potentialAction | potentialAction | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function publicAccess($publicAccess)
{
return $this->setProperty('publicAccess', $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.
@param bool|bool[] $publicAccess
@return static
@see https://schema.org/publicAccess | publicAccess | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function sameAs($sameAs)
{
return $this->setProperty('sameAs', $sameAs);
} | URL of a reference Web page that unambiguously indicates the item's
identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
official website.
@param string|string[] $sameAs
@return static
@see https://schema.org/sameAs | sameAs | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function slogan($slogan)
{
return $this->setProperty('slogan', $slogan);
} | A slogan or motto associated with the item.
@param string|string[] $slogan
@return static
@see https://schema.org/slogan | slogan | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function smokingAllowed($smokingAllowed)
{
return $this->setProperty('smokingAllowed', $smokingAllowed);
} | 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 https://schema.org/smokingAllowed | smokingAllowed | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function subjectOf($subjectOf)
{
return $this->setProperty('subjectOf', $subjectOf);
} | A CreativeWork or Event about this Thing.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
@return static
@see https://schema.org/subjectOf
@link https://github.com/schemaorg/schemaorg/issues/1670 | subjectOf | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function tourBookingPage($tourBookingPage)
{
return $this->setProperty('tourBookingPage', $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.
@param string|string[] $tourBookingPage
@return static
@see https://schema.org/tourBookingPage
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | tourBookingPage | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function yearBuilt($yearBuilt)
{
return $this->setProperty('yearBuilt', $yearBuilt);
} | The year an [[Accommodation]] was constructed. This corresponds to the
[YearBuilt field in
RESO](https://ddwiki.reso.org/display/DDW17/YearBuilt+Field).
@param float|float[]|int|int[] $yearBuilt
@return static
@see https://schema.org/yearBuilt
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | yearBuilt | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function actionAccessibilityRequirement($actionAccessibilityRequirement)
{
return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement);
} | A set of requirements that must be fulfilled in order to perform an
Action. If more than one value is specified, fulfilling one set of
requirements will allow the Action to be performed.
@param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement
@return static
@see https://schema.org/actionAccessibilityRequirement
@link https://github.com/schemaorg/schemaorg/issues/1741 | actionAccessibilityRequirement | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function actionProcess($actionProcess)
{
return $this->setProperty('actionProcess', $actionProcess);
} | Description of the process by which the action was performed.
@param \Spatie\SchemaOrg\Contracts\HowToContract|\Spatie\SchemaOrg\Contracts\HowToContract[] $actionProcess
@return static
@see https://schema.org/actionProcess | actionProcess | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function actionStatus($actionStatus)
{
return $this->setProperty('actionStatus', $actionStatus);
} | Indicates the current disposition of the Action.
@param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus
@return static
@see https://schema.org/actionStatus | actionStatus | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function additionalType($additionalType)
{
return $this->setProperty('additionalType', $additionalType);
} | An additional type for the item, typically used for adding more specific
types from external vocabularies in microdata syntax. This is a
relationship between something and a class that the thing is in.
Typically the value is a URI-identified RDF class, and in this case
corresponds to the
use of rdf:type in RDF. Text values can be used sparingly, for cases
where useful information can be added without their being an appropriate
schema to reference. In the case of text values, the class label should
follow the schema.org [style
guide](https://schema.org/docs/styleguide.html).
@param string|string[] $additionalType
@return static
@see https://schema.org/additionalType | additionalType | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function agent($agent)
{
return $this->setProperty('agent', $agent);
} | The direct performer or driver of the action (animate or inanimate). E.g.
*John* wrote a book.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent
@return static
@see https://schema.org/agent | agent | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function disambiguatingDescription($disambiguatingDescription)
{
return $this->setProperty('disambiguatingDescription', $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.
@param string|string[] $disambiguatingDescription
@return static
@see https://schema.org/disambiguatingDescription | disambiguatingDescription | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function endTime($endTime)
{
return $this->setProperty('endTime', $endTime);
} | The endTime of something. For a reserved event or service (e.g.
FoodEstablishmentReservation), the time that it is expected to end. For
actions that span a period of time, when the action was performed. E.g.
John wrote a book from January to *December*. For media, including audio
and video, it's the time offset of the end of a clip within a larger
file.
Note that Event uses startDate/endDate instead of startTime/endTime, even
when describing dates with times. This situation may be clarified in
future revisions.
@param \DateTimeInterface|\DateTimeInterface[] $endTime
@return static
@see https://schema.org/endTime
@link https://github.com/schemaorg/schemaorg/issues/2493 | endTime | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function error($error)
{
return $this->setProperty('error', $error);
} | For failed actions, more information on the cause of the failure.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error
@return static
@see https://schema.org/error | error | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function expectsAcceptanceOf($expectsAcceptanceOf)
{
return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf);
} | An Offer which must be accepted before the user can perform the Action.
For example, the user may need to buy a movie before being able to watch
it.
@param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf
@return static
@see https://schema.org/expectsAcceptanceOf
@link https://github.com/schemaorg/schemaorg/issues/1741 | expectsAcceptanceOf | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function identifier($identifier)
{
return $this->setProperty('identifier', $identifier);
} | The identifier property represents any kind of identifier for any kind of
[[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
dedicated properties for representing many of these, either as textual
strings or as URL (URI) links. See [background
notes](/docs/datamodel.html#identifierBg) for more details.
@param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
@return static
@see https://schema.org/identifier | identifier | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function image($image)
{
return $this->setProperty('image', $image);
} | An image of the item. This can be a [[URL]] or a fully described
[[ImageObject]].
@param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
@return static
@see https://schema.org/image | image | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function instrument($instrument)
{
return $this->setProperty('instrument', $instrument);
} | The object that helped the agent perform the action. E.g. John wrote a
book with *a pen*.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
@return static
@see https://schema.org/instrument | instrument | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function location($location)
{
return $this->setProperty('location', $location);
} | The location of, for example, where an event is happening, where an
organization is located, or where an action takes place.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|\Spatie\SchemaOrg\Contracts\VirtualLocationContract|\Spatie\SchemaOrg\Contracts\VirtualLocationContract[]|string|string[] $location
@return static
@see https://schema.org/location | location | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function mainEntityOfPage($mainEntityOfPage)
{
return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
} | Indicates a page (or other CreativeWork) for which this thing is the main
entity being described. See [background
notes](/docs/datamodel.html#mainEntityBackground) for details.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
@return static
@see https://schema.org/mainEntityOfPage | mainEntityOfPage | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function object($object)
{
return $this->setProperty('object', $object);
} | The object upon which the action is carried out, whose state is kept
intact or changed. Also known as the semantic roles patient, affected or
undergoer (which change their state) or theme (which doesn't). E.g. John
read *a book*.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
@return static
@see https://schema.org/object | object | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function participant($participant)
{
return $this->setProperty('participant', $participant);
} | Other co-agents that participated in the action indirectly. E.g. John
wrote a book with *Steve*.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
@return static
@see https://schema.org/participant | participant | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function potentialAction($potentialAction)
{
return $this->setProperty('potentialAction', $potentialAction);
} | Indicates a potential Action, which describes an idealized action in
which this thing would play an 'object' role.
@param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
@return static
@see https://schema.org/potentialAction | potentialAction | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function provider($provider)
{
return $this->setProperty('provider', $provider);
} | The service provider, service operator, or service performer; the goods
producer. Another party (a seller) may offer those services or goods on
behalf of the provider. A provider may also serve as the seller.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider
@return static
@see https://schema.org/provider
@see https://pending.schema.org | provider | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function result($result)
{
return $this->setProperty('result', $result);
} | The result produced in the action. E.g. John wrote *a book*.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
@return static
@see https://schema.org/result | result | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function sameAs($sameAs)
{
return $this->setProperty('sameAs', $sameAs);
} | URL of a reference Web page that unambiguously indicates the item's
identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
official website.
@param string|string[] $sameAs
@return static
@see https://schema.org/sameAs | sameAs | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function startTime($startTime)
{
return $this->setProperty('startTime', $startTime);
} | The startTime of something. For a reserved event or service (e.g.
FoodEstablishmentReservation), the time that it is expected to start. For
actions that span a period of time, when the action was performed. E.g.
John wrote a book from *January* to December. For media, including audio
and video, it's the time offset of the start of a clip within a larger
file.
Note that Event uses startDate/endDate instead of startTime/endTime, even
when describing dates with times. This situation may be clarified in
future revisions.
@param \DateTimeInterface|\DateTimeInterface[] $startTime
@return static
@see https://schema.org/startTime
@link https://github.com/schemaorg/schemaorg/issues/2493 | startTime | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function subjectOf($subjectOf)
{
return $this->setProperty('subjectOf', $subjectOf);
} | A CreativeWork or Event about this Thing.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
@return static
@see https://schema.org/subjectOf
@link https://github.com/schemaorg/schemaorg/issues/1670 | subjectOf | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function target($target)
{
return $this->setProperty('target', $target);
} | Indicates a target EntryPoint, or url, for an Action.
@param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[]|string|string[] $target
@return static
@see https://schema.org/target | target | php | spatie/schema-org | src/DrinkAction.php | https://github.com/spatie/schema-org/blob/master/src/DrinkAction.php | MIT |
public function actionProcess($actionProcess)
{
return $this->setProperty('actionProcess', $actionProcess);
} | Description of the process by which the action was performed.
@param \Spatie\SchemaOrg\Contracts\HowToContract|\Spatie\SchemaOrg\Contracts\HowToContract[] $actionProcess
@return static
@see https://schema.org/actionProcess | actionProcess | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function actionStatus($actionStatus)
{
return $this->setProperty('actionStatus', $actionStatus);
} | Indicates the current disposition of the Action.
@param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus
@return static
@see https://schema.org/actionStatus | actionStatus | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function additionalType($additionalType)
{
return $this->setProperty('additionalType', $additionalType);
} | An additional type for the item, typically used for adding more specific
types from external vocabularies in microdata syntax. This is a
relationship between something and a class that the thing is in.
Typically the value is a URI-identified RDF class, and in this case
corresponds to the
use of rdf:type in RDF. Text values can be used sparingly, for cases
where useful information can be added without their being an appropriate
schema to reference. In the case of text values, the class label should
follow the schema.org [style
guide](https://schema.org/docs/styleguide.html).
@param string|string[] $additionalType
@return static
@see https://schema.org/additionalType | additionalType | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function agent($agent)
{
return $this->setProperty('agent', $agent);
} | The direct performer or driver of the action (animate or inanimate). E.g.
*John* wrote a book.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent
@return static
@see https://schema.org/agent | agent | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function disambiguatingDescription($disambiguatingDescription)
{
return $this->setProperty('disambiguatingDescription', $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.
@param string|string[] $disambiguatingDescription
@return static
@see https://schema.org/disambiguatingDescription | disambiguatingDescription | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function endTime($endTime)
{
return $this->setProperty('endTime', $endTime);
} | The endTime of something. For a reserved event or service (e.g.
FoodEstablishmentReservation), the time that it is expected to end. For
actions that span a period of time, when the action was performed. E.g.
John wrote a book from January to *December*. For media, including audio
and video, it's the time offset of the end of a clip within a larger
file.
Note that Event uses startDate/endDate instead of startTime/endTime, even
when describing dates with times. This situation may be clarified in
future revisions.
@param \DateTimeInterface|\DateTimeInterface[] $endTime
@return static
@see https://schema.org/endTime
@link https://github.com/schemaorg/schemaorg/issues/2493 | endTime | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function error($error)
{
return $this->setProperty('error', $error);
} | For failed actions, more information on the cause of the failure.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error
@return static
@see https://schema.org/error | error | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function identifier($identifier)
{
return $this->setProperty('identifier', $identifier);
} | The identifier property represents any kind of identifier for any kind of
[[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
dedicated properties for representing many of these, either as textual
strings or as URL (URI) links. See [background
notes](/docs/datamodel.html#identifierBg) for more details.
@param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
@return static
@see https://schema.org/identifier | identifier | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function image($image)
{
return $this->setProperty('image', $image);
} | An image of the item. This can be a [[URL]] or a fully described
[[ImageObject]].
@param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
@return static
@see https://schema.org/image | image | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function instrument($instrument)
{
return $this->setProperty('instrument', $instrument);
} | The object that helped the agent perform the action. E.g. John wrote a
book with *a pen*.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
@return static
@see https://schema.org/instrument | instrument | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function location($location)
{
return $this->setProperty('location', $location);
} | The location of, for example, where an event is happening, where an
organization is located, or where an action takes place.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|\Spatie\SchemaOrg\Contracts\VirtualLocationContract|\Spatie\SchemaOrg\Contracts\VirtualLocationContract[]|string|string[] $location
@return static
@see https://schema.org/location | location | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function mainEntityOfPage($mainEntityOfPage)
{
return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
} | Indicates a page (or other CreativeWork) for which this thing is the main
entity being described. See [background
notes](/docs/datamodel.html#mainEntityBackground) for details.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
@return static
@see https://schema.org/mainEntityOfPage | mainEntityOfPage | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function object($object)
{
return $this->setProperty('object', $object);
} | The object upon which the action is carried out, whose state is kept
intact or changed. Also known as the semantic roles patient, affected or
undergoer (which change their state) or theme (which doesn't). E.g. John
read *a book*.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
@return static
@see https://schema.org/object | object | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function participant($participant)
{
return $this->setProperty('participant', $participant);
} | Other co-agents that participated in the action indirectly. E.g. John
wrote a book with *Steve*.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
@return static
@see https://schema.org/participant | participant | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function potentialAction($potentialAction)
{
return $this->setProperty('potentialAction', $potentialAction);
} | Indicates a potential Action, which describes an idealized action in
which this thing would play an 'object' role.
@param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
@return static
@see https://schema.org/potentialAction | potentialAction | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function provider($provider)
{
return $this->setProperty('provider', $provider);
} | The service provider, service operator, or service performer; the goods
producer. Another party (a seller) may offer those services or goods on
behalf of the provider. A provider may also serve as the seller.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider
@return static
@see https://schema.org/provider
@see https://pending.schema.org | provider | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function result($result)
{
return $this->setProperty('result', $result);
} | The result produced in the action. E.g. John wrote *a book*.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
@return static
@see https://schema.org/result | result | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function sameAs($sameAs)
{
return $this->setProperty('sameAs', $sameAs);
} | URL of a reference Web page that unambiguously indicates the item's
identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
official website.
@param string|string[] $sameAs
@return static
@see https://schema.org/sameAs | sameAs | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function scheduledTime($scheduledTime)
{
return $this->setProperty('scheduledTime', $scheduledTime);
} | The time the object is scheduled to.
@param \DateTimeInterface|\DateTimeInterface[] $scheduledTime
@return static
@see https://schema.org/scheduledTime | scheduledTime | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function startTime($startTime)
{
return $this->setProperty('startTime', $startTime);
} | The startTime of something. For a reserved event or service (e.g.
FoodEstablishmentReservation), the time that it is expected to start. For
actions that span a period of time, when the action was performed. E.g.
John wrote a book from *January* to December. For media, including audio
and video, it's the time offset of the start of a clip within a larger
file.
Note that Event uses startDate/endDate instead of startTime/endTime, even
when describing dates with times. This situation may be clarified in
future revisions.
@param \DateTimeInterface|\DateTimeInterface[] $startTime
@return static
@see https://schema.org/startTime
@link https://github.com/schemaorg/schemaorg/issues/2493 | startTime | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function subjectOf($subjectOf)
{
return $this->setProperty('subjectOf', $subjectOf);
} | A CreativeWork or Event about this Thing.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
@return static
@see https://schema.org/subjectOf
@link https://github.com/schemaorg/schemaorg/issues/1670 | subjectOf | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function target($target)
{
return $this->setProperty('target', $target);
} | Indicates a target EntryPoint, or url, for an Action.
@param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[]|string|string[] $target
@return static
@see https://schema.org/target | target | php | spatie/schema-org | src/CancelAction.php | https://github.com/spatie/schema-org/blob/master/src/CancelAction.php | MIT |
public function additionalType($additionalType)
{
return $this->setProperty('additionalType', $additionalType);
} | An additional type for the item, typically used for adding more specific
types from external vocabularies in microdata syntax. This is a
relationship between something and a class that the thing is in.
Typically the value is a URI-identified RDF class, and in this case
corresponds to the
use of rdf:type in RDF. Text values can be used sparingly, for cases
where useful information can be added without their being an appropriate
schema to reference. In the case of text values, the class label should
follow the schema.org [style
guide](https://schema.org/docs/styleguide.html).
@param string|string[] $additionalType
@return static
@see https://schema.org/additionalType | additionalType | php | spatie/schema-org | src/MedicalGuideline.php | https://github.com/spatie/schema-org/blob/master/src/MedicalGuideline.php | MIT |
public function code($code)
{
return $this->setProperty('code', $code);
} | A medical code for the entity, taken from a controlled vocabulary or
ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
@param \Spatie\SchemaOrg\Contracts\MedicalCodeContract|\Spatie\SchemaOrg\Contracts\MedicalCodeContract[] $code
@return static
@see https://schema.org/code
@see https://health-lifesci.schema.org | code | php | spatie/schema-org | src/MedicalGuideline.php | https://github.com/spatie/schema-org/blob/master/src/MedicalGuideline.php | MIT |
public function disambiguatingDescription($disambiguatingDescription)
{
return $this->setProperty('disambiguatingDescription', $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.
@param string|string[] $disambiguatingDescription
@return static
@see https://schema.org/disambiguatingDescription | disambiguatingDescription | php | spatie/schema-org | src/MedicalGuideline.php | https://github.com/spatie/schema-org/blob/master/src/MedicalGuideline.php | MIT |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.