@@ -23,368 +23,368 @@ |
||
23 | 23 | */ |
24 | 24 | class Clip extends MetaJsonLd implements ClipInterface, CreativeWorkInterface, ThingInterface |
25 | 25 | { |
26 | - use ClipTrait; |
|
27 | - use CreativeWorkTrait; |
|
28 | - use ThingTrait; |
|
26 | + use ClipTrait; |
|
27 | + use CreativeWorkTrait; |
|
28 | + use ThingTrait; |
|
29 | 29 | |
30 | - /** |
|
31 | - * The Schema.org Type Name |
|
32 | - * |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - public static $schemaTypeName = 'Clip'; |
|
30 | + /** |
|
31 | + * The Schema.org Type Name |
|
32 | + * |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + public static $schemaTypeName = 'Clip'; |
|
36 | 36 | |
37 | - /** |
|
38 | - * The Schema.org Type Scope |
|
39 | - * |
|
40 | - * @var string |
|
41 | - */ |
|
42 | - public static $schemaTypeScope = 'https://schema.org/Clip'; |
|
37 | + /** |
|
38 | + * The Schema.org Type Scope |
|
39 | + * |
|
40 | + * @var string |
|
41 | + */ |
|
42 | + public static $schemaTypeScope = 'https://schema.org/Clip'; |
|
43 | 43 | |
44 | - /** |
|
45 | - * The Schema.org Type Extends |
|
46 | - * |
|
47 | - * @var string |
|
48 | - */ |
|
49 | - public static $schemaTypeExtends = 'CreativeWork'; |
|
44 | + /** |
|
45 | + * The Schema.org Type Extends |
|
46 | + * |
|
47 | + * @var string |
|
48 | + */ |
|
49 | + public static $schemaTypeExtends = 'CreativeWork'; |
|
50 | 50 | |
51 | - /** |
|
52 | - * The Schema.org Type Description |
|
53 | - * |
|
54 | - * @var string |
|
55 | - */ |
|
56 | - public static $schemaTypeDescription = 'A short TV or radio program or a segment/part of a program.'; |
|
51 | + /** |
|
52 | + * The Schema.org Type Description |
|
53 | + * |
|
54 | + * @var string |
|
55 | + */ |
|
56 | + public static $schemaTypeDescription = 'A short TV or radio program or a segment/part of a program.'; |
|
57 | 57 | |
58 | 58 | |
59 | - /** |
|
60 | - * @inheritdoc |
|
61 | - */ |
|
62 | - public function getSchemaPropertyNames(): array |
|
63 | - { |
|
64 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
65 | - } |
|
59 | + /** |
|
60 | + * @inheritdoc |
|
61 | + */ |
|
62 | + public function getSchemaPropertyNames(): array |
|
63 | + { |
|
64 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
65 | + } |
|
66 | 66 | |
67 | 67 | |
68 | - /** |
|
69 | - * @inheritdoc |
|
70 | - */ |
|
71 | - public function getSchemaPropertyExpectedTypes(): array |
|
72 | - { |
|
73 | - return [ |
|
74 | - 'about' => ['Thing'], |
|
75 | - 'abstract' => ['Text'], |
|
76 | - 'accessMode' => ['Text'], |
|
77 | - 'accessModeSufficient' => ['ItemList'], |
|
78 | - 'accessibilityAPI' => ['Text'], |
|
79 | - 'accessibilityControl' => ['Text'], |
|
80 | - 'accessibilityFeature' => ['Text'], |
|
81 | - 'accessibilityHazard' => ['Text'], |
|
82 | - 'accessibilitySummary' => ['Text'], |
|
83 | - 'accountablePerson' => ['Person'], |
|
84 | - 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
85 | - 'actor' => ['Person'], |
|
86 | - 'actors' => ['Person'], |
|
87 | - 'additionalType' => ['URL'], |
|
88 | - 'aggregateRating' => ['AggregateRating'], |
|
89 | - 'alternateName' => ['Text'], |
|
90 | - 'alternativeHeadline' => ['Text'], |
|
91 | - 'archivedAt' => ['WebPage', 'URL'], |
|
92 | - 'assesses' => ['DefinedTerm', 'Text'], |
|
93 | - 'associatedMedia' => ['MediaObject'], |
|
94 | - 'audience' => ['Audience'], |
|
95 | - 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
96 | - 'author' => ['Organization', 'Person'], |
|
97 | - 'award' => ['Text'], |
|
98 | - 'awards' => ['Text'], |
|
99 | - 'character' => ['Person'], |
|
100 | - 'citation' => ['CreativeWork', 'Text'], |
|
101 | - 'clipNumber' => ['Integer', 'Text'], |
|
102 | - 'comment' => ['Comment'], |
|
103 | - 'commentCount' => ['Integer'], |
|
104 | - 'conditionsOfAccess' => ['Text'], |
|
105 | - 'contentLocation' => ['Place'], |
|
106 | - 'contentRating' => ['Text', 'Rating'], |
|
107 | - 'contentReferenceTime' => ['DateTime'], |
|
108 | - 'contributor' => ['Organization', 'Person'], |
|
109 | - 'copyrightHolder' => ['Organization', 'Person'], |
|
110 | - 'copyrightNotice' => ['Text'], |
|
111 | - 'copyrightYear' => ['Number'], |
|
112 | - 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
113 | - 'countryOfOrigin' => ['Country'], |
|
114 | - 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
115 | - 'creator' => ['Person', 'Organization'], |
|
116 | - 'creditText' => ['Text'], |
|
117 | - 'dateCreated' => ['DateTime', 'Date'], |
|
118 | - 'dateModified' => ['DateTime', 'Date'], |
|
119 | - 'datePublished' => ['DateTime', 'Date'], |
|
120 | - 'description' => ['Text'], |
|
121 | - 'director' => ['Person'], |
|
122 | - 'directors' => ['Person'], |
|
123 | - 'disambiguatingDescription' => ['Text'], |
|
124 | - 'discussionUrl' => ['URL'], |
|
125 | - 'editEIDR' => ['URL', 'Text'], |
|
126 | - 'editor' => ['Person'], |
|
127 | - 'educationalAlignment' => ['AlignmentObject'], |
|
128 | - 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
129 | - 'educationalUse' => ['DefinedTerm', 'Text'], |
|
130 | - 'encoding' => ['MediaObject'], |
|
131 | - 'encodingFormat' => ['URL', 'Text'], |
|
132 | - 'encodings' => ['MediaObject'], |
|
133 | - 'endOffset' => ['Number', 'HyperTocEntry'], |
|
134 | - 'exampleOfWork' => ['CreativeWork'], |
|
135 | - 'expires' => ['Date', 'DateTime'], |
|
136 | - 'fileFormat' => ['Text', 'URL'], |
|
137 | - 'funder' => ['Organization', 'Person'], |
|
138 | - 'funding' => ['Grant'], |
|
139 | - 'genre' => ['Text', 'URL'], |
|
140 | - 'hasPart' => ['CreativeWork'], |
|
141 | - 'headline' => ['Text'], |
|
142 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
143 | - 'image' => ['URL', 'ImageObject'], |
|
144 | - 'inLanguage' => ['Text', 'Language'], |
|
145 | - 'interactionStatistic' => ['InteractionCounter'], |
|
146 | - 'interactivityType' => ['Text'], |
|
147 | - 'interpretedAsClaim' => ['Claim'], |
|
148 | - 'isAccessibleForFree' => ['Boolean'], |
|
149 | - 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
150 | - 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
151 | - 'isFamilyFriendly' => ['Boolean'], |
|
152 | - 'isPartOf' => ['URL', 'CreativeWork'], |
|
153 | - 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
154 | - 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
155 | - 'license' => ['URL', 'CreativeWork'], |
|
156 | - 'locationCreated' => ['Place'], |
|
157 | - 'mainEntity' => ['Thing'], |
|
158 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
159 | - 'maintainer' => ['Person', 'Organization'], |
|
160 | - 'material' => ['Product', 'URL', 'Text'], |
|
161 | - 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
162 | - 'mentions' => ['Thing'], |
|
163 | - 'musicBy' => ['MusicGroup', 'Person'], |
|
164 | - 'name' => ['Text'], |
|
165 | - 'offers' => ['Demand', 'Offer'], |
|
166 | - 'partOfEpisode' => ['Episode'], |
|
167 | - 'partOfSeason' => ['CreativeWorkSeason'], |
|
168 | - 'partOfSeries' => ['CreativeWorkSeries'], |
|
169 | - 'pattern' => ['DefinedTerm', 'Text'], |
|
170 | - 'position' => ['Text', 'Integer'], |
|
171 | - 'potentialAction' => ['Action'], |
|
172 | - 'producer' => ['Organization', 'Person'], |
|
173 | - 'provider' => ['Organization', 'Person'], |
|
174 | - 'publication' => ['PublicationEvent'], |
|
175 | - 'publisher' => ['Organization', 'Person'], |
|
176 | - 'publisherImprint' => ['Organization'], |
|
177 | - 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
178 | - 'recordedAt' => ['Event'], |
|
179 | - 'releasedEvent' => ['PublicationEvent'], |
|
180 | - 'review' => ['Review'], |
|
181 | - 'reviews' => ['Review'], |
|
182 | - 'sameAs' => ['URL'], |
|
183 | - 'schemaVersion' => ['URL', 'Text'], |
|
184 | - 'sdDatePublished' => ['Date'], |
|
185 | - 'sdLicense' => ['CreativeWork', 'URL'], |
|
186 | - 'sdPublisher' => ['Organization', 'Person'], |
|
187 | - 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
188 | - 'sourceOrganization' => ['Organization'], |
|
189 | - 'spatial' => ['Place'], |
|
190 | - 'spatialCoverage' => ['Place'], |
|
191 | - 'sponsor' => ['Organization', 'Person'], |
|
192 | - 'startOffset' => ['Number', 'HyperTocEntry'], |
|
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 | - } |
|
68 | + /** |
|
69 | + * @inheritdoc |
|
70 | + */ |
|
71 | + public function getSchemaPropertyExpectedTypes(): array |
|
72 | + { |
|
73 | + return [ |
|
74 | + 'about' => ['Thing'], |
|
75 | + 'abstract' => ['Text'], |
|
76 | + 'accessMode' => ['Text'], |
|
77 | + 'accessModeSufficient' => ['ItemList'], |
|
78 | + 'accessibilityAPI' => ['Text'], |
|
79 | + 'accessibilityControl' => ['Text'], |
|
80 | + 'accessibilityFeature' => ['Text'], |
|
81 | + 'accessibilityHazard' => ['Text'], |
|
82 | + 'accessibilitySummary' => ['Text'], |
|
83 | + 'accountablePerson' => ['Person'], |
|
84 | + 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
85 | + 'actor' => ['Person'], |
|
86 | + 'actors' => ['Person'], |
|
87 | + 'additionalType' => ['URL'], |
|
88 | + 'aggregateRating' => ['AggregateRating'], |
|
89 | + 'alternateName' => ['Text'], |
|
90 | + 'alternativeHeadline' => ['Text'], |
|
91 | + 'archivedAt' => ['WebPage', 'URL'], |
|
92 | + 'assesses' => ['DefinedTerm', 'Text'], |
|
93 | + 'associatedMedia' => ['MediaObject'], |
|
94 | + 'audience' => ['Audience'], |
|
95 | + 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
96 | + 'author' => ['Organization', 'Person'], |
|
97 | + 'award' => ['Text'], |
|
98 | + 'awards' => ['Text'], |
|
99 | + 'character' => ['Person'], |
|
100 | + 'citation' => ['CreativeWork', 'Text'], |
|
101 | + 'clipNumber' => ['Integer', 'Text'], |
|
102 | + 'comment' => ['Comment'], |
|
103 | + 'commentCount' => ['Integer'], |
|
104 | + 'conditionsOfAccess' => ['Text'], |
|
105 | + 'contentLocation' => ['Place'], |
|
106 | + 'contentRating' => ['Text', 'Rating'], |
|
107 | + 'contentReferenceTime' => ['DateTime'], |
|
108 | + 'contributor' => ['Organization', 'Person'], |
|
109 | + 'copyrightHolder' => ['Organization', 'Person'], |
|
110 | + 'copyrightNotice' => ['Text'], |
|
111 | + 'copyrightYear' => ['Number'], |
|
112 | + 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
113 | + 'countryOfOrigin' => ['Country'], |
|
114 | + 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
115 | + 'creator' => ['Person', 'Organization'], |
|
116 | + 'creditText' => ['Text'], |
|
117 | + 'dateCreated' => ['DateTime', 'Date'], |
|
118 | + 'dateModified' => ['DateTime', 'Date'], |
|
119 | + 'datePublished' => ['DateTime', 'Date'], |
|
120 | + 'description' => ['Text'], |
|
121 | + 'director' => ['Person'], |
|
122 | + 'directors' => ['Person'], |
|
123 | + 'disambiguatingDescription' => ['Text'], |
|
124 | + 'discussionUrl' => ['URL'], |
|
125 | + 'editEIDR' => ['URL', 'Text'], |
|
126 | + 'editor' => ['Person'], |
|
127 | + 'educationalAlignment' => ['AlignmentObject'], |
|
128 | + 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
129 | + 'educationalUse' => ['DefinedTerm', 'Text'], |
|
130 | + 'encoding' => ['MediaObject'], |
|
131 | + 'encodingFormat' => ['URL', 'Text'], |
|
132 | + 'encodings' => ['MediaObject'], |
|
133 | + 'endOffset' => ['Number', 'HyperTocEntry'], |
|
134 | + 'exampleOfWork' => ['CreativeWork'], |
|
135 | + 'expires' => ['Date', 'DateTime'], |
|
136 | + 'fileFormat' => ['Text', 'URL'], |
|
137 | + 'funder' => ['Organization', 'Person'], |
|
138 | + 'funding' => ['Grant'], |
|
139 | + 'genre' => ['Text', 'URL'], |
|
140 | + 'hasPart' => ['CreativeWork'], |
|
141 | + 'headline' => ['Text'], |
|
142 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
143 | + 'image' => ['URL', 'ImageObject'], |
|
144 | + 'inLanguage' => ['Text', 'Language'], |
|
145 | + 'interactionStatistic' => ['InteractionCounter'], |
|
146 | + 'interactivityType' => ['Text'], |
|
147 | + 'interpretedAsClaim' => ['Claim'], |
|
148 | + 'isAccessibleForFree' => ['Boolean'], |
|
149 | + 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
150 | + 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
151 | + 'isFamilyFriendly' => ['Boolean'], |
|
152 | + 'isPartOf' => ['URL', 'CreativeWork'], |
|
153 | + 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
154 | + 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
155 | + 'license' => ['URL', 'CreativeWork'], |
|
156 | + 'locationCreated' => ['Place'], |
|
157 | + 'mainEntity' => ['Thing'], |
|
158 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
159 | + 'maintainer' => ['Person', 'Organization'], |
|
160 | + 'material' => ['Product', 'URL', 'Text'], |
|
161 | + 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
162 | + 'mentions' => ['Thing'], |
|
163 | + 'musicBy' => ['MusicGroup', 'Person'], |
|
164 | + 'name' => ['Text'], |
|
165 | + 'offers' => ['Demand', 'Offer'], |
|
166 | + 'partOfEpisode' => ['Episode'], |
|
167 | + 'partOfSeason' => ['CreativeWorkSeason'], |
|
168 | + 'partOfSeries' => ['CreativeWorkSeries'], |
|
169 | + 'pattern' => ['DefinedTerm', 'Text'], |
|
170 | + 'position' => ['Text', 'Integer'], |
|
171 | + 'potentialAction' => ['Action'], |
|
172 | + 'producer' => ['Organization', 'Person'], |
|
173 | + 'provider' => ['Organization', 'Person'], |
|
174 | + 'publication' => ['PublicationEvent'], |
|
175 | + 'publisher' => ['Organization', 'Person'], |
|
176 | + 'publisherImprint' => ['Organization'], |
|
177 | + 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
178 | + 'recordedAt' => ['Event'], |
|
179 | + 'releasedEvent' => ['PublicationEvent'], |
|
180 | + 'review' => ['Review'], |
|
181 | + 'reviews' => ['Review'], |
|
182 | + 'sameAs' => ['URL'], |
|
183 | + 'schemaVersion' => ['URL', 'Text'], |
|
184 | + 'sdDatePublished' => ['Date'], |
|
185 | + 'sdLicense' => ['CreativeWork', 'URL'], |
|
186 | + 'sdPublisher' => ['Organization', 'Person'], |
|
187 | + 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
188 | + 'sourceOrganization' => ['Organization'], |
|
189 | + 'spatial' => ['Place'], |
|
190 | + 'spatialCoverage' => ['Place'], |
|
191 | + 'sponsor' => ['Organization', 'Person'], |
|
192 | + 'startOffset' => ['Number', 'HyperTocEntry'], |
|
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 | - 'actor' => 'An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.', |
|
231 | - 'actors' => 'An actor, e.g. in TV, radio, movie, video games etc. Actors can be associated with individual items or with a series, episode, clip.', |
|
232 | - '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.', |
|
233 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
234 | - 'alternateName' => 'An alias for the item.', |
|
235 | - 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
236 | - '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.', |
|
237 | - 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
238 | - 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
239 | - 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
240 | - 'audio' => 'An embedded audio object.', |
|
241 | - '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.', |
|
242 | - 'award' => 'An award won by or for this item.', |
|
243 | - 'awards' => 'Awards won by or for this item.', |
|
244 | - 'character' => 'Fictional person connected with a creative work.', |
|
245 | - 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
246 | - 'clipNumber' => 'Position of the clip within an ordered group of clips.', |
|
247 | - 'comment' => 'Comments, typically from users.', |
|
248 | - '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.', |
|
249 | - '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 ". ', |
|
250 | - 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
251 | - 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
252 | - '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.', |
|
253 | - 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
254 | - 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
255 | - '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.', |
|
256 | - 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
257 | - 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
258 | - '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.', |
|
259 | - '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.', |
|
260 | - 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
261 | - 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
262 | - 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
263 | - 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
264 | - 'datePublished' => 'Date of first broadcast/publication.', |
|
265 | - 'description' => 'A description of the item.', |
|
266 | - 'director' => 'A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.', |
|
267 | - 'directors' => 'A director of e.g. TV, radio, movie, video games etc. content. Directors can be associated with individual items or with a series, episode, clip.', |
|
268 | - '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.', |
|
269 | - 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
270 | - '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. ', |
|
271 | - 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
272 | - '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.', |
|
273 | - '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.', |
|
274 | - 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
275 | - 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
276 | - '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.', |
|
277 | - 'encodings' => 'A media object that encodes this CreativeWork.', |
|
278 | - 'endOffset' => 'The end time of the clip expressed as the number of seconds from the beginning of the work.', |
|
279 | - 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
280 | - '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.', |
|
281 | - '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.', |
|
282 | - 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
283 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
284 | - 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
285 | - 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
286 | - 'headline' => 'Headline of the article.', |
|
287 | - '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. ', |
|
288 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
289 | - '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]].', |
|
290 | - 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
291 | - 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
292 | - '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]].', |
|
293 | - 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
294 | - 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
295 | - '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.', |
|
296 | - 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
297 | - 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
298 | - '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.', |
|
299 | - 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
300 | - 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
301 | - 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
302 | - 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
303 | - '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.', |
|
304 | - '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. ', |
|
305 | - 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
306 | - 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
307 | - 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
308 | - 'musicBy' => 'The composer of the soundtrack.', |
|
309 | - 'name' => 'The name of the item.', |
|
310 | - '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. ', |
|
311 | - 'partOfEpisode' => 'The episode to which this clip belongs.', |
|
312 | - 'partOfSeason' => 'The season to which this episode belongs.', |
|
313 | - 'partOfSeries' => 'The series to which this episode or season belongs.', |
|
314 | - '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.', |
|
315 | - 'position' => 'The position of an item in a series or sequence of items.', |
|
316 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
317 | - 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
318 | - '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.', |
|
319 | - 'publication' => 'A publication event associated with the item.', |
|
320 | - 'publisher' => 'The publisher of the creative work.', |
|
321 | - 'publisherImprint' => 'The publishing division which published the comic.', |
|
322 | - '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. ', |
|
323 | - 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
324 | - 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
325 | - 'review' => 'A review of the item.', |
|
326 | - 'reviews' => 'Review of the item.', |
|
327 | - '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.', |
|
328 | - '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.', |
|
329 | - 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
330 | - 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
331 | - '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.', |
|
332 | - '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. ', |
|
333 | - 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
334 | - 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
335 | - '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.', |
|
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 | - 'startOffset' => 'The start time of the clip expressed as the number of seconds from the beginning of the work.', |
|
338 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
339 | - 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
340 | - '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.', |
|
341 | - '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.', |
|
342 | - 'text' => 'The textual content of this CreativeWork.', |
|
343 | - 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
344 | - '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\'.', |
|
345 | - 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
346 | - '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.', |
|
347 | - 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
348 | - 'url' => 'URL of the item.', |
|
349 | - '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.', |
|
350 | - 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
351 | - 'video' => 'An embedded video object.', |
|
352 | - 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
353 | - '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.' |
|
354 | - ]; |
|
355 | - } |
|
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 | + 'actor' => 'An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.', |
|
231 | + 'actors' => 'An actor, e.g. in TV, radio, movie, video games etc. Actors can be associated with individual items or with a series, episode, clip.', |
|
232 | + '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.', |
|
233 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
234 | + 'alternateName' => 'An alias for the item.', |
|
235 | + 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
236 | + '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.', |
|
237 | + 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
238 | + 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
239 | + 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
240 | + 'audio' => 'An embedded audio object.', |
|
241 | + '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.', |
|
242 | + 'award' => 'An award won by or for this item.', |
|
243 | + 'awards' => 'Awards won by or for this item.', |
|
244 | + 'character' => 'Fictional person connected with a creative work.', |
|
245 | + 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
246 | + 'clipNumber' => 'Position of the clip within an ordered group of clips.', |
|
247 | + 'comment' => 'Comments, typically from users.', |
|
248 | + '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.', |
|
249 | + '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 ". ', |
|
250 | + 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
251 | + 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
252 | + '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.', |
|
253 | + 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
254 | + 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
255 | + '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.', |
|
256 | + 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
257 | + 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
258 | + '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.', |
|
259 | + '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.', |
|
260 | + 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
261 | + 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
262 | + 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
263 | + 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
264 | + 'datePublished' => 'Date of first broadcast/publication.', |
|
265 | + 'description' => 'A description of the item.', |
|
266 | + 'director' => 'A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.', |
|
267 | + 'directors' => 'A director of e.g. TV, radio, movie, video games etc. content. Directors can be associated with individual items or with a series, episode, clip.', |
|
268 | + '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.', |
|
269 | + 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
270 | + '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. ', |
|
271 | + 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
272 | + '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.', |
|
273 | + '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.', |
|
274 | + 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
275 | + 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
276 | + '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.', |
|
277 | + 'encodings' => 'A media object that encodes this CreativeWork.', |
|
278 | + 'endOffset' => 'The end time of the clip expressed as the number of seconds from the beginning of the work.', |
|
279 | + 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
280 | + '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.', |
|
281 | + '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.', |
|
282 | + 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
283 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
284 | + 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
285 | + 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
286 | + 'headline' => 'Headline of the article.', |
|
287 | + '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. ', |
|
288 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
289 | + '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]].', |
|
290 | + 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
291 | + 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
292 | + '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]].', |
|
293 | + 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
294 | + 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
295 | + '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.', |
|
296 | + 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
297 | + 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
298 | + '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.', |
|
299 | + 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
300 | + 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
301 | + 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
302 | + 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
303 | + '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.', |
|
304 | + '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. ', |
|
305 | + 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
306 | + 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
307 | + 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
308 | + 'musicBy' => 'The composer of the soundtrack.', |
|
309 | + 'name' => 'The name of the item.', |
|
310 | + '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. ', |
|
311 | + 'partOfEpisode' => 'The episode to which this clip belongs.', |
|
312 | + 'partOfSeason' => 'The season to which this episode belongs.', |
|
313 | + 'partOfSeries' => 'The series to which this episode or season belongs.', |
|
314 | + '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.', |
|
315 | + 'position' => 'The position of an item in a series or sequence of items.', |
|
316 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
317 | + 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
318 | + '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.', |
|
319 | + 'publication' => 'A publication event associated with the item.', |
|
320 | + 'publisher' => 'The publisher of the creative work.', |
|
321 | + 'publisherImprint' => 'The publishing division which published the comic.', |
|
322 | + '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. ', |
|
323 | + 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
324 | + 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
325 | + 'review' => 'A review of the item.', |
|
326 | + 'reviews' => 'Review of the item.', |
|
327 | + '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.', |
|
328 | + '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.', |
|
329 | + 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
330 | + 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
331 | + '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.', |
|
332 | + '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. ', |
|
333 | + 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
334 | + 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
335 | + '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.', |
|
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 | + 'startOffset' => 'The start time of the clip expressed as the number of seconds from the beginning of the work.', |
|
338 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
339 | + 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
340 | + '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.', |
|
341 | + '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.', |
|
342 | + 'text' => 'The textual content of this CreativeWork.', |
|
343 | + 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
344 | + '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\'.', |
|
345 | + 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
346 | + '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.', |
|
347 | + 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
348 | + 'url' => 'URL of the item.', |
|
349 | + '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.', |
|
350 | + 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
351 | + 'video' => 'An embedded video object.', |
|
352 | + 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
353 | + '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.' |
|
354 | + ]; |
|
355 | + } |
|
356 | 356 | |
357 | 357 | |
358 | - /** |
|
359 | - * @inheritdoc |
|
360 | - */ |
|
361 | - public function getGoogleRequiredSchema(): array |
|
362 | - { |
|
363 | - return ['description', 'name']; |
|
364 | - } |
|
358 | + /** |
|
359 | + * @inheritdoc |
|
360 | + */ |
|
361 | + public function getGoogleRequiredSchema(): array |
|
362 | + { |
|
363 | + return ['description', 'name']; |
|
364 | + } |
|
365 | 365 | |
366 | 366 | |
367 | - /** |
|
368 | - * @inheritdoc |
|
369 | - */ |
|
370 | - public function getGoogleRecommendedSchema(): array |
|
371 | - { |
|
372 | - return ['image', 'url']; |
|
373 | - } |
|
367 | + /** |
|
368 | + * @inheritdoc |
|
369 | + */ |
|
370 | + public function getGoogleRecommendedSchema(): array |
|
371 | + { |
|
372 | + return ['image', 'url']; |
|
373 | + } |
|
374 | 374 | |
375 | 375 | |
376 | - /** |
|
377 | - * @inheritdoc |
|
378 | - */ |
|
379 | - public function defineRules(): array |
|
380 | - { |
|
381 | - $rules = parent::defineRules(); |
|
382 | - $rules = array_merge($rules, [ |
|
383 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
384 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
385 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
386 | - ]); |
|
376 | + /** |
|
377 | + * @inheritdoc |
|
378 | + */ |
|
379 | + public function defineRules(): array |
|
380 | + { |
|
381 | + $rules = parent::defineRules(); |
|
382 | + $rules = array_merge($rules, [ |
|
383 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
384 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
385 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
386 | + ]); |
|
387 | 387 | |
388 | - return $rules; |
|
389 | - } |
|
388 | + return $rules; |
|
389 | + } |
|
390 | 390 | } |
@@ -23,330 +23,330 @@ |
||
23 | 23 | */ |
24 | 24 | class EntertainmentBusiness extends MetaJsonLd implements EntertainmentBusinessInterface, LocalBusinessInterface, PlaceInterface, ThingInterface, OrganizationInterface |
25 | 25 | { |
26 | - use EntertainmentBusinessTrait; |
|
27 | - use LocalBusinessTrait; |
|
28 | - use PlaceTrait; |
|
29 | - use ThingTrait; |
|
30 | - use OrganizationTrait; |
|
26 | + use EntertainmentBusinessTrait; |
|
27 | + use LocalBusinessTrait; |
|
28 | + use PlaceTrait; |
|
29 | + use ThingTrait; |
|
30 | + use OrganizationTrait; |
|
31 | 31 | |
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static $schemaTypeName = 'EntertainmentBusiness'; |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static $schemaTypeName = 'EntertainmentBusiness'; |
|
38 | 38 | |
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static $schemaTypeScope = 'https://schema.org/EntertainmentBusiness'; |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static $schemaTypeScope = 'https://schema.org/EntertainmentBusiness'; |
|
45 | 45 | |
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static $schemaTypeExtends = 'LocalBusiness'; |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static $schemaTypeExtends = 'LocalBusiness'; |
|
52 | 52 | |
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static $schemaTypeDescription = 'A business providing entertainment.'; |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static $schemaTypeDescription = 'A business providing entertainment.'; |
|
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 | - 'additionalProperty' => ['PropertyValue'], |
|
78 | - 'additionalType' => ['URL'], |
|
79 | - 'address' => ['Text', 'PostalAddress'], |
|
80 | - 'aggregateRating' => ['AggregateRating'], |
|
81 | - 'alternateName' => ['Text'], |
|
82 | - 'alumni' => ['Person'], |
|
83 | - 'amenityFeature' => ['LocationFeatureSpecification'], |
|
84 | - 'areaServed' => ['Text', 'Place', 'GeoShape', 'AdministrativeArea'], |
|
85 | - 'award' => ['Text'], |
|
86 | - 'awards' => ['Text'], |
|
87 | - 'branchCode' => ['Text'], |
|
88 | - 'branchOf' => ['Organization'], |
|
89 | - 'brand' => ['Brand', 'Organization'], |
|
90 | - 'contactPoint' => ['ContactPoint'], |
|
91 | - 'contactPoints' => ['ContactPoint'], |
|
92 | - 'containedIn' => ['Place'], |
|
93 | - 'containedInPlace' => ['Place'], |
|
94 | - 'containsPlace' => ['Place'], |
|
95 | - 'correctionsPolicy' => ['URL', 'CreativeWork'], |
|
96 | - 'currenciesAccepted' => ['Text'], |
|
97 | - 'department' => ['Organization'], |
|
98 | - 'description' => ['Text'], |
|
99 | - 'disambiguatingDescription' => ['Text'], |
|
100 | - 'dissolutionDate' => ['Date'], |
|
101 | - 'diversityPolicy' => ['URL', 'CreativeWork'], |
|
102 | - 'diversityStaffingReport' => ['Article', 'URL'], |
|
103 | - 'duns' => ['Text'], |
|
104 | - 'email' => ['Text'], |
|
105 | - 'employee' => ['Person'], |
|
106 | - 'employees' => ['Person'], |
|
107 | - 'ethicsPolicy' => ['CreativeWork', 'URL'], |
|
108 | - 'event' => ['Event'], |
|
109 | - 'events' => ['Event'], |
|
110 | - 'faxNumber' => ['Text'], |
|
111 | - 'founder' => ['Person'], |
|
112 | - 'founders' => ['Person'], |
|
113 | - 'foundingDate' => ['Date'], |
|
114 | - 'foundingLocation' => ['Place'], |
|
115 | - 'funder' => ['Organization', 'Person'], |
|
116 | - 'funding' => ['Grant'], |
|
117 | - 'geo' => ['GeoCoordinates', 'GeoShape'], |
|
118 | - 'geoContains' => ['Place', 'GeospatialGeometry'], |
|
119 | - 'geoCoveredBy' => ['GeospatialGeometry', 'Place'], |
|
120 | - 'geoCovers' => ['GeospatialGeometry', 'Place'], |
|
121 | - 'geoCrosses' => ['GeospatialGeometry', 'Place'], |
|
122 | - 'geoDisjoint' => ['GeospatialGeometry', 'Place'], |
|
123 | - 'geoEquals' => ['GeospatialGeometry', 'Place'], |
|
124 | - 'geoIntersects' => ['GeospatialGeometry', 'Place'], |
|
125 | - 'geoOverlaps' => ['GeospatialGeometry', 'Place'], |
|
126 | - 'geoTouches' => ['GeospatialGeometry', 'Place'], |
|
127 | - 'geoWithin' => ['GeospatialGeometry', 'Place'], |
|
128 | - 'globalLocationNumber' => ['Text'], |
|
129 | - 'hasCredential' => ['EducationalOccupationalCredential'], |
|
130 | - 'hasDriveThroughService' => ['Boolean'], |
|
131 | - 'hasMap' => ['URL', 'Map'], |
|
132 | - 'hasMerchantReturnPolicy' => ['MerchantReturnPolicy'], |
|
133 | - 'hasOfferCatalog' => ['OfferCatalog'], |
|
134 | - 'hasPOS' => ['Place'], |
|
135 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
136 | - 'image' => ['URL', 'ImageObject'], |
|
137 | - 'interactionStatistic' => ['InteractionCounter'], |
|
138 | - 'isAccessibleForFree' => ['Boolean'], |
|
139 | - 'isicV4' => ['Text'], |
|
140 | - 'iso6523Code' => ['Text'], |
|
141 | - 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
142 | - 'knowsAbout' => ['Thing', 'Text', 'URL'], |
|
143 | - 'knowsLanguage' => ['Text', 'Language'], |
|
144 | - 'latitude' => ['Number', 'Text'], |
|
145 | - 'legalName' => ['Text'], |
|
146 | - 'leiCode' => ['Text'], |
|
147 | - 'location' => ['Place', 'Text', 'VirtualLocation', 'PostalAddress'], |
|
148 | - 'logo' => ['ImageObject', 'URL'], |
|
149 | - 'longitude' => ['Text', 'Number'], |
|
150 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
151 | - 'makesOffer' => ['Offer'], |
|
152 | - 'map' => ['URL'], |
|
153 | - 'maps' => ['URL'], |
|
154 | - 'maximumAttendeeCapacity' => ['Integer'], |
|
155 | - 'member' => ['Organization', 'Person'], |
|
156 | - 'memberOf' => ['Organization', 'ProgramMembership'], |
|
157 | - 'members' => ['Organization', 'Person'], |
|
158 | - 'naics' => ['Text'], |
|
159 | - 'name' => ['Text'], |
|
160 | - 'nonprofitStatus' => ['NonprofitType'], |
|
161 | - 'numberOfEmployees' => ['QuantitativeValue'], |
|
162 | - 'openingHours' => ['Text'], |
|
163 | - 'openingHoursSpecification' => ['OpeningHoursSpecification'], |
|
164 | - 'ownershipFundingInfo' => ['AboutPage', 'Text', 'CreativeWork', 'URL'], |
|
165 | - 'owns' => ['Product', 'OwnershipInfo'], |
|
166 | - 'parentOrganization' => ['Organization'], |
|
167 | - 'paymentAccepted' => ['Text'], |
|
168 | - 'photo' => ['Photograph', 'ImageObject'], |
|
169 | - 'photos' => ['ImageObject', 'Photograph'], |
|
170 | - 'potentialAction' => ['Action'], |
|
171 | - 'priceRange' => ['Text'], |
|
172 | - 'publicAccess' => ['Boolean'], |
|
173 | - 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
174 | - 'review' => ['Review'], |
|
175 | - 'reviews' => ['Review'], |
|
176 | - 'sameAs' => ['URL'], |
|
177 | - 'seeks' => ['Demand'], |
|
178 | - 'serviceArea' => ['AdministrativeArea', 'Place', 'GeoShape'], |
|
179 | - 'slogan' => ['Text'], |
|
180 | - 'smokingAllowed' => ['Boolean'], |
|
181 | - 'specialOpeningHoursSpecification' => ['OpeningHoursSpecification'], |
|
182 | - 'sponsor' => ['Organization', 'Person'], |
|
183 | - 'subOrganization' => ['Organization'], |
|
184 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
185 | - 'taxID' => ['Text'], |
|
186 | - 'telephone' => ['Text'], |
|
187 | - 'tourBookingPage' => ['URL'], |
|
188 | - 'unnamedSourcesPolicy' => ['CreativeWork', 'URL'], |
|
189 | - 'url' => ['URL'], |
|
190 | - 'vatID' => ['Text'] |
|
191 | - ]; |
|
192 | - } |
|
70 | + /** |
|
71 | + * @inheritdoc |
|
72 | + */ |
|
73 | + public function getSchemaPropertyExpectedTypes(): array |
|
74 | + { |
|
75 | + return [ |
|
76 | + 'actionableFeedbackPolicy' => ['CreativeWork', 'URL'], |
|
77 | + 'additionalProperty' => ['PropertyValue'], |
|
78 | + 'additionalType' => ['URL'], |
|
79 | + 'address' => ['Text', 'PostalAddress'], |
|
80 | + 'aggregateRating' => ['AggregateRating'], |
|
81 | + 'alternateName' => ['Text'], |
|
82 | + 'alumni' => ['Person'], |
|
83 | + 'amenityFeature' => ['LocationFeatureSpecification'], |
|
84 | + 'areaServed' => ['Text', 'Place', 'GeoShape', 'AdministrativeArea'], |
|
85 | + 'award' => ['Text'], |
|
86 | + 'awards' => ['Text'], |
|
87 | + 'branchCode' => ['Text'], |
|
88 | + 'branchOf' => ['Organization'], |
|
89 | + 'brand' => ['Brand', 'Organization'], |
|
90 | + 'contactPoint' => ['ContactPoint'], |
|
91 | + 'contactPoints' => ['ContactPoint'], |
|
92 | + 'containedIn' => ['Place'], |
|
93 | + 'containedInPlace' => ['Place'], |
|
94 | + 'containsPlace' => ['Place'], |
|
95 | + 'correctionsPolicy' => ['URL', 'CreativeWork'], |
|
96 | + 'currenciesAccepted' => ['Text'], |
|
97 | + 'department' => ['Organization'], |
|
98 | + 'description' => ['Text'], |
|
99 | + 'disambiguatingDescription' => ['Text'], |
|
100 | + 'dissolutionDate' => ['Date'], |
|
101 | + 'diversityPolicy' => ['URL', 'CreativeWork'], |
|
102 | + 'diversityStaffingReport' => ['Article', 'URL'], |
|
103 | + 'duns' => ['Text'], |
|
104 | + 'email' => ['Text'], |
|
105 | + 'employee' => ['Person'], |
|
106 | + 'employees' => ['Person'], |
|
107 | + 'ethicsPolicy' => ['CreativeWork', 'URL'], |
|
108 | + 'event' => ['Event'], |
|
109 | + 'events' => ['Event'], |
|
110 | + 'faxNumber' => ['Text'], |
|
111 | + 'founder' => ['Person'], |
|
112 | + 'founders' => ['Person'], |
|
113 | + 'foundingDate' => ['Date'], |
|
114 | + 'foundingLocation' => ['Place'], |
|
115 | + 'funder' => ['Organization', 'Person'], |
|
116 | + 'funding' => ['Grant'], |
|
117 | + 'geo' => ['GeoCoordinates', 'GeoShape'], |
|
118 | + 'geoContains' => ['Place', 'GeospatialGeometry'], |
|
119 | + 'geoCoveredBy' => ['GeospatialGeometry', 'Place'], |
|
120 | + 'geoCovers' => ['GeospatialGeometry', 'Place'], |
|
121 | + 'geoCrosses' => ['GeospatialGeometry', 'Place'], |
|
122 | + 'geoDisjoint' => ['GeospatialGeometry', 'Place'], |
|
123 | + 'geoEquals' => ['GeospatialGeometry', 'Place'], |
|
124 | + 'geoIntersects' => ['GeospatialGeometry', 'Place'], |
|
125 | + 'geoOverlaps' => ['GeospatialGeometry', 'Place'], |
|
126 | + 'geoTouches' => ['GeospatialGeometry', 'Place'], |
|
127 | + 'geoWithin' => ['GeospatialGeometry', 'Place'], |
|
128 | + 'globalLocationNumber' => ['Text'], |
|
129 | + 'hasCredential' => ['EducationalOccupationalCredential'], |
|
130 | + 'hasDriveThroughService' => ['Boolean'], |
|
131 | + 'hasMap' => ['URL', 'Map'], |
|
132 | + 'hasMerchantReturnPolicy' => ['MerchantReturnPolicy'], |
|
133 | + 'hasOfferCatalog' => ['OfferCatalog'], |
|
134 | + 'hasPOS' => ['Place'], |
|
135 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
136 | + 'image' => ['URL', 'ImageObject'], |
|
137 | + 'interactionStatistic' => ['InteractionCounter'], |
|
138 | + 'isAccessibleForFree' => ['Boolean'], |
|
139 | + 'isicV4' => ['Text'], |
|
140 | + 'iso6523Code' => ['Text'], |
|
141 | + 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
142 | + 'knowsAbout' => ['Thing', 'Text', 'URL'], |
|
143 | + 'knowsLanguage' => ['Text', 'Language'], |
|
144 | + 'latitude' => ['Number', 'Text'], |
|
145 | + 'legalName' => ['Text'], |
|
146 | + 'leiCode' => ['Text'], |
|
147 | + 'location' => ['Place', 'Text', 'VirtualLocation', 'PostalAddress'], |
|
148 | + 'logo' => ['ImageObject', 'URL'], |
|
149 | + 'longitude' => ['Text', 'Number'], |
|
150 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
151 | + 'makesOffer' => ['Offer'], |
|
152 | + 'map' => ['URL'], |
|
153 | + 'maps' => ['URL'], |
|
154 | + 'maximumAttendeeCapacity' => ['Integer'], |
|
155 | + 'member' => ['Organization', 'Person'], |
|
156 | + 'memberOf' => ['Organization', 'ProgramMembership'], |
|
157 | + 'members' => ['Organization', 'Person'], |
|
158 | + 'naics' => ['Text'], |
|
159 | + 'name' => ['Text'], |
|
160 | + 'nonprofitStatus' => ['NonprofitType'], |
|
161 | + 'numberOfEmployees' => ['QuantitativeValue'], |
|
162 | + 'openingHours' => ['Text'], |
|
163 | + 'openingHoursSpecification' => ['OpeningHoursSpecification'], |
|
164 | + 'ownershipFundingInfo' => ['AboutPage', 'Text', 'CreativeWork', 'URL'], |
|
165 | + 'owns' => ['Product', 'OwnershipInfo'], |
|
166 | + 'parentOrganization' => ['Organization'], |
|
167 | + 'paymentAccepted' => ['Text'], |
|
168 | + 'photo' => ['Photograph', 'ImageObject'], |
|
169 | + 'photos' => ['ImageObject', 'Photograph'], |
|
170 | + 'potentialAction' => ['Action'], |
|
171 | + 'priceRange' => ['Text'], |
|
172 | + 'publicAccess' => ['Boolean'], |
|
173 | + 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
174 | + 'review' => ['Review'], |
|
175 | + 'reviews' => ['Review'], |
|
176 | + 'sameAs' => ['URL'], |
|
177 | + 'seeks' => ['Demand'], |
|
178 | + 'serviceArea' => ['AdministrativeArea', 'Place', 'GeoShape'], |
|
179 | + 'slogan' => ['Text'], |
|
180 | + 'smokingAllowed' => ['Boolean'], |
|
181 | + 'specialOpeningHoursSpecification' => ['OpeningHoursSpecification'], |
|
182 | + 'sponsor' => ['Organization', 'Person'], |
|
183 | + 'subOrganization' => ['Organization'], |
|
184 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
185 | + 'taxID' => ['Text'], |
|
186 | + 'telephone' => ['Text'], |
|
187 | + 'tourBookingPage' => ['URL'], |
|
188 | + 'unnamedSourcesPolicy' => ['CreativeWork', 'URL'], |
|
189 | + 'url' => ['URL'], |
|
190 | + 'vatID' => ['Text'] |
|
191 | + ]; |
|
192 | + } |
|
193 | 193 | |
194 | 194 | |
195 | - /** |
|
196 | - * @inheritdoc |
|
197 | - */ |
|
198 | - public function getSchemaPropertyDescriptions(): array |
|
199 | - { |
|
200 | - return [ |
|
201 | - '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.', |
|
202 | - '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. ', |
|
203 | - '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.', |
|
204 | - 'address' => 'Physical address of the item.', |
|
205 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
206 | - 'alternateName' => 'An alias for the item.', |
|
207 | - 'alumni' => 'Alumni of an organization.', |
|
208 | - 'amenityFeature' => 'An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.', |
|
209 | - 'areaServed' => 'The geographic area where a service or offered item is provided.', |
|
210 | - 'award' => 'An award won by or for this item.', |
|
211 | - 'awards' => 'Awards won by or for this item.', |
|
212 | - 'branchCode' => 'A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs. For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch. ', |
|
213 | - 'branchOf' => 'The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].', |
|
214 | - 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
215 | - 'contactPoint' => 'A contact point for a person or organization.', |
|
216 | - 'contactPoints' => 'A contact point for a person or organization.', |
|
217 | - 'containedIn' => 'The basic containment relation between a place and one that contains it.', |
|
218 | - 'containedInPlace' => 'The basic containment relation between a place and one that contains it.', |
|
219 | - 'containsPlace' => 'The basic containment relation between a place and another that it contains.', |
|
220 | - 'correctionsPolicy' => 'For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroom’s) disclosure and correction policy for errors.', |
|
221 | - 'currenciesAccepted' => 'The currency accepted. 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".', |
|
222 | - '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.', |
|
223 | - 'description' => 'A description of the item.', |
|
224 | - '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.', |
|
225 | - 'dissolutionDate' => 'The date that this organization was dissolved.', |
|
226 | - '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.', |
|
227 | - '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.', |
|
228 | - 'duns' => 'The Dun & Bradstreet DUNS number for identifying an organization or business person.', |
|
229 | - 'email' => 'Email address.', |
|
230 | - 'employee' => 'Someone working for this organization.', |
|
231 | - 'employees' => 'People working for this organization.', |
|
232 | - '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.', |
|
233 | - 'event' => 'Upcoming or past event associated with this place, organization, or action.', |
|
234 | - 'events' => 'Upcoming or past events associated with this place or organization.', |
|
235 | - 'faxNumber' => 'The fax number.', |
|
236 | - 'founder' => 'A person who founded this organization.', |
|
237 | - 'founders' => 'A person who founded this organization.', |
|
238 | - 'foundingDate' => 'The date that this organization was founded.', |
|
239 | - 'foundingLocation' => 'The place where the Organization was founded.', |
|
240 | - 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
241 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
242 | - 'geo' => 'The geo coordinates of the place.', |
|
243 | - 'geoContains' => 'Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
244 | - 'geoCoveredBy' => 'Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
245 | - 'geoCovers' => 'Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
246 | - 'geoCrosses' => 'Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
247 | - 'geoDisjoint' => 'Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)', |
|
248 | - 'geoEquals' => 'Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).', |
|
249 | - 'geoIntersects' => 'Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
250 | - 'geoOverlaps' => 'Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
251 | - 'geoTouches' => 'Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)', |
|
252 | - 'geoWithin' => 'Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
253 | - '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.', |
|
254 | - 'hasCredential' => 'A credential awarded to the Person or Organization.', |
|
255 | - 'hasDriveThroughService' => 'Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.', |
|
256 | - 'hasMap' => 'A URL to a map of the place.', |
|
257 | - 'hasMerchantReturnPolicy' => 'Specifies a MerchantReturnPolicy that may be applicable.', |
|
258 | - 'hasOfferCatalog' => 'Indicates an OfferCatalog listing for this Organization, Person, or Service.', |
|
259 | - 'hasPOS' => 'Points-of-Sales operated by the organization or person.', |
|
260 | - '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. ', |
|
261 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
262 | - 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
263 | - 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
264 | - 'isicV4' => 'The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.', |
|
265 | - '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. ', |
|
266 | - '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.', |
|
267 | - '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.', |
|
268 | - '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).', |
|
269 | - 'latitude' => 'The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).', |
|
270 | - 'legalName' => 'The official name of the organization, e.g. the registered company name.', |
|
271 | - 'leiCode' => 'An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.', |
|
272 | - 'location' => 'The location of, for example, where an event is happening, where an organization is located, or where an action takes place.', |
|
273 | - 'logo' => 'An associated logo.', |
|
274 | - 'longitude' => 'The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).', |
|
275 | - '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.', |
|
276 | - 'makesOffer' => 'A pointer to products or services offered by the organization or person.', |
|
277 | - 'map' => 'A URL to a map of the place.', |
|
278 | - 'maps' => 'A URL to a map of the place.', |
|
279 | - 'maximumAttendeeCapacity' => 'The total number of individuals that may attend an event or venue.', |
|
280 | - 'member' => 'A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.', |
|
281 | - 'memberOf' => 'An Organization (or ProgramMembership) to which this Person or Organization belongs.', |
|
282 | - 'members' => 'A member of this organization.', |
|
283 | - 'naics' => 'The North American Industry Classification System (NAICS) code for a particular organization or business person.', |
|
284 | - 'name' => 'The name of the item.', |
|
285 | - 'nonprofitStatus' => 'nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.', |
|
286 | - 'numberOfEmployees' => 'The number of employees in an organization, e.g. business.', |
|
287 | - 'openingHours' => 'The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas \',\' separating each day. Day or time ranges are specified using a hyphen \'-\'. * Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. * Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>. * If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.', |
|
288 | - 'openingHoursSpecification' => 'The opening hours of a certain place.', |
|
289 | - '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.', |
|
290 | - 'owns' => 'Products owned by the organization or person.', |
|
291 | - 'parentOrganization' => 'The larger organization that this organization is a [[subOrganization]] of, if any.', |
|
292 | - 'paymentAccepted' => 'Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.', |
|
293 | - 'photo' => 'A photograph of this place.', |
|
294 | - 'photos' => 'Photographs of this place.', |
|
295 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
296 | - 'priceRange' => 'The price range of the business, for example ```$$$```.', |
|
297 | - 'publicAccess' => 'A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value', |
|
298 | - '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. ', |
|
299 | - 'review' => 'A review of the item.', |
|
300 | - 'reviews' => 'Review of the item.', |
|
301 | - '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.', |
|
302 | - 'seeks' => 'A pointer to products or services sought by the organization or person (demand).', |
|
303 | - 'serviceArea' => 'The geographic area where the service is provided.', |
|
304 | - 'slogan' => 'A slogan or motto associated with the item.', |
|
305 | - 'smokingAllowed' => 'Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.', |
|
306 | - 'specialOpeningHoursSpecification' => 'The special opening hours of a certain place. Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]]. ', |
|
307 | - '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.', |
|
308 | - 'subOrganization' => 'A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific \'department\' property.', |
|
309 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
310 | - 'taxID' => 'The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.', |
|
311 | - 'telephone' => 'The telephone number.', |
|
312 | - 'tourBookingPage' => 'A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.', |
|
313 | - 'unnamedSourcesPolicy' => 'For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.', |
|
314 | - 'url' => 'URL of the item.', |
|
315 | - 'vatID' => 'The Value-added Tax ID of the organization or person.' |
|
316 | - ]; |
|
317 | - } |
|
195 | + /** |
|
196 | + * @inheritdoc |
|
197 | + */ |
|
198 | + public function getSchemaPropertyDescriptions(): array |
|
199 | + { |
|
200 | + return [ |
|
201 | + '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.', |
|
202 | + '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. ', |
|
203 | + '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.', |
|
204 | + 'address' => 'Physical address of the item.', |
|
205 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
206 | + 'alternateName' => 'An alias for the item.', |
|
207 | + 'alumni' => 'Alumni of an organization.', |
|
208 | + 'amenityFeature' => 'An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.', |
|
209 | + 'areaServed' => 'The geographic area where a service or offered item is provided.', |
|
210 | + 'award' => 'An award won by or for this item.', |
|
211 | + 'awards' => 'Awards won by or for this item.', |
|
212 | + 'branchCode' => 'A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs. For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch. ', |
|
213 | + 'branchOf' => 'The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].', |
|
214 | + 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
215 | + 'contactPoint' => 'A contact point for a person or organization.', |
|
216 | + 'contactPoints' => 'A contact point for a person or organization.', |
|
217 | + 'containedIn' => 'The basic containment relation between a place and one that contains it.', |
|
218 | + 'containedInPlace' => 'The basic containment relation between a place and one that contains it.', |
|
219 | + 'containsPlace' => 'The basic containment relation between a place and another that it contains.', |
|
220 | + 'correctionsPolicy' => 'For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroom’s) disclosure and correction policy for errors.', |
|
221 | + 'currenciesAccepted' => 'The currency accepted. 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".', |
|
222 | + '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.', |
|
223 | + 'description' => 'A description of the item.', |
|
224 | + '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.', |
|
225 | + 'dissolutionDate' => 'The date that this organization was dissolved.', |
|
226 | + '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.', |
|
227 | + '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.', |
|
228 | + 'duns' => 'The Dun & Bradstreet DUNS number for identifying an organization or business person.', |
|
229 | + 'email' => 'Email address.', |
|
230 | + 'employee' => 'Someone working for this organization.', |
|
231 | + 'employees' => 'People working for this organization.', |
|
232 | + '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.', |
|
233 | + 'event' => 'Upcoming or past event associated with this place, organization, or action.', |
|
234 | + 'events' => 'Upcoming or past events associated with this place or organization.', |
|
235 | + 'faxNumber' => 'The fax number.', |
|
236 | + 'founder' => 'A person who founded this organization.', |
|
237 | + 'founders' => 'A person who founded this organization.', |
|
238 | + 'foundingDate' => 'The date that this organization was founded.', |
|
239 | + 'foundingLocation' => 'The place where the Organization was founded.', |
|
240 | + 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
241 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
242 | + 'geo' => 'The geo coordinates of the place.', |
|
243 | + 'geoContains' => 'Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
244 | + 'geoCoveredBy' => 'Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
245 | + 'geoCovers' => 'Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
246 | + 'geoCrosses' => 'Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
247 | + 'geoDisjoint' => 'Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)', |
|
248 | + 'geoEquals' => 'Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).', |
|
249 | + 'geoIntersects' => 'Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
250 | + 'geoOverlaps' => 'Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
251 | + 'geoTouches' => 'Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)', |
|
252 | + 'geoWithin' => 'Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).', |
|
253 | + '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.', |
|
254 | + 'hasCredential' => 'A credential awarded to the Person or Organization.', |
|
255 | + 'hasDriveThroughService' => 'Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.', |
|
256 | + 'hasMap' => 'A URL to a map of the place.', |
|
257 | + 'hasMerchantReturnPolicy' => 'Specifies a MerchantReturnPolicy that may be applicable.', |
|
258 | + 'hasOfferCatalog' => 'Indicates an OfferCatalog listing for this Organization, Person, or Service.', |
|
259 | + 'hasPOS' => 'Points-of-Sales operated by the organization or person.', |
|
260 | + '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. ', |
|
261 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
262 | + 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
263 | + 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
264 | + 'isicV4' => 'The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.', |
|
265 | + '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. ', |
|
266 | + '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.', |
|
267 | + '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.', |
|
268 | + '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).', |
|
269 | + 'latitude' => 'The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).', |
|
270 | + 'legalName' => 'The official name of the organization, e.g. the registered company name.', |
|
271 | + 'leiCode' => 'An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.', |
|
272 | + 'location' => 'The location of, for example, where an event is happening, where an organization is located, or where an action takes place.', |
|
273 | + 'logo' => 'An associated logo.', |
|
274 | + 'longitude' => 'The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).', |
|
275 | + '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.', |
|
276 | + 'makesOffer' => 'A pointer to products or services offered by the organization or person.', |
|
277 | + 'map' => 'A URL to a map of the place.', |
|
278 | + 'maps' => 'A URL to a map of the place.', |
|
279 | + 'maximumAttendeeCapacity' => 'The total number of individuals that may attend an event or venue.', |
|
280 | + 'member' => 'A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.', |
|
281 | + 'memberOf' => 'An Organization (or ProgramMembership) to which this Person or Organization belongs.', |
|
282 | + 'members' => 'A member of this organization.', |
|
283 | + 'naics' => 'The North American Industry Classification System (NAICS) code for a particular organization or business person.', |
|
284 | + 'name' => 'The name of the item.', |
|
285 | + 'nonprofitStatus' => 'nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.', |
|
286 | + 'numberOfEmployees' => 'The number of employees in an organization, e.g. business.', |
|
287 | + 'openingHours' => 'The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas \',\' separating each day. Day or time ranges are specified using a hyphen \'-\'. * Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. * Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>. * If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.', |
|
288 | + 'openingHoursSpecification' => 'The opening hours of a certain place.', |
|
289 | + '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.', |
|
290 | + 'owns' => 'Products owned by the organization or person.', |
|
291 | + 'parentOrganization' => 'The larger organization that this organization is a [[subOrganization]] of, if any.', |
|
292 | + 'paymentAccepted' => 'Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.', |
|
293 | + 'photo' => 'A photograph of this place.', |
|
294 | + 'photos' => 'Photographs of this place.', |
|
295 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
296 | + 'priceRange' => 'The price range of the business, for example ```$$$```.', |
|
297 | + 'publicAccess' => 'A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value', |
|
298 | + '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. ', |
|
299 | + 'review' => 'A review of the item.', |
|
300 | + 'reviews' => 'Review of the item.', |
|
301 | + '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.', |
|
302 | + 'seeks' => 'A pointer to products or services sought by the organization or person (demand).', |
|
303 | + 'serviceArea' => 'The geographic area where the service is provided.', |
|
304 | + 'slogan' => 'A slogan or motto associated with the item.', |
|
305 | + 'smokingAllowed' => 'Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.', |
|
306 | + 'specialOpeningHoursSpecification' => 'The special opening hours of a certain place. Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]]. ', |
|
307 | + '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.', |
|
308 | + 'subOrganization' => 'A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific \'department\' property.', |
|
309 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
310 | + 'taxID' => 'The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.', |
|
311 | + 'telephone' => 'The telephone number.', |
|
312 | + 'tourBookingPage' => 'A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.', |
|
313 | + 'unnamedSourcesPolicy' => 'For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.', |
|
314 | + 'url' => 'URL of the item.', |
|
315 | + 'vatID' => 'The Value-added Tax ID of the organization or person.' |
|
316 | + ]; |
|
317 | + } |
|
318 | 318 | |
319 | 319 | |
320 | - /** |
|
321 | - * @inheritdoc |
|
322 | - */ |
|
323 | - public function getGoogleRequiredSchema(): array |
|
324 | - { |
|
325 | - return ['description', 'name']; |
|
326 | - } |
|
320 | + /** |
|
321 | + * @inheritdoc |
|
322 | + */ |
|
323 | + public function getGoogleRequiredSchema(): array |
|
324 | + { |
|
325 | + return ['description', 'name']; |
|
326 | + } |
|
327 | 327 | |
328 | 328 | |
329 | - /** |
|
330 | - * @inheritdoc |
|
331 | - */ |
|
332 | - public function getGoogleRecommendedSchema(): array |
|
333 | - { |
|
334 | - return ['image', 'url']; |
|
335 | - } |
|
329 | + /** |
|
330 | + * @inheritdoc |
|
331 | + */ |
|
332 | + public function getGoogleRecommendedSchema(): array |
|
333 | + { |
|
334 | + return ['image', 'url']; |
|
335 | + } |
|
336 | 336 | |
337 | 337 | |
338 | - /** |
|
339 | - * @inheritdoc |
|
340 | - */ |
|
341 | - public function defineRules(): array |
|
342 | - { |
|
343 | - $rules = parent::defineRules(); |
|
344 | - $rules = array_merge($rules, [ |
|
345 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
346 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
347 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
348 | - ]); |
|
338 | + /** |
|
339 | + * @inheritdoc |
|
340 | + */ |
|
341 | + public function defineRules(): array |
|
342 | + { |
|
343 | + $rules = parent::defineRules(); |
|
344 | + $rules = array_merge($rules, [ |
|
345 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
346 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
347 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
348 | + ]); |
|
349 | 349 | |
350 | - return $rules; |
|
351 | - } |
|
350 | + return $rules; |
|
351 | + } |
|
352 | 352 | } |
@@ -24,150 +24,150 @@ |
||
24 | 24 | */ |
25 | 25 | class MedicalDevice extends MetaJsonLd implements MedicalDeviceInterface, MedicalEntityInterface, ThingInterface |
26 | 26 | { |
27 | - use MedicalDeviceTrait; |
|
28 | - use MedicalEntityTrait; |
|
29 | - use ThingTrait; |
|
30 | - |
|
31 | - /** |
|
32 | - * The Schema.org Type Name |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - public static $schemaTypeName = 'MedicalDevice'; |
|
37 | - |
|
38 | - /** |
|
39 | - * The Schema.org Type Scope |
|
40 | - * |
|
41 | - * @var string |
|
42 | - */ |
|
43 | - public static $schemaTypeScope = 'https://schema.org/MedicalDevice'; |
|
44 | - |
|
45 | - /** |
|
46 | - * The Schema.org Type Extends |
|
47 | - * |
|
48 | - * @var string |
|
49 | - */ |
|
50 | - public static $schemaTypeExtends = 'MedicalEntity'; |
|
51 | - |
|
52 | - /** |
|
53 | - * The Schema.org Type Description |
|
54 | - * |
|
55 | - * @var string |
|
56 | - */ |
|
57 | - public static $schemaTypeDescription = 'Any object used in a medical capacity, such as to diagnose or treat a patient.'; |
|
58 | - |
|
59 | - |
|
60 | - /** |
|
61 | - * @inheritdoc |
|
62 | - */ |
|
63 | - public function getSchemaPropertyNames(): array |
|
64 | - { |
|
65 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
66 | - } |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * @inheritdoc |
|
71 | - */ |
|
72 | - public function getSchemaPropertyExpectedTypes(): array |
|
73 | - { |
|
74 | - return [ |
|
75 | - 'additionalType' => ['URL'], |
|
76 | - 'adverseOutcome' => ['MedicalEntity'], |
|
77 | - 'alternateName' => ['Text'], |
|
78 | - 'code' => ['MedicalCode'], |
|
79 | - 'contraindication' => ['Text', 'MedicalContraindication'], |
|
80 | - 'description' => ['Text'], |
|
81 | - 'disambiguatingDescription' => ['Text'], |
|
82 | - 'funding' => ['Grant'], |
|
83 | - 'guideline' => ['MedicalGuideline'], |
|
84 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
85 | - 'image' => ['URL', 'ImageObject'], |
|
86 | - 'legalStatus' => ['Text', 'DrugLegalStatus', 'MedicalEnumeration'], |
|
87 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
88 | - 'medicineSystem' => ['MedicineSystem'], |
|
89 | - 'name' => ['Text'], |
|
90 | - 'postOp' => ['Text'], |
|
91 | - 'potentialAction' => ['Action'], |
|
92 | - 'preOp' => ['Text'], |
|
93 | - 'procedure' => ['Text'], |
|
94 | - 'recognizingAuthority' => ['Organization'], |
|
95 | - 'relevantSpecialty' => ['MedicalSpecialty'], |
|
96 | - 'sameAs' => ['URL'], |
|
97 | - 'seriousAdverseOutcome' => ['MedicalEntity'], |
|
98 | - 'study' => ['MedicalStudy'], |
|
99 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
100 | - 'url' => ['URL'] |
|
101 | - ]; |
|
102 | - } |
|
103 | - |
|
104 | - |
|
105 | - /** |
|
106 | - * @inheritdoc |
|
107 | - */ |
|
108 | - public function getSchemaPropertyDescriptions(): array |
|
109 | - { |
|
110 | - return [ |
|
111 | - '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.', |
|
112 | - 'adverseOutcome' => 'A possible complication and/or side effect of this therapy. If it is known that an adverse outcome is serious (resulting in death, disability, or permanent damage; requiring hospitalization; or otherwise life-threatening or requiring immediate medical attention), tag it as a seriousAdverseOutcome instead.', |
|
113 | - 'alternateName' => 'An alias for the item.', |
|
114 | - 'code' => 'A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.', |
|
115 | - 'contraindication' => 'A contraindication for this therapy.', |
|
116 | - 'description' => 'A description of the item.', |
|
117 | - '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.', |
|
118 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
119 | - 'guideline' => 'A medical guideline related to this entity.', |
|
120 | - '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. ', |
|
121 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
122 | - 'legalStatus' => 'The drug or supplement\'s legal status, including any controlled substance schedules that apply.', |
|
123 | - '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.', |
|
124 | - 'medicineSystem' => 'The system of medicine that includes this MedicalEntity, for example \'evidence-based\', \'homeopathic\', \'chiropractic\', etc.', |
|
125 | - 'name' => 'The name of the item.', |
|
126 | - 'postOp' => 'A description of the postoperative procedures, care, and/or followups for this device.', |
|
127 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
128 | - 'preOp' => 'A description of the workup, testing, and other preparations required before implanting this device.', |
|
129 | - 'procedure' => 'A description of the procedure involved in setting up, using, and/or installing the device.', |
|
130 | - 'recognizingAuthority' => 'If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.', |
|
131 | - 'relevantSpecialty' => 'If applicable, a medical specialty in which this entity is relevant.', |
|
132 | - '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.', |
|
133 | - 'seriousAdverseOutcome' => 'A possible serious complication and/or serious side effect of this therapy. Serious adverse outcomes include those that are life-threatening; result in death, disability, or permanent damage; require hospitalization or prolong existing hospitalization; cause congenital anomalies or birth defects; or jeopardize the patient and may require medical or surgical intervention to prevent one of the outcomes in this definition.', |
|
134 | - 'study' => 'A medical study or trial related to this entity.', |
|
135 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
136 | - 'url' => 'URL of the item.' |
|
137 | - ]; |
|
138 | - } |
|
139 | - |
|
140 | - |
|
141 | - /** |
|
142 | - * @inheritdoc |
|
143 | - */ |
|
144 | - public function getGoogleRequiredSchema(): array |
|
145 | - { |
|
146 | - return ['description', 'name']; |
|
147 | - } |
|
148 | - |
|
149 | - |
|
150 | - /** |
|
151 | - * @inheritdoc |
|
152 | - */ |
|
153 | - public function getGoogleRecommendedSchema(): array |
|
154 | - { |
|
155 | - return ['image', 'url']; |
|
156 | - } |
|
157 | - |
|
158 | - |
|
159 | - /** |
|
160 | - * @inheritdoc |
|
161 | - */ |
|
162 | - public function defineRules(): array |
|
163 | - { |
|
164 | - $rules = parent::defineRules(); |
|
165 | - $rules = array_merge($rules, [ |
|
166 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
167 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
168 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
169 | - ]); |
|
170 | - |
|
171 | - return $rules; |
|
172 | - } |
|
27 | + use MedicalDeviceTrait; |
|
28 | + use MedicalEntityTrait; |
|
29 | + use ThingTrait; |
|
30 | + |
|
31 | + /** |
|
32 | + * The Schema.org Type Name |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + public static $schemaTypeName = 'MedicalDevice'; |
|
37 | + |
|
38 | + /** |
|
39 | + * The Schema.org Type Scope |
|
40 | + * |
|
41 | + * @var string |
|
42 | + */ |
|
43 | + public static $schemaTypeScope = 'https://schema.org/MedicalDevice'; |
|
44 | + |
|
45 | + /** |
|
46 | + * The Schema.org Type Extends |
|
47 | + * |
|
48 | + * @var string |
|
49 | + */ |
|
50 | + public static $schemaTypeExtends = 'MedicalEntity'; |
|
51 | + |
|
52 | + /** |
|
53 | + * The Schema.org Type Description |
|
54 | + * |
|
55 | + * @var string |
|
56 | + */ |
|
57 | + public static $schemaTypeDescription = 'Any object used in a medical capacity, such as to diagnose or treat a patient.'; |
|
58 | + |
|
59 | + |
|
60 | + /** |
|
61 | + * @inheritdoc |
|
62 | + */ |
|
63 | + public function getSchemaPropertyNames(): array |
|
64 | + { |
|
65 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
66 | + } |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * @inheritdoc |
|
71 | + */ |
|
72 | + public function getSchemaPropertyExpectedTypes(): array |
|
73 | + { |
|
74 | + return [ |
|
75 | + 'additionalType' => ['URL'], |
|
76 | + 'adverseOutcome' => ['MedicalEntity'], |
|
77 | + 'alternateName' => ['Text'], |
|
78 | + 'code' => ['MedicalCode'], |
|
79 | + 'contraindication' => ['Text', 'MedicalContraindication'], |
|
80 | + 'description' => ['Text'], |
|
81 | + 'disambiguatingDescription' => ['Text'], |
|
82 | + 'funding' => ['Grant'], |
|
83 | + 'guideline' => ['MedicalGuideline'], |
|
84 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
85 | + 'image' => ['URL', 'ImageObject'], |
|
86 | + 'legalStatus' => ['Text', 'DrugLegalStatus', 'MedicalEnumeration'], |
|
87 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
88 | + 'medicineSystem' => ['MedicineSystem'], |
|
89 | + 'name' => ['Text'], |
|
90 | + 'postOp' => ['Text'], |
|
91 | + 'potentialAction' => ['Action'], |
|
92 | + 'preOp' => ['Text'], |
|
93 | + 'procedure' => ['Text'], |
|
94 | + 'recognizingAuthority' => ['Organization'], |
|
95 | + 'relevantSpecialty' => ['MedicalSpecialty'], |
|
96 | + 'sameAs' => ['URL'], |
|
97 | + 'seriousAdverseOutcome' => ['MedicalEntity'], |
|
98 | + 'study' => ['MedicalStudy'], |
|
99 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
100 | + 'url' => ['URL'] |
|
101 | + ]; |
|
102 | + } |
|
103 | + |
|
104 | + |
|
105 | + /** |
|
106 | + * @inheritdoc |
|
107 | + */ |
|
108 | + public function getSchemaPropertyDescriptions(): array |
|
109 | + { |
|
110 | + return [ |
|
111 | + '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.', |
|
112 | + 'adverseOutcome' => 'A possible complication and/or side effect of this therapy. If it is known that an adverse outcome is serious (resulting in death, disability, or permanent damage; requiring hospitalization; or otherwise life-threatening or requiring immediate medical attention), tag it as a seriousAdverseOutcome instead.', |
|
113 | + 'alternateName' => 'An alias for the item.', |
|
114 | + 'code' => 'A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.', |
|
115 | + 'contraindication' => 'A contraindication for this therapy.', |
|
116 | + 'description' => 'A description of the item.', |
|
117 | + '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.', |
|
118 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
119 | + 'guideline' => 'A medical guideline related to this entity.', |
|
120 | + '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. ', |
|
121 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
122 | + 'legalStatus' => 'The drug or supplement\'s legal status, including any controlled substance schedules that apply.', |
|
123 | + '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.', |
|
124 | + 'medicineSystem' => 'The system of medicine that includes this MedicalEntity, for example \'evidence-based\', \'homeopathic\', \'chiropractic\', etc.', |
|
125 | + 'name' => 'The name of the item.', |
|
126 | + 'postOp' => 'A description of the postoperative procedures, care, and/or followups for this device.', |
|
127 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
128 | + 'preOp' => 'A description of the workup, testing, and other preparations required before implanting this device.', |
|
129 | + 'procedure' => 'A description of the procedure involved in setting up, using, and/or installing the device.', |
|
130 | + 'recognizingAuthority' => 'If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.', |
|
131 | + 'relevantSpecialty' => 'If applicable, a medical specialty in which this entity is relevant.', |
|
132 | + '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.', |
|
133 | + 'seriousAdverseOutcome' => 'A possible serious complication and/or serious side effect of this therapy. Serious adverse outcomes include those that are life-threatening; result in death, disability, or permanent damage; require hospitalization or prolong existing hospitalization; cause congenital anomalies or birth defects; or jeopardize the patient and may require medical or surgical intervention to prevent one of the outcomes in this definition.', |
|
134 | + 'study' => 'A medical study or trial related to this entity.', |
|
135 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
136 | + 'url' => 'URL of the item.' |
|
137 | + ]; |
|
138 | + } |
|
139 | + |
|
140 | + |
|
141 | + /** |
|
142 | + * @inheritdoc |
|
143 | + */ |
|
144 | + public function getGoogleRequiredSchema(): array |
|
145 | + { |
|
146 | + return ['description', 'name']; |
|
147 | + } |
|
148 | + |
|
149 | + |
|
150 | + /** |
|
151 | + * @inheritdoc |
|
152 | + */ |
|
153 | + public function getGoogleRecommendedSchema(): array |
|
154 | + { |
|
155 | + return ['image', 'url']; |
|
156 | + } |
|
157 | + |
|
158 | + |
|
159 | + /** |
|
160 | + * @inheritdoc |
|
161 | + */ |
|
162 | + public function defineRules(): array |
|
163 | + { |
|
164 | + $rules = parent::defineRules(); |
|
165 | + $rules = array_merge($rules, [ |
|
166 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
167 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
168 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
169 | + ]); |
|
170 | + |
|
171 | + return $rules; |
|
172 | + } |
|
173 | 173 | } |
@@ -23,138 +23,138 @@ |
||
23 | 23 | */ |
24 | 24 | class EmployeeRole extends MetaJsonLd implements EmployeeRoleInterface, OrganizationRoleInterface, RoleInterface, IntangibleInterface, ThingInterface |
25 | 25 | { |
26 | - use EmployeeRoleTrait; |
|
27 | - use OrganizationRoleTrait; |
|
28 | - use RoleTrait; |
|
29 | - use IntangibleTrait; |
|
30 | - use ThingTrait; |
|
31 | - |
|
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static $schemaTypeName = 'EmployeeRole'; |
|
38 | - |
|
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static $schemaTypeScope = 'https://schema.org/EmployeeRole'; |
|
45 | - |
|
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static $schemaTypeExtends = 'OrganizationRole'; |
|
52 | - |
|
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static $schemaTypeDescription = 'A subclass of OrganizationRole used to describe employee relationships.'; |
|
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 | - 'baseSalary' => ['MonetaryAmount', 'Number', 'PriceSpecification'], |
|
79 | - 'description' => ['Text'], |
|
80 | - 'disambiguatingDescription' => ['Text'], |
|
81 | - 'endDate' => ['DateTime', 'Date'], |
|
82 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
83 | - 'image' => ['URL', 'ImageObject'], |
|
84 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
85 | - 'name' => ['Text'], |
|
86 | - 'namedPosition' => ['Text', 'URL'], |
|
87 | - 'numberedPosition' => ['Number'], |
|
88 | - 'potentialAction' => ['Action'], |
|
89 | - 'roleName' => ['Text', 'URL'], |
|
90 | - 'salaryCurrency' => ['Text'], |
|
91 | - 'sameAs' => ['URL'], |
|
92 | - 'startDate' => ['DateTime', 'Date'], |
|
93 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
94 | - 'url' => ['URL'] |
|
95 | - ]; |
|
96 | - } |
|
97 | - |
|
98 | - |
|
99 | - /** |
|
100 | - * @inheritdoc |
|
101 | - */ |
|
102 | - public function getSchemaPropertyDescriptions(): array |
|
103 | - { |
|
104 | - return [ |
|
105 | - '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.', |
|
106 | - 'alternateName' => 'An alias for the item.', |
|
107 | - 'baseSalary' => 'The base salary of the job or of an employee in an EmployeeRole.', |
|
108 | - 'description' => 'A description of the item.', |
|
109 | - '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.', |
|
110 | - 'endDate' => 'The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
111 | - '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. ', |
|
112 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
113 | - '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.', |
|
114 | - 'name' => 'The name of the item.', |
|
115 | - 'namedPosition' => 'A position played, performed or filled by a person or organization, as part of an organization. For example, an athlete in a SportsTeam might play in the position named \'Quarterback\'.', |
|
116 | - 'numberedPosition' => 'A number associated with a role in an organization, for example, the number on an athlete\'s jersey.', |
|
117 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
118 | - 'roleName' => 'A role played, performed or filled by a person or organization. For example, the team of creators for a comic book might fill the roles named \'inker\', \'penciller\', and \'letterer\'; or an athlete in a SportsTeam might play in the position named \'Quarterback\'.', |
|
119 | - 'salaryCurrency' => 'The currency (coded using [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)) used for the main salary information in this job posting or for this employee.', |
|
120 | - '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.', |
|
121 | - 'startDate' => 'The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
122 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
123 | - 'url' => 'URL of the item.' |
|
124 | - ]; |
|
125 | - } |
|
126 | - |
|
127 | - |
|
128 | - /** |
|
129 | - * @inheritdoc |
|
130 | - */ |
|
131 | - public function getGoogleRequiredSchema(): array |
|
132 | - { |
|
133 | - return ['description', 'name']; |
|
134 | - } |
|
135 | - |
|
136 | - |
|
137 | - /** |
|
138 | - * @inheritdoc |
|
139 | - */ |
|
140 | - public function getGoogleRecommendedSchema(): array |
|
141 | - { |
|
142 | - return ['image', 'url']; |
|
143 | - } |
|
144 | - |
|
145 | - |
|
146 | - /** |
|
147 | - * @inheritdoc |
|
148 | - */ |
|
149 | - public function defineRules(): array |
|
150 | - { |
|
151 | - $rules = parent::defineRules(); |
|
152 | - $rules = array_merge($rules, [ |
|
153 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
154 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
155 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
156 | - ]); |
|
157 | - |
|
158 | - return $rules; |
|
159 | - } |
|
26 | + use EmployeeRoleTrait; |
|
27 | + use OrganizationRoleTrait; |
|
28 | + use RoleTrait; |
|
29 | + use IntangibleTrait; |
|
30 | + use ThingTrait; |
|
31 | + |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static $schemaTypeName = 'EmployeeRole'; |
|
38 | + |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static $schemaTypeScope = 'https://schema.org/EmployeeRole'; |
|
45 | + |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static $schemaTypeExtends = 'OrganizationRole'; |
|
52 | + |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static $schemaTypeDescription = 'A subclass of OrganizationRole used to describe employee relationships.'; |
|
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 | + 'baseSalary' => ['MonetaryAmount', 'Number', 'PriceSpecification'], |
|
79 | + 'description' => ['Text'], |
|
80 | + 'disambiguatingDescription' => ['Text'], |
|
81 | + 'endDate' => ['DateTime', 'Date'], |
|
82 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
83 | + 'image' => ['URL', 'ImageObject'], |
|
84 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
85 | + 'name' => ['Text'], |
|
86 | + 'namedPosition' => ['Text', 'URL'], |
|
87 | + 'numberedPosition' => ['Number'], |
|
88 | + 'potentialAction' => ['Action'], |
|
89 | + 'roleName' => ['Text', 'URL'], |
|
90 | + 'salaryCurrency' => ['Text'], |
|
91 | + 'sameAs' => ['URL'], |
|
92 | + 'startDate' => ['DateTime', 'Date'], |
|
93 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
94 | + 'url' => ['URL'] |
|
95 | + ]; |
|
96 | + } |
|
97 | + |
|
98 | + |
|
99 | + /** |
|
100 | + * @inheritdoc |
|
101 | + */ |
|
102 | + public function getSchemaPropertyDescriptions(): array |
|
103 | + { |
|
104 | + return [ |
|
105 | + '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.', |
|
106 | + 'alternateName' => 'An alias for the item.', |
|
107 | + 'baseSalary' => 'The base salary of the job or of an employee in an EmployeeRole.', |
|
108 | + 'description' => 'A description of the item.', |
|
109 | + '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.', |
|
110 | + 'endDate' => 'The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
111 | + '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. ', |
|
112 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
113 | + '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.', |
|
114 | + 'name' => 'The name of the item.', |
|
115 | + 'namedPosition' => 'A position played, performed or filled by a person or organization, as part of an organization. For example, an athlete in a SportsTeam might play in the position named \'Quarterback\'.', |
|
116 | + 'numberedPosition' => 'A number associated with a role in an organization, for example, the number on an athlete\'s jersey.', |
|
117 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
118 | + 'roleName' => 'A role played, performed or filled by a person or organization. For example, the team of creators for a comic book might fill the roles named \'inker\', \'penciller\', and \'letterer\'; or an athlete in a SportsTeam might play in the position named \'Quarterback\'.', |
|
119 | + 'salaryCurrency' => 'The currency (coded using [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)) used for the main salary information in this job posting or for this employee.', |
|
120 | + '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.', |
|
121 | + 'startDate' => 'The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
122 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
123 | + 'url' => 'URL of the item.' |
|
124 | + ]; |
|
125 | + } |
|
126 | + |
|
127 | + |
|
128 | + /** |
|
129 | + * @inheritdoc |
|
130 | + */ |
|
131 | + public function getGoogleRequiredSchema(): array |
|
132 | + { |
|
133 | + return ['description', 'name']; |
|
134 | + } |
|
135 | + |
|
136 | + |
|
137 | + /** |
|
138 | + * @inheritdoc |
|
139 | + */ |
|
140 | + public function getGoogleRecommendedSchema(): array |
|
141 | + { |
|
142 | + return ['image', 'url']; |
|
143 | + } |
|
144 | + |
|
145 | + |
|
146 | + /** |
|
147 | + * @inheritdoc |
|
148 | + */ |
|
149 | + public function defineRules(): array |
|
150 | + { |
|
151 | + $rules = parent::defineRules(); |
|
152 | + $rules = array_merge($rules, [ |
|
153 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
154 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
155 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
156 | + ]); |
|
157 | + |
|
158 | + return $rules; |
|
159 | + } |
|
160 | 160 | } |
@@ -24,383 +24,383 @@ |
||
24 | 24 | */ |
25 | 25 | class RadioSeries extends MetaJsonLd implements RadioSeriesInterface, CreativeWorkSeriesInterface, SeriesInterface, IntangibleInterface, ThingInterface, CreativeWorkInterface |
26 | 26 | { |
27 | - use RadioSeriesTrait; |
|
28 | - use CreativeWorkSeriesTrait; |
|
29 | - use SeriesTrait; |
|
30 | - use IntangibleTrait; |
|
31 | - use ThingTrait; |
|
32 | - use CreativeWorkTrait; |
|
27 | + use RadioSeriesTrait; |
|
28 | + use CreativeWorkSeriesTrait; |
|
29 | + use SeriesTrait; |
|
30 | + use IntangibleTrait; |
|
31 | + use ThingTrait; |
|
32 | + use CreativeWorkTrait; |
|
33 | 33 | |
34 | - /** |
|
35 | - * The Schema.org Type Name |
|
36 | - * |
|
37 | - * @var string |
|
38 | - */ |
|
39 | - public static $schemaTypeName = 'RadioSeries'; |
|
34 | + /** |
|
35 | + * The Schema.org Type Name |
|
36 | + * |
|
37 | + * @var string |
|
38 | + */ |
|
39 | + public static $schemaTypeName = 'RadioSeries'; |
|
40 | 40 | |
41 | - /** |
|
42 | - * The Schema.org Type Scope |
|
43 | - * |
|
44 | - * @var string |
|
45 | - */ |
|
46 | - public static $schemaTypeScope = 'https://schema.org/RadioSeries'; |
|
41 | + /** |
|
42 | + * The Schema.org Type Scope |
|
43 | + * |
|
44 | + * @var string |
|
45 | + */ |
|
46 | + public static $schemaTypeScope = 'https://schema.org/RadioSeries'; |
|
47 | 47 | |
48 | - /** |
|
49 | - * The Schema.org Type Extends |
|
50 | - * |
|
51 | - * @var string |
|
52 | - */ |
|
53 | - public static $schemaTypeExtends = 'CreativeWorkSeries'; |
|
48 | + /** |
|
49 | + * The Schema.org Type Extends |
|
50 | + * |
|
51 | + * @var string |
|
52 | + */ |
|
53 | + public static $schemaTypeExtends = 'CreativeWorkSeries'; |
|
54 | 54 | |
55 | - /** |
|
56 | - * The Schema.org Type Description |
|
57 | - * |
|
58 | - * @var string |
|
59 | - */ |
|
60 | - public static $schemaTypeDescription = 'CreativeWorkSeries dedicated to radio broadcast and associated online delivery.'; |
|
55 | + /** |
|
56 | + * The Schema.org Type Description |
|
57 | + * |
|
58 | + * @var string |
|
59 | + */ |
|
60 | + public static $schemaTypeDescription = 'CreativeWorkSeries dedicated to radio broadcast and associated online delivery.'; |
|
61 | 61 | |
62 | 62 | |
63 | - /** |
|
64 | - * @inheritdoc |
|
65 | - */ |
|
66 | - public function getSchemaPropertyNames(): array |
|
67 | - { |
|
68 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
69 | - } |
|
63 | + /** |
|
64 | + * @inheritdoc |
|
65 | + */ |
|
66 | + public function getSchemaPropertyNames(): array |
|
67 | + { |
|
68 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
69 | + } |
|
70 | 70 | |
71 | 71 | |
72 | - /** |
|
73 | - * @inheritdoc |
|
74 | - */ |
|
75 | - public function getSchemaPropertyExpectedTypes(): array |
|
76 | - { |
|
77 | - return [ |
|
78 | - 'about' => ['Thing'], |
|
79 | - 'abstract' => ['Text'], |
|
80 | - 'accessMode' => ['Text'], |
|
81 | - 'accessModeSufficient' => ['ItemList'], |
|
82 | - 'accessibilityAPI' => ['Text'], |
|
83 | - 'accessibilityControl' => ['Text'], |
|
84 | - 'accessibilityFeature' => ['Text'], |
|
85 | - 'accessibilityHazard' => ['Text'], |
|
86 | - 'accessibilitySummary' => ['Text'], |
|
87 | - 'accountablePerson' => ['Person'], |
|
88 | - 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
89 | - 'actor' => ['Person'], |
|
90 | - 'actors' => ['Person'], |
|
91 | - 'additionalType' => ['URL'], |
|
92 | - 'aggregateRating' => ['AggregateRating'], |
|
93 | - 'alternateName' => ['Text'], |
|
94 | - 'alternativeHeadline' => ['Text'], |
|
95 | - 'archivedAt' => ['WebPage', 'URL'], |
|
96 | - 'assesses' => ['DefinedTerm', 'Text'], |
|
97 | - 'associatedMedia' => ['MediaObject'], |
|
98 | - 'audience' => ['Audience'], |
|
99 | - 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
100 | - 'author' => ['Organization', 'Person'], |
|
101 | - 'award' => ['Text'], |
|
102 | - 'awards' => ['Text'], |
|
103 | - 'character' => ['Person'], |
|
104 | - 'citation' => ['CreativeWork', 'Text'], |
|
105 | - 'comment' => ['Comment'], |
|
106 | - 'commentCount' => ['Integer'], |
|
107 | - 'conditionsOfAccess' => ['Text'], |
|
108 | - 'containsSeason' => ['CreativeWorkSeason'], |
|
109 | - 'contentLocation' => ['Place'], |
|
110 | - 'contentRating' => ['Text', 'Rating'], |
|
111 | - 'contentReferenceTime' => ['DateTime'], |
|
112 | - 'contributor' => ['Organization', 'Person'], |
|
113 | - 'copyrightHolder' => ['Organization', 'Person'], |
|
114 | - 'copyrightNotice' => ['Text'], |
|
115 | - 'copyrightYear' => ['Number'], |
|
116 | - 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
117 | - 'countryOfOrigin' => ['Country'], |
|
118 | - 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
119 | - 'creator' => ['Person', 'Organization'], |
|
120 | - 'creditText' => ['Text'], |
|
121 | - 'dateCreated' => ['DateTime', 'Date'], |
|
122 | - 'dateModified' => ['DateTime', 'Date'], |
|
123 | - 'datePublished' => ['DateTime', 'Date'], |
|
124 | - 'description' => ['Text'], |
|
125 | - 'director' => ['Person'], |
|
126 | - 'directors' => ['Person'], |
|
127 | - 'disambiguatingDescription' => ['Text'], |
|
128 | - 'discussionUrl' => ['URL'], |
|
129 | - 'editEIDR' => ['URL', 'Text'], |
|
130 | - 'editor' => ['Person'], |
|
131 | - 'educationalAlignment' => ['AlignmentObject'], |
|
132 | - 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
133 | - 'educationalUse' => ['DefinedTerm', 'Text'], |
|
134 | - 'encoding' => ['MediaObject'], |
|
135 | - 'encodingFormat' => ['URL', 'Text'], |
|
136 | - 'encodings' => ['MediaObject'], |
|
137 | - 'endDate' => ['DateTime', 'Date'], |
|
138 | - 'episode' => ['Episode'], |
|
139 | - 'episodes' => ['Episode'], |
|
140 | - 'exampleOfWork' => ['CreativeWork'], |
|
141 | - 'expires' => ['Date', 'DateTime'], |
|
142 | - 'fileFormat' => ['Text', 'URL'], |
|
143 | - 'funder' => ['Organization', 'Person'], |
|
144 | - 'funding' => ['Grant'], |
|
145 | - 'genre' => ['Text', 'URL'], |
|
146 | - 'hasPart' => ['CreativeWork'], |
|
147 | - 'headline' => ['Text'], |
|
148 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
149 | - 'image' => ['URL', 'ImageObject'], |
|
150 | - 'inLanguage' => ['Text', 'Language'], |
|
151 | - 'interactionStatistic' => ['InteractionCounter'], |
|
152 | - 'interactivityType' => ['Text'], |
|
153 | - 'interpretedAsClaim' => ['Claim'], |
|
154 | - 'isAccessibleForFree' => ['Boolean'], |
|
155 | - 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
156 | - 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
157 | - 'isFamilyFriendly' => ['Boolean'], |
|
158 | - 'isPartOf' => ['URL', 'CreativeWork'], |
|
159 | - 'issn' => ['Text'], |
|
160 | - 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
161 | - 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
162 | - 'license' => ['URL', 'CreativeWork'], |
|
163 | - 'locationCreated' => ['Place'], |
|
164 | - 'mainEntity' => ['Thing'], |
|
165 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
166 | - 'maintainer' => ['Person', 'Organization'], |
|
167 | - 'material' => ['Product', 'URL', 'Text'], |
|
168 | - 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
169 | - 'mentions' => ['Thing'], |
|
170 | - 'musicBy' => ['MusicGroup', 'Person'], |
|
171 | - 'name' => ['Text'], |
|
172 | - 'numberOfEpisodes' => ['Integer'], |
|
173 | - 'numberOfSeasons' => ['Integer'], |
|
174 | - 'offers' => ['Demand', 'Offer'], |
|
175 | - 'pattern' => ['DefinedTerm', 'Text'], |
|
176 | - 'position' => ['Text', 'Integer'], |
|
177 | - 'potentialAction' => ['Action'], |
|
178 | - 'producer' => ['Organization', 'Person'], |
|
179 | - 'productionCompany' => ['Organization'], |
|
180 | - 'provider' => ['Organization', 'Person'], |
|
181 | - 'publication' => ['PublicationEvent'], |
|
182 | - 'publisher' => ['Organization', 'Person'], |
|
183 | - 'publisherImprint' => ['Organization'], |
|
184 | - 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
185 | - 'recordedAt' => ['Event'], |
|
186 | - 'releasedEvent' => ['PublicationEvent'], |
|
187 | - 'review' => ['Review'], |
|
188 | - 'reviews' => ['Review'], |
|
189 | - 'sameAs' => ['URL'], |
|
190 | - 'schemaVersion' => ['URL', 'Text'], |
|
191 | - 'sdDatePublished' => ['Date'], |
|
192 | - 'sdLicense' => ['CreativeWork', 'URL'], |
|
193 | - 'sdPublisher' => ['Organization', 'Person'], |
|
194 | - 'season' => ['URL', 'CreativeWorkSeason'], |
|
195 | - 'seasons' => ['CreativeWorkSeason'], |
|
196 | - 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
197 | - 'sourceOrganization' => ['Organization'], |
|
198 | - 'spatial' => ['Place'], |
|
199 | - 'spatialCoverage' => ['Place'], |
|
200 | - 'sponsor' => ['Organization', 'Person'], |
|
201 | - 'startDate' => ['DateTime', 'Date'], |
|
202 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
203 | - 'teaches' => ['DefinedTerm', 'Text'], |
|
204 | - 'temporal' => ['DateTime', 'Text'], |
|
205 | - 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
206 | - 'text' => ['Text'], |
|
207 | - 'thumbnailUrl' => ['URL'], |
|
208 | - 'timeRequired' => ['Duration'], |
|
209 | - 'trailer' => ['VideoObject'], |
|
210 | - 'translationOfWork' => ['CreativeWork'], |
|
211 | - 'translator' => ['Organization', 'Person'], |
|
212 | - 'typicalAgeRange' => ['Text'], |
|
213 | - 'url' => ['URL'], |
|
214 | - 'usageInfo' => ['URL', 'CreativeWork'], |
|
215 | - 'version' => ['Number', 'Text'], |
|
216 | - 'video' => ['VideoObject', 'Clip'], |
|
217 | - 'workExample' => ['CreativeWork'], |
|
218 | - 'workTranslation' => ['CreativeWork'] |
|
219 | - ]; |
|
220 | - } |
|
72 | + /** |
|
73 | + * @inheritdoc |
|
74 | + */ |
|
75 | + public function getSchemaPropertyExpectedTypes(): array |
|
76 | + { |
|
77 | + return [ |
|
78 | + 'about' => ['Thing'], |
|
79 | + 'abstract' => ['Text'], |
|
80 | + 'accessMode' => ['Text'], |
|
81 | + 'accessModeSufficient' => ['ItemList'], |
|
82 | + 'accessibilityAPI' => ['Text'], |
|
83 | + 'accessibilityControl' => ['Text'], |
|
84 | + 'accessibilityFeature' => ['Text'], |
|
85 | + 'accessibilityHazard' => ['Text'], |
|
86 | + 'accessibilitySummary' => ['Text'], |
|
87 | + 'accountablePerson' => ['Person'], |
|
88 | + 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
89 | + 'actor' => ['Person'], |
|
90 | + 'actors' => ['Person'], |
|
91 | + 'additionalType' => ['URL'], |
|
92 | + 'aggregateRating' => ['AggregateRating'], |
|
93 | + 'alternateName' => ['Text'], |
|
94 | + 'alternativeHeadline' => ['Text'], |
|
95 | + 'archivedAt' => ['WebPage', 'URL'], |
|
96 | + 'assesses' => ['DefinedTerm', 'Text'], |
|
97 | + 'associatedMedia' => ['MediaObject'], |
|
98 | + 'audience' => ['Audience'], |
|
99 | + 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
100 | + 'author' => ['Organization', 'Person'], |
|
101 | + 'award' => ['Text'], |
|
102 | + 'awards' => ['Text'], |
|
103 | + 'character' => ['Person'], |
|
104 | + 'citation' => ['CreativeWork', 'Text'], |
|
105 | + 'comment' => ['Comment'], |
|
106 | + 'commentCount' => ['Integer'], |
|
107 | + 'conditionsOfAccess' => ['Text'], |
|
108 | + 'containsSeason' => ['CreativeWorkSeason'], |
|
109 | + 'contentLocation' => ['Place'], |
|
110 | + 'contentRating' => ['Text', 'Rating'], |
|
111 | + 'contentReferenceTime' => ['DateTime'], |
|
112 | + 'contributor' => ['Organization', 'Person'], |
|
113 | + 'copyrightHolder' => ['Organization', 'Person'], |
|
114 | + 'copyrightNotice' => ['Text'], |
|
115 | + 'copyrightYear' => ['Number'], |
|
116 | + 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
117 | + 'countryOfOrigin' => ['Country'], |
|
118 | + 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
119 | + 'creator' => ['Person', 'Organization'], |
|
120 | + 'creditText' => ['Text'], |
|
121 | + 'dateCreated' => ['DateTime', 'Date'], |
|
122 | + 'dateModified' => ['DateTime', 'Date'], |
|
123 | + 'datePublished' => ['DateTime', 'Date'], |
|
124 | + 'description' => ['Text'], |
|
125 | + 'director' => ['Person'], |
|
126 | + 'directors' => ['Person'], |
|
127 | + 'disambiguatingDescription' => ['Text'], |
|
128 | + 'discussionUrl' => ['URL'], |
|
129 | + 'editEIDR' => ['URL', 'Text'], |
|
130 | + 'editor' => ['Person'], |
|
131 | + 'educationalAlignment' => ['AlignmentObject'], |
|
132 | + 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
133 | + 'educationalUse' => ['DefinedTerm', 'Text'], |
|
134 | + 'encoding' => ['MediaObject'], |
|
135 | + 'encodingFormat' => ['URL', 'Text'], |
|
136 | + 'encodings' => ['MediaObject'], |
|
137 | + 'endDate' => ['DateTime', 'Date'], |
|
138 | + 'episode' => ['Episode'], |
|
139 | + 'episodes' => ['Episode'], |
|
140 | + 'exampleOfWork' => ['CreativeWork'], |
|
141 | + 'expires' => ['Date', 'DateTime'], |
|
142 | + 'fileFormat' => ['Text', 'URL'], |
|
143 | + 'funder' => ['Organization', 'Person'], |
|
144 | + 'funding' => ['Grant'], |
|
145 | + 'genre' => ['Text', 'URL'], |
|
146 | + 'hasPart' => ['CreativeWork'], |
|
147 | + 'headline' => ['Text'], |
|
148 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
149 | + 'image' => ['URL', 'ImageObject'], |
|
150 | + 'inLanguage' => ['Text', 'Language'], |
|
151 | + 'interactionStatistic' => ['InteractionCounter'], |
|
152 | + 'interactivityType' => ['Text'], |
|
153 | + 'interpretedAsClaim' => ['Claim'], |
|
154 | + 'isAccessibleForFree' => ['Boolean'], |
|
155 | + 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
156 | + 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
157 | + 'isFamilyFriendly' => ['Boolean'], |
|
158 | + 'isPartOf' => ['URL', 'CreativeWork'], |
|
159 | + 'issn' => ['Text'], |
|
160 | + 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
161 | + 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
162 | + 'license' => ['URL', 'CreativeWork'], |
|
163 | + 'locationCreated' => ['Place'], |
|
164 | + 'mainEntity' => ['Thing'], |
|
165 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
166 | + 'maintainer' => ['Person', 'Organization'], |
|
167 | + 'material' => ['Product', 'URL', 'Text'], |
|
168 | + 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
169 | + 'mentions' => ['Thing'], |
|
170 | + 'musicBy' => ['MusicGroup', 'Person'], |
|
171 | + 'name' => ['Text'], |
|
172 | + 'numberOfEpisodes' => ['Integer'], |
|
173 | + 'numberOfSeasons' => ['Integer'], |
|
174 | + 'offers' => ['Demand', 'Offer'], |
|
175 | + 'pattern' => ['DefinedTerm', 'Text'], |
|
176 | + 'position' => ['Text', 'Integer'], |
|
177 | + 'potentialAction' => ['Action'], |
|
178 | + 'producer' => ['Organization', 'Person'], |
|
179 | + 'productionCompany' => ['Organization'], |
|
180 | + 'provider' => ['Organization', 'Person'], |
|
181 | + 'publication' => ['PublicationEvent'], |
|
182 | + 'publisher' => ['Organization', 'Person'], |
|
183 | + 'publisherImprint' => ['Organization'], |
|
184 | + 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
185 | + 'recordedAt' => ['Event'], |
|
186 | + 'releasedEvent' => ['PublicationEvent'], |
|
187 | + 'review' => ['Review'], |
|
188 | + 'reviews' => ['Review'], |
|
189 | + 'sameAs' => ['URL'], |
|
190 | + 'schemaVersion' => ['URL', 'Text'], |
|
191 | + 'sdDatePublished' => ['Date'], |
|
192 | + 'sdLicense' => ['CreativeWork', 'URL'], |
|
193 | + 'sdPublisher' => ['Organization', 'Person'], |
|
194 | + 'season' => ['URL', 'CreativeWorkSeason'], |
|
195 | + 'seasons' => ['CreativeWorkSeason'], |
|
196 | + 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
197 | + 'sourceOrganization' => ['Organization'], |
|
198 | + 'spatial' => ['Place'], |
|
199 | + 'spatialCoverage' => ['Place'], |
|
200 | + 'sponsor' => ['Organization', 'Person'], |
|
201 | + 'startDate' => ['DateTime', 'Date'], |
|
202 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
203 | + 'teaches' => ['DefinedTerm', 'Text'], |
|
204 | + 'temporal' => ['DateTime', 'Text'], |
|
205 | + 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
206 | + 'text' => ['Text'], |
|
207 | + 'thumbnailUrl' => ['URL'], |
|
208 | + 'timeRequired' => ['Duration'], |
|
209 | + 'trailer' => ['VideoObject'], |
|
210 | + 'translationOfWork' => ['CreativeWork'], |
|
211 | + 'translator' => ['Organization', 'Person'], |
|
212 | + 'typicalAgeRange' => ['Text'], |
|
213 | + 'url' => ['URL'], |
|
214 | + 'usageInfo' => ['URL', 'CreativeWork'], |
|
215 | + 'version' => ['Number', 'Text'], |
|
216 | + 'video' => ['VideoObject', 'Clip'], |
|
217 | + 'workExample' => ['CreativeWork'], |
|
218 | + 'workTranslation' => ['CreativeWork'] |
|
219 | + ]; |
|
220 | + } |
|
221 | 221 | |
222 | 222 | |
223 | - /** |
|
224 | - * @inheritdoc |
|
225 | - */ |
|
226 | - public function getSchemaPropertyDescriptions(): array |
|
227 | - { |
|
228 | - return [ |
|
229 | - 'about' => 'The subject matter of the content.', |
|
230 | - 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
231 | - '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).', |
|
232 | - '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).', |
|
233 | - '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).', |
|
234 | - '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).', |
|
235 | - '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).', |
|
236 | - '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).', |
|
237 | - '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."', |
|
238 | - 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
239 | - 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
240 | - 'actor' => 'An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.', |
|
241 | - 'actors' => 'An actor, e.g. in TV, radio, movie, video games etc. Actors can be associated with individual items or with a series, episode, clip.', |
|
242 | - '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.', |
|
243 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
244 | - 'alternateName' => 'An alias for the item.', |
|
245 | - 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
246 | - '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.', |
|
247 | - 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
248 | - 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
249 | - 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
250 | - 'audio' => 'An embedded audio object.', |
|
251 | - '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.', |
|
252 | - 'award' => 'An award won by or for this item.', |
|
253 | - 'awards' => 'Awards won by or for this item.', |
|
254 | - 'character' => 'Fictional person connected with a creative work.', |
|
255 | - 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
256 | - 'comment' => 'Comments, typically from users.', |
|
257 | - '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.', |
|
258 | - '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 ". ', |
|
259 | - 'containsSeason' => 'A season that is part of the media series.', |
|
260 | - 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
261 | - 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
262 | - '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.', |
|
263 | - 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
264 | - 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
265 | - '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.', |
|
266 | - 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
267 | - 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
268 | - '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.', |
|
269 | - '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.', |
|
270 | - 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
271 | - 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
272 | - 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
273 | - 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
274 | - 'datePublished' => 'Date of first broadcast/publication.', |
|
275 | - 'description' => 'A description of the item.', |
|
276 | - 'director' => 'A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.', |
|
277 | - 'directors' => 'A director of e.g. TV, radio, movie, video games etc. content. Directors can be associated with individual items or with a series, episode, clip.', |
|
278 | - '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.', |
|
279 | - 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
280 | - '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. ', |
|
281 | - 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
282 | - '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.', |
|
283 | - '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.', |
|
284 | - 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
285 | - 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
286 | - '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.', |
|
287 | - 'encodings' => 'A media object that encodes this CreativeWork.', |
|
288 | - 'endDate' => 'The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
289 | - 'episode' => 'An episode of a TV, radio or game media within a series or season.', |
|
290 | - 'episodes' => 'An episode of a TV/radio series or season.', |
|
291 | - 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
292 | - '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.', |
|
293 | - '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.', |
|
294 | - 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
295 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
296 | - 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
297 | - 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
298 | - 'headline' => 'Headline of the article.', |
|
299 | - '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. ', |
|
300 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
301 | - '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]].', |
|
302 | - 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
303 | - 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
304 | - '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]].', |
|
305 | - 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
306 | - 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
307 | - '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.', |
|
308 | - 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
309 | - 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
310 | - 'issn' => 'The International Standard Serial Number (ISSN) that identifies this serial publication. You can repeat this property to identify different formats of, or the linking ISSN (ISSN-L) for, this serial publication.', |
|
311 | - '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.', |
|
312 | - 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
313 | - 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
314 | - 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
315 | - 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
316 | - '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.', |
|
317 | - '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. ', |
|
318 | - 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
319 | - 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
320 | - 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
321 | - 'musicBy' => 'The composer of the soundtrack.', |
|
322 | - 'name' => 'The name of the item.', |
|
323 | - 'numberOfEpisodes' => 'The number of episodes in this season or series.', |
|
324 | - 'numberOfSeasons' => 'The number of seasons in this series.', |
|
325 | - '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. ', |
|
326 | - '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.', |
|
327 | - 'position' => 'The position of an item in a series or sequence of items.', |
|
328 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
329 | - 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
330 | - 'productionCompany' => 'The production company or studio responsible for the item, e.g. series, video game, episode etc.', |
|
331 | - '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.', |
|
332 | - 'publication' => 'A publication event associated with the item.', |
|
333 | - 'publisher' => 'The publisher of the creative work.', |
|
334 | - 'publisherImprint' => 'The publishing division which published the comic.', |
|
335 | - '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. ', |
|
336 | - 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
337 | - 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
338 | - 'review' => 'A review of the item.', |
|
339 | - 'reviews' => 'Review of the item.', |
|
340 | - '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.', |
|
341 | - '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.', |
|
342 | - 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
343 | - 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
344 | - '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.', |
|
345 | - 'season' => 'A season in a media series.', |
|
346 | - 'seasons' => 'A season in a media series.', |
|
347 | - '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. ', |
|
348 | - 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
349 | - 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
350 | - '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.', |
|
351 | - '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.', |
|
352 | - 'startDate' => 'The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
353 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
354 | - 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
355 | - '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.', |
|
356 | - '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.', |
|
357 | - 'text' => 'The textual content of this CreativeWork.', |
|
358 | - 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
359 | - '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\'.', |
|
360 | - 'trailer' => 'The trailer of a movie or TV/radio series, season, episode, etc.', |
|
361 | - 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
362 | - '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.', |
|
363 | - 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
364 | - 'url' => 'URL of the item.', |
|
365 | - '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.', |
|
366 | - 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
367 | - 'video' => 'An embedded video object.', |
|
368 | - 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
369 | - '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.' |
|
370 | - ]; |
|
371 | - } |
|
223 | + /** |
|
224 | + * @inheritdoc |
|
225 | + */ |
|
226 | + public function getSchemaPropertyDescriptions(): array |
|
227 | + { |
|
228 | + return [ |
|
229 | + 'about' => 'The subject matter of the content.', |
|
230 | + 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
231 | + '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).', |
|
232 | + '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).', |
|
233 | + '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).', |
|
234 | + '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).', |
|
235 | + '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).', |
|
236 | + '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).', |
|
237 | + '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."', |
|
238 | + 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
239 | + 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
240 | + 'actor' => 'An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.', |
|
241 | + 'actors' => 'An actor, e.g. in TV, radio, movie, video games etc. Actors can be associated with individual items or with a series, episode, clip.', |
|
242 | + '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.', |
|
243 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
244 | + 'alternateName' => 'An alias for the item.', |
|
245 | + 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
246 | + '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.', |
|
247 | + 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
248 | + 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
249 | + 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
250 | + 'audio' => 'An embedded audio object.', |
|
251 | + '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.', |
|
252 | + 'award' => 'An award won by or for this item.', |
|
253 | + 'awards' => 'Awards won by or for this item.', |
|
254 | + 'character' => 'Fictional person connected with a creative work.', |
|
255 | + 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
256 | + 'comment' => 'Comments, typically from users.', |
|
257 | + '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.', |
|
258 | + '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 ". ', |
|
259 | + 'containsSeason' => 'A season that is part of the media series.', |
|
260 | + 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
261 | + 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
262 | + '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.', |
|
263 | + 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
264 | + 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
265 | + '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.', |
|
266 | + 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
267 | + 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
268 | + '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.', |
|
269 | + '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.', |
|
270 | + 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
271 | + 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
272 | + 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
273 | + 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
274 | + 'datePublished' => 'Date of first broadcast/publication.', |
|
275 | + 'description' => 'A description of the item.', |
|
276 | + 'director' => 'A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.', |
|
277 | + 'directors' => 'A director of e.g. TV, radio, movie, video games etc. content. Directors can be associated with individual items or with a series, episode, clip.', |
|
278 | + '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.', |
|
279 | + 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
280 | + '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. ', |
|
281 | + 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
282 | + '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.', |
|
283 | + '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.', |
|
284 | + 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
285 | + 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
286 | + '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.', |
|
287 | + 'encodings' => 'A media object that encodes this CreativeWork.', |
|
288 | + 'endDate' => 'The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
289 | + 'episode' => 'An episode of a TV, radio or game media within a series or season.', |
|
290 | + 'episodes' => 'An episode of a TV/radio series or season.', |
|
291 | + 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
292 | + '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.', |
|
293 | + '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.', |
|
294 | + 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
295 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
296 | + 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
297 | + 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
298 | + 'headline' => 'Headline of the article.', |
|
299 | + '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. ', |
|
300 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
301 | + '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]].', |
|
302 | + 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
303 | + 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
304 | + '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]].', |
|
305 | + 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
306 | + 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
307 | + '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.', |
|
308 | + 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
309 | + 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
310 | + 'issn' => 'The International Standard Serial Number (ISSN) that identifies this serial publication. You can repeat this property to identify different formats of, or the linking ISSN (ISSN-L) for, this serial publication.', |
|
311 | + '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.', |
|
312 | + 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
313 | + 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
314 | + 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
315 | + 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
316 | + '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.', |
|
317 | + '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. ', |
|
318 | + 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
319 | + 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
320 | + 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
321 | + 'musicBy' => 'The composer of the soundtrack.', |
|
322 | + 'name' => 'The name of the item.', |
|
323 | + 'numberOfEpisodes' => 'The number of episodes in this season or series.', |
|
324 | + 'numberOfSeasons' => 'The number of seasons in this series.', |
|
325 | + '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. ', |
|
326 | + '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.', |
|
327 | + 'position' => 'The position of an item in a series or sequence of items.', |
|
328 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
329 | + 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
330 | + 'productionCompany' => 'The production company or studio responsible for the item, e.g. series, video game, episode etc.', |
|
331 | + '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.', |
|
332 | + 'publication' => 'A publication event associated with the item.', |
|
333 | + 'publisher' => 'The publisher of the creative work.', |
|
334 | + 'publisherImprint' => 'The publishing division which published the comic.', |
|
335 | + '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. ', |
|
336 | + 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
337 | + 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
338 | + 'review' => 'A review of the item.', |
|
339 | + 'reviews' => 'Review of the item.', |
|
340 | + '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.', |
|
341 | + '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.', |
|
342 | + 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
343 | + 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
344 | + '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.', |
|
345 | + 'season' => 'A season in a media series.', |
|
346 | + 'seasons' => 'A season in a media series.', |
|
347 | + '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. ', |
|
348 | + 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
349 | + 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
350 | + '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.', |
|
351 | + '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.', |
|
352 | + 'startDate' => 'The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
353 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
354 | + 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
355 | + '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.', |
|
356 | + '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.', |
|
357 | + 'text' => 'The textual content of this CreativeWork.', |
|
358 | + 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
359 | + '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\'.', |
|
360 | + 'trailer' => 'The trailer of a movie or TV/radio series, season, episode, etc.', |
|
361 | + 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
362 | + '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.', |
|
363 | + 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
364 | + 'url' => 'URL of the item.', |
|
365 | + '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.', |
|
366 | + 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
367 | + 'video' => 'An embedded video object.', |
|
368 | + 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
369 | + '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.' |
|
370 | + ]; |
|
371 | + } |
|
372 | 372 | |
373 | 373 | |
374 | - /** |
|
375 | - * @inheritdoc |
|
376 | - */ |
|
377 | - public function getGoogleRequiredSchema(): array |
|
378 | - { |
|
379 | - return ['description', 'name']; |
|
380 | - } |
|
374 | + /** |
|
375 | + * @inheritdoc |
|
376 | + */ |
|
377 | + public function getGoogleRequiredSchema(): array |
|
378 | + { |
|
379 | + return ['description', 'name']; |
|
380 | + } |
|
381 | 381 | |
382 | 382 | |
383 | - /** |
|
384 | - * @inheritdoc |
|
385 | - */ |
|
386 | - public function getGoogleRecommendedSchema(): array |
|
387 | - { |
|
388 | - return ['image', 'url']; |
|
389 | - } |
|
383 | + /** |
|
384 | + * @inheritdoc |
|
385 | + */ |
|
386 | + public function getGoogleRecommendedSchema(): array |
|
387 | + { |
|
388 | + return ['image', 'url']; |
|
389 | + } |
|
390 | 390 | |
391 | 391 | |
392 | - /** |
|
393 | - * @inheritdoc |
|
394 | - */ |
|
395 | - public function defineRules(): array |
|
396 | - { |
|
397 | - $rules = parent::defineRules(); |
|
398 | - $rules = array_merge($rules, [ |
|
399 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
400 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
401 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
402 | - ]); |
|
392 | + /** |
|
393 | + * @inheritdoc |
|
394 | + */ |
|
395 | + public function defineRules(): array |
|
396 | + { |
|
397 | + $rules = parent::defineRules(); |
|
398 | + $rules = array_merge($rules, [ |
|
399 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
400 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
401 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
402 | + ]); |
|
403 | 403 | |
404 | - return $rules; |
|
405 | - } |
|
404 | + return $rules; |
|
405 | + } |
|
406 | 406 | } |
@@ -23,146 +23,146 @@ |
||
23 | 23 | */ |
24 | 24 | class InteractAction extends MetaJsonLd implements InteractActionInterface, ActionInterface, ThingInterface |
25 | 25 | { |
26 | - use InteractActionTrait; |
|
27 | - use ActionTrait; |
|
28 | - use ThingTrait; |
|
29 | - |
|
30 | - /** |
|
31 | - * The Schema.org Type Name |
|
32 | - * |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - public static $schemaTypeName = 'InteractAction'; |
|
36 | - |
|
37 | - /** |
|
38 | - * The Schema.org Type Scope |
|
39 | - * |
|
40 | - * @var string |
|
41 | - */ |
|
42 | - public static $schemaTypeScope = 'https://schema.org/InteractAction'; |
|
43 | - |
|
44 | - /** |
|
45 | - * The Schema.org Type Extends |
|
46 | - * |
|
47 | - * @var string |
|
48 | - */ |
|
49 | - public static $schemaTypeExtends = 'Action'; |
|
50 | - |
|
51 | - /** |
|
52 | - * The Schema.org Type Description |
|
53 | - * |
|
54 | - * @var string |
|
55 | - */ |
|
56 | - public static $schemaTypeDescription = 'The act of interacting with another person or organization.'; |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * @inheritdoc |
|
61 | - */ |
|
62 | - public function getSchemaPropertyNames(): array |
|
63 | - { |
|
64 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
65 | - } |
|
66 | - |
|
67 | - |
|
68 | - /** |
|
69 | - * @inheritdoc |
|
70 | - */ |
|
71 | - public function getSchemaPropertyExpectedTypes(): array |
|
72 | - { |
|
73 | - return [ |
|
74 | - 'actionStatus' => ['ActionStatusType'], |
|
75 | - 'additionalType' => ['URL'], |
|
76 | - 'agent' => ['Organization', 'Person'], |
|
77 | - 'alternateName' => ['Text'], |
|
78 | - 'description' => ['Text'], |
|
79 | - 'disambiguatingDescription' => ['Text'], |
|
80 | - 'endTime' => ['DateTime', 'Time'], |
|
81 | - 'error' => ['Thing'], |
|
82 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
83 | - 'image' => ['URL', 'ImageObject'], |
|
84 | - 'instrument' => ['Thing'], |
|
85 | - 'location' => ['Place', 'Text', 'VirtualLocation', 'PostalAddress'], |
|
86 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
87 | - 'name' => ['Text'], |
|
88 | - 'object' => ['Thing'], |
|
89 | - 'participant' => ['Organization', 'Person'], |
|
90 | - 'potentialAction' => ['Action'], |
|
91 | - 'provider' => ['Organization', 'Person'], |
|
92 | - 'result' => ['Thing'], |
|
93 | - 'sameAs' => ['URL'], |
|
94 | - 'startTime' => ['Time', 'DateTime'], |
|
95 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
96 | - 'target' => ['URL', 'EntryPoint'], |
|
97 | - 'url' => ['URL'] |
|
98 | - ]; |
|
99 | - } |
|
100 | - |
|
101 | - |
|
102 | - /** |
|
103 | - * @inheritdoc |
|
104 | - */ |
|
105 | - public function getSchemaPropertyDescriptions(): array |
|
106 | - { |
|
107 | - return [ |
|
108 | - 'actionStatus' => 'Indicates the current disposition of the Action.', |
|
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 | - 'agent' => 'The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.', |
|
111 | - 'alternateName' => 'An alias for the item.', |
|
112 | - 'description' => 'A description of the item.', |
|
113 | - '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.', |
|
114 | - 'endTime' => 'The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it\'s the time offset of the end of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.', |
|
115 | - 'error' => 'For failed actions, more information on the cause of the failure.', |
|
116 | - '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. ', |
|
117 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
118 | - 'instrument' => 'The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.', |
|
119 | - 'location' => 'The location of, for example, where an event is happening, where an organization is located, or where an action takes place.', |
|
120 | - '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.', |
|
121 | - 'name' => 'The name of the item.', |
|
122 | - 'object' => 'The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn\'t). E.g. John read *a book*.', |
|
123 | - 'participant' => 'Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.', |
|
124 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
125 | - '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.', |
|
126 | - 'result' => 'The result produced in the action. E.g. John wrote *a book*.', |
|
127 | - '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.', |
|
128 | - 'startTime' => 'The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it\'s the time offset of the start of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.', |
|
129 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
130 | - 'target' => 'Indicates a target EntryPoint, or url, for an Action.', |
|
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 | - } |
|
26 | + use InteractActionTrait; |
|
27 | + use ActionTrait; |
|
28 | + use ThingTrait; |
|
29 | + |
|
30 | + /** |
|
31 | + * The Schema.org Type Name |
|
32 | + * |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + public static $schemaTypeName = 'InteractAction'; |
|
36 | + |
|
37 | + /** |
|
38 | + * The Schema.org Type Scope |
|
39 | + * |
|
40 | + * @var string |
|
41 | + */ |
|
42 | + public static $schemaTypeScope = 'https://schema.org/InteractAction'; |
|
43 | + |
|
44 | + /** |
|
45 | + * The Schema.org Type Extends |
|
46 | + * |
|
47 | + * @var string |
|
48 | + */ |
|
49 | + public static $schemaTypeExtends = 'Action'; |
|
50 | + |
|
51 | + /** |
|
52 | + * The Schema.org Type Description |
|
53 | + * |
|
54 | + * @var string |
|
55 | + */ |
|
56 | + public static $schemaTypeDescription = 'The act of interacting with another person or organization.'; |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * @inheritdoc |
|
61 | + */ |
|
62 | + public function getSchemaPropertyNames(): array |
|
63 | + { |
|
64 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
65 | + } |
|
66 | + |
|
67 | + |
|
68 | + /** |
|
69 | + * @inheritdoc |
|
70 | + */ |
|
71 | + public function getSchemaPropertyExpectedTypes(): array |
|
72 | + { |
|
73 | + return [ |
|
74 | + 'actionStatus' => ['ActionStatusType'], |
|
75 | + 'additionalType' => ['URL'], |
|
76 | + 'agent' => ['Organization', 'Person'], |
|
77 | + 'alternateName' => ['Text'], |
|
78 | + 'description' => ['Text'], |
|
79 | + 'disambiguatingDescription' => ['Text'], |
|
80 | + 'endTime' => ['DateTime', 'Time'], |
|
81 | + 'error' => ['Thing'], |
|
82 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
83 | + 'image' => ['URL', 'ImageObject'], |
|
84 | + 'instrument' => ['Thing'], |
|
85 | + 'location' => ['Place', 'Text', 'VirtualLocation', 'PostalAddress'], |
|
86 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
87 | + 'name' => ['Text'], |
|
88 | + 'object' => ['Thing'], |
|
89 | + 'participant' => ['Organization', 'Person'], |
|
90 | + 'potentialAction' => ['Action'], |
|
91 | + 'provider' => ['Organization', 'Person'], |
|
92 | + 'result' => ['Thing'], |
|
93 | + 'sameAs' => ['URL'], |
|
94 | + 'startTime' => ['Time', 'DateTime'], |
|
95 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
96 | + 'target' => ['URL', 'EntryPoint'], |
|
97 | + 'url' => ['URL'] |
|
98 | + ]; |
|
99 | + } |
|
100 | + |
|
101 | + |
|
102 | + /** |
|
103 | + * @inheritdoc |
|
104 | + */ |
|
105 | + public function getSchemaPropertyDescriptions(): array |
|
106 | + { |
|
107 | + return [ |
|
108 | + 'actionStatus' => 'Indicates the current disposition of the Action.', |
|
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 | + 'agent' => 'The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.', |
|
111 | + 'alternateName' => 'An alias for the item.', |
|
112 | + 'description' => 'A description of the item.', |
|
113 | + '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.', |
|
114 | + 'endTime' => 'The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it\'s the time offset of the end of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.', |
|
115 | + 'error' => 'For failed actions, more information on the cause of the failure.', |
|
116 | + '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. ', |
|
117 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
118 | + 'instrument' => 'The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.', |
|
119 | + 'location' => 'The location of, for example, where an event is happening, where an organization is located, or where an action takes place.', |
|
120 | + '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.', |
|
121 | + 'name' => 'The name of the item.', |
|
122 | + 'object' => 'The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn\'t). E.g. John read *a book*.', |
|
123 | + 'participant' => 'Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.', |
|
124 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
125 | + '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.', |
|
126 | + 'result' => 'The result produced in the action. E.g. John wrote *a book*.', |
|
127 | + '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.', |
|
128 | + 'startTime' => 'The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it\'s the time offset of the start of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.', |
|
129 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
130 | + 'target' => 'Indicates a target EntryPoint, or url, for an Action.', |
|
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 | } |
@@ -24,172 +24,172 @@ |
||
24 | 24 | */ |
25 | 25 | class MedicalSymptom extends MetaJsonLd implements MedicalSymptomInterface, MedicalSignOrSymptomInterface, MedicalConditionInterface, MedicalEntityInterface, ThingInterface |
26 | 26 | { |
27 | - use MedicalSymptomTrait; |
|
28 | - use MedicalSignOrSymptomTrait; |
|
29 | - use MedicalConditionTrait; |
|
30 | - use MedicalEntityTrait; |
|
31 | - use ThingTrait; |
|
32 | - |
|
33 | - /** |
|
34 | - * The Schema.org Type Name |
|
35 | - * |
|
36 | - * @var string |
|
37 | - */ |
|
38 | - public static $schemaTypeName = 'MedicalSymptom'; |
|
39 | - |
|
40 | - /** |
|
41 | - * The Schema.org Type Scope |
|
42 | - * |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - public static $schemaTypeScope = 'https://schema.org/MedicalSymptom'; |
|
46 | - |
|
47 | - /** |
|
48 | - * The Schema.org Type Extends |
|
49 | - * |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - public static $schemaTypeExtends = 'MedicalSignOrSymptom'; |
|
53 | - |
|
54 | - /** |
|
55 | - * The Schema.org Type Description |
|
56 | - * |
|
57 | - * @var string |
|
58 | - */ |
|
59 | - public static $schemaTypeDescription = 'Any complaint sensed and expressed by the patient (therefore defined as subjective) like stomachache, lower-back pain, or fatigue.'; |
|
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 | - 'associatedAnatomy' => ['SuperficialAnatomy', 'AnatomicalSystem', 'AnatomicalStructure'], |
|
80 | - 'code' => ['MedicalCode'], |
|
81 | - 'description' => ['Text'], |
|
82 | - 'differentialDiagnosis' => ['DDxElement'], |
|
83 | - 'disambiguatingDescription' => ['Text'], |
|
84 | - 'drug' => ['Drug'], |
|
85 | - 'epidemiology' => ['Text'], |
|
86 | - 'expectedPrognosis' => ['Text'], |
|
87 | - 'funding' => ['Grant'], |
|
88 | - 'guideline' => ['MedicalGuideline'], |
|
89 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
90 | - 'image' => ['URL', 'ImageObject'], |
|
91 | - 'legalStatus' => ['Text', 'DrugLegalStatus', 'MedicalEnumeration'], |
|
92 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
93 | - 'medicineSystem' => ['MedicineSystem'], |
|
94 | - 'name' => ['Text'], |
|
95 | - 'naturalProgression' => ['Text'], |
|
96 | - 'pathophysiology' => ['Text'], |
|
97 | - 'possibleComplication' => ['Text'], |
|
98 | - 'possibleTreatment' => ['MedicalTherapy'], |
|
99 | - 'potentialAction' => ['Action'], |
|
100 | - 'primaryPrevention' => ['MedicalTherapy'], |
|
101 | - 'recognizingAuthority' => ['Organization'], |
|
102 | - 'relevantSpecialty' => ['MedicalSpecialty'], |
|
103 | - 'riskFactor' => ['MedicalRiskFactor'], |
|
104 | - 'sameAs' => ['URL'], |
|
105 | - 'secondaryPrevention' => ['MedicalTherapy'], |
|
106 | - 'signOrSymptom' => ['MedicalSignOrSymptom'], |
|
107 | - 'stage' => ['MedicalConditionStage'], |
|
108 | - 'status' => ['MedicalStudyStatus', 'Text', 'EventStatusType'], |
|
109 | - 'study' => ['MedicalStudy'], |
|
110 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
111 | - 'typicalTest' => ['MedicalTest'], |
|
112 | - 'url' => ['URL'] |
|
113 | - ]; |
|
114 | - } |
|
115 | - |
|
116 | - |
|
117 | - /** |
|
118 | - * @inheritdoc |
|
119 | - */ |
|
120 | - public function getSchemaPropertyDescriptions(): array |
|
121 | - { |
|
122 | - return [ |
|
123 | - '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.', |
|
124 | - 'alternateName' => 'An alias for the item.', |
|
125 | - 'associatedAnatomy' => 'The anatomy of the underlying organ system or structures associated with this entity.', |
|
126 | - 'code' => 'A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.', |
|
127 | - 'description' => 'A description of the item.', |
|
128 | - 'differentialDiagnosis' => 'One of a set of differential diagnoses for the condition. Specifically, a closely-related or competing diagnosis typically considered later in the cognitive process whereby this medical condition is distinguished from others most likely responsible for a similar collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses in a patient.', |
|
129 | - '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.', |
|
130 | - 'drug' => 'Specifying a drug or medicine used in a medication procedure.', |
|
131 | - 'epidemiology' => 'The characteristics of associated patients, such as age, gender, race etc.', |
|
132 | - 'expectedPrognosis' => 'The likely outcome in either the short term or long term of the medical condition.', |
|
133 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
134 | - 'guideline' => 'A medical guideline related to this entity.', |
|
135 | - '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. ', |
|
136 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
137 | - 'legalStatus' => 'The drug or supplement\'s legal status, including any controlled substance schedules that apply.', |
|
138 | - '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.', |
|
139 | - 'medicineSystem' => 'The system of medicine that includes this MedicalEntity, for example \'evidence-based\', \'homeopathic\', \'chiropractic\', etc.', |
|
140 | - 'name' => 'The name of the item.', |
|
141 | - 'naturalProgression' => 'The expected progression of the condition if it is not treated and allowed to progress naturally.', |
|
142 | - 'pathophysiology' => 'Changes in the normal mechanical, physical, and biochemical functions that are associated with this activity or condition.', |
|
143 | - 'possibleComplication' => 'A possible unexpected and unfavorable evolution of a medical condition. Complications may include worsening of the signs or symptoms of the disease, extension of the condition to other organ systems, etc.', |
|
144 | - 'possibleTreatment' => 'A possible treatment to address this condition, sign or symptom.', |
|
145 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
146 | - 'primaryPrevention' => 'A preventative therapy used to prevent an initial occurrence of the medical condition, such as vaccination.', |
|
147 | - 'recognizingAuthority' => 'If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.', |
|
148 | - 'relevantSpecialty' => 'If applicable, a medical specialty in which this entity is relevant.', |
|
149 | - 'riskFactor' => 'A modifiable or non-modifiable factor that increases the risk of a patient contracting this condition, e.g. age, coexisting condition.', |
|
150 | - '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.', |
|
151 | - 'secondaryPrevention' => 'A preventative therapy used to prevent reoccurrence of the medical condition after an initial episode of the condition.', |
|
152 | - 'signOrSymptom' => 'A sign or symptom of this condition. Signs are objective or physically observable manifestations of the medical condition while symptoms are the subjective experience of the medical condition.', |
|
153 | - 'stage' => 'The stage of the condition, if applicable.', |
|
154 | - 'status' => 'The status of the study (enumerated).', |
|
155 | - 'study' => 'A medical study or trial related to this entity.', |
|
156 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
157 | - 'typicalTest' => 'A medical test typically performed given this condition.', |
|
158 | - 'url' => 'URL of the item.' |
|
159 | - ]; |
|
160 | - } |
|
161 | - |
|
162 | - |
|
163 | - /** |
|
164 | - * @inheritdoc |
|
165 | - */ |
|
166 | - public function getGoogleRequiredSchema(): array |
|
167 | - { |
|
168 | - return ['description', 'name']; |
|
169 | - } |
|
170 | - |
|
171 | - |
|
172 | - /** |
|
173 | - * @inheritdoc |
|
174 | - */ |
|
175 | - public function getGoogleRecommendedSchema(): array |
|
176 | - { |
|
177 | - return ['image', 'url']; |
|
178 | - } |
|
179 | - |
|
180 | - |
|
181 | - /** |
|
182 | - * @inheritdoc |
|
183 | - */ |
|
184 | - public function defineRules(): array |
|
185 | - { |
|
186 | - $rules = parent::defineRules(); |
|
187 | - $rules = array_merge($rules, [ |
|
188 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
189 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
190 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
191 | - ]); |
|
192 | - |
|
193 | - return $rules; |
|
194 | - } |
|
27 | + use MedicalSymptomTrait; |
|
28 | + use MedicalSignOrSymptomTrait; |
|
29 | + use MedicalConditionTrait; |
|
30 | + use MedicalEntityTrait; |
|
31 | + use ThingTrait; |
|
32 | + |
|
33 | + /** |
|
34 | + * The Schema.org Type Name |
|
35 | + * |
|
36 | + * @var string |
|
37 | + */ |
|
38 | + public static $schemaTypeName = 'MedicalSymptom'; |
|
39 | + |
|
40 | + /** |
|
41 | + * The Schema.org Type Scope |
|
42 | + * |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + public static $schemaTypeScope = 'https://schema.org/MedicalSymptom'; |
|
46 | + |
|
47 | + /** |
|
48 | + * The Schema.org Type Extends |
|
49 | + * |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + public static $schemaTypeExtends = 'MedicalSignOrSymptom'; |
|
53 | + |
|
54 | + /** |
|
55 | + * The Schema.org Type Description |
|
56 | + * |
|
57 | + * @var string |
|
58 | + */ |
|
59 | + public static $schemaTypeDescription = 'Any complaint sensed and expressed by the patient (therefore defined as subjective) like stomachache, lower-back pain, or fatigue.'; |
|
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 | + 'associatedAnatomy' => ['SuperficialAnatomy', 'AnatomicalSystem', 'AnatomicalStructure'], |
|
80 | + 'code' => ['MedicalCode'], |
|
81 | + 'description' => ['Text'], |
|
82 | + 'differentialDiagnosis' => ['DDxElement'], |
|
83 | + 'disambiguatingDescription' => ['Text'], |
|
84 | + 'drug' => ['Drug'], |
|
85 | + 'epidemiology' => ['Text'], |
|
86 | + 'expectedPrognosis' => ['Text'], |
|
87 | + 'funding' => ['Grant'], |
|
88 | + 'guideline' => ['MedicalGuideline'], |
|
89 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
90 | + 'image' => ['URL', 'ImageObject'], |
|
91 | + 'legalStatus' => ['Text', 'DrugLegalStatus', 'MedicalEnumeration'], |
|
92 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
93 | + 'medicineSystem' => ['MedicineSystem'], |
|
94 | + 'name' => ['Text'], |
|
95 | + 'naturalProgression' => ['Text'], |
|
96 | + 'pathophysiology' => ['Text'], |
|
97 | + 'possibleComplication' => ['Text'], |
|
98 | + 'possibleTreatment' => ['MedicalTherapy'], |
|
99 | + 'potentialAction' => ['Action'], |
|
100 | + 'primaryPrevention' => ['MedicalTherapy'], |
|
101 | + 'recognizingAuthority' => ['Organization'], |
|
102 | + 'relevantSpecialty' => ['MedicalSpecialty'], |
|
103 | + 'riskFactor' => ['MedicalRiskFactor'], |
|
104 | + 'sameAs' => ['URL'], |
|
105 | + 'secondaryPrevention' => ['MedicalTherapy'], |
|
106 | + 'signOrSymptom' => ['MedicalSignOrSymptom'], |
|
107 | + 'stage' => ['MedicalConditionStage'], |
|
108 | + 'status' => ['MedicalStudyStatus', 'Text', 'EventStatusType'], |
|
109 | + 'study' => ['MedicalStudy'], |
|
110 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
111 | + 'typicalTest' => ['MedicalTest'], |
|
112 | + 'url' => ['URL'] |
|
113 | + ]; |
|
114 | + } |
|
115 | + |
|
116 | + |
|
117 | + /** |
|
118 | + * @inheritdoc |
|
119 | + */ |
|
120 | + public function getSchemaPropertyDescriptions(): array |
|
121 | + { |
|
122 | + return [ |
|
123 | + '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.', |
|
124 | + 'alternateName' => 'An alias for the item.', |
|
125 | + 'associatedAnatomy' => 'The anatomy of the underlying organ system or structures associated with this entity.', |
|
126 | + 'code' => 'A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.', |
|
127 | + 'description' => 'A description of the item.', |
|
128 | + 'differentialDiagnosis' => 'One of a set of differential diagnoses for the condition. Specifically, a closely-related or competing diagnosis typically considered later in the cognitive process whereby this medical condition is distinguished from others most likely responsible for a similar collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses in a patient.', |
|
129 | + '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.', |
|
130 | + 'drug' => 'Specifying a drug or medicine used in a medication procedure.', |
|
131 | + 'epidemiology' => 'The characteristics of associated patients, such as age, gender, race etc.', |
|
132 | + 'expectedPrognosis' => 'The likely outcome in either the short term or long term of the medical condition.', |
|
133 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
134 | + 'guideline' => 'A medical guideline related to this entity.', |
|
135 | + '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. ', |
|
136 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
137 | + 'legalStatus' => 'The drug or supplement\'s legal status, including any controlled substance schedules that apply.', |
|
138 | + '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.', |
|
139 | + 'medicineSystem' => 'The system of medicine that includes this MedicalEntity, for example \'evidence-based\', \'homeopathic\', \'chiropractic\', etc.', |
|
140 | + 'name' => 'The name of the item.', |
|
141 | + 'naturalProgression' => 'The expected progression of the condition if it is not treated and allowed to progress naturally.', |
|
142 | + 'pathophysiology' => 'Changes in the normal mechanical, physical, and biochemical functions that are associated with this activity or condition.', |
|
143 | + 'possibleComplication' => 'A possible unexpected and unfavorable evolution of a medical condition. Complications may include worsening of the signs or symptoms of the disease, extension of the condition to other organ systems, etc.', |
|
144 | + 'possibleTreatment' => 'A possible treatment to address this condition, sign or symptom.', |
|
145 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
146 | + 'primaryPrevention' => 'A preventative therapy used to prevent an initial occurrence of the medical condition, such as vaccination.', |
|
147 | + 'recognizingAuthority' => 'If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.', |
|
148 | + 'relevantSpecialty' => 'If applicable, a medical specialty in which this entity is relevant.', |
|
149 | + 'riskFactor' => 'A modifiable or non-modifiable factor that increases the risk of a patient contracting this condition, e.g. age, coexisting condition.', |
|
150 | + '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.', |
|
151 | + 'secondaryPrevention' => 'A preventative therapy used to prevent reoccurrence of the medical condition after an initial episode of the condition.', |
|
152 | + 'signOrSymptom' => 'A sign or symptom of this condition. Signs are objective or physically observable manifestations of the medical condition while symptoms are the subjective experience of the medical condition.', |
|
153 | + 'stage' => 'The stage of the condition, if applicable.', |
|
154 | + 'status' => 'The status of the study (enumerated).', |
|
155 | + 'study' => 'A medical study or trial related to this entity.', |
|
156 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
157 | + 'typicalTest' => 'A medical test typically performed given this condition.', |
|
158 | + 'url' => 'URL of the item.' |
|
159 | + ]; |
|
160 | + } |
|
161 | + |
|
162 | + |
|
163 | + /** |
|
164 | + * @inheritdoc |
|
165 | + */ |
|
166 | + public function getGoogleRequiredSchema(): array |
|
167 | + { |
|
168 | + return ['description', 'name']; |
|
169 | + } |
|
170 | + |
|
171 | + |
|
172 | + /** |
|
173 | + * @inheritdoc |
|
174 | + */ |
|
175 | + public function getGoogleRecommendedSchema(): array |
|
176 | + { |
|
177 | + return ['image', 'url']; |
|
178 | + } |
|
179 | + |
|
180 | + |
|
181 | + /** |
|
182 | + * @inheritdoc |
|
183 | + */ |
|
184 | + public function defineRules(): array |
|
185 | + { |
|
186 | + $rules = parent::defineRules(); |
|
187 | + $rules = array_merge($rules, [ |
|
188 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
189 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
190 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
191 | + ]); |
|
192 | + |
|
193 | + return $rules; |
|
194 | + } |
|
195 | 195 | } |
@@ -23,351 +23,351 @@ |
||
23 | 23 | */ |
24 | 24 | class WPHeader extends MetaJsonLd implements WPHeaderInterface, WebPageElementInterface, CreativeWorkInterface, ThingInterface |
25 | 25 | { |
26 | - use WPHeaderTrait; |
|
27 | - use WebPageElementTrait; |
|
28 | - use CreativeWorkTrait; |
|
29 | - use ThingTrait; |
|
26 | + use WPHeaderTrait; |
|
27 | + use WebPageElementTrait; |
|
28 | + use CreativeWorkTrait; |
|
29 | + use ThingTrait; |
|
30 | 30 | |
31 | - /** |
|
32 | - * The Schema.org Type Name |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - public static $schemaTypeName = 'WPHeader'; |
|
31 | + /** |
|
32 | + * The Schema.org Type Name |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + public static $schemaTypeName = 'WPHeader'; |
|
37 | 37 | |
38 | - /** |
|
39 | - * The Schema.org Type Scope |
|
40 | - * |
|
41 | - * @var string |
|
42 | - */ |
|
43 | - public static $schemaTypeScope = 'https://schema.org/WPHeader'; |
|
38 | + /** |
|
39 | + * The Schema.org Type Scope |
|
40 | + * |
|
41 | + * @var string |
|
42 | + */ |
|
43 | + public static $schemaTypeScope = 'https://schema.org/WPHeader'; |
|
44 | 44 | |
45 | - /** |
|
46 | - * The Schema.org Type Extends |
|
47 | - * |
|
48 | - * @var string |
|
49 | - */ |
|
50 | - public static $schemaTypeExtends = 'WebPageElement'; |
|
45 | + /** |
|
46 | + * The Schema.org Type Extends |
|
47 | + * |
|
48 | + * @var string |
|
49 | + */ |
|
50 | + public static $schemaTypeExtends = 'WebPageElement'; |
|
51 | 51 | |
52 | - /** |
|
53 | - * The Schema.org Type Description |
|
54 | - * |
|
55 | - * @var string |
|
56 | - */ |
|
57 | - public static $schemaTypeDescription = 'The header section of the page.'; |
|
52 | + /** |
|
53 | + * The Schema.org Type Description |
|
54 | + * |
|
55 | + * @var string |
|
56 | + */ |
|
57 | + public static $schemaTypeDescription = 'The header section of the 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 | - 'character' => ['Person'], |
|
99 | - 'citation' => ['CreativeWork', 'Text'], |
|
100 | - 'comment' => ['Comment'], |
|
101 | - 'commentCount' => ['Integer'], |
|
102 | - 'conditionsOfAccess' => ['Text'], |
|
103 | - 'contentLocation' => ['Place'], |
|
104 | - 'contentRating' => ['Text', 'Rating'], |
|
105 | - 'contentReferenceTime' => ['DateTime'], |
|
106 | - 'contributor' => ['Organization', 'Person'], |
|
107 | - 'copyrightHolder' => ['Organization', 'Person'], |
|
108 | - 'copyrightNotice' => ['Text'], |
|
109 | - 'copyrightYear' => ['Number'], |
|
110 | - 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
111 | - 'countryOfOrigin' => ['Country'], |
|
112 | - 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
113 | - 'creator' => ['Person', 'Organization'], |
|
114 | - 'creditText' => ['Text'], |
|
115 | - 'cssSelector' => ['CssSelectorType'], |
|
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 | - 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
151 | - 'license' => ['URL', 'CreativeWork'], |
|
152 | - 'locationCreated' => ['Place'], |
|
153 | - 'mainEntity' => ['Thing'], |
|
154 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
155 | - 'maintainer' => ['Person', 'Organization'], |
|
156 | - 'material' => ['Product', 'URL', 'Text'], |
|
157 | - 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
158 | - 'mentions' => ['Thing'], |
|
159 | - 'name' => ['Text'], |
|
160 | - 'offers' => ['Demand', 'Offer'], |
|
161 | - 'pattern' => ['DefinedTerm', 'Text'], |
|
162 | - 'position' => ['Text', 'Integer'], |
|
163 | - 'potentialAction' => ['Action'], |
|
164 | - 'producer' => ['Organization', 'Person'], |
|
165 | - 'provider' => ['Organization', 'Person'], |
|
166 | - 'publication' => ['PublicationEvent'], |
|
167 | - 'publisher' => ['Organization', 'Person'], |
|
168 | - 'publisherImprint' => ['Organization'], |
|
169 | - 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
170 | - 'recordedAt' => ['Event'], |
|
171 | - 'releasedEvent' => ['PublicationEvent'], |
|
172 | - 'review' => ['Review'], |
|
173 | - 'reviews' => ['Review'], |
|
174 | - 'sameAs' => ['URL'], |
|
175 | - 'schemaVersion' => ['URL', 'Text'], |
|
176 | - 'sdDatePublished' => ['Date'], |
|
177 | - 'sdLicense' => ['CreativeWork', 'URL'], |
|
178 | - 'sdPublisher' => ['Organization', 'Person'], |
|
179 | - 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
180 | - 'sourceOrganization' => ['Organization'], |
|
181 | - 'spatial' => ['Place'], |
|
182 | - 'spatialCoverage' => ['Place'], |
|
183 | - 'sponsor' => ['Organization', 'Person'], |
|
184 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
185 | - 'teaches' => ['DefinedTerm', 'Text'], |
|
186 | - 'temporal' => ['DateTime', 'Text'], |
|
187 | - 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
188 | - 'text' => ['Text'], |
|
189 | - 'thumbnailUrl' => ['URL'], |
|
190 | - 'timeRequired' => ['Duration'], |
|
191 | - 'translationOfWork' => ['CreativeWork'], |
|
192 | - 'translator' => ['Organization', 'Person'], |
|
193 | - 'typicalAgeRange' => ['Text'], |
|
194 | - 'url' => ['URL'], |
|
195 | - 'usageInfo' => ['URL', 'CreativeWork'], |
|
196 | - 'version' => ['Number', 'Text'], |
|
197 | - 'video' => ['VideoObject', 'Clip'], |
|
198 | - 'workExample' => ['CreativeWork'], |
|
199 | - 'workTranslation' => ['CreativeWork'], |
|
200 | - 'xpath' => ['XPathType'] |
|
201 | - ]; |
|
202 | - } |
|
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 | + 'character' => ['Person'], |
|
99 | + 'citation' => ['CreativeWork', 'Text'], |
|
100 | + 'comment' => ['Comment'], |
|
101 | + 'commentCount' => ['Integer'], |
|
102 | + 'conditionsOfAccess' => ['Text'], |
|
103 | + 'contentLocation' => ['Place'], |
|
104 | + 'contentRating' => ['Text', 'Rating'], |
|
105 | + 'contentReferenceTime' => ['DateTime'], |
|
106 | + 'contributor' => ['Organization', 'Person'], |
|
107 | + 'copyrightHolder' => ['Organization', 'Person'], |
|
108 | + 'copyrightNotice' => ['Text'], |
|
109 | + 'copyrightYear' => ['Number'], |
|
110 | + 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
111 | + 'countryOfOrigin' => ['Country'], |
|
112 | + 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
113 | + 'creator' => ['Person', 'Organization'], |
|
114 | + 'creditText' => ['Text'], |
|
115 | + 'cssSelector' => ['CssSelectorType'], |
|
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 | + 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
151 | + 'license' => ['URL', 'CreativeWork'], |
|
152 | + 'locationCreated' => ['Place'], |
|
153 | + 'mainEntity' => ['Thing'], |
|
154 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
155 | + 'maintainer' => ['Person', 'Organization'], |
|
156 | + 'material' => ['Product', 'URL', 'Text'], |
|
157 | + 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
158 | + 'mentions' => ['Thing'], |
|
159 | + 'name' => ['Text'], |
|
160 | + 'offers' => ['Demand', 'Offer'], |
|
161 | + 'pattern' => ['DefinedTerm', 'Text'], |
|
162 | + 'position' => ['Text', 'Integer'], |
|
163 | + 'potentialAction' => ['Action'], |
|
164 | + 'producer' => ['Organization', 'Person'], |
|
165 | + 'provider' => ['Organization', 'Person'], |
|
166 | + 'publication' => ['PublicationEvent'], |
|
167 | + 'publisher' => ['Organization', 'Person'], |
|
168 | + 'publisherImprint' => ['Organization'], |
|
169 | + 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
170 | + 'recordedAt' => ['Event'], |
|
171 | + 'releasedEvent' => ['PublicationEvent'], |
|
172 | + 'review' => ['Review'], |
|
173 | + 'reviews' => ['Review'], |
|
174 | + 'sameAs' => ['URL'], |
|
175 | + 'schemaVersion' => ['URL', 'Text'], |
|
176 | + 'sdDatePublished' => ['Date'], |
|
177 | + 'sdLicense' => ['CreativeWork', 'URL'], |
|
178 | + 'sdPublisher' => ['Organization', 'Person'], |
|
179 | + 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
180 | + 'sourceOrganization' => ['Organization'], |
|
181 | + 'spatial' => ['Place'], |
|
182 | + 'spatialCoverage' => ['Place'], |
|
183 | + 'sponsor' => ['Organization', 'Person'], |
|
184 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
185 | + 'teaches' => ['DefinedTerm', 'Text'], |
|
186 | + 'temporal' => ['DateTime', 'Text'], |
|
187 | + 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
188 | + 'text' => ['Text'], |
|
189 | + 'thumbnailUrl' => ['URL'], |
|
190 | + 'timeRequired' => ['Duration'], |
|
191 | + 'translationOfWork' => ['CreativeWork'], |
|
192 | + 'translator' => ['Organization', 'Person'], |
|
193 | + 'typicalAgeRange' => ['Text'], |
|
194 | + 'url' => ['URL'], |
|
195 | + 'usageInfo' => ['URL', 'CreativeWork'], |
|
196 | + 'version' => ['Number', 'Text'], |
|
197 | + 'video' => ['VideoObject', 'Clip'], |
|
198 | + 'workExample' => ['CreativeWork'], |
|
199 | + 'workTranslation' => ['CreativeWork'], |
|
200 | + 'xpath' => ['XPathType'] |
|
201 | + ]; |
|
202 | + } |
|
203 | 203 | |
204 | 204 | |
205 | - /** |
|
206 | - * @inheritdoc |
|
207 | - */ |
|
208 | - public function getSchemaPropertyDescriptions(): array |
|
209 | - { |
|
210 | - return [ |
|
211 | - 'about' => 'The subject matter of the content.', |
|
212 | - 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
213 | - '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).', |
|
214 | - '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).', |
|
215 | - '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).', |
|
216 | - '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).', |
|
217 | - '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).', |
|
218 | - '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).', |
|
219 | - '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."', |
|
220 | - 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
221 | - 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
222 | - '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.', |
|
223 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
224 | - 'alternateName' => 'An alias for the item.', |
|
225 | - 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
226 | - '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.', |
|
227 | - 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
228 | - 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
229 | - 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
230 | - 'audio' => 'An embedded audio object.', |
|
231 | - '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.', |
|
232 | - 'award' => 'An award won by or for this item.', |
|
233 | - 'awards' => 'Awards won by or for this item.', |
|
234 | - 'character' => 'Fictional person connected with a creative work.', |
|
235 | - 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
236 | - 'comment' => 'Comments, typically from users.', |
|
237 | - '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.', |
|
238 | - '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 ". ', |
|
239 | - 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
240 | - 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
241 | - '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.', |
|
242 | - 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
243 | - 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
244 | - '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.', |
|
245 | - 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
246 | - 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
247 | - '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.', |
|
248 | - '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.', |
|
249 | - 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
250 | - 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
251 | - 'cssSelector' => 'A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".', |
|
252 | - 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
253 | - 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
254 | - 'datePublished' => 'Date of first broadcast/publication.', |
|
255 | - 'description' => 'A description of the item.', |
|
256 | - '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.', |
|
257 | - 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
258 | - '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. ', |
|
259 | - 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
260 | - '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.', |
|
261 | - '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.', |
|
262 | - 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
263 | - 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
264 | - '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.', |
|
265 | - 'encodings' => 'A media object that encodes this CreativeWork.', |
|
266 | - 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
267 | - '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.', |
|
268 | - '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.', |
|
269 | - 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
270 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
271 | - 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
272 | - 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
273 | - 'headline' => 'Headline of the article.', |
|
274 | - '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. ', |
|
275 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
276 | - '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]].', |
|
277 | - 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
278 | - 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
279 | - '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]].', |
|
280 | - 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
281 | - 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
282 | - '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.', |
|
283 | - 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
284 | - 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
285 | - '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.', |
|
286 | - 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
287 | - 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
288 | - 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
289 | - 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
290 | - '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.', |
|
291 | - '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. ', |
|
292 | - 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
293 | - 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
294 | - 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
295 | - 'name' => 'The name of the item.', |
|
296 | - '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. ', |
|
297 | - '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.', |
|
298 | - 'position' => 'The position of an item in a series or sequence of items.', |
|
299 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
300 | - 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
301 | - '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.', |
|
302 | - 'publication' => 'A publication event associated with the item.', |
|
303 | - 'publisher' => 'The publisher of the creative work.', |
|
304 | - 'publisherImprint' => 'The publishing division which published the comic.', |
|
305 | - '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. ', |
|
306 | - 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
307 | - 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
308 | - 'review' => 'A review of the item.', |
|
309 | - 'reviews' => 'Review of the item.', |
|
310 | - '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.', |
|
311 | - '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.', |
|
312 | - 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
313 | - 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
314 | - '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.', |
|
315 | - '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. ', |
|
316 | - 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
317 | - 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
318 | - '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.', |
|
319 | - '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.', |
|
320 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
321 | - 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
322 | - '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.', |
|
323 | - '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.', |
|
324 | - 'text' => 'The textual content of this CreativeWork.', |
|
325 | - 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
326 | - '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\'.', |
|
327 | - 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
328 | - '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.', |
|
329 | - 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
330 | - 'url' => 'URL of the item.', |
|
331 | - '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.', |
|
332 | - 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
333 | - 'video' => 'An embedded video object.', |
|
334 | - 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
335 | - '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.', |
|
336 | - 'xpath' => 'An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".' |
|
337 | - ]; |
|
338 | - } |
|
205 | + /** |
|
206 | + * @inheritdoc |
|
207 | + */ |
|
208 | + public function getSchemaPropertyDescriptions(): array |
|
209 | + { |
|
210 | + return [ |
|
211 | + 'about' => 'The subject matter of the content.', |
|
212 | + 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
213 | + '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).', |
|
214 | + '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).', |
|
215 | + '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).', |
|
216 | + '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).', |
|
217 | + '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).', |
|
218 | + '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).', |
|
219 | + '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."', |
|
220 | + 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
221 | + 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
222 | + '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.', |
|
223 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
224 | + 'alternateName' => 'An alias for the item.', |
|
225 | + 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
226 | + '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.', |
|
227 | + 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
228 | + 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
229 | + 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
230 | + 'audio' => 'An embedded audio object.', |
|
231 | + '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.', |
|
232 | + 'award' => 'An award won by or for this item.', |
|
233 | + 'awards' => 'Awards won by or for this item.', |
|
234 | + 'character' => 'Fictional person connected with a creative work.', |
|
235 | + 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
236 | + 'comment' => 'Comments, typically from users.', |
|
237 | + '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.', |
|
238 | + '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 ". ', |
|
239 | + 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
240 | + 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
241 | + '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.', |
|
242 | + 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
243 | + 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
244 | + '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.', |
|
245 | + 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
246 | + 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
247 | + '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.', |
|
248 | + '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.', |
|
249 | + 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
250 | + 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
251 | + 'cssSelector' => 'A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".', |
|
252 | + 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
253 | + 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
254 | + 'datePublished' => 'Date of first broadcast/publication.', |
|
255 | + 'description' => 'A description of the item.', |
|
256 | + '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.', |
|
257 | + 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
258 | + '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. ', |
|
259 | + 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
260 | + '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.', |
|
261 | + '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.', |
|
262 | + 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
263 | + 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
264 | + '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.', |
|
265 | + 'encodings' => 'A media object that encodes this CreativeWork.', |
|
266 | + 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
267 | + '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.', |
|
268 | + '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.', |
|
269 | + 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
270 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
271 | + 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
272 | + 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
273 | + 'headline' => 'Headline of the article.', |
|
274 | + '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. ', |
|
275 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
276 | + '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]].', |
|
277 | + 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
278 | + 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
279 | + '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]].', |
|
280 | + 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
281 | + 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
282 | + '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.', |
|
283 | + 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
284 | + 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
285 | + '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.', |
|
286 | + 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
287 | + 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
288 | + 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
289 | + 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
290 | + '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.', |
|
291 | + '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. ', |
|
292 | + 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
293 | + 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
294 | + 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
295 | + 'name' => 'The name of the item.', |
|
296 | + '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. ', |
|
297 | + '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.', |
|
298 | + 'position' => 'The position of an item in a series or sequence of items.', |
|
299 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
300 | + 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
301 | + '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.', |
|
302 | + 'publication' => 'A publication event associated with the item.', |
|
303 | + 'publisher' => 'The publisher of the creative work.', |
|
304 | + 'publisherImprint' => 'The publishing division which published the comic.', |
|
305 | + '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. ', |
|
306 | + 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
307 | + 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
308 | + 'review' => 'A review of the item.', |
|
309 | + 'reviews' => 'Review of the item.', |
|
310 | + '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.', |
|
311 | + '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.', |
|
312 | + 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
313 | + 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
314 | + '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.', |
|
315 | + '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. ', |
|
316 | + 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
317 | + 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
318 | + '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.', |
|
319 | + '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.', |
|
320 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
321 | + 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
322 | + '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.', |
|
323 | + '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.', |
|
324 | + 'text' => 'The textual content of this CreativeWork.', |
|
325 | + 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
326 | + '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\'.', |
|
327 | + 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
328 | + '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.', |
|
329 | + 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
330 | + 'url' => 'URL of the item.', |
|
331 | + '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.', |
|
332 | + 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
333 | + 'video' => 'An embedded video object.', |
|
334 | + 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
335 | + '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.', |
|
336 | + 'xpath' => 'An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".' |
|
337 | + ]; |
|
338 | + } |
|
339 | 339 | |
340 | 340 | |
341 | - /** |
|
342 | - * @inheritdoc |
|
343 | - */ |
|
344 | - public function getGoogleRequiredSchema(): array |
|
345 | - { |
|
346 | - return ['description', 'name']; |
|
347 | - } |
|
341 | + /** |
|
342 | + * @inheritdoc |
|
343 | + */ |
|
344 | + public function getGoogleRequiredSchema(): array |
|
345 | + { |
|
346 | + return ['description', 'name']; |
|
347 | + } |
|
348 | 348 | |
349 | 349 | |
350 | - /** |
|
351 | - * @inheritdoc |
|
352 | - */ |
|
353 | - public function getGoogleRecommendedSchema(): array |
|
354 | - { |
|
355 | - return ['image', 'url']; |
|
356 | - } |
|
350 | + /** |
|
351 | + * @inheritdoc |
|
352 | + */ |
|
353 | + public function getGoogleRecommendedSchema(): array |
|
354 | + { |
|
355 | + return ['image', 'url']; |
|
356 | + } |
|
357 | 357 | |
358 | 358 | |
359 | - /** |
|
360 | - * @inheritdoc |
|
361 | - */ |
|
362 | - public function defineRules(): array |
|
363 | - { |
|
364 | - $rules = parent::defineRules(); |
|
365 | - $rules = array_merge($rules, [ |
|
366 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
367 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
368 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
369 | - ]); |
|
359 | + /** |
|
360 | + * @inheritdoc |
|
361 | + */ |
|
362 | + public function defineRules(): array |
|
363 | + { |
|
364 | + $rules = parent::defineRules(); |
|
365 | + $rules = array_merge($rules, [ |
|
366 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
367 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
368 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
369 | + ]); |
|
370 | 370 | |
371 | - return $rules; |
|
372 | - } |
|
371 | + return $rules; |
|
372 | + } |
|
373 | 373 | } |
@@ -24,142 +24,142 @@ |
||
24 | 24 | */ |
25 | 25 | class Substance extends MetaJsonLd implements SubstanceInterface, MedicalEntityInterface, ThingInterface |
26 | 26 | { |
27 | - use SubstanceTrait; |
|
28 | - use MedicalEntityTrait; |
|
29 | - use ThingTrait; |
|
30 | - |
|
31 | - /** |
|
32 | - * The Schema.org Type Name |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - public static $schemaTypeName = 'Substance'; |
|
37 | - |
|
38 | - /** |
|
39 | - * The Schema.org Type Scope |
|
40 | - * |
|
41 | - * @var string |
|
42 | - */ |
|
43 | - public static $schemaTypeScope = 'https://schema.org/Substance'; |
|
44 | - |
|
45 | - /** |
|
46 | - * The Schema.org Type Extends |
|
47 | - * |
|
48 | - * @var string |
|
49 | - */ |
|
50 | - public static $schemaTypeExtends = 'MedicalEntity'; |
|
51 | - |
|
52 | - /** |
|
53 | - * The Schema.org Type Description |
|
54 | - * |
|
55 | - * @var string |
|
56 | - */ |
|
57 | - public static $schemaTypeDescription = 'Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical.'; |
|
58 | - |
|
59 | - |
|
60 | - /** |
|
61 | - * @inheritdoc |
|
62 | - */ |
|
63 | - public function getSchemaPropertyNames(): array |
|
64 | - { |
|
65 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
66 | - } |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * @inheritdoc |
|
71 | - */ |
|
72 | - public function getSchemaPropertyExpectedTypes(): array |
|
73 | - { |
|
74 | - return [ |
|
75 | - 'activeIngredient' => ['Text'], |
|
76 | - 'additionalType' => ['URL'], |
|
77 | - 'alternateName' => ['Text'], |
|
78 | - 'code' => ['MedicalCode'], |
|
79 | - 'description' => ['Text'], |
|
80 | - 'disambiguatingDescription' => ['Text'], |
|
81 | - 'funding' => ['Grant'], |
|
82 | - 'guideline' => ['MedicalGuideline'], |
|
83 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
84 | - 'image' => ['URL', 'ImageObject'], |
|
85 | - 'legalStatus' => ['Text', 'DrugLegalStatus', 'MedicalEnumeration'], |
|
86 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
87 | - 'maximumIntake' => ['MaximumDoseSchedule'], |
|
88 | - 'medicineSystem' => ['MedicineSystem'], |
|
89 | - 'name' => ['Text'], |
|
90 | - 'potentialAction' => ['Action'], |
|
91 | - 'recognizingAuthority' => ['Organization'], |
|
92 | - 'relevantSpecialty' => ['MedicalSpecialty'], |
|
93 | - 'sameAs' => ['URL'], |
|
94 | - 'study' => ['MedicalStudy'], |
|
95 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
96 | - 'url' => ['URL'] |
|
97 | - ]; |
|
98 | - } |
|
99 | - |
|
100 | - |
|
101 | - /** |
|
102 | - * @inheritdoc |
|
103 | - */ |
|
104 | - public function getSchemaPropertyDescriptions(): array |
|
105 | - { |
|
106 | - return [ |
|
107 | - 'activeIngredient' => 'An active ingredient, typically chemical compounds and/or biologic substances.', |
|
108 | - '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.', |
|
109 | - 'alternateName' => 'An alias for the item.', |
|
110 | - 'code' => 'A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.', |
|
111 | - 'description' => 'A description of the item.', |
|
112 | - '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.', |
|
113 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
114 | - 'guideline' => 'A medical guideline related to this entity.', |
|
115 | - '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. ', |
|
116 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
117 | - 'legalStatus' => 'The drug or supplement\'s legal status, including any controlled substance schedules that apply.', |
|
118 | - '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.', |
|
119 | - 'maximumIntake' => 'Recommended intake of this supplement for a given population as defined by a specific recommending authority.', |
|
120 | - 'medicineSystem' => 'The system of medicine that includes this MedicalEntity, for example \'evidence-based\', \'homeopathic\', \'chiropractic\', etc.', |
|
121 | - 'name' => 'The name of the item.', |
|
122 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
123 | - 'recognizingAuthority' => 'If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.', |
|
124 | - 'relevantSpecialty' => 'If applicable, a medical specialty in which this entity is relevant.', |
|
125 | - '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.', |
|
126 | - 'study' => 'A medical study or trial related to this entity.', |
|
127 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
128 | - 'url' => 'URL of the item.' |
|
129 | - ]; |
|
130 | - } |
|
131 | - |
|
132 | - |
|
133 | - /** |
|
134 | - * @inheritdoc |
|
135 | - */ |
|
136 | - public function getGoogleRequiredSchema(): array |
|
137 | - { |
|
138 | - return ['description', 'name']; |
|
139 | - } |
|
140 | - |
|
141 | - |
|
142 | - /** |
|
143 | - * @inheritdoc |
|
144 | - */ |
|
145 | - public function getGoogleRecommendedSchema(): array |
|
146 | - { |
|
147 | - return ['image', 'url']; |
|
148 | - } |
|
149 | - |
|
150 | - |
|
151 | - /** |
|
152 | - * @inheritdoc |
|
153 | - */ |
|
154 | - public function defineRules(): array |
|
155 | - { |
|
156 | - $rules = parent::defineRules(); |
|
157 | - $rules = array_merge($rules, [ |
|
158 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
159 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
160 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
161 | - ]); |
|
162 | - |
|
163 | - return $rules; |
|
164 | - } |
|
27 | + use SubstanceTrait; |
|
28 | + use MedicalEntityTrait; |
|
29 | + use ThingTrait; |
|
30 | + |
|
31 | + /** |
|
32 | + * The Schema.org Type Name |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + public static $schemaTypeName = 'Substance'; |
|
37 | + |
|
38 | + /** |
|
39 | + * The Schema.org Type Scope |
|
40 | + * |
|
41 | + * @var string |
|
42 | + */ |
|
43 | + public static $schemaTypeScope = 'https://schema.org/Substance'; |
|
44 | + |
|
45 | + /** |
|
46 | + * The Schema.org Type Extends |
|
47 | + * |
|
48 | + * @var string |
|
49 | + */ |
|
50 | + public static $schemaTypeExtends = 'MedicalEntity'; |
|
51 | + |
|
52 | + /** |
|
53 | + * The Schema.org Type Description |
|
54 | + * |
|
55 | + * @var string |
|
56 | + */ |
|
57 | + public static $schemaTypeDescription = 'Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical.'; |
|
58 | + |
|
59 | + |
|
60 | + /** |
|
61 | + * @inheritdoc |
|
62 | + */ |
|
63 | + public function getSchemaPropertyNames(): array |
|
64 | + { |
|
65 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
66 | + } |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * @inheritdoc |
|
71 | + */ |
|
72 | + public function getSchemaPropertyExpectedTypes(): array |
|
73 | + { |
|
74 | + return [ |
|
75 | + 'activeIngredient' => ['Text'], |
|
76 | + 'additionalType' => ['URL'], |
|
77 | + 'alternateName' => ['Text'], |
|
78 | + 'code' => ['MedicalCode'], |
|
79 | + 'description' => ['Text'], |
|
80 | + 'disambiguatingDescription' => ['Text'], |
|
81 | + 'funding' => ['Grant'], |
|
82 | + 'guideline' => ['MedicalGuideline'], |
|
83 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
84 | + 'image' => ['URL', 'ImageObject'], |
|
85 | + 'legalStatus' => ['Text', 'DrugLegalStatus', 'MedicalEnumeration'], |
|
86 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
87 | + 'maximumIntake' => ['MaximumDoseSchedule'], |
|
88 | + 'medicineSystem' => ['MedicineSystem'], |
|
89 | + 'name' => ['Text'], |
|
90 | + 'potentialAction' => ['Action'], |
|
91 | + 'recognizingAuthority' => ['Organization'], |
|
92 | + 'relevantSpecialty' => ['MedicalSpecialty'], |
|
93 | + 'sameAs' => ['URL'], |
|
94 | + 'study' => ['MedicalStudy'], |
|
95 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
96 | + 'url' => ['URL'] |
|
97 | + ]; |
|
98 | + } |
|
99 | + |
|
100 | + |
|
101 | + /** |
|
102 | + * @inheritdoc |
|
103 | + */ |
|
104 | + public function getSchemaPropertyDescriptions(): array |
|
105 | + { |
|
106 | + return [ |
|
107 | + 'activeIngredient' => 'An active ingredient, typically chemical compounds and/or biologic substances.', |
|
108 | + '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.', |
|
109 | + 'alternateName' => 'An alias for the item.', |
|
110 | + 'code' => 'A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.', |
|
111 | + 'description' => 'A description of the item.', |
|
112 | + '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.', |
|
113 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
114 | + 'guideline' => 'A medical guideline related to this entity.', |
|
115 | + '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. ', |
|
116 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
117 | + 'legalStatus' => 'The drug or supplement\'s legal status, including any controlled substance schedules that apply.', |
|
118 | + '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.', |
|
119 | + 'maximumIntake' => 'Recommended intake of this supplement for a given population as defined by a specific recommending authority.', |
|
120 | + 'medicineSystem' => 'The system of medicine that includes this MedicalEntity, for example \'evidence-based\', \'homeopathic\', \'chiropractic\', etc.', |
|
121 | + 'name' => 'The name of the item.', |
|
122 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
123 | + 'recognizingAuthority' => 'If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.', |
|
124 | + 'relevantSpecialty' => 'If applicable, a medical specialty in which this entity is relevant.', |
|
125 | + '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.', |
|
126 | + 'study' => 'A medical study or trial related to this entity.', |
|
127 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
128 | + 'url' => 'URL of the item.' |
|
129 | + ]; |
|
130 | + } |
|
131 | + |
|
132 | + |
|
133 | + /** |
|
134 | + * @inheritdoc |
|
135 | + */ |
|
136 | + public function getGoogleRequiredSchema(): array |
|
137 | + { |
|
138 | + return ['description', 'name']; |
|
139 | + } |
|
140 | + |
|
141 | + |
|
142 | + /** |
|
143 | + * @inheritdoc |
|
144 | + */ |
|
145 | + public function getGoogleRecommendedSchema(): array |
|
146 | + { |
|
147 | + return ['image', 'url']; |
|
148 | + } |
|
149 | + |
|
150 | + |
|
151 | + /** |
|
152 | + * @inheritdoc |
|
153 | + */ |
|
154 | + public function defineRules(): array |
|
155 | + { |
|
156 | + $rules = parent::defineRules(); |
|
157 | + $rules = array_merge($rules, [ |
|
158 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
159 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
160 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
161 | + ]); |
|
162 | + |
|
163 | + return $rules; |
|
164 | + } |
|
165 | 165 | } |