setProperty('additionalProperty', $additionalProperty); } /** * 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 */ public function additionalType($additionalType) { return $this->setProperty('additionalType', $additionalType); } /** * An alias for the item. * * @param string|string[] $alternateName * * @return static * * @see https://schema.org/alternateName */ public function alternateName($alternateName) { return $this->setProperty('alternateName', $alternateName); } /** * A description of the item. * * @param \Spatie\SchemaOrg\Contracts\TextObjectContract|\Spatie\SchemaOrg\Contracts\TextObjectContract[]|string|string[] $description * * @return static * * @see https://schema.org/description */ public function description($description) { return $this->setProperty('description', $description); } /** * 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 */ public function disambiguatingDescription($disambiguatingDescription) { return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** * 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 */ public function identifier($identifier) { return $this->setProperty('identifier', $identifier); } /** * 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 */ public function image($image) { return $this->setProperty('image', $image); } /** * 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 */ public function mainEntityOfPage($mainEntityOfPage) { return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** * The upper value of some characteristic or property. * * @param float|float[]|int|int[] $maxValue * * @return static * * @see https://schema.org/maxValue */ public function maxValue($maxValue) { return $this->setProperty('maxValue', $maxValue); } /** * The lower value of some characteristic or property. * * @param float|float[]|int|int[] $minValue * * @return static * * @see https://schema.org/minValue */ public function minValue($minValue) { return $this->setProperty('minValue', $minValue); } /** * The name of the item. * * @param string|string[] $name * * @return static * * @see https://schema.org/name */ public function name($name) { return $this->setProperty('name', $name); } /** * 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 */ public function potentialAction($potentialAction) { return $this->setProperty('potentialAction', $potentialAction); } /** * 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 */ public function sameAs($sameAs) { return $this->setProperty('sameAs', $sameAs); } /** * 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 */ public function subjectOf($subjectOf) { return $this->setProperty('subjectOf', $subjectOf); } /** * 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 */ public function unitCode($unitCode) { return $this->setProperty('unitCode', $unitCode); } /** * A string or text indicating the unit of measurement. Useful if you cannot * provide a standard unit code for * unitCode. * * @param string|string[] $unitText * * @return static * * @see https://schema.org/unitText */ public function unitText($unitText) { return $this->setProperty('unitText', $unitText); } /** * URL of the item. * * @param string|string[] $url * * @return static * * @see https://schema.org/url */ public function url($url) { return $this->setProperty('url', $url); } /** * 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 */ public function value($value) { return $this->setProperty('value', $value); } /** * 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 */ public function valueReference($valueReference) { return $this->setProperty('valueReference', $valueReference); } }