@@ -33,238 +33,238 @@ |
||
33 | 33 | */ |
34 | 34 | class ProductGroup extends MetaJsonLd implements ProductGroupInterface, ProductInterface, ThingInterface |
35 | 35 | { |
36 | - use ProductGroupTrait; |
|
37 | - use ProductTrait; |
|
38 | - use ThingTrait; |
|
36 | + use ProductGroupTrait; |
|
37 | + use ProductTrait; |
|
38 | + use ThingTrait; |
|
39 | 39 | |
40 | - /** |
|
41 | - * The Schema.org Type Name |
|
42 | - * |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - public static $schemaTypeName = 'ProductGroup'; |
|
40 | + /** |
|
41 | + * The Schema.org Type Name |
|
42 | + * |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + public static $schemaTypeName = 'ProductGroup'; |
|
46 | 46 | |
47 | - /** |
|
48 | - * The Schema.org Type Scope |
|
49 | - * |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - public static $schemaTypeScope = 'https://schema.org/ProductGroup'; |
|
47 | + /** |
|
48 | + * The Schema.org Type Scope |
|
49 | + * |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + public static $schemaTypeScope = 'https://schema.org/ProductGroup'; |
|
53 | 53 | |
54 | - /** |
|
55 | - * The Schema.org Type Extends |
|
56 | - * |
|
57 | - * @var string |
|
58 | - */ |
|
59 | - public static $schemaTypeExtends = 'Product'; |
|
54 | + /** |
|
55 | + * The Schema.org Type Extends |
|
56 | + * |
|
57 | + * @var string |
|
58 | + */ |
|
59 | + public static $schemaTypeExtends = 'Product'; |
|
60 | 60 | |
61 | - /** |
|
62 | - * The Schema.org Type Description |
|
63 | - * |
|
64 | - * @var string |
|
65 | - */ |
|
66 | - public static $schemaTypeDescription = "A ProductGroup represents a group of [[Product]]s that vary only in certain well-described ways, such as by [[size]], [[color]], [[material]] etc.\n\nWhile a ProductGroup itself is not directly offered for sale, the various varying products that it represents can be. The ProductGroup serves as a prototype or template, standing in for all of the products who have an [[isVariantOf]] relationship to it. As such, properties (including additional types) can be applied to the ProductGroup to represent characteristics shared by each of the (possibly very many) variants. Properties that reference a ProductGroup are not included in this mechanism; neither are the following specific properties [[variesBy]], [[hasVariant]], [[url]]. "; |
|
61 | + /** |
|
62 | + * The Schema.org Type Description |
|
63 | + * |
|
64 | + * @var string |
|
65 | + */ |
|
66 | + public static $schemaTypeDescription = "A ProductGroup represents a group of [[Product]]s that vary only in certain well-described ways, such as by [[size]], [[color]], [[material]] etc.\n\nWhile a ProductGroup itself is not directly offered for sale, the various varying products that it represents can be. The ProductGroup serves as a prototype or template, standing in for all of the products who have an [[isVariantOf]] relationship to it. As such, properties (including additional types) can be applied to the ProductGroup to represent characteristics shared by each of the (possibly very many) variants. Properties that reference a ProductGroup are not included in this mechanism; neither are the following specific properties [[variesBy]], [[hasVariant]], [[url]]. "; |
|
67 | 67 | |
68 | 68 | |
69 | - /** |
|
70 | - * @inheritdoc |
|
71 | - */ |
|
72 | - public function getSchemaPropertyNames(): array |
|
73 | - { |
|
74 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
75 | - } |
|
69 | + /** |
|
70 | + * @inheritdoc |
|
71 | + */ |
|
72 | + public function getSchemaPropertyNames(): array |
|
73 | + { |
|
74 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
75 | + } |
|
76 | 76 | |
77 | 77 | |
78 | - /** |
|
79 | - * @inheritdoc |
|
80 | - */ |
|
81 | - public function getSchemaPropertyExpectedTypes(): array |
|
82 | - { |
|
83 | - return [ |
|
84 | - 'additionalProperty' => ['PropertyValue'], |
|
85 | - 'additionalType' => ['URL'], |
|
86 | - 'aggregateRating' => ['AggregateRating'], |
|
87 | - 'alternateName' => ['Text'], |
|
88 | - 'asin' => ['Text', 'URL'], |
|
89 | - 'audience' => ['Audience'], |
|
90 | - 'award' => ['Text'], |
|
91 | - 'awards' => ['Text'], |
|
92 | - 'brand' => ['Brand', 'Organization'], |
|
93 | - 'category' => ['URL', 'CategoryCode', 'Text', 'Thing', 'PhysicalActivityCategory'], |
|
94 | - 'color' => ['Text'], |
|
95 | - 'countryOfAssembly' => ['Text'], |
|
96 | - 'countryOfLastProcessing' => ['Text'], |
|
97 | - 'countryOfOrigin' => ['Country'], |
|
98 | - 'depth' => ['QuantitativeValue', 'Distance'], |
|
99 | - 'description' => ['Text'], |
|
100 | - 'disambiguatingDescription' => ['Text'], |
|
101 | - 'funding' => ['Grant'], |
|
102 | - 'gtin' => ['Text', 'URL'], |
|
103 | - 'gtin12' => ['Text'], |
|
104 | - 'gtin13' => ['Text'], |
|
105 | - 'gtin14' => ['Text'], |
|
106 | - 'gtin8' => ['Text'], |
|
107 | - 'hasAdultConsideration' => ['AdultOrientedEnumeration'], |
|
108 | - 'hasEnergyConsumptionDetails' => ['EnergyConsumptionDetails'], |
|
109 | - 'hasMeasurement' => ['QuantitativeValue'], |
|
110 | - 'hasMerchantReturnPolicy' => ['MerchantReturnPolicy'], |
|
111 | - 'hasVariant' => ['Product'], |
|
112 | - 'height' => ['QuantitativeValue', 'Distance'], |
|
113 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
114 | - 'image' => ['URL', 'ImageObject'], |
|
115 | - 'inProductGroupWithID' => ['Text'], |
|
116 | - 'isAccessoryOrSparePartFor' => ['Product'], |
|
117 | - 'isConsumableFor' => ['Product'], |
|
118 | - 'isFamilyFriendly' => ['Boolean'], |
|
119 | - 'isRelatedTo' => ['Product', 'Service'], |
|
120 | - 'isSimilarTo' => ['Product', 'Service'], |
|
121 | - 'isVariantOf' => ['ProductModel', 'ProductGroup'], |
|
122 | - 'itemCondition' => ['OfferItemCondition'], |
|
123 | - 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
124 | - 'logo' => ['ImageObject', 'URL'], |
|
125 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
126 | - 'manufacturer' => ['Organization'], |
|
127 | - 'material' => ['Product', 'URL', 'Text'], |
|
128 | - 'mobileUrl' => ['Text'], |
|
129 | - 'model' => ['ProductModel', 'Text'], |
|
130 | - 'mpn' => ['Text'], |
|
131 | - 'name' => ['Text'], |
|
132 | - 'negativeNotes' => ['ListItem', 'Text', 'ItemList', 'WebContent'], |
|
133 | - 'nsn' => ['Text'], |
|
134 | - 'offers' => ['Demand', 'Offer'], |
|
135 | - 'pattern' => ['DefinedTerm', 'Text'], |
|
136 | - 'positiveNotes' => ['Text', 'WebContent', 'ListItem', 'ItemList'], |
|
137 | - 'potentialAction' => ['Action'], |
|
138 | - 'productGroupID' => ['Text'], |
|
139 | - 'productID' => ['Text'], |
|
140 | - 'productionDate' => ['Date'], |
|
141 | - 'purchaseDate' => ['Date'], |
|
142 | - 'releaseDate' => ['Date'], |
|
143 | - 'review' => ['Review'], |
|
144 | - 'reviews' => ['Review'], |
|
145 | - 'sameAs' => ['URL'], |
|
146 | - 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
147 | - 'sku' => ['Text'], |
|
148 | - 'slogan' => ['Text'], |
|
149 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
150 | - 'url' => ['URL'], |
|
151 | - 'variesBy' => ['Text', 'DefinedTerm'], |
|
152 | - 'weight' => ['QuantitativeValue'], |
|
153 | - 'width' => ['Distance', 'QuantitativeValue'] |
|
154 | - ]; |
|
155 | - } |
|
78 | + /** |
|
79 | + * @inheritdoc |
|
80 | + */ |
|
81 | + public function getSchemaPropertyExpectedTypes(): array |
|
82 | + { |
|
83 | + return [ |
|
84 | + 'additionalProperty' => ['PropertyValue'], |
|
85 | + 'additionalType' => ['URL'], |
|
86 | + 'aggregateRating' => ['AggregateRating'], |
|
87 | + 'alternateName' => ['Text'], |
|
88 | + 'asin' => ['Text', 'URL'], |
|
89 | + 'audience' => ['Audience'], |
|
90 | + 'award' => ['Text'], |
|
91 | + 'awards' => ['Text'], |
|
92 | + 'brand' => ['Brand', 'Organization'], |
|
93 | + 'category' => ['URL', 'CategoryCode', 'Text', 'Thing', 'PhysicalActivityCategory'], |
|
94 | + 'color' => ['Text'], |
|
95 | + 'countryOfAssembly' => ['Text'], |
|
96 | + 'countryOfLastProcessing' => ['Text'], |
|
97 | + 'countryOfOrigin' => ['Country'], |
|
98 | + 'depth' => ['QuantitativeValue', 'Distance'], |
|
99 | + 'description' => ['Text'], |
|
100 | + 'disambiguatingDescription' => ['Text'], |
|
101 | + 'funding' => ['Grant'], |
|
102 | + 'gtin' => ['Text', 'URL'], |
|
103 | + 'gtin12' => ['Text'], |
|
104 | + 'gtin13' => ['Text'], |
|
105 | + 'gtin14' => ['Text'], |
|
106 | + 'gtin8' => ['Text'], |
|
107 | + 'hasAdultConsideration' => ['AdultOrientedEnumeration'], |
|
108 | + 'hasEnergyConsumptionDetails' => ['EnergyConsumptionDetails'], |
|
109 | + 'hasMeasurement' => ['QuantitativeValue'], |
|
110 | + 'hasMerchantReturnPolicy' => ['MerchantReturnPolicy'], |
|
111 | + 'hasVariant' => ['Product'], |
|
112 | + 'height' => ['QuantitativeValue', 'Distance'], |
|
113 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
114 | + 'image' => ['URL', 'ImageObject'], |
|
115 | + 'inProductGroupWithID' => ['Text'], |
|
116 | + 'isAccessoryOrSparePartFor' => ['Product'], |
|
117 | + 'isConsumableFor' => ['Product'], |
|
118 | + 'isFamilyFriendly' => ['Boolean'], |
|
119 | + 'isRelatedTo' => ['Product', 'Service'], |
|
120 | + 'isSimilarTo' => ['Product', 'Service'], |
|
121 | + 'isVariantOf' => ['ProductModel', 'ProductGroup'], |
|
122 | + 'itemCondition' => ['OfferItemCondition'], |
|
123 | + 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
124 | + 'logo' => ['ImageObject', 'URL'], |
|
125 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
126 | + 'manufacturer' => ['Organization'], |
|
127 | + 'material' => ['Product', 'URL', 'Text'], |
|
128 | + 'mobileUrl' => ['Text'], |
|
129 | + 'model' => ['ProductModel', 'Text'], |
|
130 | + 'mpn' => ['Text'], |
|
131 | + 'name' => ['Text'], |
|
132 | + 'negativeNotes' => ['ListItem', 'Text', 'ItemList', 'WebContent'], |
|
133 | + 'nsn' => ['Text'], |
|
134 | + 'offers' => ['Demand', 'Offer'], |
|
135 | + 'pattern' => ['DefinedTerm', 'Text'], |
|
136 | + 'positiveNotes' => ['Text', 'WebContent', 'ListItem', 'ItemList'], |
|
137 | + 'potentialAction' => ['Action'], |
|
138 | + 'productGroupID' => ['Text'], |
|
139 | + 'productID' => ['Text'], |
|
140 | + 'productionDate' => ['Date'], |
|
141 | + 'purchaseDate' => ['Date'], |
|
142 | + 'releaseDate' => ['Date'], |
|
143 | + 'review' => ['Review'], |
|
144 | + 'reviews' => ['Review'], |
|
145 | + 'sameAs' => ['URL'], |
|
146 | + 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
147 | + 'sku' => ['Text'], |
|
148 | + 'slogan' => ['Text'], |
|
149 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
150 | + 'url' => ['URL'], |
|
151 | + 'variesBy' => ['Text', 'DefinedTerm'], |
|
152 | + 'weight' => ['QuantitativeValue'], |
|
153 | + 'width' => ['Distance', 'QuantitativeValue'] |
|
154 | + ]; |
|
155 | + } |
|
156 | 156 | |
157 | 157 | |
158 | - /** |
|
159 | - * @inheritdoc |
|
160 | - */ |
|
161 | - public function getSchemaPropertyDescriptions(): array |
|
162 | - { |
|
163 | - return [ |
|
164 | - 'additionalProperty' => 'A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org. Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism. ', |
|
165 | - '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
166 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
167 | - 'alternateName' => 'An alias for the item.', |
|
168 | - 'asin' => 'An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)\'s article). Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details. ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.', |
|
169 | - 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
170 | - 'award' => 'An award won by or for this item.', |
|
171 | - 'awards' => 'Awards won by or for this item.', |
|
172 | - 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
173 | - 'category' => 'A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.', |
|
174 | - 'color' => 'The color of the product.', |
|
175 | - 'countryOfAssembly' => 'The place where the product was assembled.', |
|
176 | - 'countryOfLastProcessing' => 'The place where the item (typically [[Product]]) was last processed and tested before importation.', |
|
177 | - 'countryOfOrigin' => 'The country of origin of something, including products as well as creative works such as movie and TV content. In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable. In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.', |
|
178 | - 'depth' => 'The depth of the item.', |
|
179 | - 'description' => 'A description of the item.', |
|
180 | - '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.', |
|
181 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
182 | - 'gtin' => 'A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes. The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809) for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1\'s GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties. Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.', |
|
183 | - 'gtin12' => 'The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.', |
|
184 | - 'gtin13' => 'The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.', |
|
185 | - 'gtin14' => 'The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.', |
|
186 | - 'gtin8' => 'The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.', |
|
187 | - 'hasAdultConsideration' => 'Used to tag an item to be intended or suitable for consumption or use by adults only.', |
|
188 | - 'hasEnergyConsumptionDetails' => 'Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.', |
|
189 | - 'hasMeasurement' => 'A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.', |
|
190 | - 'hasMerchantReturnPolicy' => 'Specifies a MerchantReturnPolicy that may be applicable.', |
|
191 | - 'hasVariant' => 'Indicates a [[Product]] that is a member of this [[ProductGroup]] (or [[ProductModel]]).', |
|
192 | - 'height' => 'The height of the item.', |
|
193 | - '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. ', |
|
194 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
195 | - 'inProductGroupWithID' => 'Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]]. ', |
|
196 | - 'isAccessoryOrSparePartFor' => 'A pointer to another product (or multiple products) for which this product is an accessory or spare part.', |
|
197 | - 'isConsumableFor' => 'A pointer to another product (or multiple products) for which this product is a consumable.', |
|
198 | - 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
199 | - 'isRelatedTo' => 'A pointer to another, somehow related product (or multiple products).', |
|
200 | - 'isSimilarTo' => 'A pointer to another, functionally similar product (or multiple products).', |
|
201 | - 'isVariantOf' => 'Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group.', |
|
202 | - 'itemCondition' => 'A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.', |
|
203 | - '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.', |
|
204 | - 'logo' => 'An associated logo.', |
|
205 | - '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.', |
|
206 | - 'manufacturer' => 'The manufacturer of the product.', |
|
207 | - 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
208 | - 'mobileUrl' => 'The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated \'mobile site\'. To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style. ', |
|
209 | - 'model' => 'The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.', |
|
210 | - 'mpn' => 'The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.', |
|
211 | - 'name' => 'The name of the item.', |
|
212 | - 'negativeNotes' => 'Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]]. The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).', |
|
213 | - 'nsn' => 'Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [[Product]]. ', |
|
214 | - 'offers' => 'An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. ', |
|
215 | - 'pattern' => 'A pattern that something has, for example \'polka dot\', \'striped\', \'Canadian flag\'. Values are typically expressed as text, although links to controlled value schemes are also supported.', |
|
216 | - 'positiveNotes' => 'Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews. In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).', |
|
217 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
218 | - 'productGroupID' => 'Indicates a textual identifier for a ProductGroup.', |
|
219 | - 'productID' => 'The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```.', |
|
220 | - 'productionDate' => 'The date of production of the item, e.g. vehicle.', |
|
221 | - 'purchaseDate' => 'The date the item, e.g. vehicle, was purchased by the current owner.', |
|
222 | - 'releaseDate' => 'The release date of a product or product model. This can be used to distinguish the exact variant of a product.', |
|
223 | - 'review' => 'A review of the item.', |
|
224 | - 'reviews' => 'Review of the item.', |
|
225 | - '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.', |
|
226 | - 'size' => 'A standardized size of a product or creative work, specified either through a simple textual string (for example \'XL\', \'32Wx34L\'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. ', |
|
227 | - 'sku' => 'The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.', |
|
228 | - 'slogan' => 'A slogan or motto associated with the item.', |
|
229 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
230 | - 'url' => 'URL of the item.', |
|
231 | - 'variesBy' => 'Indicates the property or properties by which the variants in a [[ProductGroup]] vary, e.g. their size, color etc. Schema.org properties can be referenced by their short name e.g. "color"; terms defined elsewhere can be referenced with their URIs.', |
|
232 | - 'weight' => 'The weight of the product or person.', |
|
233 | - 'width' => 'The width of the item.' |
|
234 | - ]; |
|
235 | - } |
|
158 | + /** |
|
159 | + * @inheritdoc |
|
160 | + */ |
|
161 | + public function getSchemaPropertyDescriptions(): array |
|
162 | + { |
|
163 | + return [ |
|
164 | + 'additionalProperty' => 'A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org. Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism. ', |
|
165 | + '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
166 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
167 | + 'alternateName' => 'An alias for the item.', |
|
168 | + 'asin' => 'An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)\'s article). Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details. ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.', |
|
169 | + 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
170 | + 'award' => 'An award won by or for this item.', |
|
171 | + 'awards' => 'Awards won by or for this item.', |
|
172 | + 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
173 | + 'category' => 'A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.', |
|
174 | + 'color' => 'The color of the product.', |
|
175 | + 'countryOfAssembly' => 'The place where the product was assembled.', |
|
176 | + 'countryOfLastProcessing' => 'The place where the item (typically [[Product]]) was last processed and tested before importation.', |
|
177 | + 'countryOfOrigin' => 'The country of origin of something, including products as well as creative works such as movie and TV content. In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable. In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.', |
|
178 | + 'depth' => 'The depth of the item.', |
|
179 | + 'description' => 'A description of the item.', |
|
180 | + '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.', |
|
181 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
182 | + 'gtin' => 'A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes. The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809) for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1\'s GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties. Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.', |
|
183 | + 'gtin12' => 'The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.', |
|
184 | + 'gtin13' => 'The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.', |
|
185 | + 'gtin14' => 'The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.', |
|
186 | + 'gtin8' => 'The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.', |
|
187 | + 'hasAdultConsideration' => 'Used to tag an item to be intended or suitable for consumption or use by adults only.', |
|
188 | + 'hasEnergyConsumptionDetails' => 'Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.', |
|
189 | + 'hasMeasurement' => 'A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.', |
|
190 | + 'hasMerchantReturnPolicy' => 'Specifies a MerchantReturnPolicy that may be applicable.', |
|
191 | + 'hasVariant' => 'Indicates a [[Product]] that is a member of this [[ProductGroup]] (or [[ProductModel]]).', |
|
192 | + 'height' => 'The height of the item.', |
|
193 | + '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. ', |
|
194 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
195 | + 'inProductGroupWithID' => 'Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]]. ', |
|
196 | + 'isAccessoryOrSparePartFor' => 'A pointer to another product (or multiple products) for which this product is an accessory or spare part.', |
|
197 | + 'isConsumableFor' => 'A pointer to another product (or multiple products) for which this product is a consumable.', |
|
198 | + 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
199 | + 'isRelatedTo' => 'A pointer to another, somehow related product (or multiple products).', |
|
200 | + 'isSimilarTo' => 'A pointer to another, functionally similar product (or multiple products).', |
|
201 | + 'isVariantOf' => 'Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group.', |
|
202 | + 'itemCondition' => 'A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.', |
|
203 | + '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.', |
|
204 | + 'logo' => 'An associated logo.', |
|
205 | + '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.', |
|
206 | + 'manufacturer' => 'The manufacturer of the product.', |
|
207 | + 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
208 | + 'mobileUrl' => 'The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated \'mobile site\'. To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style. ', |
|
209 | + 'model' => 'The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.', |
|
210 | + 'mpn' => 'The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.', |
|
211 | + 'name' => 'The name of the item.', |
|
212 | + 'negativeNotes' => 'Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]]. The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).', |
|
213 | + 'nsn' => 'Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [[Product]]. ', |
|
214 | + 'offers' => 'An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. ', |
|
215 | + 'pattern' => 'A pattern that something has, for example \'polka dot\', \'striped\', \'Canadian flag\'. Values are typically expressed as text, although links to controlled value schemes are also supported.', |
|
216 | + 'positiveNotes' => 'Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews. In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).', |
|
217 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
218 | + 'productGroupID' => 'Indicates a textual identifier for a ProductGroup.', |
|
219 | + 'productID' => 'The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```.', |
|
220 | + 'productionDate' => 'The date of production of the item, e.g. vehicle.', |
|
221 | + 'purchaseDate' => 'The date the item, e.g. vehicle, was purchased by the current owner.', |
|
222 | + 'releaseDate' => 'The release date of a product or product model. This can be used to distinguish the exact variant of a product.', |
|
223 | + 'review' => 'A review of the item.', |
|
224 | + 'reviews' => 'Review of the item.', |
|
225 | + '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.', |
|
226 | + 'size' => 'A standardized size of a product or creative work, specified either through a simple textual string (for example \'XL\', \'32Wx34L\'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. ', |
|
227 | + 'sku' => 'The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.', |
|
228 | + 'slogan' => 'A slogan or motto associated with the item.', |
|
229 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
230 | + 'url' => 'URL of the item.', |
|
231 | + 'variesBy' => 'Indicates the property or properties by which the variants in a [[ProductGroup]] vary, e.g. their size, color etc. Schema.org properties can be referenced by their short name e.g. "color"; terms defined elsewhere can be referenced with their URIs.', |
|
232 | + 'weight' => 'The weight of the product or person.', |
|
233 | + 'width' => 'The width of the item.' |
|
234 | + ]; |
|
235 | + } |
|
236 | 236 | |
237 | 237 | |
238 | - /** |
|
239 | - * @inheritdoc |
|
240 | - */ |
|
241 | - public function getGoogleRequiredSchema(): array |
|
242 | - { |
|
243 | - return ['description', 'name']; |
|
244 | - } |
|
238 | + /** |
|
239 | + * @inheritdoc |
|
240 | + */ |
|
241 | + public function getGoogleRequiredSchema(): array |
|
242 | + { |
|
243 | + return ['description', 'name']; |
|
244 | + } |
|
245 | 245 | |
246 | 246 | |
247 | - /** |
|
248 | - * @inheritdoc |
|
249 | - */ |
|
250 | - public function getGoogleRecommendedSchema(): array |
|
251 | - { |
|
252 | - return ['image', 'url']; |
|
253 | - } |
|
247 | + /** |
|
248 | + * @inheritdoc |
|
249 | + */ |
|
250 | + public function getGoogleRecommendedSchema(): array |
|
251 | + { |
|
252 | + return ['image', 'url']; |
|
253 | + } |
|
254 | 254 | |
255 | 255 | |
256 | - /** |
|
257 | - * @inheritdoc |
|
258 | - */ |
|
259 | - public function defineRules(): array |
|
260 | - { |
|
261 | - $rules = parent::defineRules(); |
|
262 | - $rules = array_merge($rules, [ |
|
263 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
264 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
265 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
266 | - ]); |
|
256 | + /** |
|
257 | + * @inheritdoc |
|
258 | + */ |
|
259 | + public function defineRules(): array |
|
260 | + { |
|
261 | + $rules = parent::defineRules(); |
|
262 | + $rules = array_merge($rules, [ |
|
263 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
264 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
265 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
266 | + ]); |
|
267 | 267 | |
268 | - return $rules; |
|
269 | - } |
|
268 | + return $rules; |
|
269 | + } |
|
270 | 270 | } |
@@ -24,267 +24,267 @@ |
||
24 | 24 | */ |
25 | 25 | class MusicGroup extends MetaJsonLd implements MusicGroupInterface, PerformingGroupInterface, OrganizationInterface, ThingInterface |
26 | 26 | { |
27 | - use MusicGroupTrait; |
|
28 | - use PerformingGroupTrait; |
|
29 | - use OrganizationTrait; |
|
30 | - use ThingTrait; |
|
27 | + use MusicGroupTrait; |
|
28 | + use PerformingGroupTrait; |
|
29 | + use OrganizationTrait; |
|
30 | + use ThingTrait; |
|
31 | 31 | |
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static $schemaTypeName = 'MusicGroup'; |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static $schemaTypeName = 'MusicGroup'; |
|
38 | 38 | |
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static $schemaTypeScope = 'https://schema.org/MusicGroup'; |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static $schemaTypeScope = 'https://schema.org/MusicGroup'; |
|
45 | 45 | |
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static $schemaTypeExtends = 'PerformingGroup'; |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static $schemaTypeExtends = 'PerformingGroup'; |
|
52 | 52 | |
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static $schemaTypeDescription = 'A musical group, such as a band, an orchestra, or a choir. Can also be a solo musician.'; |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static $schemaTypeDescription = 'A musical group, such as a band, an orchestra, or a choir. Can also be a solo musician.'; |
|
59 | 59 | |
60 | 60 | |
61 | - /** |
|
62 | - * @inheritdoc |
|
63 | - */ |
|
64 | - public function getSchemaPropertyNames(): array |
|
65 | - { |
|
66 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
67 | - } |
|
61 | + /** |
|
62 | + * @inheritdoc |
|
63 | + */ |
|
64 | + public function getSchemaPropertyNames(): array |
|
65 | + { |
|
66 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
67 | + } |
|
68 | 68 | |
69 | 69 | |
70 | - /** |
|
71 | - * @inheritdoc |
|
72 | - */ |
|
73 | - public function getSchemaPropertyExpectedTypes(): array |
|
74 | - { |
|
75 | - return [ |
|
76 | - 'actionableFeedbackPolicy' => ['CreativeWork', 'URL'], |
|
77 | - 'additionalType' => ['URL'], |
|
78 | - 'address' => ['Text', 'PostalAddress'], |
|
79 | - 'aggregateRating' => ['AggregateRating'], |
|
80 | - 'album' => ['MusicAlbum'], |
|
81 | - 'albums' => ['MusicAlbum'], |
|
82 | - 'alternateName' => ['Text'], |
|
83 | - 'alumni' => ['Person'], |
|
84 | - 'areaServed' => ['Text', 'Place', 'GeoShape', 'AdministrativeArea'], |
|
85 | - 'award' => ['Text'], |
|
86 | - 'awards' => ['Text'], |
|
87 | - 'brand' => ['Brand', 'Organization'], |
|
88 | - 'contactPoint' => ['ContactPoint'], |
|
89 | - 'contactPoints' => ['ContactPoint'], |
|
90 | - 'correctionsPolicy' => ['URL', 'CreativeWork'], |
|
91 | - 'department' => ['Organization'], |
|
92 | - 'description' => ['Text'], |
|
93 | - 'disambiguatingDescription' => ['Text'], |
|
94 | - 'dissolutionDate' => ['Date'], |
|
95 | - 'diversityPolicy' => ['URL', 'CreativeWork'], |
|
96 | - 'diversityStaffingReport' => ['Article', 'URL'], |
|
97 | - 'duns' => ['Text'], |
|
98 | - 'email' => ['Text'], |
|
99 | - 'employee' => ['Person'], |
|
100 | - 'employees' => ['Person'], |
|
101 | - 'ethicsPolicy' => ['CreativeWork', 'URL'], |
|
102 | - 'event' => ['Event'], |
|
103 | - 'events' => ['Event'], |
|
104 | - 'faxNumber' => ['Text'], |
|
105 | - 'founder' => ['Person'], |
|
106 | - 'founders' => ['Person'], |
|
107 | - 'foundingDate' => ['Date'], |
|
108 | - 'foundingLocation' => ['Place'], |
|
109 | - 'funder' => ['Organization', 'Person'], |
|
110 | - 'funding' => ['Grant'], |
|
111 | - 'genre' => ['Text', 'URL'], |
|
112 | - 'globalLocationNumber' => ['Text'], |
|
113 | - 'hasCredential' => ['EducationalOccupationalCredential'], |
|
114 | - 'hasMerchantReturnPolicy' => ['MerchantReturnPolicy'], |
|
115 | - 'hasOfferCatalog' => ['OfferCatalog'], |
|
116 | - 'hasPOS' => ['Place'], |
|
117 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
118 | - 'image' => ['URL', 'ImageObject'], |
|
119 | - 'interactionStatistic' => ['InteractionCounter'], |
|
120 | - 'isicV4' => ['Text'], |
|
121 | - 'iso6523Code' => ['Text'], |
|
122 | - 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
123 | - 'knowsAbout' => ['Thing', 'Text', 'URL'], |
|
124 | - 'knowsLanguage' => ['Text', 'Language'], |
|
125 | - 'legalName' => ['Text'], |
|
126 | - 'leiCode' => ['Text'], |
|
127 | - 'location' => ['Place', 'Text', 'VirtualLocation', 'PostalAddress'], |
|
128 | - 'logo' => ['ImageObject', 'URL'], |
|
129 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
130 | - 'makesOffer' => ['Offer'], |
|
131 | - 'member' => ['Organization', 'Person'], |
|
132 | - 'memberOf' => ['Organization', 'ProgramMembership'], |
|
133 | - 'members' => ['Organization', 'Person'], |
|
134 | - 'musicGroupMember' => ['Person'], |
|
135 | - 'naics' => ['Text'], |
|
136 | - 'name' => ['Text'], |
|
137 | - 'nonprofitStatus' => ['NonprofitType'], |
|
138 | - 'numberOfEmployees' => ['QuantitativeValue'], |
|
139 | - 'ownershipFundingInfo' => ['AboutPage', 'Text', 'CreativeWork', 'URL'], |
|
140 | - 'owns' => ['Product', 'OwnershipInfo'], |
|
141 | - 'parentOrganization' => ['Organization'], |
|
142 | - 'potentialAction' => ['Action'], |
|
143 | - 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
144 | - 'review' => ['Review'], |
|
145 | - 'reviews' => ['Review'], |
|
146 | - 'sameAs' => ['URL'], |
|
147 | - 'seeks' => ['Demand'], |
|
148 | - 'serviceArea' => ['AdministrativeArea', 'Place', 'GeoShape'], |
|
149 | - 'slogan' => ['Text'], |
|
150 | - 'sponsor' => ['Organization', 'Person'], |
|
151 | - 'subOrganization' => ['Organization'], |
|
152 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
153 | - 'taxID' => ['Text'], |
|
154 | - 'telephone' => ['Text'], |
|
155 | - 'track' => ['ItemList', 'MusicRecording'], |
|
156 | - 'tracks' => ['MusicRecording'], |
|
157 | - 'unnamedSourcesPolicy' => ['CreativeWork', 'URL'], |
|
158 | - 'url' => ['URL'], |
|
159 | - 'vatID' => ['Text'] |
|
160 | - ]; |
|
161 | - } |
|
70 | + /** |
|
71 | + * @inheritdoc |
|
72 | + */ |
|
73 | + public function getSchemaPropertyExpectedTypes(): array |
|
74 | + { |
|
75 | + return [ |
|
76 | + 'actionableFeedbackPolicy' => ['CreativeWork', 'URL'], |
|
77 | + 'additionalType' => ['URL'], |
|
78 | + 'address' => ['Text', 'PostalAddress'], |
|
79 | + 'aggregateRating' => ['AggregateRating'], |
|
80 | + 'album' => ['MusicAlbum'], |
|
81 | + 'albums' => ['MusicAlbum'], |
|
82 | + 'alternateName' => ['Text'], |
|
83 | + 'alumni' => ['Person'], |
|
84 | + 'areaServed' => ['Text', 'Place', 'GeoShape', 'AdministrativeArea'], |
|
85 | + 'award' => ['Text'], |
|
86 | + 'awards' => ['Text'], |
|
87 | + 'brand' => ['Brand', 'Organization'], |
|
88 | + 'contactPoint' => ['ContactPoint'], |
|
89 | + 'contactPoints' => ['ContactPoint'], |
|
90 | + 'correctionsPolicy' => ['URL', 'CreativeWork'], |
|
91 | + 'department' => ['Organization'], |
|
92 | + 'description' => ['Text'], |
|
93 | + 'disambiguatingDescription' => ['Text'], |
|
94 | + 'dissolutionDate' => ['Date'], |
|
95 | + 'diversityPolicy' => ['URL', 'CreativeWork'], |
|
96 | + 'diversityStaffingReport' => ['Article', 'URL'], |
|
97 | + 'duns' => ['Text'], |
|
98 | + 'email' => ['Text'], |
|
99 | + 'employee' => ['Person'], |
|
100 | + 'employees' => ['Person'], |
|
101 | + 'ethicsPolicy' => ['CreativeWork', 'URL'], |
|
102 | + 'event' => ['Event'], |
|
103 | + 'events' => ['Event'], |
|
104 | + 'faxNumber' => ['Text'], |
|
105 | + 'founder' => ['Person'], |
|
106 | + 'founders' => ['Person'], |
|
107 | + 'foundingDate' => ['Date'], |
|
108 | + 'foundingLocation' => ['Place'], |
|
109 | + 'funder' => ['Organization', 'Person'], |
|
110 | + 'funding' => ['Grant'], |
|
111 | + 'genre' => ['Text', 'URL'], |
|
112 | + 'globalLocationNumber' => ['Text'], |
|
113 | + 'hasCredential' => ['EducationalOccupationalCredential'], |
|
114 | + 'hasMerchantReturnPolicy' => ['MerchantReturnPolicy'], |
|
115 | + 'hasOfferCatalog' => ['OfferCatalog'], |
|
116 | + 'hasPOS' => ['Place'], |
|
117 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
118 | + 'image' => ['URL', 'ImageObject'], |
|
119 | + 'interactionStatistic' => ['InteractionCounter'], |
|
120 | + 'isicV4' => ['Text'], |
|
121 | + 'iso6523Code' => ['Text'], |
|
122 | + 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
123 | + 'knowsAbout' => ['Thing', 'Text', 'URL'], |
|
124 | + 'knowsLanguage' => ['Text', 'Language'], |
|
125 | + 'legalName' => ['Text'], |
|
126 | + 'leiCode' => ['Text'], |
|
127 | + 'location' => ['Place', 'Text', 'VirtualLocation', 'PostalAddress'], |
|
128 | + 'logo' => ['ImageObject', 'URL'], |
|
129 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
130 | + 'makesOffer' => ['Offer'], |
|
131 | + 'member' => ['Organization', 'Person'], |
|
132 | + 'memberOf' => ['Organization', 'ProgramMembership'], |
|
133 | + 'members' => ['Organization', 'Person'], |
|
134 | + 'musicGroupMember' => ['Person'], |
|
135 | + 'naics' => ['Text'], |
|
136 | + 'name' => ['Text'], |
|
137 | + 'nonprofitStatus' => ['NonprofitType'], |
|
138 | + 'numberOfEmployees' => ['QuantitativeValue'], |
|
139 | + 'ownershipFundingInfo' => ['AboutPage', 'Text', 'CreativeWork', 'URL'], |
|
140 | + 'owns' => ['Product', 'OwnershipInfo'], |
|
141 | + 'parentOrganization' => ['Organization'], |
|
142 | + 'potentialAction' => ['Action'], |
|
143 | + 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
144 | + 'review' => ['Review'], |
|
145 | + 'reviews' => ['Review'], |
|
146 | + 'sameAs' => ['URL'], |
|
147 | + 'seeks' => ['Demand'], |
|
148 | + 'serviceArea' => ['AdministrativeArea', 'Place', 'GeoShape'], |
|
149 | + 'slogan' => ['Text'], |
|
150 | + 'sponsor' => ['Organization', 'Person'], |
|
151 | + 'subOrganization' => ['Organization'], |
|
152 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
153 | + 'taxID' => ['Text'], |
|
154 | + 'telephone' => ['Text'], |
|
155 | + 'track' => ['ItemList', 'MusicRecording'], |
|
156 | + 'tracks' => ['MusicRecording'], |
|
157 | + 'unnamedSourcesPolicy' => ['CreativeWork', 'URL'], |
|
158 | + 'url' => ['URL'], |
|
159 | + 'vatID' => ['Text'] |
|
160 | + ]; |
|
161 | + } |
|
162 | 162 | |
163 | 163 | |
164 | - /** |
|
165 | - * @inheritdoc |
|
166 | - */ |
|
167 | - public function getSchemaPropertyDescriptions(): array |
|
168 | - { |
|
169 | - return [ |
|
170 | - 'actionableFeedbackPolicy' => 'For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroom’s), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.', |
|
171 | - '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
172 | - 'address' => 'Physical address of the item.', |
|
173 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
174 | - 'album' => 'A music album.', |
|
175 | - 'albums' => 'A collection of music albums.', |
|
176 | - 'alternateName' => 'An alias for the item.', |
|
177 | - 'alumni' => 'Alumni of an organization.', |
|
178 | - 'areaServed' => 'The geographic area where a service or offered item is provided.', |
|
179 | - 'award' => 'An award won by or for this item.', |
|
180 | - 'awards' => 'Awards won by or for this item.', |
|
181 | - 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
182 | - 'contactPoint' => 'A contact point for a person or organization.', |
|
183 | - 'contactPoints' => 'A contact point for a person or organization.', |
|
184 | - 'correctionsPolicy' => 'For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroom’s) disclosure and correction policy for errors.', |
|
185 | - 'department' => 'A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.', |
|
186 | - 'description' => 'A description of the item.', |
|
187 | - '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.', |
|
188 | - 'dissolutionDate' => 'The date that this organization was dissolved.', |
|
189 | - 'diversityPolicy' => 'Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroom’s diversity policy on both staffing and sources, typically providing staffing data.', |
|
190 | - 'diversityStaffingReport' => 'For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.', |
|
191 | - 'duns' => 'The Dun & Bradstreet DUNS number for identifying an organization or business person.', |
|
192 | - 'email' => 'Email address.', |
|
193 | - 'employee' => 'Someone working for this organization.', |
|
194 | - 'employees' => 'People working for this organization.', |
|
195 | - 'ethicsPolicy' => 'Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.', |
|
196 | - 'event' => 'Upcoming or past event associated with this place, organization, or action.', |
|
197 | - 'events' => 'Upcoming or past events associated with this place or organization.', |
|
198 | - 'faxNumber' => 'The fax number.', |
|
199 | - 'founder' => 'A person who founded this organization.', |
|
200 | - 'founders' => 'A person who founded this organization.', |
|
201 | - 'foundingDate' => 'The date that this organization was founded.', |
|
202 | - 'foundingLocation' => 'The place where the Organization was founded.', |
|
203 | - 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
204 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
205 | - 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
206 | - '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.', |
|
207 | - 'hasCredential' => 'A credential awarded to the Person or Organization.', |
|
208 | - 'hasMerchantReturnPolicy' => 'Specifies a MerchantReturnPolicy that may be applicable.', |
|
209 | - 'hasOfferCatalog' => 'Indicates an OfferCatalog listing for this Organization, Person, or Service.', |
|
210 | - 'hasPOS' => 'Points-of-Sales operated by the organization or person.', |
|
211 | - '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. ', |
|
212 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
213 | - 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
214 | - 'isicV4' => 'The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.', |
|
215 | - 'iso6523Code' => 'An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly. ', |
|
216 | - '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.', |
|
217 | - 'knowsAbout' => 'Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.', |
|
218 | - 'knowsLanguage' => 'Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).', |
|
219 | - 'legalName' => 'The official name of the organization, e.g. the registered company name.', |
|
220 | - 'leiCode' => 'An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.', |
|
221 | - 'location' => 'The location of, for example, where an event is happening, where an organization is located, or where an action takes place.', |
|
222 | - 'logo' => 'An associated logo.', |
|
223 | - '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.', |
|
224 | - 'makesOffer' => 'A pointer to products or services offered by the organization or person.', |
|
225 | - 'member' => 'A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.', |
|
226 | - 'memberOf' => 'An Organization (or ProgramMembership) to which this Person or Organization belongs.', |
|
227 | - 'members' => 'A member of this organization.', |
|
228 | - 'musicGroupMember' => 'A member of a music group—for example, John, Paul, George, or Ringo.', |
|
229 | - 'naics' => 'The North American Industry Classification System (NAICS) code for a particular organization or business person.', |
|
230 | - 'name' => 'The name of the item.', |
|
231 | - 'nonprofitStatus' => 'nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.', |
|
232 | - 'numberOfEmployees' => 'The number of employees in an organization, e.g. business.', |
|
233 | - 'ownershipFundingInfo' => 'For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.', |
|
234 | - 'owns' => 'Products owned by the organization or person.', |
|
235 | - 'parentOrganization' => 'The larger organization that this organization is a [[subOrganization]] of, if any.', |
|
236 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
237 | - 'publishingPrinciples' => 'The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. ', |
|
238 | - 'review' => 'A review of the item.', |
|
239 | - 'reviews' => 'Review of the item.', |
|
240 | - '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.', |
|
241 | - 'seeks' => 'A pointer to products or services sought by the organization or person (demand).', |
|
242 | - 'serviceArea' => 'The geographic area where the service is provided.', |
|
243 | - 'slogan' => 'A slogan or motto associated with the item.', |
|
244 | - 'sponsor' => 'A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.', |
|
245 | - 'subOrganization' => 'A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific \'department\' property.', |
|
246 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
247 | - 'taxID' => 'The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.', |
|
248 | - 'telephone' => 'The telephone number.', |
|
249 | - 'track' => 'A music recording (track)—usually a single song. If an ItemList is given, the list should contain items of type MusicRecording.', |
|
250 | - 'tracks' => 'A music recording (track)—usually a single song.', |
|
251 | - 'unnamedSourcesPolicy' => 'For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.', |
|
252 | - 'url' => 'URL of the item.', |
|
253 | - 'vatID' => 'The Value-added Tax ID of the organization or person.' |
|
254 | - ]; |
|
255 | - } |
|
164 | + /** |
|
165 | + * @inheritdoc |
|
166 | + */ |
|
167 | + public function getSchemaPropertyDescriptions(): array |
|
168 | + { |
|
169 | + return [ |
|
170 | + 'actionableFeedbackPolicy' => 'For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroom’s), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.', |
|
171 | + '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
172 | + 'address' => 'Physical address of the item.', |
|
173 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
174 | + 'album' => 'A music album.', |
|
175 | + 'albums' => 'A collection of music albums.', |
|
176 | + 'alternateName' => 'An alias for the item.', |
|
177 | + 'alumni' => 'Alumni of an organization.', |
|
178 | + 'areaServed' => 'The geographic area where a service or offered item is provided.', |
|
179 | + 'award' => 'An award won by or for this item.', |
|
180 | + 'awards' => 'Awards won by or for this item.', |
|
181 | + 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
182 | + 'contactPoint' => 'A contact point for a person or organization.', |
|
183 | + 'contactPoints' => 'A contact point for a person or organization.', |
|
184 | + 'correctionsPolicy' => 'For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroom’s) disclosure and correction policy for errors.', |
|
185 | + 'department' => 'A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.', |
|
186 | + 'description' => 'A description of the item.', |
|
187 | + '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.', |
|
188 | + 'dissolutionDate' => 'The date that this organization was dissolved.', |
|
189 | + 'diversityPolicy' => 'Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroom’s diversity policy on both staffing and sources, typically providing staffing data.', |
|
190 | + 'diversityStaffingReport' => 'For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.', |
|
191 | + 'duns' => 'The Dun & Bradstreet DUNS number for identifying an organization or business person.', |
|
192 | + 'email' => 'Email address.', |
|
193 | + 'employee' => 'Someone working for this organization.', |
|
194 | + 'employees' => 'People working for this organization.', |
|
195 | + 'ethicsPolicy' => 'Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.', |
|
196 | + 'event' => 'Upcoming or past event associated with this place, organization, or action.', |
|
197 | + 'events' => 'Upcoming or past events associated with this place or organization.', |
|
198 | + 'faxNumber' => 'The fax number.', |
|
199 | + 'founder' => 'A person who founded this organization.', |
|
200 | + 'founders' => 'A person who founded this organization.', |
|
201 | + 'foundingDate' => 'The date that this organization was founded.', |
|
202 | + 'foundingLocation' => 'The place where the Organization was founded.', |
|
203 | + 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
204 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
205 | + 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
206 | + '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.', |
|
207 | + 'hasCredential' => 'A credential awarded to the Person or Organization.', |
|
208 | + 'hasMerchantReturnPolicy' => 'Specifies a MerchantReturnPolicy that may be applicable.', |
|
209 | + 'hasOfferCatalog' => 'Indicates an OfferCatalog listing for this Organization, Person, or Service.', |
|
210 | + 'hasPOS' => 'Points-of-Sales operated by the organization or person.', |
|
211 | + '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. ', |
|
212 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
213 | + 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
214 | + 'isicV4' => 'The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.', |
|
215 | + 'iso6523Code' => 'An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly. ', |
|
216 | + '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.', |
|
217 | + 'knowsAbout' => 'Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.', |
|
218 | + 'knowsLanguage' => 'Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).', |
|
219 | + 'legalName' => 'The official name of the organization, e.g. the registered company name.', |
|
220 | + 'leiCode' => 'An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.', |
|
221 | + 'location' => 'The location of, for example, where an event is happening, where an organization is located, or where an action takes place.', |
|
222 | + 'logo' => 'An associated logo.', |
|
223 | + '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.', |
|
224 | + 'makesOffer' => 'A pointer to products or services offered by the organization or person.', |
|
225 | + 'member' => 'A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.', |
|
226 | + 'memberOf' => 'An Organization (or ProgramMembership) to which this Person or Organization belongs.', |
|
227 | + 'members' => 'A member of this organization.', |
|
228 | + 'musicGroupMember' => 'A member of a music group—for example, John, Paul, George, or Ringo.', |
|
229 | + 'naics' => 'The North American Industry Classification System (NAICS) code for a particular organization or business person.', |
|
230 | + 'name' => 'The name of the item.', |
|
231 | + 'nonprofitStatus' => 'nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.', |
|
232 | + 'numberOfEmployees' => 'The number of employees in an organization, e.g. business.', |
|
233 | + 'ownershipFundingInfo' => 'For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.', |
|
234 | + 'owns' => 'Products owned by the organization or person.', |
|
235 | + 'parentOrganization' => 'The larger organization that this organization is a [[subOrganization]] of, if any.', |
|
236 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
237 | + 'publishingPrinciples' => 'The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. ', |
|
238 | + 'review' => 'A review of the item.', |
|
239 | + 'reviews' => 'Review of the item.', |
|
240 | + '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.', |
|
241 | + 'seeks' => 'A pointer to products or services sought by the organization or person (demand).', |
|
242 | + 'serviceArea' => 'The geographic area where the service is provided.', |
|
243 | + 'slogan' => 'A slogan or motto associated with the item.', |
|
244 | + 'sponsor' => 'A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.', |
|
245 | + 'subOrganization' => 'A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific \'department\' property.', |
|
246 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
247 | + 'taxID' => 'The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.', |
|
248 | + 'telephone' => 'The telephone number.', |
|
249 | + 'track' => 'A music recording (track)—usually a single song. If an ItemList is given, the list should contain items of type MusicRecording.', |
|
250 | + 'tracks' => 'A music recording (track)—usually a single song.', |
|
251 | + 'unnamedSourcesPolicy' => 'For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.', |
|
252 | + 'url' => 'URL of the item.', |
|
253 | + 'vatID' => 'The Value-added Tax ID of the organization or person.' |
|
254 | + ]; |
|
255 | + } |
|
256 | 256 | |
257 | 257 | |
258 | - /** |
|
259 | - * @inheritdoc |
|
260 | - */ |
|
261 | - public function getGoogleRequiredSchema(): array |
|
262 | - { |
|
263 | - return ['description', 'name']; |
|
264 | - } |
|
258 | + /** |
|
259 | + * @inheritdoc |
|
260 | + */ |
|
261 | + public function getGoogleRequiredSchema(): array |
|
262 | + { |
|
263 | + return ['description', 'name']; |
|
264 | + } |
|
265 | 265 | |
266 | 266 | |
267 | - /** |
|
268 | - * @inheritdoc |
|
269 | - */ |
|
270 | - public function getGoogleRecommendedSchema(): array |
|
271 | - { |
|
272 | - return ['image', 'url']; |
|
273 | - } |
|
267 | + /** |
|
268 | + * @inheritdoc |
|
269 | + */ |
|
270 | + public function getGoogleRecommendedSchema(): array |
|
271 | + { |
|
272 | + return ['image', 'url']; |
|
273 | + } |
|
274 | 274 | |
275 | 275 | |
276 | - /** |
|
277 | - * @inheritdoc |
|
278 | - */ |
|
279 | - public function defineRules(): array |
|
280 | - { |
|
281 | - $rules = parent::defineRules(); |
|
282 | - $rules = array_merge($rules, [ |
|
283 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
284 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
285 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
286 | - ]); |
|
276 | + /** |
|
277 | + * @inheritdoc |
|
278 | + */ |
|
279 | + public function defineRules(): array |
|
280 | + { |
|
281 | + $rules = parent::defineRules(); |
|
282 | + $rules = array_merge($rules, [ |
|
283 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
284 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
285 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
286 | + ]); |
|
287 | 287 | |
288 | - return $rules; |
|
289 | - } |
|
288 | + return $rules; |
|
289 | + } |
|
290 | 290 | } |
@@ -23,367 +23,367 @@ |
||
23 | 23 | */ |
24 | 24 | class CheckoutPage extends MetaJsonLd implements CheckoutPageInterface, WebPageInterface, CreativeWorkInterface, ThingInterface |
25 | 25 | { |
26 | - use CheckoutPageTrait; |
|
27 | - use WebPageTrait; |
|
28 | - use CreativeWorkTrait; |
|
29 | - use ThingTrait; |
|
26 | + use CheckoutPageTrait; |
|
27 | + use WebPageTrait; |
|
28 | + use CreativeWorkTrait; |
|
29 | + use ThingTrait; |
|
30 | 30 | |
31 | - /** |
|
32 | - * The Schema.org Type Name |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - public static $schemaTypeName = 'CheckoutPage'; |
|
31 | + /** |
|
32 | + * The Schema.org Type Name |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + public static $schemaTypeName = 'CheckoutPage'; |
|
37 | 37 | |
38 | - /** |
|
39 | - * The Schema.org Type Scope |
|
40 | - * |
|
41 | - * @var string |
|
42 | - */ |
|
43 | - public static $schemaTypeScope = 'https://schema.org/CheckoutPage'; |
|
38 | + /** |
|
39 | + * The Schema.org Type Scope |
|
40 | + * |
|
41 | + * @var string |
|
42 | + */ |
|
43 | + public static $schemaTypeScope = 'https://schema.org/CheckoutPage'; |
|
44 | 44 | |
45 | - /** |
|
46 | - * The Schema.org Type Extends |
|
47 | - * |
|
48 | - * @var string |
|
49 | - */ |
|
50 | - public static $schemaTypeExtends = 'WebPage'; |
|
45 | + /** |
|
46 | + * The Schema.org Type Extends |
|
47 | + * |
|
48 | + * @var string |
|
49 | + */ |
|
50 | + public static $schemaTypeExtends = 'WebPage'; |
|
51 | 51 | |
52 | - /** |
|
53 | - * The Schema.org Type Description |
|
54 | - * |
|
55 | - * @var string |
|
56 | - */ |
|
57 | - public static $schemaTypeDescription = 'Web page type: Checkout page.'; |
|
52 | + /** |
|
53 | + * The Schema.org Type Description |
|
54 | + * |
|
55 | + * @var string |
|
56 | + */ |
|
57 | + public static $schemaTypeDescription = 'Web page type: Checkout page.'; |
|
58 | 58 | |
59 | 59 | |
60 | - /** |
|
61 | - * @inheritdoc |
|
62 | - */ |
|
63 | - public function getSchemaPropertyNames(): array |
|
64 | - { |
|
65 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
66 | - } |
|
60 | + /** |
|
61 | + * @inheritdoc |
|
62 | + */ |
|
63 | + public function getSchemaPropertyNames(): array |
|
64 | + { |
|
65 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
66 | + } |
|
67 | 67 | |
68 | 68 | |
69 | - /** |
|
70 | - * @inheritdoc |
|
71 | - */ |
|
72 | - public function getSchemaPropertyExpectedTypes(): array |
|
73 | - { |
|
74 | - return [ |
|
75 | - 'about' => ['Thing'], |
|
76 | - 'abstract' => ['Text'], |
|
77 | - 'accessMode' => ['Text'], |
|
78 | - 'accessModeSufficient' => ['ItemList'], |
|
79 | - 'accessibilityAPI' => ['Text'], |
|
80 | - 'accessibilityControl' => ['Text'], |
|
81 | - 'accessibilityFeature' => ['Text'], |
|
82 | - 'accessibilityHazard' => ['Text'], |
|
83 | - 'accessibilitySummary' => ['Text'], |
|
84 | - 'accountablePerson' => ['Person'], |
|
85 | - 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
86 | - 'additionalType' => ['URL'], |
|
87 | - 'aggregateRating' => ['AggregateRating'], |
|
88 | - 'alternateName' => ['Text'], |
|
89 | - 'alternativeHeadline' => ['Text'], |
|
90 | - 'archivedAt' => ['WebPage', 'URL'], |
|
91 | - 'assesses' => ['DefinedTerm', 'Text'], |
|
92 | - 'associatedMedia' => ['MediaObject'], |
|
93 | - 'audience' => ['Audience'], |
|
94 | - 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
95 | - 'author' => ['Organization', 'Person'], |
|
96 | - 'award' => ['Text'], |
|
97 | - 'awards' => ['Text'], |
|
98 | - 'breadcrumb' => ['BreadcrumbList', 'Text'], |
|
99 | - 'character' => ['Person'], |
|
100 | - 'citation' => ['CreativeWork', 'Text'], |
|
101 | - 'comment' => ['Comment'], |
|
102 | - 'commentCount' => ['Integer'], |
|
103 | - 'conditionsOfAccess' => ['Text'], |
|
104 | - 'contentLocation' => ['Place'], |
|
105 | - 'contentRating' => ['Text', 'Rating'], |
|
106 | - 'contentReferenceTime' => ['DateTime'], |
|
107 | - 'contributor' => ['Organization', 'Person'], |
|
108 | - 'copyrightHolder' => ['Organization', 'Person'], |
|
109 | - 'copyrightNotice' => ['Text'], |
|
110 | - 'copyrightYear' => ['Number'], |
|
111 | - 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
112 | - 'countryOfOrigin' => ['Country'], |
|
113 | - 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
114 | - 'creator' => ['Person', 'Organization'], |
|
115 | - 'creditText' => ['Text'], |
|
116 | - 'dateCreated' => ['DateTime', 'Date'], |
|
117 | - 'dateModified' => ['DateTime', 'Date'], |
|
118 | - 'datePublished' => ['DateTime', 'Date'], |
|
119 | - 'description' => ['Text'], |
|
120 | - 'disambiguatingDescription' => ['Text'], |
|
121 | - 'discussionUrl' => ['URL'], |
|
122 | - 'editEIDR' => ['URL', 'Text'], |
|
123 | - 'editor' => ['Person'], |
|
124 | - 'educationalAlignment' => ['AlignmentObject'], |
|
125 | - 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
126 | - 'educationalUse' => ['DefinedTerm', 'Text'], |
|
127 | - 'encoding' => ['MediaObject'], |
|
128 | - 'encodingFormat' => ['URL', 'Text'], |
|
129 | - 'encodings' => ['MediaObject'], |
|
130 | - 'exampleOfWork' => ['CreativeWork'], |
|
131 | - 'expires' => ['Date', 'DateTime'], |
|
132 | - 'fileFormat' => ['Text', 'URL'], |
|
133 | - 'funder' => ['Organization', 'Person'], |
|
134 | - 'funding' => ['Grant'], |
|
135 | - 'genre' => ['Text', 'URL'], |
|
136 | - 'hasPart' => ['CreativeWork'], |
|
137 | - 'headline' => ['Text'], |
|
138 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
139 | - 'image' => ['URL', 'ImageObject'], |
|
140 | - 'inLanguage' => ['Text', 'Language'], |
|
141 | - 'interactionStatistic' => ['InteractionCounter'], |
|
142 | - 'interactivityType' => ['Text'], |
|
143 | - 'interpretedAsClaim' => ['Claim'], |
|
144 | - 'isAccessibleForFree' => ['Boolean'], |
|
145 | - 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
146 | - 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
147 | - 'isFamilyFriendly' => ['Boolean'], |
|
148 | - 'isPartOf' => ['URL', 'CreativeWork'], |
|
149 | - 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
150 | - 'lastReviewed' => ['Date'], |
|
151 | - 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
152 | - 'license' => ['URL', 'CreativeWork'], |
|
153 | - 'locationCreated' => ['Place'], |
|
154 | - 'mainContentOfPage' => ['WebPageElement'], |
|
155 | - 'mainEntity' => ['Thing'], |
|
156 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
157 | - 'maintainer' => ['Person', 'Organization'], |
|
158 | - 'material' => ['Product', 'URL', 'Text'], |
|
159 | - 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
160 | - 'mentions' => ['Thing'], |
|
161 | - 'name' => ['Text'], |
|
162 | - 'offers' => ['Demand', 'Offer'], |
|
163 | - 'pattern' => ['DefinedTerm', 'Text'], |
|
164 | - 'position' => ['Text', 'Integer'], |
|
165 | - 'potentialAction' => ['Action'], |
|
166 | - 'primaryImageOfPage' => ['ImageObject'], |
|
167 | - 'producer' => ['Organization', 'Person'], |
|
168 | - 'provider' => ['Organization', 'Person'], |
|
169 | - 'publication' => ['PublicationEvent'], |
|
170 | - 'publisher' => ['Organization', 'Person'], |
|
171 | - 'publisherImprint' => ['Organization'], |
|
172 | - 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
173 | - 'recordedAt' => ['Event'], |
|
174 | - 'relatedLink' => ['URL'], |
|
175 | - 'releasedEvent' => ['PublicationEvent'], |
|
176 | - 'review' => ['Review'], |
|
177 | - 'reviewedBy' => ['Organization', 'Person'], |
|
178 | - 'reviews' => ['Review'], |
|
179 | - 'sameAs' => ['URL'], |
|
180 | - 'schemaVersion' => ['URL', 'Text'], |
|
181 | - 'sdDatePublished' => ['Date'], |
|
182 | - 'sdLicense' => ['CreativeWork', 'URL'], |
|
183 | - 'sdPublisher' => ['Organization', 'Person'], |
|
184 | - 'significantLink' => ['URL'], |
|
185 | - 'significantLinks' => ['URL'], |
|
186 | - 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
187 | - 'sourceOrganization' => ['Organization'], |
|
188 | - 'spatial' => ['Place'], |
|
189 | - 'spatialCoverage' => ['Place'], |
|
190 | - 'speakable' => ['SpeakableSpecification', 'URL'], |
|
191 | - 'specialty' => ['Specialty'], |
|
192 | - 'sponsor' => ['Organization', 'Person'], |
|
193 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
194 | - 'teaches' => ['DefinedTerm', 'Text'], |
|
195 | - 'temporal' => ['DateTime', 'Text'], |
|
196 | - 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
197 | - 'text' => ['Text'], |
|
198 | - 'thumbnailUrl' => ['URL'], |
|
199 | - 'timeRequired' => ['Duration'], |
|
200 | - 'translationOfWork' => ['CreativeWork'], |
|
201 | - 'translator' => ['Organization', 'Person'], |
|
202 | - 'typicalAgeRange' => ['Text'], |
|
203 | - 'url' => ['URL'], |
|
204 | - 'usageInfo' => ['URL', 'CreativeWork'], |
|
205 | - 'version' => ['Number', 'Text'], |
|
206 | - 'video' => ['VideoObject', 'Clip'], |
|
207 | - 'workExample' => ['CreativeWork'], |
|
208 | - 'workTranslation' => ['CreativeWork'] |
|
209 | - ]; |
|
210 | - } |
|
69 | + /** |
|
70 | + * @inheritdoc |
|
71 | + */ |
|
72 | + public function getSchemaPropertyExpectedTypes(): array |
|
73 | + { |
|
74 | + return [ |
|
75 | + 'about' => ['Thing'], |
|
76 | + 'abstract' => ['Text'], |
|
77 | + 'accessMode' => ['Text'], |
|
78 | + 'accessModeSufficient' => ['ItemList'], |
|
79 | + 'accessibilityAPI' => ['Text'], |
|
80 | + 'accessibilityControl' => ['Text'], |
|
81 | + 'accessibilityFeature' => ['Text'], |
|
82 | + 'accessibilityHazard' => ['Text'], |
|
83 | + 'accessibilitySummary' => ['Text'], |
|
84 | + 'accountablePerson' => ['Person'], |
|
85 | + 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
86 | + 'additionalType' => ['URL'], |
|
87 | + 'aggregateRating' => ['AggregateRating'], |
|
88 | + 'alternateName' => ['Text'], |
|
89 | + 'alternativeHeadline' => ['Text'], |
|
90 | + 'archivedAt' => ['WebPage', 'URL'], |
|
91 | + 'assesses' => ['DefinedTerm', 'Text'], |
|
92 | + 'associatedMedia' => ['MediaObject'], |
|
93 | + 'audience' => ['Audience'], |
|
94 | + 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
95 | + 'author' => ['Organization', 'Person'], |
|
96 | + 'award' => ['Text'], |
|
97 | + 'awards' => ['Text'], |
|
98 | + 'breadcrumb' => ['BreadcrumbList', 'Text'], |
|
99 | + 'character' => ['Person'], |
|
100 | + 'citation' => ['CreativeWork', 'Text'], |
|
101 | + 'comment' => ['Comment'], |
|
102 | + 'commentCount' => ['Integer'], |
|
103 | + 'conditionsOfAccess' => ['Text'], |
|
104 | + 'contentLocation' => ['Place'], |
|
105 | + 'contentRating' => ['Text', 'Rating'], |
|
106 | + 'contentReferenceTime' => ['DateTime'], |
|
107 | + 'contributor' => ['Organization', 'Person'], |
|
108 | + 'copyrightHolder' => ['Organization', 'Person'], |
|
109 | + 'copyrightNotice' => ['Text'], |
|
110 | + 'copyrightYear' => ['Number'], |
|
111 | + 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
112 | + 'countryOfOrigin' => ['Country'], |
|
113 | + 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
114 | + 'creator' => ['Person', 'Organization'], |
|
115 | + 'creditText' => ['Text'], |
|
116 | + 'dateCreated' => ['DateTime', 'Date'], |
|
117 | + 'dateModified' => ['DateTime', 'Date'], |
|
118 | + 'datePublished' => ['DateTime', 'Date'], |
|
119 | + 'description' => ['Text'], |
|
120 | + 'disambiguatingDescription' => ['Text'], |
|
121 | + 'discussionUrl' => ['URL'], |
|
122 | + 'editEIDR' => ['URL', 'Text'], |
|
123 | + 'editor' => ['Person'], |
|
124 | + 'educationalAlignment' => ['AlignmentObject'], |
|
125 | + 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
126 | + 'educationalUse' => ['DefinedTerm', 'Text'], |
|
127 | + 'encoding' => ['MediaObject'], |
|
128 | + 'encodingFormat' => ['URL', 'Text'], |
|
129 | + 'encodings' => ['MediaObject'], |
|
130 | + 'exampleOfWork' => ['CreativeWork'], |
|
131 | + 'expires' => ['Date', 'DateTime'], |
|
132 | + 'fileFormat' => ['Text', 'URL'], |
|
133 | + 'funder' => ['Organization', 'Person'], |
|
134 | + 'funding' => ['Grant'], |
|
135 | + 'genre' => ['Text', 'URL'], |
|
136 | + 'hasPart' => ['CreativeWork'], |
|
137 | + 'headline' => ['Text'], |
|
138 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
139 | + 'image' => ['URL', 'ImageObject'], |
|
140 | + 'inLanguage' => ['Text', 'Language'], |
|
141 | + 'interactionStatistic' => ['InteractionCounter'], |
|
142 | + 'interactivityType' => ['Text'], |
|
143 | + 'interpretedAsClaim' => ['Claim'], |
|
144 | + 'isAccessibleForFree' => ['Boolean'], |
|
145 | + 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
146 | + 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
147 | + 'isFamilyFriendly' => ['Boolean'], |
|
148 | + 'isPartOf' => ['URL', 'CreativeWork'], |
|
149 | + 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
150 | + 'lastReviewed' => ['Date'], |
|
151 | + 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
152 | + 'license' => ['URL', 'CreativeWork'], |
|
153 | + 'locationCreated' => ['Place'], |
|
154 | + 'mainContentOfPage' => ['WebPageElement'], |
|
155 | + 'mainEntity' => ['Thing'], |
|
156 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
157 | + 'maintainer' => ['Person', 'Organization'], |
|
158 | + 'material' => ['Product', 'URL', 'Text'], |
|
159 | + 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
160 | + 'mentions' => ['Thing'], |
|
161 | + 'name' => ['Text'], |
|
162 | + 'offers' => ['Demand', 'Offer'], |
|
163 | + 'pattern' => ['DefinedTerm', 'Text'], |
|
164 | + 'position' => ['Text', 'Integer'], |
|
165 | + 'potentialAction' => ['Action'], |
|
166 | + 'primaryImageOfPage' => ['ImageObject'], |
|
167 | + 'producer' => ['Organization', 'Person'], |
|
168 | + 'provider' => ['Organization', 'Person'], |
|
169 | + 'publication' => ['PublicationEvent'], |
|
170 | + 'publisher' => ['Organization', 'Person'], |
|
171 | + 'publisherImprint' => ['Organization'], |
|
172 | + 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
173 | + 'recordedAt' => ['Event'], |
|
174 | + 'relatedLink' => ['URL'], |
|
175 | + 'releasedEvent' => ['PublicationEvent'], |
|
176 | + 'review' => ['Review'], |
|
177 | + 'reviewedBy' => ['Organization', 'Person'], |
|
178 | + 'reviews' => ['Review'], |
|
179 | + 'sameAs' => ['URL'], |
|
180 | + 'schemaVersion' => ['URL', 'Text'], |
|
181 | + 'sdDatePublished' => ['Date'], |
|
182 | + 'sdLicense' => ['CreativeWork', 'URL'], |
|
183 | + 'sdPublisher' => ['Organization', 'Person'], |
|
184 | + 'significantLink' => ['URL'], |
|
185 | + 'significantLinks' => ['URL'], |
|
186 | + 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
187 | + 'sourceOrganization' => ['Organization'], |
|
188 | + 'spatial' => ['Place'], |
|
189 | + 'spatialCoverage' => ['Place'], |
|
190 | + 'speakable' => ['SpeakableSpecification', 'URL'], |
|
191 | + 'specialty' => ['Specialty'], |
|
192 | + 'sponsor' => ['Organization', 'Person'], |
|
193 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
194 | + 'teaches' => ['DefinedTerm', 'Text'], |
|
195 | + 'temporal' => ['DateTime', 'Text'], |
|
196 | + 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
197 | + 'text' => ['Text'], |
|
198 | + 'thumbnailUrl' => ['URL'], |
|
199 | + 'timeRequired' => ['Duration'], |
|
200 | + 'translationOfWork' => ['CreativeWork'], |
|
201 | + 'translator' => ['Organization', 'Person'], |
|
202 | + 'typicalAgeRange' => ['Text'], |
|
203 | + 'url' => ['URL'], |
|
204 | + 'usageInfo' => ['URL', 'CreativeWork'], |
|
205 | + 'version' => ['Number', 'Text'], |
|
206 | + 'video' => ['VideoObject', 'Clip'], |
|
207 | + 'workExample' => ['CreativeWork'], |
|
208 | + 'workTranslation' => ['CreativeWork'] |
|
209 | + ]; |
|
210 | + } |
|
211 | 211 | |
212 | 212 | |
213 | - /** |
|
214 | - * @inheritdoc |
|
215 | - */ |
|
216 | - public function getSchemaPropertyDescriptions(): array |
|
217 | - { |
|
218 | - return [ |
|
219 | - 'about' => 'The subject matter of the content.', |
|
220 | - 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
221 | - 'accessMode' => 'The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).', |
|
222 | - 'accessModeSufficient' => 'A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).', |
|
223 | - 'accessibilityAPI' => 'Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).', |
|
224 | - 'accessibilityControl' => 'Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).', |
|
225 | - 'accessibilityFeature' => 'Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).', |
|
226 | - 'accessibilityHazard' => 'A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).', |
|
227 | - 'accessibilitySummary' => 'A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."', |
|
228 | - 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
229 | - 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
230 | - '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
231 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
232 | - 'alternateName' => 'An alias for the item.', |
|
233 | - 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
234 | - 'archivedAt' => 'Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.', |
|
235 | - 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
236 | - 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
237 | - 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
238 | - 'audio' => 'An embedded audio object.', |
|
239 | - 'author' => 'The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.', |
|
240 | - 'award' => 'An award won by or for this item.', |
|
241 | - 'awards' => 'Awards won by or for this item.', |
|
242 | - 'breadcrumb' => 'A set of links that can help a user understand and navigate a website hierarchy.', |
|
243 | - 'character' => 'Fictional person connected with a creative work.', |
|
244 | - 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
245 | - 'comment' => 'Comments, typically from users.', |
|
246 | - 'commentCount' => 'The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.', |
|
247 | - 'conditionsOfAccess' => 'Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language. For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". ', |
|
248 | - 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
249 | - 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
250 | - 'contentReferenceTime' => 'The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.', |
|
251 | - 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
252 | - 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
253 | - 'copyrightNotice' => 'Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.', |
|
254 | - 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
255 | - 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
256 | - 'countryOfOrigin' => 'The country of origin of something, including products as well as creative works such as movie and TV content. In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable. In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.', |
|
257 | - 'creativeWorkStatus' => 'The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.', |
|
258 | - 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
259 | - 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
260 | - 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
261 | - 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
262 | - 'datePublished' => 'Date of first broadcast/publication.', |
|
263 | - 'description' => 'A description of the item.', |
|
264 | - '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.', |
|
265 | - 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
266 | - 'editEIDR' => 'An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. ', |
|
267 | - 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
268 | - 'educationalAlignment' => 'An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.', |
|
269 | - 'educationalLevel' => 'The level in terms of progression through an educational or training context. Examples of educational levels include \'beginner\', \'intermediate\' or \'advanced\', and formal sets of level indicators.', |
|
270 | - 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
271 | - 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
272 | - 'encodingFormat' => 'Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc. In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.', |
|
273 | - 'encodings' => 'A media object that encodes this CreativeWork.', |
|
274 | - 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
275 | - 'expires' => 'Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.', |
|
276 | - 'fileFormat' => 'Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, \'encoding\' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.', |
|
277 | - 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
278 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
279 | - 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
280 | - 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
281 | - 'headline' => 'Headline of the article.', |
|
282 | - '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. ', |
|
283 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
284 | - 'inLanguage' => 'The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].', |
|
285 | - 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
286 | - 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
287 | - 'interpretedAsClaim' => 'Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].', |
|
288 | - 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
289 | - 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
290 | - 'isBasedOnUrl' => 'A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.', |
|
291 | - 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
292 | - 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
293 | - '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.', |
|
294 | - 'lastReviewed' => 'Date on which the content on this web page was last reviewed for accuracy and/or completeness.', |
|
295 | - 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
296 | - 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
297 | - 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
298 | - 'mainContentOfPage' => 'Indicates if this web page element is the main subject of the page.', |
|
299 | - 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
300 | - '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.', |
|
301 | - 'maintainer' => 'A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. ', |
|
302 | - 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
303 | - 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
304 | - 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
305 | - 'name' => 'The name of the item.', |
|
306 | - 'offers' => 'An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. ', |
|
307 | - 'pattern' => 'A pattern that something has, for example \'polka dot\', \'striped\', \'Canadian flag\'. Values are typically expressed as text, although links to controlled value schemes are also supported.', |
|
308 | - 'position' => 'The position of an item in a series or sequence of items.', |
|
309 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
310 | - 'primaryImageOfPage' => 'Indicates the main image on the page.', |
|
311 | - 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
312 | - '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.', |
|
313 | - 'publication' => 'A publication event associated with the item.', |
|
314 | - 'publisher' => 'The publisher of the creative work.', |
|
315 | - 'publisherImprint' => 'The publishing division which published the comic.', |
|
316 | - 'publishingPrinciples' => 'The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. ', |
|
317 | - 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
318 | - 'relatedLink' => 'A link related to this web page, for example to other related web pages.', |
|
319 | - 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
320 | - 'review' => 'A review of the item.', |
|
321 | - 'reviewedBy' => 'People or organizations that have reviewed the content on this web page for accuracy and/or completeness.', |
|
322 | - 'reviews' => 'Review of the item.', |
|
323 | - '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.', |
|
324 | - 'schemaVersion' => 'Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.', |
|
325 | - 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
326 | - 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
327 | - 'sdPublisher' => 'Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit.', |
|
328 | - 'significantLink' => 'One of the more significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.', |
|
329 | - 'significantLinks' => 'The most significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.', |
|
330 | - 'size' => 'A standardized size of a product or creative work, specified either through a simple textual string (for example \'XL\', \'32Wx34L\'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. ', |
|
331 | - 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
332 | - 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
333 | - 'spatialCoverage' => 'The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.', |
|
334 | - '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. ', |
|
335 | - 'specialty' => 'One of the domain specialities to which this web page\'s content applies.', |
|
336 | - 'sponsor' => 'A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.', |
|
337 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
338 | - 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
339 | - 'temporal' => 'The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.', |
|
340 | - 'temporalCoverage' => 'The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.', |
|
341 | - 'text' => 'The textual content of this CreativeWork.', |
|
342 | - 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
343 | - 'timeRequired' => 'Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. \'PT30M\', \'PT1H25M\'.', |
|
344 | - 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
345 | - 'translator' => 'Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.', |
|
346 | - 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
347 | - 'url' => 'URL of the item.', |
|
348 | - 'usageInfo' => 'The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.', |
|
349 | - 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
350 | - 'video' => 'An embedded video object.', |
|
351 | - 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
352 | - 'workTranslation' => 'A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo.' |
|
353 | - ]; |
|
354 | - } |
|
213 | + /** |
|
214 | + * @inheritdoc |
|
215 | + */ |
|
216 | + public function getSchemaPropertyDescriptions(): array |
|
217 | + { |
|
218 | + return [ |
|
219 | + 'about' => 'The subject matter of the content.', |
|
220 | + 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
221 | + 'accessMode' => 'The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).', |
|
222 | + 'accessModeSufficient' => 'A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).', |
|
223 | + 'accessibilityAPI' => 'Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).', |
|
224 | + 'accessibilityControl' => 'Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).', |
|
225 | + 'accessibilityFeature' => 'Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).', |
|
226 | + 'accessibilityHazard' => 'A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).', |
|
227 | + 'accessibilitySummary' => 'A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."', |
|
228 | + 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
229 | + 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
230 | + '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
231 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
232 | + 'alternateName' => 'An alias for the item.', |
|
233 | + 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
234 | + 'archivedAt' => 'Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.', |
|
235 | + 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
236 | + 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
237 | + 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
238 | + 'audio' => 'An embedded audio object.', |
|
239 | + 'author' => 'The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.', |
|
240 | + 'award' => 'An award won by or for this item.', |
|
241 | + 'awards' => 'Awards won by or for this item.', |
|
242 | + 'breadcrumb' => 'A set of links that can help a user understand and navigate a website hierarchy.', |
|
243 | + 'character' => 'Fictional person connected with a creative work.', |
|
244 | + 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
245 | + 'comment' => 'Comments, typically from users.', |
|
246 | + 'commentCount' => 'The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.', |
|
247 | + 'conditionsOfAccess' => 'Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language. For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". ', |
|
248 | + 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
249 | + 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
250 | + 'contentReferenceTime' => 'The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.', |
|
251 | + 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
252 | + 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
253 | + 'copyrightNotice' => 'Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.', |
|
254 | + 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
255 | + 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
256 | + 'countryOfOrigin' => 'The country of origin of something, including products as well as creative works such as movie and TV content. In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable. In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.', |
|
257 | + 'creativeWorkStatus' => 'The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.', |
|
258 | + 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
259 | + 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
260 | + 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
261 | + 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
262 | + 'datePublished' => 'Date of first broadcast/publication.', |
|
263 | + 'description' => 'A description of the item.', |
|
264 | + '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.', |
|
265 | + 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
266 | + 'editEIDR' => 'An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. ', |
|
267 | + 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
268 | + 'educationalAlignment' => 'An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.', |
|
269 | + 'educationalLevel' => 'The level in terms of progression through an educational or training context. Examples of educational levels include \'beginner\', \'intermediate\' or \'advanced\', and formal sets of level indicators.', |
|
270 | + 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
271 | + 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
272 | + 'encodingFormat' => 'Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc. In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.', |
|
273 | + 'encodings' => 'A media object that encodes this CreativeWork.', |
|
274 | + 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
275 | + 'expires' => 'Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.', |
|
276 | + 'fileFormat' => 'Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, \'encoding\' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.', |
|
277 | + 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
278 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
279 | + 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
280 | + 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
281 | + 'headline' => 'Headline of the article.', |
|
282 | + '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. ', |
|
283 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
284 | + 'inLanguage' => 'The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].', |
|
285 | + 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
286 | + 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
287 | + 'interpretedAsClaim' => 'Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].', |
|
288 | + 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
289 | + 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
290 | + 'isBasedOnUrl' => 'A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.', |
|
291 | + 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
292 | + 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
293 | + '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.', |
|
294 | + 'lastReviewed' => 'Date on which the content on this web page was last reviewed for accuracy and/or completeness.', |
|
295 | + 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
296 | + 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
297 | + 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
298 | + 'mainContentOfPage' => 'Indicates if this web page element is the main subject of the page.', |
|
299 | + 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
300 | + '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.', |
|
301 | + 'maintainer' => 'A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. ', |
|
302 | + 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
303 | + 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
304 | + 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
305 | + 'name' => 'The name of the item.', |
|
306 | + 'offers' => 'An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. ', |
|
307 | + 'pattern' => 'A pattern that something has, for example \'polka dot\', \'striped\', \'Canadian flag\'. Values are typically expressed as text, although links to controlled value schemes are also supported.', |
|
308 | + 'position' => 'The position of an item in a series or sequence of items.', |
|
309 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
310 | + 'primaryImageOfPage' => 'Indicates the main image on the page.', |
|
311 | + 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
312 | + '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.', |
|
313 | + 'publication' => 'A publication event associated with the item.', |
|
314 | + 'publisher' => 'The publisher of the creative work.', |
|
315 | + 'publisherImprint' => 'The publishing division which published the comic.', |
|
316 | + 'publishingPrinciples' => 'The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. ', |
|
317 | + 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
318 | + 'relatedLink' => 'A link related to this web page, for example to other related web pages.', |
|
319 | + 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
320 | + 'review' => 'A review of the item.', |
|
321 | + 'reviewedBy' => 'People or organizations that have reviewed the content on this web page for accuracy and/or completeness.', |
|
322 | + 'reviews' => 'Review of the item.', |
|
323 | + '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.', |
|
324 | + 'schemaVersion' => 'Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.', |
|
325 | + 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
326 | + 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
327 | + 'sdPublisher' => 'Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit.', |
|
328 | + 'significantLink' => 'One of the more significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.', |
|
329 | + 'significantLinks' => 'The most significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.', |
|
330 | + 'size' => 'A standardized size of a product or creative work, specified either through a simple textual string (for example \'XL\', \'32Wx34L\'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. ', |
|
331 | + 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
332 | + 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
333 | + 'spatialCoverage' => 'The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.', |
|
334 | + '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. ', |
|
335 | + 'specialty' => 'One of the domain specialities to which this web page\'s content applies.', |
|
336 | + 'sponsor' => 'A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.', |
|
337 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
338 | + 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
339 | + 'temporal' => 'The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.', |
|
340 | + 'temporalCoverage' => 'The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.', |
|
341 | + 'text' => 'The textual content of this CreativeWork.', |
|
342 | + 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
343 | + 'timeRequired' => 'Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. \'PT30M\', \'PT1H25M\'.', |
|
344 | + 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
345 | + 'translator' => 'Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.', |
|
346 | + 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
347 | + 'url' => 'URL of the item.', |
|
348 | + 'usageInfo' => 'The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.', |
|
349 | + 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
350 | + 'video' => 'An embedded video object.', |
|
351 | + 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
352 | + 'workTranslation' => 'A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo.' |
|
353 | + ]; |
|
354 | + } |
|
355 | 355 | |
356 | 356 | |
357 | - /** |
|
358 | - * @inheritdoc |
|
359 | - */ |
|
360 | - public function getGoogleRequiredSchema(): array |
|
361 | - { |
|
362 | - return ['description', 'name']; |
|
363 | - } |
|
357 | + /** |
|
358 | + * @inheritdoc |
|
359 | + */ |
|
360 | + public function getGoogleRequiredSchema(): array |
|
361 | + { |
|
362 | + return ['description', 'name']; |
|
363 | + } |
|
364 | 364 | |
365 | 365 | |
366 | - /** |
|
367 | - * @inheritdoc |
|
368 | - */ |
|
369 | - public function getGoogleRecommendedSchema(): array |
|
370 | - { |
|
371 | - return ['image', 'url']; |
|
372 | - } |
|
366 | + /** |
|
367 | + * @inheritdoc |
|
368 | + */ |
|
369 | + public function getGoogleRecommendedSchema(): array |
|
370 | + { |
|
371 | + return ['image', 'url']; |
|
372 | + } |
|
373 | 373 | |
374 | 374 | |
375 | - /** |
|
376 | - * @inheritdoc |
|
377 | - */ |
|
378 | - public function defineRules(): array |
|
379 | - { |
|
380 | - $rules = parent::defineRules(); |
|
381 | - $rules = array_merge($rules, [ |
|
382 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
383 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
384 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
385 | - ]); |
|
375 | + /** |
|
376 | + * @inheritdoc |
|
377 | + */ |
|
378 | + public function defineRules(): array |
|
379 | + { |
|
380 | + $rules = parent::defineRules(); |
|
381 | + $rules = array_merge($rules, [ |
|
382 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
383 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
384 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
385 | + ]); |
|
386 | 386 | |
387 | - return $rules; |
|
388 | - } |
|
387 | + return $rules; |
|
388 | + } |
|
389 | 389 | } |
@@ -23,127 +23,127 @@ |
||
23 | 23 | */ |
24 | 24 | class PartiallyInForce extends MetaJsonLd implements PartiallyInForceInterface, LegalForceStatusInterface, StatusEnumerationInterface, EnumerationInterface, IntangibleInterface, ThingInterface |
25 | 25 | { |
26 | - use PartiallyInForceTrait; |
|
27 | - use LegalForceStatusTrait; |
|
28 | - use StatusEnumerationTrait; |
|
29 | - use EnumerationTrait; |
|
30 | - use IntangibleTrait; |
|
31 | - use ThingTrait; |
|
32 | - |
|
33 | - /** |
|
34 | - * The Schema.org Type Name |
|
35 | - * |
|
36 | - * @var string |
|
37 | - */ |
|
38 | - public static $schemaTypeName = 'PartiallyInForce'; |
|
39 | - |
|
40 | - /** |
|
41 | - * The Schema.org Type Scope |
|
42 | - * |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - public static $schemaTypeScope = 'https://schema.org/PartiallyInForce'; |
|
46 | - |
|
47 | - /** |
|
48 | - * The Schema.org Type Extends |
|
49 | - * |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - public static $schemaTypeExtends = 'LegalForceStatus'; |
|
53 | - |
|
54 | - /** |
|
55 | - * The Schema.org Type Description |
|
56 | - * |
|
57 | - * @var string |
|
58 | - */ |
|
59 | - public static $schemaTypeDescription = 'Indicates that parts of the legislation are in force, and parts are not.'; |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * @inheritdoc |
|
64 | - */ |
|
65 | - public function getSchemaPropertyNames(): array |
|
66 | - { |
|
67 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * @inheritdoc |
|
73 | - */ |
|
74 | - public function getSchemaPropertyExpectedTypes(): array |
|
75 | - { |
|
76 | - return [ |
|
77 | - 'additionalType' => ['URL'], |
|
78 | - 'alternateName' => ['Text'], |
|
79 | - 'description' => ['Text'], |
|
80 | - 'disambiguatingDescription' => ['Text'], |
|
81 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
82 | - 'image' => ['URL', 'ImageObject'], |
|
83 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
84 | - 'name' => ['Text'], |
|
85 | - 'potentialAction' => ['Action'], |
|
86 | - 'sameAs' => ['URL'], |
|
87 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
88 | - 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
89 | - 'url' => ['URL'] |
|
90 | - ]; |
|
91 | - } |
|
92 | - |
|
93 | - |
|
94 | - /** |
|
95 | - * @inheritdoc |
|
96 | - */ |
|
97 | - public function getSchemaPropertyDescriptions(): array |
|
98 | - { |
|
99 | - return [ |
|
100 | - '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
101 | - 'alternateName' => 'An alias for the item.', |
|
102 | - 'description' => 'A description of the item.', |
|
103 | - '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.', |
|
104 | - '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. ', |
|
105 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
106 | - '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.', |
|
107 | - 'name' => 'The name of the item.', |
|
108 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
109 | - '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.', |
|
110 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
111 | - 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
112 | - 'url' => 'URL of the item.' |
|
113 | - ]; |
|
114 | - } |
|
115 | - |
|
116 | - |
|
117 | - /** |
|
118 | - * @inheritdoc |
|
119 | - */ |
|
120 | - public function getGoogleRequiredSchema(): array |
|
121 | - { |
|
122 | - return ['description', 'name']; |
|
123 | - } |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @inheritdoc |
|
128 | - */ |
|
129 | - public function getGoogleRecommendedSchema(): array |
|
130 | - { |
|
131 | - return ['image', 'url']; |
|
132 | - } |
|
133 | - |
|
134 | - |
|
135 | - /** |
|
136 | - * @inheritdoc |
|
137 | - */ |
|
138 | - public function defineRules(): array |
|
139 | - { |
|
140 | - $rules = parent::defineRules(); |
|
141 | - $rules = array_merge($rules, [ |
|
142 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
143 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
144 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
145 | - ]); |
|
146 | - |
|
147 | - return $rules; |
|
148 | - } |
|
26 | + use PartiallyInForceTrait; |
|
27 | + use LegalForceStatusTrait; |
|
28 | + use StatusEnumerationTrait; |
|
29 | + use EnumerationTrait; |
|
30 | + use IntangibleTrait; |
|
31 | + use ThingTrait; |
|
32 | + |
|
33 | + /** |
|
34 | + * The Schema.org Type Name |
|
35 | + * |
|
36 | + * @var string |
|
37 | + */ |
|
38 | + public static $schemaTypeName = 'PartiallyInForce'; |
|
39 | + |
|
40 | + /** |
|
41 | + * The Schema.org Type Scope |
|
42 | + * |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + public static $schemaTypeScope = 'https://schema.org/PartiallyInForce'; |
|
46 | + |
|
47 | + /** |
|
48 | + * The Schema.org Type Extends |
|
49 | + * |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + public static $schemaTypeExtends = 'LegalForceStatus'; |
|
53 | + |
|
54 | + /** |
|
55 | + * The Schema.org Type Description |
|
56 | + * |
|
57 | + * @var string |
|
58 | + */ |
|
59 | + public static $schemaTypeDescription = 'Indicates that parts of the legislation are in force, and parts are not.'; |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * @inheritdoc |
|
64 | + */ |
|
65 | + public function getSchemaPropertyNames(): array |
|
66 | + { |
|
67 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * @inheritdoc |
|
73 | + */ |
|
74 | + public function getSchemaPropertyExpectedTypes(): array |
|
75 | + { |
|
76 | + return [ |
|
77 | + 'additionalType' => ['URL'], |
|
78 | + 'alternateName' => ['Text'], |
|
79 | + 'description' => ['Text'], |
|
80 | + 'disambiguatingDescription' => ['Text'], |
|
81 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
82 | + 'image' => ['URL', 'ImageObject'], |
|
83 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
84 | + 'name' => ['Text'], |
|
85 | + 'potentialAction' => ['Action'], |
|
86 | + 'sameAs' => ['URL'], |
|
87 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
88 | + 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
89 | + 'url' => ['URL'] |
|
90 | + ]; |
|
91 | + } |
|
92 | + |
|
93 | + |
|
94 | + /** |
|
95 | + * @inheritdoc |
|
96 | + */ |
|
97 | + public function getSchemaPropertyDescriptions(): array |
|
98 | + { |
|
99 | + return [ |
|
100 | + '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
101 | + 'alternateName' => 'An alias for the item.', |
|
102 | + 'description' => 'A description of the item.', |
|
103 | + '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.', |
|
104 | + '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. ', |
|
105 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
106 | + '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.', |
|
107 | + 'name' => 'The name of the item.', |
|
108 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
109 | + '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.', |
|
110 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
111 | + 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
112 | + 'url' => 'URL of the item.' |
|
113 | + ]; |
|
114 | + } |
|
115 | + |
|
116 | + |
|
117 | + /** |
|
118 | + * @inheritdoc |
|
119 | + */ |
|
120 | + public function getGoogleRequiredSchema(): array |
|
121 | + { |
|
122 | + return ['description', 'name']; |
|
123 | + } |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @inheritdoc |
|
128 | + */ |
|
129 | + public function getGoogleRecommendedSchema(): array |
|
130 | + { |
|
131 | + return ['image', 'url']; |
|
132 | + } |
|
133 | + |
|
134 | + |
|
135 | + /** |
|
136 | + * @inheritdoc |
|
137 | + */ |
|
138 | + public function defineRules(): array |
|
139 | + { |
|
140 | + $rules = parent::defineRules(); |
|
141 | + $rules = array_merge($rules, [ |
|
142 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
143 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
144 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
145 | + ]); |
|
146 | + |
|
147 | + return $rules; |
|
148 | + } |
|
149 | 149 | } |
@@ -24,135 +24,135 @@ |
||
24 | 24 | */ |
25 | 25 | class TelevisionChannel extends MetaJsonLd implements TelevisionChannelInterface, BroadcastChannelInterface, IntangibleInterface, ThingInterface |
26 | 26 | { |
27 | - use TelevisionChannelTrait; |
|
28 | - use BroadcastChannelTrait; |
|
29 | - use IntangibleTrait; |
|
30 | - use ThingTrait; |
|
31 | - |
|
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static $schemaTypeName = 'TelevisionChannel'; |
|
38 | - |
|
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static $schemaTypeScope = 'https://schema.org/TelevisionChannel'; |
|
45 | - |
|
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static $schemaTypeExtends = 'BroadcastChannel'; |
|
52 | - |
|
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static $schemaTypeDescription = 'A unique instance of a television BroadcastService on a CableOrSatelliteService lineup.'; |
|
59 | - |
|
60 | - |
|
61 | - /** |
|
62 | - * @inheritdoc |
|
63 | - */ |
|
64 | - public function getSchemaPropertyNames(): array |
|
65 | - { |
|
66 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
67 | - } |
|
68 | - |
|
69 | - |
|
70 | - /** |
|
71 | - * @inheritdoc |
|
72 | - */ |
|
73 | - public function getSchemaPropertyExpectedTypes(): array |
|
74 | - { |
|
75 | - return [ |
|
76 | - 'additionalType' => ['URL'], |
|
77 | - 'alternateName' => ['Text'], |
|
78 | - 'broadcastChannelId' => ['Text'], |
|
79 | - 'broadcastFrequency' => ['Text', 'BroadcastFrequencySpecification'], |
|
80 | - 'broadcastServiceTier' => ['Text'], |
|
81 | - 'description' => ['Text'], |
|
82 | - 'disambiguatingDescription' => ['Text'], |
|
83 | - 'genre' => ['Text', 'URL'], |
|
84 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
85 | - 'image' => ['URL', 'ImageObject'], |
|
86 | - 'inBroadcastLineup' => ['CableOrSatelliteService'], |
|
87 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
88 | - 'name' => ['Text'], |
|
89 | - 'potentialAction' => ['Action'], |
|
90 | - 'providesBroadcastService' => ['BroadcastService'], |
|
91 | - 'sameAs' => ['URL'], |
|
92 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
93 | - 'url' => ['URL'] |
|
94 | - ]; |
|
95 | - } |
|
96 | - |
|
97 | - |
|
98 | - /** |
|
99 | - * @inheritdoc |
|
100 | - */ |
|
101 | - public function getSchemaPropertyDescriptions(): array |
|
102 | - { |
|
103 | - return [ |
|
104 | - '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
105 | - 'alternateName' => 'An alias for the item.', |
|
106 | - 'broadcastChannelId' => 'The unique address by which the BroadcastService can be identified in a provider lineup. In US, this is typically a number.', |
|
107 | - 'broadcastFrequency' => 'The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. "87 FM".', |
|
108 | - 'broadcastServiceTier' => 'The type of service required to have access to the channel (e.g. Standard or Premium).', |
|
109 | - 'description' => 'A description of the item.', |
|
110 | - '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.', |
|
111 | - 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
112 | - '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. ', |
|
113 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
114 | - 'inBroadcastLineup' => 'The CableOrSatelliteService offering the channel.', |
|
115 | - '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.', |
|
116 | - 'name' => 'The name of the item.', |
|
117 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
118 | - 'providesBroadcastService' => 'The BroadcastService offered on this channel.', |
|
119 | - '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.', |
|
120 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
121 | - 'url' => 'URL of the item.' |
|
122 | - ]; |
|
123 | - } |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @inheritdoc |
|
128 | - */ |
|
129 | - public function getGoogleRequiredSchema(): array |
|
130 | - { |
|
131 | - return ['description', 'name']; |
|
132 | - } |
|
133 | - |
|
134 | - |
|
135 | - /** |
|
136 | - * @inheritdoc |
|
137 | - */ |
|
138 | - public function getGoogleRecommendedSchema(): array |
|
139 | - { |
|
140 | - return ['image', 'url']; |
|
141 | - } |
|
142 | - |
|
143 | - |
|
144 | - /** |
|
145 | - * @inheritdoc |
|
146 | - */ |
|
147 | - public function defineRules(): array |
|
148 | - { |
|
149 | - $rules = parent::defineRules(); |
|
150 | - $rules = array_merge($rules, [ |
|
151 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
152 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
153 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
154 | - ]); |
|
155 | - |
|
156 | - return $rules; |
|
157 | - } |
|
27 | + use TelevisionChannelTrait; |
|
28 | + use BroadcastChannelTrait; |
|
29 | + use IntangibleTrait; |
|
30 | + use ThingTrait; |
|
31 | + |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static $schemaTypeName = 'TelevisionChannel'; |
|
38 | + |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static $schemaTypeScope = 'https://schema.org/TelevisionChannel'; |
|
45 | + |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static $schemaTypeExtends = 'BroadcastChannel'; |
|
52 | + |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static $schemaTypeDescription = 'A unique instance of a television BroadcastService on a CableOrSatelliteService lineup.'; |
|
59 | + |
|
60 | + |
|
61 | + /** |
|
62 | + * @inheritdoc |
|
63 | + */ |
|
64 | + public function getSchemaPropertyNames(): array |
|
65 | + { |
|
66 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
67 | + } |
|
68 | + |
|
69 | + |
|
70 | + /** |
|
71 | + * @inheritdoc |
|
72 | + */ |
|
73 | + public function getSchemaPropertyExpectedTypes(): array |
|
74 | + { |
|
75 | + return [ |
|
76 | + 'additionalType' => ['URL'], |
|
77 | + 'alternateName' => ['Text'], |
|
78 | + 'broadcastChannelId' => ['Text'], |
|
79 | + 'broadcastFrequency' => ['Text', 'BroadcastFrequencySpecification'], |
|
80 | + 'broadcastServiceTier' => ['Text'], |
|
81 | + 'description' => ['Text'], |
|
82 | + 'disambiguatingDescription' => ['Text'], |
|
83 | + 'genre' => ['Text', 'URL'], |
|
84 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
85 | + 'image' => ['URL', 'ImageObject'], |
|
86 | + 'inBroadcastLineup' => ['CableOrSatelliteService'], |
|
87 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
88 | + 'name' => ['Text'], |
|
89 | + 'potentialAction' => ['Action'], |
|
90 | + 'providesBroadcastService' => ['BroadcastService'], |
|
91 | + 'sameAs' => ['URL'], |
|
92 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
93 | + 'url' => ['URL'] |
|
94 | + ]; |
|
95 | + } |
|
96 | + |
|
97 | + |
|
98 | + /** |
|
99 | + * @inheritdoc |
|
100 | + */ |
|
101 | + public function getSchemaPropertyDescriptions(): array |
|
102 | + { |
|
103 | + return [ |
|
104 | + '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
105 | + 'alternateName' => 'An alias for the item.', |
|
106 | + 'broadcastChannelId' => 'The unique address by which the BroadcastService can be identified in a provider lineup. In US, this is typically a number.', |
|
107 | + 'broadcastFrequency' => 'The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. "87 FM".', |
|
108 | + 'broadcastServiceTier' => 'The type of service required to have access to the channel (e.g. Standard or Premium).', |
|
109 | + 'description' => 'A description of the item.', |
|
110 | + '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.', |
|
111 | + 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
112 | + '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. ', |
|
113 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
114 | + 'inBroadcastLineup' => 'The CableOrSatelliteService offering the channel.', |
|
115 | + '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.', |
|
116 | + 'name' => 'The name of the item.', |
|
117 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
118 | + 'providesBroadcastService' => 'The BroadcastService offered on this channel.', |
|
119 | + '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.', |
|
120 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
121 | + 'url' => 'URL of the item.' |
|
122 | + ]; |
|
123 | + } |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @inheritdoc |
|
128 | + */ |
|
129 | + public function getGoogleRequiredSchema(): array |
|
130 | + { |
|
131 | + return ['description', 'name']; |
|
132 | + } |
|
133 | + |
|
134 | + |
|
135 | + /** |
|
136 | + * @inheritdoc |
|
137 | + */ |
|
138 | + public function getGoogleRecommendedSchema(): array |
|
139 | + { |
|
140 | + return ['image', 'url']; |
|
141 | + } |
|
142 | + |
|
143 | + |
|
144 | + /** |
|
145 | + * @inheritdoc |
|
146 | + */ |
|
147 | + public function defineRules(): array |
|
148 | + { |
|
149 | + $rules = parent::defineRules(); |
|
150 | + $rules = array_merge($rules, [ |
|
151 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
152 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
153 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
154 | + ]); |
|
155 | + |
|
156 | + return $rules; |
|
157 | + } |
|
158 | 158 | } |
@@ -23,158 +23,158 @@ |
||
23 | 23 | */ |
24 | 24 | class UnitPriceSpecification extends MetaJsonLd implements UnitPriceSpecificationInterface, PriceSpecificationInterface, StructuredValueInterface, IntangibleInterface, ThingInterface |
25 | 25 | { |
26 | - use UnitPriceSpecificationTrait; |
|
27 | - use PriceSpecificationTrait; |
|
28 | - use StructuredValueTrait; |
|
29 | - use IntangibleTrait; |
|
30 | - use ThingTrait; |
|
31 | - |
|
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static $schemaTypeName = 'UnitPriceSpecification'; |
|
38 | - |
|
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static $schemaTypeScope = 'https://schema.org/UnitPriceSpecification'; |
|
45 | - |
|
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static $schemaTypeExtends = 'PriceSpecification'; |
|
52 | - |
|
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static $schemaTypeDescription = 'The price asked for a given offer by the respective organization or person.'; |
|
59 | - |
|
60 | - |
|
61 | - /** |
|
62 | - * @inheritdoc |
|
63 | - */ |
|
64 | - public function getSchemaPropertyNames(): array |
|
65 | - { |
|
66 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
67 | - } |
|
68 | - |
|
69 | - |
|
70 | - /** |
|
71 | - * @inheritdoc |
|
72 | - */ |
|
73 | - public function getSchemaPropertyExpectedTypes(): array |
|
74 | - { |
|
75 | - return [ |
|
76 | - 'additionalType' => ['URL'], |
|
77 | - 'alternateName' => ['Text'], |
|
78 | - 'billingDuration' => ['Number', 'QuantitativeValue', 'Duration'], |
|
79 | - 'billingIncrement' => ['Number'], |
|
80 | - 'billingStart' => ['Number'], |
|
81 | - 'description' => ['Text'], |
|
82 | - 'disambiguatingDescription' => ['Text'], |
|
83 | - 'eligibleQuantity' => ['QuantitativeValue'], |
|
84 | - 'eligibleTransactionVolume' => ['PriceSpecification'], |
|
85 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
86 | - 'image' => ['URL', 'ImageObject'], |
|
87 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
88 | - 'maxPrice' => ['Number'], |
|
89 | - 'minPrice' => ['Number'], |
|
90 | - 'name' => ['Text'], |
|
91 | - 'potentialAction' => ['Action'], |
|
92 | - 'price' => ['Text', 'Number'], |
|
93 | - 'priceComponentType' => ['PriceComponentTypeEnumeration'], |
|
94 | - 'priceCurrency' => ['Text'], |
|
95 | - 'priceType' => ['Text', 'PriceTypeEnumeration'], |
|
96 | - 'referenceQuantity' => ['QuantitativeValue'], |
|
97 | - 'sameAs' => ['URL'], |
|
98 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
99 | - 'unitCode' => ['Text', 'URL'], |
|
100 | - 'unitText' => ['Text'], |
|
101 | - 'url' => ['URL'], |
|
102 | - 'validFrom' => ['Date', 'DateTime'], |
|
103 | - 'validThrough' => ['Date', 'DateTime'], |
|
104 | - 'valueAddedTaxIncluded' => ['Boolean'] |
|
105 | - ]; |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * @inheritdoc |
|
111 | - */ |
|
112 | - public function getSchemaPropertyDescriptions(): array |
|
113 | - { |
|
114 | - return [ |
|
115 | - '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
116 | - 'alternateName' => 'An alias for the item.', |
|
117 | - 'billingDuration' => 'Specifies for how long this price (or price component) will be billed. Can be used, for example, to model the contractual duration of a subscription or payment plan. Type can be either a Duration or a Number (in which case the unit of measurement, for example month, is specified by the unitCode property).', |
|
118 | - 'billingIncrement' => 'This property specifies the minimal quantity and rounding increment that will be the basis for the billing. The unit of measurement is specified by the unitCode property.', |
|
119 | - 'billingStart' => 'Specifies after how much time this price (or price component) becomes valid and billing starts. Can be used, for example, to model a price increase after the first year of a subscription. The unit of measurement is specified by the unitCode property.', |
|
120 | - 'description' => 'A description of the item.', |
|
121 | - '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.', |
|
122 | - 'eligibleQuantity' => 'The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.', |
|
123 | - 'eligibleTransactionVolume' => 'The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.', |
|
124 | - '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. ', |
|
125 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
126 | - '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.', |
|
127 | - 'maxPrice' => 'The highest price if the price is a range.', |
|
128 | - 'minPrice' => 'The lowest price if the price is a range.', |
|
129 | - 'name' => 'The name of the item.', |
|
130 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
131 | - 'price' => 'The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes. Usage guidelines: * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as \'$\' in the value. * Use \'.\' (Unicode \'FULL STOP\' (U+002E)) rather than \',\' to indicate a decimal point. Avoid using these symbols as a readability separator. * Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting. * Use values from 0123456789 (Unicode \'DIGIT ZERO\' (U+0030) to \'DIGIT NINE\' (U+0039)) rather than superficially similar Unicode symbols. ', |
|
132 | - 'priceComponentType' => 'Identifies a price component (for example, a line item on an invoice), part of the total price for an offer.', |
|
133 | - 'priceCurrency' => 'The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes. Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".', |
|
134 | - 'priceType' => 'Defines the type of a price specified for an offered product, for example a list price, a (temporary) sale price or a manufacturer suggested retail price. If multiple prices are specified for an offer the [[priceType]] property can be used to identify the type of each such specified price. The value of priceType can be specified as a value from enumeration PriceTypeEnumeration or as a free form text string for price types that are not already predefined in PriceTypeEnumeration.', |
|
135 | - 'referenceQuantity' => 'The reference quantity for which a certain price applies, e.g. 1 EUR per 4 kWh of electricity. This property is a replacement for unitOfMeasurement for the advanced cases where the price does not relate to a standard unit.', |
|
136 | - '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.', |
|
137 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
138 | - '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.', |
|
139 | - '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>.', |
|
140 | - 'url' => 'URL of the item.', |
|
141 | - 'validFrom' => 'The date when the item becomes valid.', |
|
142 | - 'validThrough' => 'The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.', |
|
143 | - 'valueAddedTaxIncluded' => 'Specifies whether the applicable value-added tax (VAT) is included in the price specification or not.' |
|
144 | - ]; |
|
145 | - } |
|
146 | - |
|
147 | - |
|
148 | - /** |
|
149 | - * @inheritdoc |
|
150 | - */ |
|
151 | - public function getGoogleRequiredSchema(): array |
|
152 | - { |
|
153 | - return ['description', 'name']; |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * @inheritdoc |
|
159 | - */ |
|
160 | - public function getGoogleRecommendedSchema(): array |
|
161 | - { |
|
162 | - return ['image', 'url']; |
|
163 | - } |
|
164 | - |
|
165 | - |
|
166 | - /** |
|
167 | - * @inheritdoc |
|
168 | - */ |
|
169 | - public function defineRules(): array |
|
170 | - { |
|
171 | - $rules = parent::defineRules(); |
|
172 | - $rules = array_merge($rules, [ |
|
173 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
174 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
175 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
176 | - ]); |
|
177 | - |
|
178 | - return $rules; |
|
179 | - } |
|
26 | + use UnitPriceSpecificationTrait; |
|
27 | + use PriceSpecificationTrait; |
|
28 | + use StructuredValueTrait; |
|
29 | + use IntangibleTrait; |
|
30 | + use ThingTrait; |
|
31 | + |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static $schemaTypeName = 'UnitPriceSpecification'; |
|
38 | + |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static $schemaTypeScope = 'https://schema.org/UnitPriceSpecification'; |
|
45 | + |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static $schemaTypeExtends = 'PriceSpecification'; |
|
52 | + |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static $schemaTypeDescription = 'The price asked for a given offer by the respective organization or person.'; |
|
59 | + |
|
60 | + |
|
61 | + /** |
|
62 | + * @inheritdoc |
|
63 | + */ |
|
64 | + public function getSchemaPropertyNames(): array |
|
65 | + { |
|
66 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
67 | + } |
|
68 | + |
|
69 | + |
|
70 | + /** |
|
71 | + * @inheritdoc |
|
72 | + */ |
|
73 | + public function getSchemaPropertyExpectedTypes(): array |
|
74 | + { |
|
75 | + return [ |
|
76 | + 'additionalType' => ['URL'], |
|
77 | + 'alternateName' => ['Text'], |
|
78 | + 'billingDuration' => ['Number', 'QuantitativeValue', 'Duration'], |
|
79 | + 'billingIncrement' => ['Number'], |
|
80 | + 'billingStart' => ['Number'], |
|
81 | + 'description' => ['Text'], |
|
82 | + 'disambiguatingDescription' => ['Text'], |
|
83 | + 'eligibleQuantity' => ['QuantitativeValue'], |
|
84 | + 'eligibleTransactionVolume' => ['PriceSpecification'], |
|
85 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
86 | + 'image' => ['URL', 'ImageObject'], |
|
87 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
88 | + 'maxPrice' => ['Number'], |
|
89 | + 'minPrice' => ['Number'], |
|
90 | + 'name' => ['Text'], |
|
91 | + 'potentialAction' => ['Action'], |
|
92 | + 'price' => ['Text', 'Number'], |
|
93 | + 'priceComponentType' => ['PriceComponentTypeEnumeration'], |
|
94 | + 'priceCurrency' => ['Text'], |
|
95 | + 'priceType' => ['Text', 'PriceTypeEnumeration'], |
|
96 | + 'referenceQuantity' => ['QuantitativeValue'], |
|
97 | + 'sameAs' => ['URL'], |
|
98 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
99 | + 'unitCode' => ['Text', 'URL'], |
|
100 | + 'unitText' => ['Text'], |
|
101 | + 'url' => ['URL'], |
|
102 | + 'validFrom' => ['Date', 'DateTime'], |
|
103 | + 'validThrough' => ['Date', 'DateTime'], |
|
104 | + 'valueAddedTaxIncluded' => ['Boolean'] |
|
105 | + ]; |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * @inheritdoc |
|
111 | + */ |
|
112 | + public function getSchemaPropertyDescriptions(): array |
|
113 | + { |
|
114 | + return [ |
|
115 | + '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
116 | + 'alternateName' => 'An alias for the item.', |
|
117 | + 'billingDuration' => 'Specifies for how long this price (or price component) will be billed. Can be used, for example, to model the contractual duration of a subscription or payment plan. Type can be either a Duration or a Number (in which case the unit of measurement, for example month, is specified by the unitCode property).', |
|
118 | + 'billingIncrement' => 'This property specifies the minimal quantity and rounding increment that will be the basis for the billing. The unit of measurement is specified by the unitCode property.', |
|
119 | + 'billingStart' => 'Specifies after how much time this price (or price component) becomes valid and billing starts. Can be used, for example, to model a price increase after the first year of a subscription. The unit of measurement is specified by the unitCode property.', |
|
120 | + 'description' => 'A description of the item.', |
|
121 | + '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.', |
|
122 | + 'eligibleQuantity' => 'The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.', |
|
123 | + 'eligibleTransactionVolume' => 'The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.', |
|
124 | + '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. ', |
|
125 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
126 | + '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.', |
|
127 | + 'maxPrice' => 'The highest price if the price is a range.', |
|
128 | + 'minPrice' => 'The lowest price if the price is a range.', |
|
129 | + 'name' => 'The name of the item.', |
|
130 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
131 | + 'price' => 'The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes. Usage guidelines: * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as \'$\' in the value. * Use \'.\' (Unicode \'FULL STOP\' (U+002E)) rather than \',\' to indicate a decimal point. Avoid using these symbols as a readability separator. * Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting. * Use values from 0123456789 (Unicode \'DIGIT ZERO\' (U+0030) to \'DIGIT NINE\' (U+0039)) rather than superficially similar Unicode symbols. ', |
|
132 | + 'priceComponentType' => 'Identifies a price component (for example, a line item on an invoice), part of the total price for an offer.', |
|
133 | + 'priceCurrency' => 'The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes. Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".', |
|
134 | + 'priceType' => 'Defines the type of a price specified for an offered product, for example a list price, a (temporary) sale price or a manufacturer suggested retail price. If multiple prices are specified for an offer the [[priceType]] property can be used to identify the type of each such specified price. The value of priceType can be specified as a value from enumeration PriceTypeEnumeration or as a free form text string for price types that are not already predefined in PriceTypeEnumeration.', |
|
135 | + 'referenceQuantity' => 'The reference quantity for which a certain price applies, e.g. 1 EUR per 4 kWh of electricity. This property is a replacement for unitOfMeasurement for the advanced cases where the price does not relate to a standard unit.', |
|
136 | + '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.', |
|
137 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
138 | + '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.', |
|
139 | + '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>.', |
|
140 | + 'url' => 'URL of the item.', |
|
141 | + 'validFrom' => 'The date when the item becomes valid.', |
|
142 | + 'validThrough' => 'The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.', |
|
143 | + 'valueAddedTaxIncluded' => 'Specifies whether the applicable value-added tax (VAT) is included in the price specification or not.' |
|
144 | + ]; |
|
145 | + } |
|
146 | + |
|
147 | + |
|
148 | + /** |
|
149 | + * @inheritdoc |
|
150 | + */ |
|
151 | + public function getGoogleRequiredSchema(): array |
|
152 | + { |
|
153 | + return ['description', 'name']; |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * @inheritdoc |
|
159 | + */ |
|
160 | + public function getGoogleRecommendedSchema(): array |
|
161 | + { |
|
162 | + return ['image', 'url']; |
|
163 | + } |
|
164 | + |
|
165 | + |
|
166 | + /** |
|
167 | + * @inheritdoc |
|
168 | + */ |
|
169 | + public function defineRules(): array |
|
170 | + { |
|
171 | + $rules = parent::defineRules(); |
|
172 | + $rules = array_merge($rules, [ |
|
173 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
174 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
175 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
176 | + ]); |
|
177 | + |
|
178 | + return $rules; |
|
179 | + } |
|
180 | 180 | } |
@@ -24,145 +24,145 @@ |
||
24 | 24 | */ |
25 | 25 | class MedicalRiskScore extends MetaJsonLd implements MedicalRiskScoreInterface, MedicalRiskEstimatorInterface, MedicalEntityInterface, ThingInterface |
26 | 26 | { |
27 | - use MedicalRiskScoreTrait; |
|
28 | - use MedicalRiskEstimatorTrait; |
|
29 | - use MedicalEntityTrait; |
|
30 | - use ThingTrait; |
|
31 | - |
|
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static $schemaTypeName = 'MedicalRiskScore'; |
|
38 | - |
|
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static $schemaTypeScope = 'https://schema.org/MedicalRiskScore'; |
|
45 | - |
|
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static $schemaTypeExtends = 'MedicalRiskEstimator'; |
|
52 | - |
|
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static $schemaTypeDescription = 'A simple system that adds up the number of risk factors to yield a score that is associated with prognosis, e.g. CHAD score, TIMI risk score.'; |
|
59 | - |
|
60 | - |
|
61 | - /** |
|
62 | - * @inheritdoc |
|
63 | - */ |
|
64 | - public function getSchemaPropertyNames(): array |
|
65 | - { |
|
66 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
67 | - } |
|
68 | - |
|
69 | - |
|
70 | - /** |
|
71 | - * @inheritdoc |
|
72 | - */ |
|
73 | - public function getSchemaPropertyExpectedTypes(): array |
|
74 | - { |
|
75 | - return [ |
|
76 | - 'additionalType' => ['URL'], |
|
77 | - 'algorithm' => ['Text'], |
|
78 | - 'alternateName' => ['Text'], |
|
79 | - 'code' => ['MedicalCode'], |
|
80 | - 'description' => ['Text'], |
|
81 | - 'disambiguatingDescription' => ['Text'], |
|
82 | - 'estimatesRiskOf' => ['MedicalEntity'], |
|
83 | - 'funding' => ['Grant'], |
|
84 | - 'guideline' => ['MedicalGuideline'], |
|
85 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
86 | - 'image' => ['URL', 'ImageObject'], |
|
87 | - 'includedRiskFactor' => ['MedicalRiskFactor'], |
|
88 | - 'legalStatus' => ['Text', 'DrugLegalStatus', 'MedicalEnumeration'], |
|
89 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
90 | - 'medicineSystem' => ['MedicineSystem'], |
|
91 | - 'name' => ['Text'], |
|
92 | - 'potentialAction' => ['Action'], |
|
93 | - 'recognizingAuthority' => ['Organization'], |
|
94 | - 'relevantSpecialty' => ['MedicalSpecialty'], |
|
95 | - 'sameAs' => ['URL'], |
|
96 | - 'study' => ['MedicalStudy'], |
|
97 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
98 | - 'url' => ['URL'] |
|
99 | - ]; |
|
100 | - } |
|
101 | - |
|
102 | - |
|
103 | - /** |
|
104 | - * @inheritdoc |
|
105 | - */ |
|
106 | - public function getSchemaPropertyDescriptions(): array |
|
107 | - { |
|
108 | - return [ |
|
109 | - '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
110 | - 'algorithm' => 'The algorithm or rules to follow to compute the score.', |
|
111 | - 'alternateName' => 'An alias for the item.', |
|
112 | - 'code' => 'A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.', |
|
113 | - 'description' => 'A description of the item.', |
|
114 | - '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.', |
|
115 | - 'estimatesRiskOf' => 'The condition, complication, or symptom whose risk is being estimated.', |
|
116 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
117 | - 'guideline' => 'A medical guideline related to this entity.', |
|
118 | - '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. ', |
|
119 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
120 | - 'includedRiskFactor' => 'A modifiable or non-modifiable risk factor included in the calculation, e.g. age, coexisting condition.', |
|
121 | - 'legalStatus' => 'The drug or supplement\'s legal status, including any controlled substance schedules that apply.', |
|
122 | - '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.', |
|
123 | - 'medicineSystem' => 'The system of medicine that includes this MedicalEntity, for example \'evidence-based\', \'homeopathic\', \'chiropractic\', etc.', |
|
124 | - 'name' => 'The name of the item.', |
|
125 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
126 | - 'recognizingAuthority' => 'If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.', |
|
127 | - 'relevantSpecialty' => 'If applicable, a medical specialty in which this entity is relevant.', |
|
128 | - '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.', |
|
129 | - 'study' => 'A medical study or trial related to this entity.', |
|
130 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
131 | - 'url' => 'URL of the item.' |
|
132 | - ]; |
|
133 | - } |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * @inheritdoc |
|
138 | - */ |
|
139 | - public function getGoogleRequiredSchema(): array |
|
140 | - { |
|
141 | - return ['description', 'name']; |
|
142 | - } |
|
143 | - |
|
144 | - |
|
145 | - /** |
|
146 | - * @inheritdoc |
|
147 | - */ |
|
148 | - public function getGoogleRecommendedSchema(): array |
|
149 | - { |
|
150 | - return ['image', 'url']; |
|
151 | - } |
|
152 | - |
|
153 | - |
|
154 | - /** |
|
155 | - * @inheritdoc |
|
156 | - */ |
|
157 | - public function defineRules(): array |
|
158 | - { |
|
159 | - $rules = parent::defineRules(); |
|
160 | - $rules = array_merge($rules, [ |
|
161 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
162 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
163 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
164 | - ]); |
|
165 | - |
|
166 | - return $rules; |
|
167 | - } |
|
27 | + use MedicalRiskScoreTrait; |
|
28 | + use MedicalRiskEstimatorTrait; |
|
29 | + use MedicalEntityTrait; |
|
30 | + use ThingTrait; |
|
31 | + |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static $schemaTypeName = 'MedicalRiskScore'; |
|
38 | + |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static $schemaTypeScope = 'https://schema.org/MedicalRiskScore'; |
|
45 | + |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static $schemaTypeExtends = 'MedicalRiskEstimator'; |
|
52 | + |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static $schemaTypeDescription = 'A simple system that adds up the number of risk factors to yield a score that is associated with prognosis, e.g. CHAD score, TIMI risk score.'; |
|
59 | + |
|
60 | + |
|
61 | + /** |
|
62 | + * @inheritdoc |
|
63 | + */ |
|
64 | + public function getSchemaPropertyNames(): array |
|
65 | + { |
|
66 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
67 | + } |
|
68 | + |
|
69 | + |
|
70 | + /** |
|
71 | + * @inheritdoc |
|
72 | + */ |
|
73 | + public function getSchemaPropertyExpectedTypes(): array |
|
74 | + { |
|
75 | + return [ |
|
76 | + 'additionalType' => ['URL'], |
|
77 | + 'algorithm' => ['Text'], |
|
78 | + 'alternateName' => ['Text'], |
|
79 | + 'code' => ['MedicalCode'], |
|
80 | + 'description' => ['Text'], |
|
81 | + 'disambiguatingDescription' => ['Text'], |
|
82 | + 'estimatesRiskOf' => ['MedicalEntity'], |
|
83 | + 'funding' => ['Grant'], |
|
84 | + 'guideline' => ['MedicalGuideline'], |
|
85 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
86 | + 'image' => ['URL', 'ImageObject'], |
|
87 | + 'includedRiskFactor' => ['MedicalRiskFactor'], |
|
88 | + 'legalStatus' => ['Text', 'DrugLegalStatus', 'MedicalEnumeration'], |
|
89 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
90 | + 'medicineSystem' => ['MedicineSystem'], |
|
91 | + 'name' => ['Text'], |
|
92 | + 'potentialAction' => ['Action'], |
|
93 | + 'recognizingAuthority' => ['Organization'], |
|
94 | + 'relevantSpecialty' => ['MedicalSpecialty'], |
|
95 | + 'sameAs' => ['URL'], |
|
96 | + 'study' => ['MedicalStudy'], |
|
97 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
98 | + 'url' => ['URL'] |
|
99 | + ]; |
|
100 | + } |
|
101 | + |
|
102 | + |
|
103 | + /** |
|
104 | + * @inheritdoc |
|
105 | + */ |
|
106 | + public function getSchemaPropertyDescriptions(): array |
|
107 | + { |
|
108 | + return [ |
|
109 | + '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
110 | + 'algorithm' => 'The algorithm or rules to follow to compute the score.', |
|
111 | + 'alternateName' => 'An alias for the item.', |
|
112 | + 'code' => 'A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.', |
|
113 | + 'description' => 'A description of the item.', |
|
114 | + '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.', |
|
115 | + 'estimatesRiskOf' => 'The condition, complication, or symptom whose risk is being estimated.', |
|
116 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
117 | + 'guideline' => 'A medical guideline related to this entity.', |
|
118 | + '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. ', |
|
119 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
120 | + 'includedRiskFactor' => 'A modifiable or non-modifiable risk factor included in the calculation, e.g. age, coexisting condition.', |
|
121 | + 'legalStatus' => 'The drug or supplement\'s legal status, including any controlled substance schedules that apply.', |
|
122 | + '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.', |
|
123 | + 'medicineSystem' => 'The system of medicine that includes this MedicalEntity, for example \'evidence-based\', \'homeopathic\', \'chiropractic\', etc.', |
|
124 | + 'name' => 'The name of the item.', |
|
125 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
126 | + 'recognizingAuthority' => 'If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.', |
|
127 | + 'relevantSpecialty' => 'If applicable, a medical specialty in which this entity is relevant.', |
|
128 | + '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.', |
|
129 | + 'study' => 'A medical study or trial related to this entity.', |
|
130 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
131 | + 'url' => 'URL of the item.' |
|
132 | + ]; |
|
133 | + } |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * @inheritdoc |
|
138 | + */ |
|
139 | + public function getGoogleRequiredSchema(): array |
|
140 | + { |
|
141 | + return ['description', 'name']; |
|
142 | + } |
|
143 | + |
|
144 | + |
|
145 | + /** |
|
146 | + * @inheritdoc |
|
147 | + */ |
|
148 | + public function getGoogleRecommendedSchema(): array |
|
149 | + { |
|
150 | + return ['image', 'url']; |
|
151 | + } |
|
152 | + |
|
153 | + |
|
154 | + /** |
|
155 | + * @inheritdoc |
|
156 | + */ |
|
157 | + public function defineRules(): array |
|
158 | + { |
|
159 | + $rules = parent::defineRules(); |
|
160 | + $rules = array_merge($rules, [ |
|
161 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
162 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
163 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
164 | + ]); |
|
165 | + |
|
166 | + return $rules; |
|
167 | + } |
|
168 | 168 | } |
@@ -82,372 +82,372 @@ |
||
82 | 82 | */ |
83 | 83 | class SpecialAnnouncement extends MetaJsonLd implements SpecialAnnouncementInterface, CreativeWorkInterface, ThingInterface |
84 | 84 | { |
85 | - use SpecialAnnouncementTrait; |
|
86 | - use CreativeWorkTrait; |
|
87 | - use ThingTrait; |
|
85 | + use SpecialAnnouncementTrait; |
|
86 | + use CreativeWorkTrait; |
|
87 | + use ThingTrait; |
|
88 | 88 | |
89 | - /** |
|
90 | - * The Schema.org Type Name |
|
91 | - * |
|
92 | - * @var string |
|
93 | - */ |
|
94 | - public static $schemaTypeName = 'SpecialAnnouncement'; |
|
89 | + /** |
|
90 | + * The Schema.org Type Name |
|
91 | + * |
|
92 | + * @var string |
|
93 | + */ |
|
94 | + public static $schemaTypeName = 'SpecialAnnouncement'; |
|
95 | 95 | |
96 | - /** |
|
97 | - * The Schema.org Type Scope |
|
98 | - * |
|
99 | - * @var string |
|
100 | - */ |
|
101 | - public static $schemaTypeScope = 'https://schema.org/SpecialAnnouncement'; |
|
96 | + /** |
|
97 | + * The Schema.org Type Scope |
|
98 | + * |
|
99 | + * @var string |
|
100 | + */ |
|
101 | + public static $schemaTypeScope = 'https://schema.org/SpecialAnnouncement'; |
|
102 | 102 | |
103 | - /** |
|
104 | - * The Schema.org Type Extends |
|
105 | - * |
|
106 | - * @var string |
|
107 | - */ |
|
108 | - public static $schemaTypeExtends = 'CreativeWork'; |
|
103 | + /** |
|
104 | + * The Schema.org Type Extends |
|
105 | + * |
|
106 | + * @var string |
|
107 | + */ |
|
108 | + public static $schemaTypeExtends = 'CreativeWork'; |
|
109 | 109 | |
110 | - /** |
|
111 | - * The Schema.org Type Description |
|
112 | - * |
|
113 | - * @var string |
|
114 | - */ |
|
115 | - public static $schemaTypeDescription = "A SpecialAnnouncement combines a simple date-stamped textual information update\n with contextualized Web links and other structured data. It represents an information update made by a\n locally-oriented organization, for example schools, pharmacies, healthcare providers, community groups, police,\n local government.\n\nFor work in progress guidelines on Coronavirus-related markup see [this doc](https://docs.google.com/document/d/14ikaGCKxo50rRM7nvKSlbUpjyIk2WMQd3IkB1lItlrM/edit#).\n\nThe motivating scenario for SpecialAnnouncement is the [Coronavirus pandemic](https://en.wikipedia.org/wiki/2019%E2%80%9320_coronavirus_pandemic), and the initial vocabulary is oriented to this urgent situation. Schema.org\nexpect to improve the markup iteratively as it is deployed and as feedback emerges from use. In addition to our\nusual [Github entry](https://github.com/schemaorg/schemaorg/issues/2490), feedback comments can also be provided in [this document](https://docs.google.com/document/d/1fpdFFxk8s87CWwACs53SGkYv3aafSxz_DTtOQxMrBJQ/edit#).\n\n\nWhile this schema is designed to communicate urgent crisis-related information, it is not the same as an emergency warning technology like [CAP](https://en.wikipedia.org/wiki/Common_Alerting_Protocol), although there may be overlaps. The intent is to cover\nthe kinds of everyday practical information being posted to existing websites during an emergency situation.\n\nSeveral kinds of information can be provided:\n\nWe encourage the provision of \"name\", \"text\", \"datePosted\", \"expires\" (if appropriate), \"category\" and\n\"url\" as a simple baseline. It is important to provide a value for \"category\" where possible, most ideally as a well known\nURL from Wikipedia or Wikidata. In the case of the 2019-2020 Coronavirus pandemic, this should be \"https://en.wikipedia.org/w/index.php?title=2019-20\\_coronavirus\\_pandemic\" or \"https://www.wikidata.org/wiki/Q81068910\".\n\nFor many of the possible properties, values can either be simple links or an inline description, depending on whether a summary is available. For a link, provide just the URL of the appropriate page as the property's value. For an inline description, use a [[WebContent]] type, and provide the url as a property of that, alongside at least a simple \"[[text]]\" summary of the page. It is\nunlikely that a single SpecialAnnouncement will need all of the possible properties simultaneously.\n\nWe expect that in many cases the page referenced might contain more specialized structured data, e.g. contact info, [[openingHours]], [[Event]], [[FAQPage]] etc. By linking to those pages from a [[SpecialAnnouncement]] you can help make it clearer that the events are related to the situation (e.g. Coronavirus) indicated by the [[category]] property of the [[SpecialAnnouncement]].\n\nMany [[SpecialAnnouncement]]s will relate to particular regions and to identifiable local organizations. Use [[spatialCoverage]] for the region, and [[announcementLocation]] to indicate specific [[LocalBusiness]]es and [[CivicStructure]]s. If the announcement affects both a particular region and a specific location (for example, a library closure that serves an entire region), use both [[spatialCoverage]] and [[announcementLocation]].\n\nThe [[about]] property can be used to indicate entities that are the focus of the announcement. We now recommend using [[about]] only\nfor representing non-location entities (e.g. a [[Course]] or a [[RadioStation]]). For places, use [[announcementLocation]] and [[spatialCoverage]]. Consumers of this markup should be aware that the initial design encouraged the use of [[about]] for locations too.\n\nThe basic content of [[SpecialAnnouncement]] is similar to that of an [RSS](https://en.wikipedia.org/wiki/RSS) or [Atom](https://en.wikipedia.org/wiki/Atom_(Web_standard)) feed. For publishers without such feeds, basic feed-like information can be shared by posting\n[[SpecialAnnouncement]] updates in a page, e.g. using JSON-LD. For sites with Atom/RSS functionality, you can point to a feed\nwith the [[webFeed]] property. This can be a simple URL, or an inline [[DataFeed]] object, with [[encodingFormat]] providing\nmedia type information, e.g. \"application/rss+xml\" or \"application/atom+xml\"."; |
|
110 | + /** |
|
111 | + * The Schema.org Type Description |
|
112 | + * |
|
113 | + * @var string |
|
114 | + */ |
|
115 | + public static $schemaTypeDescription = "A SpecialAnnouncement combines a simple date-stamped textual information update\n with contextualized Web links and other structured data. It represents an information update made by a\n locally-oriented organization, for example schools, pharmacies, healthcare providers, community groups, police,\n local government.\n\nFor work in progress guidelines on Coronavirus-related markup see [this doc](https://docs.google.com/document/d/14ikaGCKxo50rRM7nvKSlbUpjyIk2WMQd3IkB1lItlrM/edit#).\n\nThe motivating scenario for SpecialAnnouncement is the [Coronavirus pandemic](https://en.wikipedia.org/wiki/2019%E2%80%9320_coronavirus_pandemic), and the initial vocabulary is oriented to this urgent situation. Schema.org\nexpect to improve the markup iteratively as it is deployed and as feedback emerges from use. In addition to our\nusual [Github entry](https://github.com/schemaorg/schemaorg/issues/2490), feedback comments can also be provided in [this document](https://docs.google.com/document/d/1fpdFFxk8s87CWwACs53SGkYv3aafSxz_DTtOQxMrBJQ/edit#).\n\n\nWhile this schema is designed to communicate urgent crisis-related information, it is not the same as an emergency warning technology like [CAP](https://en.wikipedia.org/wiki/Common_Alerting_Protocol), although there may be overlaps. The intent is to cover\nthe kinds of everyday practical information being posted to existing websites during an emergency situation.\n\nSeveral kinds of information can be provided:\n\nWe encourage the provision of \"name\", \"text\", \"datePosted\", \"expires\" (if appropriate), \"category\" and\n\"url\" as a simple baseline. It is important to provide a value for \"category\" where possible, most ideally as a well known\nURL from Wikipedia or Wikidata. In the case of the 2019-2020 Coronavirus pandemic, this should be \"https://en.wikipedia.org/w/index.php?title=2019-20\\_coronavirus\\_pandemic\" or \"https://www.wikidata.org/wiki/Q81068910\".\n\nFor many of the possible properties, values can either be simple links or an inline description, depending on whether a summary is available. For a link, provide just the URL of the appropriate page as the property's value. For an inline description, use a [[WebContent]] type, and provide the url as a property of that, alongside at least a simple \"[[text]]\" summary of the page. It is\nunlikely that a single SpecialAnnouncement will need all of the possible properties simultaneously.\n\nWe expect that in many cases the page referenced might contain more specialized structured data, e.g. contact info, [[openingHours]], [[Event]], [[FAQPage]] etc. By linking to those pages from a [[SpecialAnnouncement]] you can help make it clearer that the events are related to the situation (e.g. Coronavirus) indicated by the [[category]] property of the [[SpecialAnnouncement]].\n\nMany [[SpecialAnnouncement]]s will relate to particular regions and to identifiable local organizations. Use [[spatialCoverage]] for the region, and [[announcementLocation]] to indicate specific [[LocalBusiness]]es and [[CivicStructure]]s. If the announcement affects both a particular region and a specific location (for example, a library closure that serves an entire region), use both [[spatialCoverage]] and [[announcementLocation]].\n\nThe [[about]] property can be used to indicate entities that are the focus of the announcement. We now recommend using [[about]] only\nfor representing non-location entities (e.g. a [[Course]] or a [[RadioStation]]). For places, use [[announcementLocation]] and [[spatialCoverage]]. Consumers of this markup should be aware that the initial design encouraged the use of [[about]] for locations too.\n\nThe basic content of [[SpecialAnnouncement]] is similar to that of an [RSS](https://en.wikipedia.org/wiki/RSS) or [Atom](https://en.wikipedia.org/wiki/Atom_(Web_standard)) feed. For publishers without such feeds, basic feed-like information can be shared by posting\n[[SpecialAnnouncement]] updates in a page, e.g. using JSON-LD. For sites with Atom/RSS functionality, you can point to a feed\nwith the [[webFeed]] property. This can be a simple URL, or an inline [[DataFeed]] object, with [[encodingFormat]] providing\nmedia type information, e.g. \"application/rss+xml\" or \"application/atom+xml\"."; |
|
116 | 116 | |
117 | 117 | |
118 | - /** |
|
119 | - * @inheritdoc |
|
120 | - */ |
|
121 | - public function getSchemaPropertyNames(): array |
|
122 | - { |
|
123 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
124 | - } |
|
118 | + /** |
|
119 | + * @inheritdoc |
|
120 | + */ |
|
121 | + public function getSchemaPropertyNames(): array |
|
122 | + { |
|
123 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
124 | + } |
|
125 | 125 | |
126 | 126 | |
127 | - /** |
|
128 | - * @inheritdoc |
|
129 | - */ |
|
130 | - public function getSchemaPropertyExpectedTypes(): array |
|
131 | - { |
|
132 | - return [ |
|
133 | - 'about' => ['Thing'], |
|
134 | - 'abstract' => ['Text'], |
|
135 | - 'accessMode' => ['Text'], |
|
136 | - 'accessModeSufficient' => ['ItemList'], |
|
137 | - 'accessibilityAPI' => ['Text'], |
|
138 | - 'accessibilityControl' => ['Text'], |
|
139 | - 'accessibilityFeature' => ['Text'], |
|
140 | - 'accessibilityHazard' => ['Text'], |
|
141 | - 'accessibilitySummary' => ['Text'], |
|
142 | - 'accountablePerson' => ['Person'], |
|
143 | - 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
144 | - 'additionalType' => ['URL'], |
|
145 | - 'aggregateRating' => ['AggregateRating'], |
|
146 | - 'alternateName' => ['Text'], |
|
147 | - 'alternativeHeadline' => ['Text'], |
|
148 | - 'announcementLocation' => ['CivicStructure', 'LocalBusiness'], |
|
149 | - 'archivedAt' => ['WebPage', 'URL'], |
|
150 | - 'assesses' => ['DefinedTerm', 'Text'], |
|
151 | - 'associatedMedia' => ['MediaObject'], |
|
152 | - 'audience' => ['Audience'], |
|
153 | - 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
154 | - 'author' => ['Organization', 'Person'], |
|
155 | - 'award' => ['Text'], |
|
156 | - 'awards' => ['Text'], |
|
157 | - 'category' => ['URL', 'CategoryCode', 'Text', 'Thing', 'PhysicalActivityCategory'], |
|
158 | - 'character' => ['Person'], |
|
159 | - 'citation' => ['CreativeWork', 'Text'], |
|
160 | - 'comment' => ['Comment'], |
|
161 | - 'commentCount' => ['Integer'], |
|
162 | - 'conditionsOfAccess' => ['Text'], |
|
163 | - 'contentLocation' => ['Place'], |
|
164 | - 'contentRating' => ['Text', 'Rating'], |
|
165 | - 'contentReferenceTime' => ['DateTime'], |
|
166 | - 'contributor' => ['Organization', 'Person'], |
|
167 | - 'copyrightHolder' => ['Organization', 'Person'], |
|
168 | - 'copyrightNotice' => ['Text'], |
|
169 | - 'copyrightYear' => ['Number'], |
|
170 | - 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
171 | - 'countryOfOrigin' => ['Country'], |
|
172 | - 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
173 | - 'creator' => ['Person', 'Organization'], |
|
174 | - 'creditText' => ['Text'], |
|
175 | - 'dateCreated' => ['DateTime', 'Date'], |
|
176 | - 'dateModified' => ['DateTime', 'Date'], |
|
177 | - 'datePosted' => ['DateTime', 'Date'], |
|
178 | - 'datePublished' => ['DateTime', 'Date'], |
|
179 | - 'description' => ['Text'], |
|
180 | - 'disambiguatingDescription' => ['Text'], |
|
181 | - 'discussionUrl' => ['URL'], |
|
182 | - 'diseasePreventionInfo' => ['WebContent', 'URL'], |
|
183 | - 'diseaseSpreadStatistics' => ['WebContent', 'Observation', 'Dataset', 'URL'], |
|
184 | - 'editEIDR' => ['URL', 'Text'], |
|
185 | - 'editor' => ['Person'], |
|
186 | - 'educationalAlignment' => ['AlignmentObject'], |
|
187 | - 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
188 | - 'educationalUse' => ['DefinedTerm', 'Text'], |
|
189 | - 'encoding' => ['MediaObject'], |
|
190 | - 'encodingFormat' => ['URL', 'Text'], |
|
191 | - 'encodings' => ['MediaObject'], |
|
192 | - 'exampleOfWork' => ['CreativeWork'], |
|
193 | - 'expires' => ['Date', 'DateTime'], |
|
194 | - 'fileFormat' => ['Text', 'URL'], |
|
195 | - 'funder' => ['Organization', 'Person'], |
|
196 | - 'funding' => ['Grant'], |
|
197 | - 'genre' => ['Text', 'URL'], |
|
198 | - 'gettingTestedInfo' => ['WebContent', 'URL'], |
|
199 | - 'governmentBenefitsInfo' => ['GovernmentService'], |
|
200 | - 'hasPart' => ['CreativeWork'], |
|
201 | - 'headline' => ['Text'], |
|
202 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
203 | - 'image' => ['URL', 'ImageObject'], |
|
204 | - 'inLanguage' => ['Text', 'Language'], |
|
205 | - 'interactionStatistic' => ['InteractionCounter'], |
|
206 | - 'interactivityType' => ['Text'], |
|
207 | - 'interpretedAsClaim' => ['Claim'], |
|
208 | - 'isAccessibleForFree' => ['Boolean'], |
|
209 | - 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
210 | - 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
211 | - 'isFamilyFriendly' => ['Boolean'], |
|
212 | - 'isPartOf' => ['URL', 'CreativeWork'], |
|
213 | - 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
214 | - 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
215 | - 'license' => ['URL', 'CreativeWork'], |
|
216 | - 'locationCreated' => ['Place'], |
|
217 | - 'mainEntity' => ['Thing'], |
|
218 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
219 | - 'maintainer' => ['Person', 'Organization'], |
|
220 | - 'material' => ['Product', 'URL', 'Text'], |
|
221 | - 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
222 | - 'mentions' => ['Thing'], |
|
223 | - 'name' => ['Text'], |
|
224 | - 'newsUpdatesAndGuidelines' => ['WebContent', 'URL'], |
|
225 | - 'offers' => ['Demand', 'Offer'], |
|
226 | - 'pattern' => ['DefinedTerm', 'Text'], |
|
227 | - 'position' => ['Text', 'Integer'], |
|
228 | - 'potentialAction' => ['Action'], |
|
229 | - 'producer' => ['Organization', 'Person'], |
|
230 | - 'provider' => ['Organization', 'Person'], |
|
231 | - 'publicTransportClosuresInfo' => ['WebContent', 'URL'], |
|
232 | - 'publication' => ['PublicationEvent'], |
|
233 | - 'publisher' => ['Organization', 'Person'], |
|
234 | - 'publisherImprint' => ['Organization'], |
|
235 | - 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
236 | - 'quarantineGuidelines' => ['URL', 'WebContent'], |
|
237 | - 'recordedAt' => ['Event'], |
|
238 | - 'releasedEvent' => ['PublicationEvent'], |
|
239 | - 'review' => ['Review'], |
|
240 | - 'reviews' => ['Review'], |
|
241 | - 'sameAs' => ['URL'], |
|
242 | - 'schemaVersion' => ['URL', 'Text'], |
|
243 | - 'schoolClosuresInfo' => ['WebContent', 'URL'], |
|
244 | - 'sdDatePublished' => ['Date'], |
|
245 | - 'sdLicense' => ['CreativeWork', 'URL'], |
|
246 | - 'sdPublisher' => ['Organization', 'Person'], |
|
247 | - 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
248 | - 'sourceOrganization' => ['Organization'], |
|
249 | - 'spatial' => ['Place'], |
|
250 | - 'spatialCoverage' => ['Place'], |
|
251 | - 'sponsor' => ['Organization', 'Person'], |
|
252 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
253 | - 'teaches' => ['DefinedTerm', 'Text'], |
|
254 | - 'temporal' => ['DateTime', 'Text'], |
|
255 | - 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
256 | - 'text' => ['Text'], |
|
257 | - 'thumbnailUrl' => ['URL'], |
|
258 | - 'timeRequired' => ['Duration'], |
|
259 | - 'translationOfWork' => ['CreativeWork'], |
|
260 | - 'translator' => ['Organization', 'Person'], |
|
261 | - 'travelBans' => ['URL', 'WebContent'], |
|
262 | - 'typicalAgeRange' => ['Text'], |
|
263 | - 'url' => ['URL'], |
|
264 | - 'usageInfo' => ['URL', 'CreativeWork'], |
|
265 | - 'version' => ['Number', 'Text'], |
|
266 | - 'video' => ['VideoObject', 'Clip'], |
|
267 | - 'webFeed' => ['DataFeed', 'URL'], |
|
268 | - 'workExample' => ['CreativeWork'], |
|
269 | - 'workTranslation' => ['CreativeWork'] |
|
270 | - ]; |
|
271 | - } |
|
127 | + /** |
|
128 | + * @inheritdoc |
|
129 | + */ |
|
130 | + public function getSchemaPropertyExpectedTypes(): array |
|
131 | + { |
|
132 | + return [ |
|
133 | + 'about' => ['Thing'], |
|
134 | + 'abstract' => ['Text'], |
|
135 | + 'accessMode' => ['Text'], |
|
136 | + 'accessModeSufficient' => ['ItemList'], |
|
137 | + 'accessibilityAPI' => ['Text'], |
|
138 | + 'accessibilityControl' => ['Text'], |
|
139 | + 'accessibilityFeature' => ['Text'], |
|
140 | + 'accessibilityHazard' => ['Text'], |
|
141 | + 'accessibilitySummary' => ['Text'], |
|
142 | + 'accountablePerson' => ['Person'], |
|
143 | + 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
144 | + 'additionalType' => ['URL'], |
|
145 | + 'aggregateRating' => ['AggregateRating'], |
|
146 | + 'alternateName' => ['Text'], |
|
147 | + 'alternativeHeadline' => ['Text'], |
|
148 | + 'announcementLocation' => ['CivicStructure', 'LocalBusiness'], |
|
149 | + 'archivedAt' => ['WebPage', 'URL'], |
|
150 | + 'assesses' => ['DefinedTerm', 'Text'], |
|
151 | + 'associatedMedia' => ['MediaObject'], |
|
152 | + 'audience' => ['Audience'], |
|
153 | + 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
154 | + 'author' => ['Organization', 'Person'], |
|
155 | + 'award' => ['Text'], |
|
156 | + 'awards' => ['Text'], |
|
157 | + 'category' => ['URL', 'CategoryCode', 'Text', 'Thing', 'PhysicalActivityCategory'], |
|
158 | + 'character' => ['Person'], |
|
159 | + 'citation' => ['CreativeWork', 'Text'], |
|
160 | + 'comment' => ['Comment'], |
|
161 | + 'commentCount' => ['Integer'], |
|
162 | + 'conditionsOfAccess' => ['Text'], |
|
163 | + 'contentLocation' => ['Place'], |
|
164 | + 'contentRating' => ['Text', 'Rating'], |
|
165 | + 'contentReferenceTime' => ['DateTime'], |
|
166 | + 'contributor' => ['Organization', 'Person'], |
|
167 | + 'copyrightHolder' => ['Organization', 'Person'], |
|
168 | + 'copyrightNotice' => ['Text'], |
|
169 | + 'copyrightYear' => ['Number'], |
|
170 | + 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
171 | + 'countryOfOrigin' => ['Country'], |
|
172 | + 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
173 | + 'creator' => ['Person', 'Organization'], |
|
174 | + 'creditText' => ['Text'], |
|
175 | + 'dateCreated' => ['DateTime', 'Date'], |
|
176 | + 'dateModified' => ['DateTime', 'Date'], |
|
177 | + 'datePosted' => ['DateTime', 'Date'], |
|
178 | + 'datePublished' => ['DateTime', 'Date'], |
|
179 | + 'description' => ['Text'], |
|
180 | + 'disambiguatingDescription' => ['Text'], |
|
181 | + 'discussionUrl' => ['URL'], |
|
182 | + 'diseasePreventionInfo' => ['WebContent', 'URL'], |
|
183 | + 'diseaseSpreadStatistics' => ['WebContent', 'Observation', 'Dataset', 'URL'], |
|
184 | + 'editEIDR' => ['URL', 'Text'], |
|
185 | + 'editor' => ['Person'], |
|
186 | + 'educationalAlignment' => ['AlignmentObject'], |
|
187 | + 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
188 | + 'educationalUse' => ['DefinedTerm', 'Text'], |
|
189 | + 'encoding' => ['MediaObject'], |
|
190 | + 'encodingFormat' => ['URL', 'Text'], |
|
191 | + 'encodings' => ['MediaObject'], |
|
192 | + 'exampleOfWork' => ['CreativeWork'], |
|
193 | + 'expires' => ['Date', 'DateTime'], |
|
194 | + 'fileFormat' => ['Text', 'URL'], |
|
195 | + 'funder' => ['Organization', 'Person'], |
|
196 | + 'funding' => ['Grant'], |
|
197 | + 'genre' => ['Text', 'URL'], |
|
198 | + 'gettingTestedInfo' => ['WebContent', 'URL'], |
|
199 | + 'governmentBenefitsInfo' => ['GovernmentService'], |
|
200 | + 'hasPart' => ['CreativeWork'], |
|
201 | + 'headline' => ['Text'], |
|
202 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
203 | + 'image' => ['URL', 'ImageObject'], |
|
204 | + 'inLanguage' => ['Text', 'Language'], |
|
205 | + 'interactionStatistic' => ['InteractionCounter'], |
|
206 | + 'interactivityType' => ['Text'], |
|
207 | + 'interpretedAsClaim' => ['Claim'], |
|
208 | + 'isAccessibleForFree' => ['Boolean'], |
|
209 | + 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
210 | + 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
211 | + 'isFamilyFriendly' => ['Boolean'], |
|
212 | + 'isPartOf' => ['URL', 'CreativeWork'], |
|
213 | + 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
214 | + 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
215 | + 'license' => ['URL', 'CreativeWork'], |
|
216 | + 'locationCreated' => ['Place'], |
|
217 | + 'mainEntity' => ['Thing'], |
|
218 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
219 | + 'maintainer' => ['Person', 'Organization'], |
|
220 | + 'material' => ['Product', 'URL', 'Text'], |
|
221 | + 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
222 | + 'mentions' => ['Thing'], |
|
223 | + 'name' => ['Text'], |
|
224 | + 'newsUpdatesAndGuidelines' => ['WebContent', 'URL'], |
|
225 | + 'offers' => ['Demand', 'Offer'], |
|
226 | + 'pattern' => ['DefinedTerm', 'Text'], |
|
227 | + 'position' => ['Text', 'Integer'], |
|
228 | + 'potentialAction' => ['Action'], |
|
229 | + 'producer' => ['Organization', 'Person'], |
|
230 | + 'provider' => ['Organization', 'Person'], |
|
231 | + 'publicTransportClosuresInfo' => ['WebContent', 'URL'], |
|
232 | + 'publication' => ['PublicationEvent'], |
|
233 | + 'publisher' => ['Organization', 'Person'], |
|
234 | + 'publisherImprint' => ['Organization'], |
|
235 | + 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
236 | + 'quarantineGuidelines' => ['URL', 'WebContent'], |
|
237 | + 'recordedAt' => ['Event'], |
|
238 | + 'releasedEvent' => ['PublicationEvent'], |
|
239 | + 'review' => ['Review'], |
|
240 | + 'reviews' => ['Review'], |
|
241 | + 'sameAs' => ['URL'], |
|
242 | + 'schemaVersion' => ['URL', 'Text'], |
|
243 | + 'schoolClosuresInfo' => ['WebContent', 'URL'], |
|
244 | + 'sdDatePublished' => ['Date'], |
|
245 | + 'sdLicense' => ['CreativeWork', 'URL'], |
|
246 | + 'sdPublisher' => ['Organization', 'Person'], |
|
247 | + 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
248 | + 'sourceOrganization' => ['Organization'], |
|
249 | + 'spatial' => ['Place'], |
|
250 | + 'spatialCoverage' => ['Place'], |
|
251 | + 'sponsor' => ['Organization', 'Person'], |
|
252 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
253 | + 'teaches' => ['DefinedTerm', 'Text'], |
|
254 | + 'temporal' => ['DateTime', 'Text'], |
|
255 | + 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
256 | + 'text' => ['Text'], |
|
257 | + 'thumbnailUrl' => ['URL'], |
|
258 | + 'timeRequired' => ['Duration'], |
|
259 | + 'translationOfWork' => ['CreativeWork'], |
|
260 | + 'translator' => ['Organization', 'Person'], |
|
261 | + 'travelBans' => ['URL', 'WebContent'], |
|
262 | + 'typicalAgeRange' => ['Text'], |
|
263 | + 'url' => ['URL'], |
|
264 | + 'usageInfo' => ['URL', 'CreativeWork'], |
|
265 | + 'version' => ['Number', 'Text'], |
|
266 | + 'video' => ['VideoObject', 'Clip'], |
|
267 | + 'webFeed' => ['DataFeed', 'URL'], |
|
268 | + 'workExample' => ['CreativeWork'], |
|
269 | + 'workTranslation' => ['CreativeWork'] |
|
270 | + ]; |
|
271 | + } |
|
272 | 272 | |
273 | 273 | |
274 | - /** |
|
275 | - * @inheritdoc |
|
276 | - */ |
|
277 | - public function getSchemaPropertyDescriptions(): array |
|
278 | - { |
|
279 | - return [ |
|
280 | - 'about' => 'The subject matter of the content.', |
|
281 | - 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
282 | - 'accessMode' => 'The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).', |
|
283 | - 'accessModeSufficient' => 'A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).', |
|
284 | - 'accessibilityAPI' => 'Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).', |
|
285 | - 'accessibilityControl' => 'Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).', |
|
286 | - 'accessibilityFeature' => 'Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).', |
|
287 | - 'accessibilityHazard' => 'A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).', |
|
288 | - 'accessibilitySummary' => 'A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."', |
|
289 | - 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
290 | - 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
291 | - '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
292 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
293 | - 'alternateName' => 'An alias for the item.', |
|
294 | - 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
295 | - 'announcementLocation' => 'Indicates a specific [[CivicStructure]] or [[LocalBusiness]] associated with the SpecialAnnouncement. For example, a specific testing facility or business with special opening hours. For a larger geographic region like a quarantine of an entire region, use [[spatialCoverage]].', |
|
296 | - 'archivedAt' => 'Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.', |
|
297 | - 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
298 | - 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
299 | - 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
300 | - 'audio' => 'An embedded audio object.', |
|
301 | - 'author' => 'The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.', |
|
302 | - 'award' => 'An award won by or for this item.', |
|
303 | - 'awards' => 'Awards won by or for this item.', |
|
304 | - 'category' => 'A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.', |
|
305 | - 'character' => 'Fictional person connected with a creative work.', |
|
306 | - 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
307 | - 'comment' => 'Comments, typically from users.', |
|
308 | - 'commentCount' => 'The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.', |
|
309 | - 'conditionsOfAccess' => 'Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language. For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". ', |
|
310 | - 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
311 | - 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
312 | - 'contentReferenceTime' => 'The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.', |
|
313 | - 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
314 | - 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
315 | - 'copyrightNotice' => 'Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.', |
|
316 | - 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
317 | - 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
318 | - 'countryOfOrigin' => 'The country of origin of something, including products as well as creative works such as movie and TV content. In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable. In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.', |
|
319 | - 'creativeWorkStatus' => 'The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.', |
|
320 | - 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
321 | - 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
322 | - 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
323 | - 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
324 | - 'datePosted' => 'Publication date of an online listing.', |
|
325 | - 'datePublished' => 'Date of first broadcast/publication.', |
|
326 | - 'description' => 'A description of the item.', |
|
327 | - '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.', |
|
328 | - 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
329 | - 'diseasePreventionInfo' => 'Information about disease prevention.', |
|
330 | - 'diseaseSpreadStatistics' => 'Statistical information about the spread of a disease, either as [[WebContent]], or described directly as a [[Dataset]], or the specific [[Observation]]s in the dataset. When a [[WebContent]] URL is provided, the page indicated might also contain more such markup.', |
|
331 | - 'editEIDR' => 'An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. ', |
|
332 | - 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
333 | - 'educationalAlignment' => 'An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.', |
|
334 | - 'educationalLevel' => 'The level in terms of progression through an educational or training context. Examples of educational levels include \'beginner\', \'intermediate\' or \'advanced\', and formal sets of level indicators.', |
|
335 | - 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
336 | - 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
337 | - 'encodingFormat' => 'Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc. In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.', |
|
338 | - 'encodings' => 'A media object that encodes this CreativeWork.', |
|
339 | - 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
340 | - 'expires' => 'Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.', |
|
341 | - 'fileFormat' => 'Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, \'encoding\' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.', |
|
342 | - 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
343 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
344 | - 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
345 | - 'gettingTestedInfo' => 'Information about getting tested (for a [[MedicalCondition]]), e.g. in the context of a pandemic.', |
|
346 | - 'governmentBenefitsInfo' => 'governmentBenefitsInfo provides information about government benefits associated with a SpecialAnnouncement.', |
|
347 | - 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
348 | - 'headline' => 'Headline of the article.', |
|
349 | - '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. ', |
|
350 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
351 | - 'inLanguage' => 'The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].', |
|
352 | - 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
353 | - 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
354 | - 'interpretedAsClaim' => 'Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].', |
|
355 | - 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
356 | - 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
357 | - 'isBasedOnUrl' => 'A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.', |
|
358 | - 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
359 | - 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
360 | - '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.', |
|
361 | - 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
362 | - 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
363 | - 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
364 | - 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
365 | - '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.', |
|
366 | - 'maintainer' => 'A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. ', |
|
367 | - 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
368 | - 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
369 | - 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
370 | - 'name' => 'The name of the item.', |
|
371 | - 'newsUpdatesAndGuidelines' => 'Indicates a page with news updates and guidelines. This could often be (but is not required to be) the main page containing [[SpecialAnnouncement]] markup on a site.', |
|
372 | - 'offers' => 'An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. ', |
|
373 | - 'pattern' => 'A pattern that something has, for example \'polka dot\', \'striped\', \'Canadian flag\'. Values are typically expressed as text, although links to controlled value schemes are also supported.', |
|
374 | - 'position' => 'The position of an item in a series or sequence of items.', |
|
375 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
376 | - 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
377 | - '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.', |
|
378 | - 'publicTransportClosuresInfo' => 'Information about public transport closures.', |
|
379 | - 'publication' => 'A publication event associated with the item.', |
|
380 | - 'publisher' => 'The publisher of the creative work.', |
|
381 | - 'publisherImprint' => 'The publishing division which published the comic.', |
|
382 | - 'publishingPrinciples' => 'The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. ', |
|
383 | - 'quarantineGuidelines' => 'Guidelines about quarantine rules, e.g. in the context of a pandemic.', |
|
384 | - 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
385 | - 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
386 | - 'review' => 'A review of the item.', |
|
387 | - 'reviews' => 'Review of the item.', |
|
388 | - '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.', |
|
389 | - 'schemaVersion' => 'Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.', |
|
390 | - 'schoolClosuresInfo' => 'Information about school closures.', |
|
391 | - 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
392 | - 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
393 | - 'sdPublisher' => 'Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit.', |
|
394 | - 'size' => 'A standardized size of a product or creative work, specified either through a simple textual string (for example \'XL\', \'32Wx34L\'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. ', |
|
395 | - 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
396 | - 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
397 | - 'spatialCoverage' => 'The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.', |
|
398 | - 'sponsor' => 'A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.', |
|
399 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
400 | - 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
401 | - 'temporal' => 'The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.', |
|
402 | - 'temporalCoverage' => 'The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.', |
|
403 | - 'text' => 'The textual content of this CreativeWork.', |
|
404 | - 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
405 | - 'timeRequired' => 'Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. \'PT30M\', \'PT1H25M\'.', |
|
406 | - 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
407 | - 'translator' => 'Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.', |
|
408 | - 'travelBans' => 'Information about travel bans, e.g. in the context of a pandemic.', |
|
409 | - 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
410 | - 'url' => 'URL of the item.', |
|
411 | - 'usageInfo' => 'The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.', |
|
412 | - 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
413 | - 'video' => 'An embedded video object.', |
|
414 | - 'webFeed' => 'The URL for a feed, e.g. associated with a podcast series, blog, or series of date-stamped updates. This is usually RSS or Atom.', |
|
415 | - 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
416 | - 'workTranslation' => 'A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo.' |
|
417 | - ]; |
|
418 | - } |
|
274 | + /** |
|
275 | + * @inheritdoc |
|
276 | + */ |
|
277 | + public function getSchemaPropertyDescriptions(): array |
|
278 | + { |
|
279 | + return [ |
|
280 | + 'about' => 'The subject matter of the content.', |
|
281 | + 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
282 | + 'accessMode' => 'The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).', |
|
283 | + 'accessModeSufficient' => 'A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).', |
|
284 | + 'accessibilityAPI' => 'Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).', |
|
285 | + 'accessibilityControl' => 'Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).', |
|
286 | + 'accessibilityFeature' => 'Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).', |
|
287 | + 'accessibilityHazard' => 'A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).', |
|
288 | + 'accessibilitySummary' => 'A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."', |
|
289 | + 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
290 | + 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
291 | + '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
292 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
293 | + 'alternateName' => 'An alias for the item.', |
|
294 | + 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
295 | + 'announcementLocation' => 'Indicates a specific [[CivicStructure]] or [[LocalBusiness]] associated with the SpecialAnnouncement. For example, a specific testing facility or business with special opening hours. For a larger geographic region like a quarantine of an entire region, use [[spatialCoverage]].', |
|
296 | + 'archivedAt' => 'Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.', |
|
297 | + 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
298 | + 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
299 | + 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
300 | + 'audio' => 'An embedded audio object.', |
|
301 | + 'author' => 'The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.', |
|
302 | + 'award' => 'An award won by or for this item.', |
|
303 | + 'awards' => 'Awards won by or for this item.', |
|
304 | + 'category' => 'A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.', |
|
305 | + 'character' => 'Fictional person connected with a creative work.', |
|
306 | + 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
307 | + 'comment' => 'Comments, typically from users.', |
|
308 | + 'commentCount' => 'The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.', |
|
309 | + 'conditionsOfAccess' => 'Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language. For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". ', |
|
310 | + 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
311 | + 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
312 | + 'contentReferenceTime' => 'The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.', |
|
313 | + 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
314 | + 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
315 | + 'copyrightNotice' => 'Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.', |
|
316 | + 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
317 | + 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
318 | + 'countryOfOrigin' => 'The country of origin of something, including products as well as creative works such as movie and TV content. In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable. In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.', |
|
319 | + 'creativeWorkStatus' => 'The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.', |
|
320 | + 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
321 | + 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
322 | + 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
323 | + 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
324 | + 'datePosted' => 'Publication date of an online listing.', |
|
325 | + 'datePublished' => 'Date of first broadcast/publication.', |
|
326 | + 'description' => 'A description of the item.', |
|
327 | + '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.', |
|
328 | + 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
329 | + 'diseasePreventionInfo' => 'Information about disease prevention.', |
|
330 | + 'diseaseSpreadStatistics' => 'Statistical information about the spread of a disease, either as [[WebContent]], or described directly as a [[Dataset]], or the specific [[Observation]]s in the dataset. When a [[WebContent]] URL is provided, the page indicated might also contain more such markup.', |
|
331 | + 'editEIDR' => 'An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. ', |
|
332 | + 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
333 | + 'educationalAlignment' => 'An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.', |
|
334 | + 'educationalLevel' => 'The level in terms of progression through an educational or training context. Examples of educational levels include \'beginner\', \'intermediate\' or \'advanced\', and formal sets of level indicators.', |
|
335 | + 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
336 | + 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
337 | + 'encodingFormat' => 'Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc. In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.', |
|
338 | + 'encodings' => 'A media object that encodes this CreativeWork.', |
|
339 | + 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
340 | + 'expires' => 'Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.', |
|
341 | + 'fileFormat' => 'Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, \'encoding\' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.', |
|
342 | + 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
343 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
344 | + 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
345 | + 'gettingTestedInfo' => 'Information about getting tested (for a [[MedicalCondition]]), e.g. in the context of a pandemic.', |
|
346 | + 'governmentBenefitsInfo' => 'governmentBenefitsInfo provides information about government benefits associated with a SpecialAnnouncement.', |
|
347 | + 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
348 | + 'headline' => 'Headline of the article.', |
|
349 | + '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. ', |
|
350 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
351 | + 'inLanguage' => 'The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].', |
|
352 | + 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
353 | + 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
354 | + 'interpretedAsClaim' => 'Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].', |
|
355 | + 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
356 | + 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
357 | + 'isBasedOnUrl' => 'A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.', |
|
358 | + 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
359 | + 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
360 | + '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.', |
|
361 | + 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
362 | + 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
363 | + 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
364 | + 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
365 | + '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.', |
|
366 | + 'maintainer' => 'A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. ', |
|
367 | + 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
368 | + 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
369 | + 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
370 | + 'name' => 'The name of the item.', |
|
371 | + 'newsUpdatesAndGuidelines' => 'Indicates a page with news updates and guidelines. This could often be (but is not required to be) the main page containing [[SpecialAnnouncement]] markup on a site.', |
|
372 | + 'offers' => 'An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. ', |
|
373 | + 'pattern' => 'A pattern that something has, for example \'polka dot\', \'striped\', \'Canadian flag\'. Values are typically expressed as text, although links to controlled value schemes are also supported.', |
|
374 | + 'position' => 'The position of an item in a series or sequence of items.', |
|
375 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
376 | + 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
377 | + '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.', |
|
378 | + 'publicTransportClosuresInfo' => 'Information about public transport closures.', |
|
379 | + 'publication' => 'A publication event associated with the item.', |
|
380 | + 'publisher' => 'The publisher of the creative work.', |
|
381 | + 'publisherImprint' => 'The publishing division which published the comic.', |
|
382 | + 'publishingPrinciples' => 'The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. ', |
|
383 | + 'quarantineGuidelines' => 'Guidelines about quarantine rules, e.g. in the context of a pandemic.', |
|
384 | + 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
385 | + 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
386 | + 'review' => 'A review of the item.', |
|
387 | + 'reviews' => 'Review of the item.', |
|
388 | + '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.', |
|
389 | + 'schemaVersion' => 'Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.', |
|
390 | + 'schoolClosuresInfo' => 'Information about school closures.', |
|
391 | + 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
392 | + 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
393 | + 'sdPublisher' => 'Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit.', |
|
394 | + 'size' => 'A standardized size of a product or creative work, specified either through a simple textual string (for example \'XL\', \'32Wx34L\'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. ', |
|
395 | + 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
396 | + 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
397 | + 'spatialCoverage' => 'The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.', |
|
398 | + 'sponsor' => 'A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.', |
|
399 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
400 | + 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
401 | + 'temporal' => 'The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.', |
|
402 | + 'temporalCoverage' => 'The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.', |
|
403 | + 'text' => 'The textual content of this CreativeWork.', |
|
404 | + 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
405 | + 'timeRequired' => 'Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. \'PT30M\', \'PT1H25M\'.', |
|
406 | + 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
407 | + 'translator' => 'Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.', |
|
408 | + 'travelBans' => 'Information about travel bans, e.g. in the context of a pandemic.', |
|
409 | + 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
410 | + 'url' => 'URL of the item.', |
|
411 | + 'usageInfo' => 'The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.', |
|
412 | + 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
413 | + 'video' => 'An embedded video object.', |
|
414 | + 'webFeed' => 'The URL for a feed, e.g. associated with a podcast series, blog, or series of date-stamped updates. This is usually RSS or Atom.', |
|
415 | + 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
416 | + 'workTranslation' => 'A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo.' |
|
417 | + ]; |
|
418 | + } |
|
419 | 419 | |
420 | 420 | |
421 | - /** |
|
422 | - * @inheritdoc |
|
423 | - */ |
|
424 | - public function getGoogleRequiredSchema(): array |
|
425 | - { |
|
426 | - return ['description', 'name']; |
|
427 | - } |
|
421 | + /** |
|
422 | + * @inheritdoc |
|
423 | + */ |
|
424 | + public function getGoogleRequiredSchema(): array |
|
425 | + { |
|
426 | + return ['description', 'name']; |
|
427 | + } |
|
428 | 428 | |
429 | 429 | |
430 | - /** |
|
431 | - * @inheritdoc |
|
432 | - */ |
|
433 | - public function getGoogleRecommendedSchema(): array |
|
434 | - { |
|
435 | - return ['image', 'url']; |
|
436 | - } |
|
430 | + /** |
|
431 | + * @inheritdoc |
|
432 | + */ |
|
433 | + public function getGoogleRecommendedSchema(): array |
|
434 | + { |
|
435 | + return ['image', 'url']; |
|
436 | + } |
|
437 | 437 | |
438 | 438 | |
439 | - /** |
|
440 | - * @inheritdoc |
|
441 | - */ |
|
442 | - public function defineRules(): array |
|
443 | - { |
|
444 | - $rules = parent::defineRules(); |
|
445 | - $rules = array_merge($rules, [ |
|
446 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
447 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
448 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
449 | - ]); |
|
439 | + /** |
|
440 | + * @inheritdoc |
|
441 | + */ |
|
442 | + public function defineRules(): array |
|
443 | + { |
|
444 | + $rules = parent::defineRules(); |
|
445 | + $rules = array_merge($rules, [ |
|
446 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
447 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
448 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
449 | + ]); |
|
450 | 450 | |
451 | - return $rules; |
|
452 | - } |
|
451 | + return $rules; |
|
452 | + } |
|
453 | 453 | } |
@@ -24,127 +24,127 @@ |
||
24 | 24 | */ |
25 | 25 | class Nonprofit501c9 extends MetaJsonLd implements Nonprofit501c9Interface, USNonprofitTypeInterface, NonprofitTypeInterface, EnumerationInterface, IntangibleInterface, ThingInterface |
26 | 26 | { |
27 | - use Nonprofit501c9Trait; |
|
28 | - use USNonprofitTypeTrait; |
|
29 | - use NonprofitTypeTrait; |
|
30 | - use EnumerationTrait; |
|
31 | - use IntangibleTrait; |
|
32 | - use ThingTrait; |
|
33 | - |
|
34 | - /** |
|
35 | - * The Schema.org Type Name |
|
36 | - * |
|
37 | - * @var string |
|
38 | - */ |
|
39 | - public static $schemaTypeName = 'Nonprofit501c9'; |
|
40 | - |
|
41 | - /** |
|
42 | - * The Schema.org Type Scope |
|
43 | - * |
|
44 | - * @var string |
|
45 | - */ |
|
46 | - public static $schemaTypeScope = 'https://schema.org/Nonprofit501c9'; |
|
47 | - |
|
48 | - /** |
|
49 | - * The Schema.org Type Extends |
|
50 | - * |
|
51 | - * @var string |
|
52 | - */ |
|
53 | - public static $schemaTypeExtends = 'USNonprofitType'; |
|
54 | - |
|
55 | - /** |
|
56 | - * The Schema.org Type Description |
|
57 | - * |
|
58 | - * @var string |
|
59 | - */ |
|
60 | - public static $schemaTypeDescription = 'Nonprofit501c9: Non-profit type referring to Voluntary Employee Beneficiary Associations.'; |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * @inheritdoc |
|
65 | - */ |
|
66 | - public function getSchemaPropertyNames(): array |
|
67 | - { |
|
68 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
69 | - } |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * @inheritdoc |
|
74 | - */ |
|
75 | - public function getSchemaPropertyExpectedTypes(): array |
|
76 | - { |
|
77 | - return [ |
|
78 | - 'additionalType' => ['URL'], |
|
79 | - 'alternateName' => ['Text'], |
|
80 | - 'description' => ['Text'], |
|
81 | - 'disambiguatingDescription' => ['Text'], |
|
82 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
83 | - 'image' => ['URL', 'ImageObject'], |
|
84 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
85 | - 'name' => ['Text'], |
|
86 | - 'potentialAction' => ['Action'], |
|
87 | - 'sameAs' => ['URL'], |
|
88 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
89 | - 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
90 | - 'url' => ['URL'] |
|
91 | - ]; |
|
92 | - } |
|
93 | - |
|
94 | - |
|
95 | - /** |
|
96 | - * @inheritdoc |
|
97 | - */ |
|
98 | - public function getSchemaPropertyDescriptions(): array |
|
99 | - { |
|
100 | - return [ |
|
101 | - '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
102 | - 'alternateName' => 'An alias for the item.', |
|
103 | - 'description' => 'A description of the item.', |
|
104 | - '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.', |
|
105 | - '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. ', |
|
106 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
107 | - '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.', |
|
108 | - 'name' => 'The name of the item.', |
|
109 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
110 | - '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.', |
|
111 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
112 | - 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
113 | - 'url' => 'URL of the item.' |
|
114 | - ]; |
|
115 | - } |
|
116 | - |
|
117 | - |
|
118 | - /** |
|
119 | - * @inheritdoc |
|
120 | - */ |
|
121 | - public function getGoogleRequiredSchema(): array |
|
122 | - { |
|
123 | - return ['description', 'name']; |
|
124 | - } |
|
125 | - |
|
126 | - |
|
127 | - /** |
|
128 | - * @inheritdoc |
|
129 | - */ |
|
130 | - public function getGoogleRecommendedSchema(): array |
|
131 | - { |
|
132 | - return ['image', 'url']; |
|
133 | - } |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * @inheritdoc |
|
138 | - */ |
|
139 | - public function defineRules(): array |
|
140 | - { |
|
141 | - $rules = parent::defineRules(); |
|
142 | - $rules = array_merge($rules, [ |
|
143 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
144 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
145 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
146 | - ]); |
|
147 | - |
|
148 | - return $rules; |
|
149 | - } |
|
27 | + use Nonprofit501c9Trait; |
|
28 | + use USNonprofitTypeTrait; |
|
29 | + use NonprofitTypeTrait; |
|
30 | + use EnumerationTrait; |
|
31 | + use IntangibleTrait; |
|
32 | + use ThingTrait; |
|
33 | + |
|
34 | + /** |
|
35 | + * The Schema.org Type Name |
|
36 | + * |
|
37 | + * @var string |
|
38 | + */ |
|
39 | + public static $schemaTypeName = 'Nonprofit501c9'; |
|
40 | + |
|
41 | + /** |
|
42 | + * The Schema.org Type Scope |
|
43 | + * |
|
44 | + * @var string |
|
45 | + */ |
|
46 | + public static $schemaTypeScope = 'https://schema.org/Nonprofit501c9'; |
|
47 | + |
|
48 | + /** |
|
49 | + * The Schema.org Type Extends |
|
50 | + * |
|
51 | + * @var string |
|
52 | + */ |
|
53 | + public static $schemaTypeExtends = 'USNonprofitType'; |
|
54 | + |
|
55 | + /** |
|
56 | + * The Schema.org Type Description |
|
57 | + * |
|
58 | + * @var string |
|
59 | + */ |
|
60 | + public static $schemaTypeDescription = 'Nonprofit501c9: Non-profit type referring to Voluntary Employee Beneficiary Associations.'; |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * @inheritdoc |
|
65 | + */ |
|
66 | + public function getSchemaPropertyNames(): array |
|
67 | + { |
|
68 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
69 | + } |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * @inheritdoc |
|
74 | + */ |
|
75 | + public function getSchemaPropertyExpectedTypes(): array |
|
76 | + { |
|
77 | + return [ |
|
78 | + 'additionalType' => ['URL'], |
|
79 | + 'alternateName' => ['Text'], |
|
80 | + 'description' => ['Text'], |
|
81 | + 'disambiguatingDescription' => ['Text'], |
|
82 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
83 | + 'image' => ['URL', 'ImageObject'], |
|
84 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
85 | + 'name' => ['Text'], |
|
86 | + 'potentialAction' => ['Action'], |
|
87 | + 'sameAs' => ['URL'], |
|
88 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
89 | + 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
90 | + 'url' => ['URL'] |
|
91 | + ]; |
|
92 | + } |
|
93 | + |
|
94 | + |
|
95 | + /** |
|
96 | + * @inheritdoc |
|
97 | + */ |
|
98 | + public function getSchemaPropertyDescriptions(): array |
|
99 | + { |
|
100 | + return [ |
|
101 | + '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. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
102 | + 'alternateName' => 'An alias for the item.', |
|
103 | + 'description' => 'A description of the item.', |
|
104 | + '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.', |
|
105 | + '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. ', |
|
106 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
107 | + '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.', |
|
108 | + 'name' => 'The name of the item.', |
|
109 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
110 | + '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.', |
|
111 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
112 | + 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
113 | + 'url' => 'URL of the item.' |
|
114 | + ]; |
|
115 | + } |
|
116 | + |
|
117 | + |
|
118 | + /** |
|
119 | + * @inheritdoc |
|
120 | + */ |
|
121 | + public function getGoogleRequiredSchema(): array |
|
122 | + { |
|
123 | + return ['description', 'name']; |
|
124 | + } |
|
125 | + |
|
126 | + |
|
127 | + /** |
|
128 | + * @inheritdoc |
|
129 | + */ |
|
130 | + public function getGoogleRecommendedSchema(): array |
|
131 | + { |
|
132 | + return ['image', 'url']; |
|
133 | + } |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * @inheritdoc |
|
138 | + */ |
|
139 | + public function defineRules(): array |
|
140 | + { |
|
141 | + $rules = parent::defineRules(); |
|
142 | + $rules = array_merge($rules, [ |
|
143 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
144 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
145 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
146 | + ]); |
|
147 | + |
|
148 | + return $rules; |
|
149 | + } |
|
150 | 150 | } |