code
stringlengths 17
247k
| 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 encodesCreativeWork($encodesCreativeWork)
{
return $this->setProperty('encodesCreativeWork', $encodesCreativeWork);
} | The CreativeWork encoded by this media object.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[] $encodesCreativeWork
@return static
@see https://schema.org/encodesCreativeWork | encodesCreativeWork | php | spatie/schema-org | src/MusicVideoObject.php | https://github.com/spatie/schema-org/blob/master/src/MusicVideoObject.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/MusicVideoObject.php | https://github.com/spatie/schema-org/blob/master/src/MusicVideoObject.php | MIT |
public function ineligibleRegion($ineligibleRegion)
{
return $this->setProperty('ineligibleRegion', $ineligibleRegion);
} | The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the
GeoShape for the geo-political region(s) for which the offer or delivery
charge specification is not valid, e.g. a region where the transaction is
not allowed.
See also [[eligibleRegion]].
@param \Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|string|string[] $ineligibleRegion
@return static
@see https://schema.org/ineligibleRegion
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2242 | ineligibleRegion | php | spatie/schema-org | src/MusicVideoObject.php | https://github.com/spatie/schema-org/blob/master/src/MusicVideoObject.php | MIT |
public function playerType($playerType)
{
return $this->setProperty('playerType', $playerType);
} | Player type required—for example, Flash or Silverlight.
@param string|string[] $playerType
@return static
@see https://schema.org/playerType | playerType | php | spatie/schema-org | src/MusicVideoObject.php | https://github.com/spatie/schema-org/blob/master/src/MusicVideoObject.php | MIT |
public function regionsAllowed($regionsAllowed)
{
return $this->setProperty('regionsAllowed', $regionsAllowed);
} | The regions where the media is allowed. If not specified, then it's
assumed to be allowed everywhere. Specify the countries in [ISO 3166
format](http://en.wikipedia.org/wiki/ISO_3166).
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $regionsAllowed
@return static
@see https://schema.org/regionsAllowed | regionsAllowed | php | spatie/schema-org | src/MusicVideoObject.php | https://github.com/spatie/schema-org/blob/master/src/MusicVideoObject.php | MIT |
public function requiresSubscription($requiresSubscription)
{
return $this->setProperty('requiresSubscription', $requiresSubscription);
} | Indicates if use of the media require a subscription (either paid or
free). Allowed values are ```true``` or ```false``` (note that an earlier
version had 'yes', 'no').
@param \Spatie\SchemaOrg\Contracts\MediaSubscriptionContract|\Spatie\SchemaOrg\Contracts\MediaSubscriptionContract[]|bool|bool[] $requiresSubscription
@return static
@see https://schema.org/requiresSubscription
@link https://github.com/schemaorg/schemaorg/issues/1741 | requiresSubscription | php | spatie/schema-org | src/MusicVideoObject.php | https://github.com/spatie/schema-org/blob/master/src/MusicVideoObject.php | MIT |
public function sha256($sha256)
{
return $this->setProperty('sha256', $sha256);
} | The [SHA-2](https://en.wikipedia.org/wiki/SHA-2) SHA256 hash of the
content of the item. For example, a zero-length input has value
'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'.
@param string|string[] $sha256
@return static
@see https://schema.org/sha256
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2450 | sha256 | php | spatie/schema-org | src/MusicVideoObject.php | https://github.com/spatie/schema-org/blob/master/src/MusicVideoObject.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/MusicVideoObject.php | https://github.com/spatie/schema-org/blob/master/src/MusicVideoObject.php | MIT |
public function uploadDate($uploadDate)
{
return $this->setProperty('uploadDate', $uploadDate);
} | Date (including time if available) when this media object was uploaded to
this site.
@param \DateTimeInterface|\DateTimeInterface[] $uploadDate
@return static
@see https://schema.org/uploadDate | uploadDate | php | spatie/schema-org | src/MusicVideoObject.php | https://github.com/spatie/schema-org/blob/master/src/MusicVideoObject.php | MIT |
public function articleBody($articleBody)
{
return $this->setProperty('articleBody', $articleBody);
} | The actual body of the article.
@param string|string[] $articleBody
@return static
@see https://schema.org/articleBody | articleBody | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function articleSection($articleSection)
{
return $this->setProperty('articleSection', $articleSection);
} | Articles may belong to one or more 'sections' in a magazine or newspaper,
such as Sports, Lifestyle, etc.
@param string|string[] $articleSection
@return static
@see https://schema.org/articleSection | articleSection | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function backstory($backstory)
{
return $this->setProperty('backstory', $backstory);
} | For an [[Article]], typically a [[NewsArticle]], the backstory property
provides a textual summary giving a brief explanation of why and how an
article was created. In a journalistic setting this could include
information about reporting process, methods, interviews, data sources,
etc.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $backstory
@return static
@see https://schema.org/backstory
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1688 | backstory | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function dateline($dateline)
{
return $this->setProperty('dateline', $dateline);
} | A [dateline](https://en.wikipedia.org/wiki/Dateline) is a brief piece of
text included in news articles that describes where and when the story
was written or filed though the date is often omitted. Sometimes only a
placename is provided.
Structured representations of dateline-related information can also be
expressed more explicitly using [[locationCreated]] (which represents
where a work was created, e.g. where a news report was written). For
location depicted or described in the content, use [[contentLocation]].
Dateline summaries are oriented more towards human readers than towards
automated processing, and can vary substantially. Some examples: "BEIRUT,
Lebanon, June 2.", "Paris, France", "December 19, 2017 11:43AM Reporting
from Washington", "Beijing/Moscow", "QUEZON CITY, Philippines".
@param string|string[] $dateline
@return static
@see https://schema.org/dateline | dateline | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function printColumn($printColumn)
{
return $this->setProperty('printColumn', $printColumn);
} | The number of the column in which the NewsArticle appears in the print
edition.
@param string|string[] $printColumn
@return static
@see https://schema.org/printColumn | printColumn | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function printEdition($printEdition)
{
return $this->setProperty('printEdition', $printEdition);
} | The edition of the print product in which the NewsArticle appears.
@param string|string[] $printEdition
@return static
@see https://schema.org/printEdition | printEdition | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function printPage($printPage)
{
return $this->setProperty('printPage', $printPage);
} | If this NewsArticle appears in print, this field indicates the name of
the page on which the article is found. Please note that this field is
intended for the exact page name (e.g. A5, B18).
@param string|string[] $printPage
@return static
@see https://schema.org/printPage | printPage | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function printSection($printSection)
{
return $this->setProperty('printSection', $printSection);
} | If this NewsArticle appears in print, this field indicates the print
section in which the article appeared.
@param string|string[] $printSection
@return static
@see https://schema.org/printSection | printSection | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function speakable($speakable)
{
return $this->setProperty('speakable', $speakable);
} | Indicates sections of a Web page that are particularly 'speakable' in the
sense of being highlighted as being especially appropriate for
text-to-speech conversion. Other sections of a page may also be usefully
spoken in particular circumstances; the 'speakable' property serves to
indicate the parts most likely to be generally useful for speech.
The *speakable* property can be repeated an arbitrary number of times,
with three kinds of possible 'content-locator' values:
1.) *id-value* URL references - uses *id-value* of an element in the page
being annotated. The simplest use of *speakable* has (potentially
relative) URL values, referencing identified sections of the document
concerned.
2.) CSS Selectors - addresses content in the annotated page, e.g. via
class attribute. Use the [[cssSelector]] property.
3.) XPaths - addresses content via XPaths (assuming an XML view of the
content). Use the [[xpath]] property.
For more sophisticated markup of speakable sections beyond simple ID
references, either CSS selectors or XPath expressions to pick out
document section(s) as speakable. For this
we define a supporting type, [[SpeakableSpecification]] which is defined
to be a possible value of the *speakable* property.
@param \Spatie\SchemaOrg\Contracts\SpeakableSpecificationContract|\Spatie\SchemaOrg\Contracts\SpeakableSpecificationContract[]|string|string[] $speakable
@return static
@see https://schema.org/speakable
@link https://github.com/schemaorg/schemaorg/issues/1389 | speakable | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function wordCount($wordCount)
{
return $this->setProperty('wordCount', $wordCount);
} | The number of words in the text of the Article.
@param int|int[] $wordCount
@return static
@see https://schema.org/wordCount | wordCount | php | spatie/schema-org | src/BackgroundNewsArticle.php | https://github.com/spatie/schema-org/blob/master/src/BackgroundNewsArticle.php | MIT |
public function associatedAnatomy($associatedAnatomy)
{
return $this->setProperty('associatedAnatomy', $associatedAnatomy);
} | The anatomy of the underlying organ system or structures associated with
this entity.
@param \Spatie\SchemaOrg\Contracts\AnatomicalStructureContract|\Spatie\SchemaOrg\Contracts\AnatomicalStructureContract[]|\Spatie\SchemaOrg\Contracts\AnatomicalSystemContract|\Spatie\SchemaOrg\Contracts\AnatomicalSystemContract[]|\Spatie\SchemaOrg\Contracts\SuperficialAnatomyContract|\Spatie\SchemaOrg\Contracts\SuperficialAnatomyContract[] $associatedAnatomy
@return static
@see https://schema.org/associatedAnatomy
@see https://health-lifesci.schema.org | associatedAnatomy | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.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/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function differentialDiagnosis($differentialDiagnosis)
{
return $this->setProperty('differentialDiagnosis', $differentialDiagnosis);
} | One of a set of differential diagnoses for the condition. Specifically, a
closely-related or competing diagnosis typically considered later in the
cognitive process whereby this medical condition is distinguished from
others most likely responsible for a similar collection of signs and
symptoms to reach the most parsimonious diagnosis or diagnoses in a
patient.
@param \Spatie\SchemaOrg\Contracts\DDxElementContract|\Spatie\SchemaOrg\Contracts\DDxElementContract[] $differentialDiagnosis
@return static
@see https://schema.org/differentialDiagnosis
@see https://health-lifesci.schema.org | differentialDiagnosis | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function drug($drug)
{
return $this->setProperty('drug', $drug);
} | Specifying a drug or medicine used in a medication procedure.
@param \Spatie\SchemaOrg\Contracts\DrugContract|\Spatie\SchemaOrg\Contracts\DrugContract[] $drug
@return static
@see https://schema.org/drug
@see https://health-lifesci.schema.org | drug | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function epidemiology($epidemiology)
{
return $this->setProperty('epidemiology', $epidemiology);
} | The characteristics of associated patients, such as age, gender, race
etc.
@param string|string[] $epidemiology
@return static
@see https://schema.org/epidemiology
@see https://health-lifesci.schema.org | epidemiology | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function expectedPrognosis($expectedPrognosis)
{
return $this->setProperty('expectedPrognosis', $expectedPrognosis);
} | The likely outcome in either the short term or long term of the medical
condition.
@param string|string[] $expectedPrognosis
@return static
@see https://schema.org/expectedPrognosis
@see https://health-lifesci.schema.org | expectedPrognosis | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function guideline($guideline)
{
return $this->setProperty('guideline', $guideline);
} | A medical guideline related to this entity.
@param \Spatie\SchemaOrg\Contracts\MedicalGuidelineContract|\Spatie\SchemaOrg\Contracts\MedicalGuidelineContract[] $guideline
@return static
@see https://schema.org/guideline
@see https://health-lifesci.schema.org | guideline | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function legalStatus($legalStatus)
{
return $this->setProperty('legalStatus', $legalStatus);
} | The drug or supplement's legal status, including any controlled substance
schedules that apply.
@param \Spatie\SchemaOrg\Contracts\DrugLegalStatusContract|\Spatie\SchemaOrg\Contracts\DrugLegalStatusContract[]|\Spatie\SchemaOrg\Contracts\MedicalEnumerationContract|\Spatie\SchemaOrg\Contracts\MedicalEnumerationContract[]|string|string[] $legalStatus
@return static
@see https://schema.org/legalStatus
@see https://health-lifesci.schema.org | legalStatus | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function medicineSystem($medicineSystem)
{
return $this->setProperty('medicineSystem', $medicineSystem);
} | The system of medicine that includes this MedicalEntity, for example
'evidence-based', 'homeopathic', 'chiropractic', etc.
@param \Spatie\SchemaOrg\Contracts\MedicineSystemContract|\Spatie\SchemaOrg\Contracts\MedicineSystemContract[] $medicineSystem
@return static
@see https://schema.org/medicineSystem
@see https://health-lifesci.schema.org | medicineSystem | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function naturalProgression($naturalProgression)
{
return $this->setProperty('naturalProgression', $naturalProgression);
} | The expected progression of the condition if it is not treated and
allowed to progress naturally.
@param string|string[] $naturalProgression
@return static
@see https://schema.org/naturalProgression
@see https://health-lifesci.schema.org | naturalProgression | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function pathophysiology($pathophysiology)
{
return $this->setProperty('pathophysiology', $pathophysiology);
} | Changes in the normal mechanical, physical, and biochemical functions
that are associated with this activity or condition.
@param string|string[] $pathophysiology
@return static
@see https://schema.org/pathophysiology
@see https://health-lifesci.schema.org | pathophysiology | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function possibleComplication($possibleComplication)
{
return $this->setProperty('possibleComplication', $possibleComplication);
} | A possible unexpected and unfavorable evolution of a medical condition.
Complications may include worsening of the signs or symptoms of the
disease, extension of the condition to other organ systems, etc.
@param string|string[] $possibleComplication
@return static
@see https://schema.org/possibleComplication
@see https://health-lifesci.schema.org | possibleComplication | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function possibleTreatment($possibleTreatment)
{
return $this->setProperty('possibleTreatment', $possibleTreatment);
} | A possible treatment to address this condition, sign or symptom.
@param \Spatie\SchemaOrg\Contracts\MedicalTherapyContract|\Spatie\SchemaOrg\Contracts\MedicalTherapyContract[] $possibleTreatment
@return static
@see https://schema.org/possibleTreatment
@see https://health-lifesci.schema.org | possibleTreatment | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function primaryPrevention($primaryPrevention)
{
return $this->setProperty('primaryPrevention', $primaryPrevention);
} | A preventative therapy used to prevent an initial occurrence of the
medical condition, such as vaccination.
@param \Spatie\SchemaOrg\Contracts\MedicalTherapyContract|\Spatie\SchemaOrg\Contracts\MedicalTherapyContract[] $primaryPrevention
@return static
@see https://schema.org/primaryPrevention
@see https://health-lifesci.schema.org | primaryPrevention | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function recognizingAuthority($recognizingAuthority)
{
return $this->setProperty('recognizingAuthority', $recognizingAuthority);
} | If applicable, the organization that officially recognizes this entity as
part of its endorsed system of medicine.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $recognizingAuthority
@return static
@see https://schema.org/recognizingAuthority
@see https://health-lifesci.schema.org | recognizingAuthority | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function relevantSpecialty($relevantSpecialty)
{
return $this->setProperty('relevantSpecialty', $relevantSpecialty);
} | If applicable, a medical specialty in which this entity is relevant.
@param \Spatie\SchemaOrg\Contracts\MedicalSpecialtyContract|\Spatie\SchemaOrg\Contracts\MedicalSpecialtyContract[] $relevantSpecialty
@return static
@see https://schema.org/relevantSpecialty
@see https://health-lifesci.schema.org | relevantSpecialty | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function riskFactor($riskFactor)
{
return $this->setProperty('riskFactor', $riskFactor);
} | A modifiable or non-modifiable factor that increases the risk of a
patient contracting this condition, e.g. age, coexisting condition.
@param \Spatie\SchemaOrg\Contracts\MedicalRiskFactorContract|\Spatie\SchemaOrg\Contracts\MedicalRiskFactorContract[] $riskFactor
@return static
@see https://schema.org/riskFactor
@see https://health-lifesci.schema.org | riskFactor | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function secondaryPrevention($secondaryPrevention)
{
return $this->setProperty('secondaryPrevention', $secondaryPrevention);
} | A preventative therapy used to prevent reoccurrence of the medical
condition after an initial episode of the condition.
@param \Spatie\SchemaOrg\Contracts\MedicalTherapyContract|\Spatie\SchemaOrg\Contracts\MedicalTherapyContract[] $secondaryPrevention
@return static
@see https://schema.org/secondaryPrevention
@see https://health-lifesci.schema.org | secondaryPrevention | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function signOrSymptom($signOrSymptom)
{
return $this->setProperty('signOrSymptom', $signOrSymptom);
} | A sign or symptom of this condition. Signs are objective or physically
observable manifestations of the medical condition while symptoms are the
subjective experience of the medical condition.
@param \Spatie\SchemaOrg\Contracts\MedicalSignOrSymptomContract|\Spatie\SchemaOrg\Contracts\MedicalSignOrSymptomContract[] $signOrSymptom
@return static
@see https://schema.org/signOrSymptom
@see https://health-lifesci.schema.org | signOrSymptom | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function stage($stage)
{
return $this->setProperty('stage', $stage);
} | The stage of the condition, if applicable.
@param \Spatie\SchemaOrg\Contracts\MedicalConditionStageContract|\Spatie\SchemaOrg\Contracts\MedicalConditionStageContract[] $stage
@return static
@see https://schema.org/stage
@see https://health-lifesci.schema.org | stage | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function status($status)
{
return $this->setProperty('status', $status);
} | The status of the study (enumerated).
@param \Spatie\SchemaOrg\Contracts\EventStatusTypeContract|\Spatie\SchemaOrg\Contracts\EventStatusTypeContract[]|\Spatie\SchemaOrg\Contracts\MedicalStudyStatusContract|\Spatie\SchemaOrg\Contracts\MedicalStudyStatusContract[]|string|string[] $status
@return static
@see https://schema.org/status
@see https://health-lifesci.schema.org | status | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function study($study)
{
return $this->setProperty('study', $study);
} | A medical study or trial related to this entity.
@param \Spatie\SchemaOrg\Contracts\MedicalStudyContract|\Spatie\SchemaOrg\Contracts\MedicalStudyContract[] $study
@return static
@see https://schema.org/study
@see https://health-lifesci.schema.org | study | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function typicalTest($typicalTest)
{
return $this->setProperty('typicalTest', $typicalTest);
} | A medical test typically performed given this condition.
@param \Spatie\SchemaOrg\Contracts\MedicalTestContract|\Spatie\SchemaOrg\Contracts\MedicalTestContract[] $typicalTest
@return static
@see https://schema.org/typicalTest
@see https://health-lifesci.schema.org | typicalTest | php | spatie/schema-org | src/MedicalCondition.php | https://github.com/spatie/schema-org/blob/master/src/MedicalCondition.php | MIT |
public function maxValue($maxValue)
{
return $this->setProperty('maxValue', $maxValue);
} | The upper value of some characteristic or property.
@param float|float[]|int|int[] $maxValue
@return static
@see https://schema.org/maxValue | maxValue | php | spatie/schema-org | src/QuantitativeValue.php | https://github.com/spatie/schema-org/blob/master/src/QuantitativeValue.php | MIT |
public function minValue($minValue)
{
return $this->setProperty('minValue', $minValue);
} | The lower value of some characteristic or property.
@param float|float[]|int|int[] $minValue
@return static
@see https://schema.org/minValue | minValue | php | spatie/schema-org | src/QuantitativeValue.php | https://github.com/spatie/schema-org/blob/master/src/QuantitativeValue.php | MIT |
public function unitCode($unitCode)
{
return $this->setProperty('unitCode', $unitCode);
} | The unit of measurement given using the UN/CEFACT Common Code (3
characters) or a URL. Other codes than the UN/CEFACT Common Code may be
used with a prefix followed by a colon.
@param string|string[] $unitCode
@return static
@see https://schema.org/unitCode | unitCode | php | spatie/schema-org | src/QuantitativeValue.php | https://github.com/spatie/schema-org/blob/master/src/QuantitativeValue.php | MIT |
public function unitText($unitText)
{
return $this->setProperty('unitText', $unitText);
} | A string or text indicating the unit of measurement. Useful if you cannot
provide a standard unit code for
<a href='unitCode'>unitCode</a>.
@param string|string[] $unitText
@return static
@see https://schema.org/unitText | unitText | php | spatie/schema-org | src/QuantitativeValue.php | https://github.com/spatie/schema-org/blob/master/src/QuantitativeValue.php | MIT |
public function value($value)
{
return $this->setProperty('value', $value);
} | The value of a [[QuantitativeValue]] (including [[Observation]]) or
property value node.
* For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type
for values is 'Number'.
* For [[PropertyValue]], it can be 'Text', 'Number', 'Boolean', or
'StructuredValue'.
* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
NINE' (U+0039)) rather than superficially similar Unicode symbols.
* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
decimal point. Avoid using these symbols as a readability separator.
@param \Spatie\SchemaOrg\Contracts\StructuredValueContract|\Spatie\SchemaOrg\Contracts\StructuredValueContract[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value
@return static
@see https://schema.org/value | value | php | spatie/schema-org | src/QuantitativeValue.php | https://github.com/spatie/schema-org/blob/master/src/QuantitativeValue.php | MIT |
public function valueReference($valueReference)
{
return $this->setProperty('valueReference', $valueReference);
} | A secondary value that provides additional information on the original
value, e.g. a reference temperature or a type of measurement.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|\Spatie\SchemaOrg\Contracts\EnumerationContract|\Spatie\SchemaOrg\Contracts\EnumerationContract[]|\Spatie\SchemaOrg\Contracts\MeasurementTypeEnumerationContract|\Spatie\SchemaOrg\Contracts\MeasurementTypeEnumerationContract[]|\Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|\Spatie\SchemaOrg\Contracts\QualitativeValueContract|\Spatie\SchemaOrg\Contracts\QualitativeValueContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|\Spatie\SchemaOrg\Contracts\StructuredValueContract|\Spatie\SchemaOrg\Contracts\StructuredValueContract[]|string|string[] $valueReference
@return static
@see https://schema.org/valueReference | valueReference | php | spatie/schema-org | src/QuantitativeValue.php | https://github.com/spatie/schema-org/blob/master/src/QuantitativeValue.php | MIT |
public function breadcrumb($breadcrumb)
{
return $this->setProperty('breadcrumb', $breadcrumb);
} | A set of links that can help a user understand and navigate a website
hierarchy.
@param \Spatie\SchemaOrg\Contracts\BreadcrumbListContract|\Spatie\SchemaOrg\Contracts\BreadcrumbListContract[]|string|string[] $breadcrumb
@return static
@see https://schema.org/breadcrumb | breadcrumb | php | spatie/schema-org | src/AboutPage.php | https://github.com/spatie/schema-org/blob/master/src/AboutPage.php | MIT |
public function lastReviewed($lastReviewed)
{
return $this->setProperty('lastReviewed', $lastReviewed);
} | Date on which the content on this web page was last reviewed for accuracy
and/or completeness.
@param \DateTimeInterface|\DateTimeInterface[] $lastReviewed
@return static
@see https://schema.org/lastReviewed | lastReviewed | php | spatie/schema-org | src/AboutPage.php | https://github.com/spatie/schema-org/blob/master/src/AboutPage.php | MIT |
public function mainContentOfPage($mainContentOfPage)
{
return $this->setProperty('mainContentOfPage', $mainContentOfPage);
} | Indicates if this web page element is the main subject of the page.
@param \Spatie\SchemaOrg\Contracts\WebPageElementContract|\Spatie\SchemaOrg\Contracts\WebPageElementContract[] $mainContentOfPage
@return static
@see https://schema.org/mainContentOfPage | mainContentOfPage | php | spatie/schema-org | src/AboutPage.php | https://github.com/spatie/schema-org/blob/master/src/AboutPage.php | MIT |
public function primaryImageOfPage($primaryImageOfPage)
{
return $this->setProperty('primaryImageOfPage', $primaryImageOfPage);
} | Indicates the main image on the page.
@param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[] $primaryImageOfPage
@return static
@see https://schema.org/primaryImageOfPage | primaryImageOfPage | php | spatie/schema-org | src/AboutPage.php | https://github.com/spatie/schema-org/blob/master/src/AboutPage.php | MIT |
public function relatedLink($relatedLink)
{
return $this->setProperty('relatedLink', $relatedLink);
} | A link related to this web page, for example to other related web pages.
@param string|string[] $relatedLink
@return static
@see https://schema.org/relatedLink | relatedLink | php | spatie/schema-org | src/AboutPage.php | https://github.com/spatie/schema-org/blob/master/src/AboutPage.php | MIT |
public function reviewedBy($reviewedBy)
{
return $this->setProperty('reviewedBy', $reviewedBy);
} | People or organizations that have reviewed the content on this web page
for accuracy and/or completeness.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $reviewedBy
@return static
@see https://schema.org/reviewedBy | reviewedBy | php | spatie/schema-org | src/AboutPage.php | https://github.com/spatie/schema-org/blob/master/src/AboutPage.php | MIT |
public function significantLink($significantLink)
{
return $this->setProperty('significantLink', $significantLink);
} | One of the more significant URLs on the page. Typically, these are the
non-navigation links that are clicked on the most.
@param string|string[] $significantLink
@return static
@see https://schema.org/significantLink | significantLink | php | spatie/schema-org | src/AboutPage.php | https://github.com/spatie/schema-org/blob/master/src/AboutPage.php | MIT |
public function significantLinks($significantLinks)
{
return $this->setProperty('significantLinks', $significantLinks);
} | The most significant URLs on the page. Typically, these are the
non-navigation links that are clicked on the most.
@param string|string[] $significantLinks
@return static
@see https://schema.org/significantLinks | significantLinks | php | spatie/schema-org | src/AboutPage.php | https://github.com/spatie/schema-org/blob/master/src/AboutPage.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/CheckAction.php | https://github.com/spatie/schema-org/blob/master/src/CheckAction.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/CheckAction.php | https://github.com/spatie/schema-org/blob/master/src/CheckAction.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/CheckAction.php | https://github.com/spatie/schema-org/blob/master/src/CheckAction.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/CheckAction.php | https://github.com/spatie/schema-org/blob/master/src/CheckAction.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/CheckAction.php | https://github.com/spatie/schema-org/blob/master/src/CheckAction.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/CheckAction.php | https://github.com/spatie/schema-org/blob/master/src/CheckAction.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/CheckAction.php | https://github.com/spatie/schema-org/blob/master/src/CheckAction.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/CheckAction.php | https://github.com/spatie/schema-org/blob/master/src/CheckAction.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/CheckAction.php | https://github.com/spatie/schema-org/blob/master/src/CheckAction.php | MIT |
public function inSupportOf($inSupportOf)
{
return $this->setProperty('inSupportOf', $inSupportOf);
} | Qualification, candidature, degree, application that Thesis supports.
@param string|string[] $inSupportOf
@return static
@see https://schema.org/inSupportOf
@see https://bib.schema.org | inSupportOf | php | spatie/schema-org | src/Thesis.php | https://github.com/spatie/schema-org/blob/master/src/Thesis.php | MIT |
public function bestRating($bestRating)
{
return $this->setProperty('bestRating', $bestRating);
} | The highest value allowed in this rating system.
@param float|float[]|int|int[]|string|string[] $bestRating
@return static
@see https://schema.org/bestRating | bestRating | php | spatie/schema-org | src/EmployerAggregateRating.php | https://github.com/spatie/schema-org/blob/master/src/EmployerAggregateRating.php | MIT |
public function itemReviewed($itemReviewed)
{
return $this->setProperty('itemReviewed', $itemReviewed);
} | The item that is being reviewed/rated.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $itemReviewed
@return static
@see https://schema.org/itemReviewed | itemReviewed | php | spatie/schema-org | src/EmployerAggregateRating.php | https://github.com/spatie/schema-org/blob/master/src/EmployerAggregateRating.php | MIT |
public function ratingCount($ratingCount)
{
return $this->setProperty('ratingCount', $ratingCount);
} | The count of total number of ratings.
@param int|int[] $ratingCount
@return static
@see https://schema.org/ratingCount | ratingCount | php | spatie/schema-org | src/EmployerAggregateRating.php | https://github.com/spatie/schema-org/blob/master/src/EmployerAggregateRating.php | MIT |
public function ratingExplanation($ratingExplanation)
{
return $this->setProperty('ratingExplanation', $ratingExplanation);
} | A short explanation (e.g. one to two sentences) providing background
context and other information that led to the conclusion expressed in the
rating. This is particularly applicable to ratings associated with "fact
check" markup using [[ClaimReview]].
@param string|string[] $ratingExplanation
@return static
@see https://schema.org/ratingExplanation
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2300 | ratingExplanation | php | spatie/schema-org | src/EmployerAggregateRating.php | https://github.com/spatie/schema-org/blob/master/src/EmployerAggregateRating.php | MIT |
public function ratingValue($ratingValue)
{
return $this->setProperty('ratingValue', $ratingValue);
} | The rating for the content.
Usage guidelines:
* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
NINE' (U+0039)) rather than superficially similar Unicode symbols.
* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
decimal point. Avoid using these symbols as a readability separator.
@param float|float[]|int|int[]|string|string[] $ratingValue
@return static
@see https://schema.org/ratingValue | ratingValue | php | spatie/schema-org | src/EmployerAggregateRating.php | https://github.com/spatie/schema-org/blob/master/src/EmployerAggregateRating.php | MIT |
public function reviewAspect($reviewAspect)
{
return $this->setProperty('reviewAspect', $reviewAspect);
} | This Review or Rating is relevant to this part or facet of the
itemReviewed.
@param string|string[] $reviewAspect
@return static
@see https://schema.org/reviewAspect
@link https://github.com/schemaorg/schemaorg/issues/1689 | reviewAspect | php | spatie/schema-org | src/EmployerAggregateRating.php | https://github.com/spatie/schema-org/blob/master/src/EmployerAggregateRating.php | MIT |
public function reviewCount($reviewCount)
{
return $this->setProperty('reviewCount', $reviewCount);
} | The count of total number of reviews.
@param int|int[] $reviewCount
@return static
@see https://schema.org/reviewCount | reviewCount | php | spatie/schema-org | src/EmployerAggregateRating.php | https://github.com/spatie/schema-org/blob/master/src/EmployerAggregateRating.php | MIT |
public function worstRating($worstRating)
{
return $this->setProperty('worstRating', $worstRating);
} | The lowest value allowed in this rating system.
@param float|float[]|int|int[]|string|string[] $worstRating
@return static
@see https://schema.org/worstRating | worstRating | php | spatie/schema-org | src/EmployerAggregateRating.php | https://github.com/spatie/schema-org/blob/master/src/EmployerAggregateRating.php | MIT |
public function characterName($characterName)
{
return $this->setProperty('characterName', $characterName);
} | The name of a character played in some acting or performing role, i.e. in
a PerformanceRole.
@param string|string[] $characterName
@return static
@see https://schema.org/characterName | characterName | php | spatie/schema-org | src/PerformanceRole.php | https://github.com/spatie/schema-org/blob/master/src/PerformanceRole.php | MIT |
public function endDate($endDate)
{
return $this->setProperty('endDate', $endDate);
} | The end date and time of the item (in [ISO 8601 date
format](http://en.wikipedia.org/wiki/ISO_8601)).
@param \DateTimeInterface|\DateTimeInterface[] $endDate
@return static
@see https://schema.org/endDate
@link https://github.com/schemaorg/schemaorg/issues/2486 | endDate | php | spatie/schema-org | src/PerformanceRole.php | https://github.com/spatie/schema-org/blob/master/src/PerformanceRole.php | MIT |
public function namedPosition($namedPosition)
{
return $this->setProperty('namedPosition', $namedPosition);
} | A position played, performed or filled by a person or organization, as
part of an organization. For example, an athlete in a SportsTeam might
play in the position named 'Quarterback'.
@param string|string[] $namedPosition
@return static
@see https://schema.org/namedPosition | namedPosition | php | spatie/schema-org | src/PerformanceRole.php | https://github.com/spatie/schema-org/blob/master/src/PerformanceRole.php | MIT |
public function roleName($roleName)
{
return $this->setProperty('roleName', $roleName);
} | A role played, performed or filled by a person or organization. For
example, the team of creators for a comic book might fill the roles named
'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might
play in the position named 'Quarterback'.
@param string|string[] $roleName
@return static
@see https://schema.org/roleName | roleName | php | spatie/schema-org | src/PerformanceRole.php | https://github.com/spatie/schema-org/blob/master/src/PerformanceRole.php | MIT |
public function startDate($startDate)
{
return $this->setProperty('startDate', $startDate);
} | The start date and time of the item (in [ISO 8601 date
format](http://en.wikipedia.org/wiki/ISO_8601)).
@param \DateTimeInterface|\DateTimeInterface[] $startDate
@return static
@see https://schema.org/startDate
@link https://github.com/schemaorg/schemaorg/issues/2486 | startDate | php | spatie/schema-org | src/PerformanceRole.php | https://github.com/spatie/schema-org/blob/master/src/PerformanceRole.php | MIT |
public function postalCodeBegin($postalCodeBegin)
{
return $this->setProperty('postalCodeBegin', $postalCodeBegin);
} | First postal code in a range (included).
@param string|string[] $postalCodeBegin
@return static
@see https://schema.org/postalCodeBegin
@link https://github.com/schemaorg/schemaorg/issues/2506 | postalCodeBegin | php | spatie/schema-org | src/PostalCodeRangeSpecification.php | https://github.com/spatie/schema-org/blob/master/src/PostalCodeRangeSpecification.php | MIT |
public function postalCodeEnd($postalCodeEnd)
{
return $this->setProperty('postalCodeEnd', $postalCodeEnd);
} | Last postal code in the range (included). Needs to be after
[[postalCodeBegin]].
@param string|string[] $postalCodeEnd
@return static
@see https://schema.org/postalCodeEnd
@link https://github.com/schemaorg/schemaorg/issues/2506 | postalCodeEnd | php | spatie/schema-org | src/PostalCodeRangeSpecification.php | https://github.com/spatie/schema-org/blob/master/src/PostalCodeRangeSpecification.php | MIT |
public function increasesRiskOf($increasesRiskOf)
{
return $this->setProperty('increasesRiskOf', $increasesRiskOf);
} | The condition, complication, etc. influenced by this factor.
@param \Spatie\SchemaOrg\Contracts\MedicalEntityContract|\Spatie\SchemaOrg\Contracts\MedicalEntityContract[] $increasesRiskOf
@return static
@see https://schema.org/increasesRiskOf
@see https://health-lifesci.schema.org | increasesRiskOf | php | spatie/schema-org | src/MedicalRiskFactor.php | https://github.com/spatie/schema-org/blob/master/src/MedicalRiskFactor.php | MIT |
public function accommodationCategory($accommodationCategory)
{
return $this->setProperty('accommodationCategory', $accommodationCategory);
} | Category of an [[Accommodation]], following real estate conventions, e.g.
RESO (see
[PropertySubType](https://ddwiki.reso.org/display/DDW17/PropertySubType+Field),
and
[PropertyType](https://ddwiki.reso.org/display/DDW17/PropertyType+Field)
fields for suggested values).
@param string|string[] $accommodationCategory
@return static
@see https://schema.org/accommodationCategory
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | accommodationCategory | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
public function accommodationFloorPlan($accommodationFloorPlan)
{
return $this->setProperty('accommodationFloorPlan', $accommodationFloorPlan);
} | A floorplan of some [[Accommodation]].
@param \Spatie\SchemaOrg\Contracts\FloorPlanContract|\Spatie\SchemaOrg\Contracts\FloorPlanContract[] $accommodationFloorPlan
@return static
@see https://schema.org/accommodationFloorPlan
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | accommodationFloorPlan | php | spatie/schema-org | src/House.php | https://github.com/spatie/schema-org/blob/master/src/House.php | MIT |
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 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 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 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 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 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 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 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 |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.