@@ -23,151 +23,151 @@ |
||
23 | 23 | */ |
24 | 24 | class DownloadAction extends MetaJsonLd implements DownloadActionInterface, TransferActionInterface, ActionInterface, ThingInterface |
25 | 25 | { |
26 | - use DownloadActionTrait; |
|
27 | - use TransferActionTrait; |
|
28 | - use ActionTrait; |
|
29 | - use ThingTrait; |
|
30 | - |
|
31 | - /** |
|
32 | - * The Schema.org Type Name |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - public static string $schemaTypeName = 'DownloadAction'; |
|
37 | - |
|
38 | - /** |
|
39 | - * The Schema.org Type Scope |
|
40 | - * |
|
41 | - * @var string |
|
42 | - */ |
|
43 | - public static string $schemaTypeScope = 'https://schema.org/DownloadAction'; |
|
44 | - |
|
45 | - /** |
|
46 | - * The Schema.org Type Extends |
|
47 | - * |
|
48 | - * @var string |
|
49 | - */ |
|
50 | - public static string $schemaTypeExtends = 'TransferAction'; |
|
51 | - |
|
52 | - /** |
|
53 | - * The Schema.org Type Description |
|
54 | - * |
|
55 | - * @var string |
|
56 | - */ |
|
57 | - public static string $schemaTypeDescription = 'The act of downloading an object.'; |
|
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 | - 'actionStatus' => ['ActionStatusType'], |
|
76 | - 'additionalType' => ['URL'], |
|
77 | - 'agent' => ['Organization', 'Person'], |
|
78 | - 'alternateName' => ['Text'], |
|
79 | - 'description' => ['Text'], |
|
80 | - 'disambiguatingDescription' => ['Text'], |
|
81 | - 'endTime' => ['DateTime', 'Time'], |
|
82 | - 'error' => ['Thing'], |
|
83 | - 'fromLocation' => ['Place'], |
|
84 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
85 | - 'image' => ['URL', 'ImageObject'], |
|
86 | - 'instrument' => ['Thing'], |
|
87 | - 'location' => ['Place', 'Text', 'VirtualLocation', 'PostalAddress'], |
|
88 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
89 | - 'name' => ['Text'], |
|
90 | - 'object' => ['Thing'], |
|
91 | - 'participant' => ['Organization', 'Person'], |
|
92 | - 'potentialAction' => ['Action'], |
|
93 | - 'provider' => ['Organization', 'Person'], |
|
94 | - 'result' => ['Thing'], |
|
95 | - 'sameAs' => ['URL'], |
|
96 | - 'startTime' => ['Time', 'DateTime'], |
|
97 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
98 | - 'target' => ['URL', 'EntryPoint'], |
|
99 | - 'toLocation' => ['Place'], |
|
100 | - 'url' => ['URL'] |
|
101 | - ]; |
|
102 | - } |
|
103 | - |
|
104 | - |
|
105 | - /** |
|
106 | - * @inheritdoc |
|
107 | - */ |
|
108 | - public function getSchemaPropertyDescriptions(): array |
|
109 | - { |
|
110 | - return [ |
|
111 | - 'actionStatus' => 'Indicates the current disposition of the Action.', |
|
112 | - '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.', |
|
113 | - 'agent' => 'The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.', |
|
114 | - 'alternateName' => 'An alias for the item.', |
|
115 | - 'description' => 'A description of the item.', |
|
116 | - '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.', |
|
117 | - '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.', |
|
118 | - 'error' => 'For failed actions, more information on the cause of the failure.', |
|
119 | - 'fromLocation' => 'A sub property of location. The original location of the object or the agent before the action.', |
|
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 | - 'instrument' => 'The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.', |
|
123 | - 'location' => 'The location of, for example, where an event is happening, where an organization is located, or where an action takes place.', |
|
124 | - '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.', |
|
125 | - 'name' => 'The name of the item.', |
|
126 | - '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*.', |
|
127 | - 'participant' => 'Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.', |
|
128 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
129 | - '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.', |
|
130 | - 'result' => 'The result produced in the action. E.g. John wrote *a book*.', |
|
131 | - '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.', |
|
132 | - '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.', |
|
133 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
134 | - 'target' => 'Indicates a target EntryPoint, or url, for an Action.', |
|
135 | - 'toLocation' => 'A sub property of location. The final location of the object or the agent after the action.', |
|
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 | - } |
|
26 | + use DownloadActionTrait; |
|
27 | + use TransferActionTrait; |
|
28 | + use ActionTrait; |
|
29 | + use ThingTrait; |
|
30 | + |
|
31 | + /** |
|
32 | + * The Schema.org Type Name |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + public static string $schemaTypeName = 'DownloadAction'; |
|
37 | + |
|
38 | + /** |
|
39 | + * The Schema.org Type Scope |
|
40 | + * |
|
41 | + * @var string |
|
42 | + */ |
|
43 | + public static string $schemaTypeScope = 'https://schema.org/DownloadAction'; |
|
44 | + |
|
45 | + /** |
|
46 | + * The Schema.org Type Extends |
|
47 | + * |
|
48 | + * @var string |
|
49 | + */ |
|
50 | + public static string $schemaTypeExtends = 'TransferAction'; |
|
51 | + |
|
52 | + /** |
|
53 | + * The Schema.org Type Description |
|
54 | + * |
|
55 | + * @var string |
|
56 | + */ |
|
57 | + public static string $schemaTypeDescription = 'The act of downloading an object.'; |
|
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 | + 'actionStatus' => ['ActionStatusType'], |
|
76 | + 'additionalType' => ['URL'], |
|
77 | + 'agent' => ['Organization', 'Person'], |
|
78 | + 'alternateName' => ['Text'], |
|
79 | + 'description' => ['Text'], |
|
80 | + 'disambiguatingDescription' => ['Text'], |
|
81 | + 'endTime' => ['DateTime', 'Time'], |
|
82 | + 'error' => ['Thing'], |
|
83 | + 'fromLocation' => ['Place'], |
|
84 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
85 | + 'image' => ['URL', 'ImageObject'], |
|
86 | + 'instrument' => ['Thing'], |
|
87 | + 'location' => ['Place', 'Text', 'VirtualLocation', 'PostalAddress'], |
|
88 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
89 | + 'name' => ['Text'], |
|
90 | + 'object' => ['Thing'], |
|
91 | + 'participant' => ['Organization', 'Person'], |
|
92 | + 'potentialAction' => ['Action'], |
|
93 | + 'provider' => ['Organization', 'Person'], |
|
94 | + 'result' => ['Thing'], |
|
95 | + 'sameAs' => ['URL'], |
|
96 | + 'startTime' => ['Time', 'DateTime'], |
|
97 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
98 | + 'target' => ['URL', 'EntryPoint'], |
|
99 | + 'toLocation' => ['Place'], |
|
100 | + 'url' => ['URL'] |
|
101 | + ]; |
|
102 | + } |
|
103 | + |
|
104 | + |
|
105 | + /** |
|
106 | + * @inheritdoc |
|
107 | + */ |
|
108 | + public function getSchemaPropertyDescriptions(): array |
|
109 | + { |
|
110 | + return [ |
|
111 | + 'actionStatus' => 'Indicates the current disposition of the Action.', |
|
112 | + '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.', |
|
113 | + 'agent' => 'The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.', |
|
114 | + 'alternateName' => 'An alias for the item.', |
|
115 | + 'description' => 'A description of the item.', |
|
116 | + '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.', |
|
117 | + '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.', |
|
118 | + 'error' => 'For failed actions, more information on the cause of the failure.', |
|
119 | + 'fromLocation' => 'A sub property of location. The original location of the object or the agent before the action.', |
|
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 | + 'instrument' => 'The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.', |
|
123 | + 'location' => 'The location of, for example, where an event is happening, where an organization is located, or where an action takes place.', |
|
124 | + '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.', |
|
125 | + 'name' => 'The name of the item.', |
|
126 | + '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*.', |
|
127 | + 'participant' => 'Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.', |
|
128 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
129 | + '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.', |
|
130 | + 'result' => 'The result produced in the action. E.g. John wrote *a book*.', |
|
131 | + '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.', |
|
132 | + '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.', |
|
133 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
134 | + 'target' => 'Indicates a target EntryPoint, or url, for an Action.', |
|
135 | + 'toLocation' => 'A sub property of location. The final location of the object or the agent after the action.', |
|
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,127 +23,127 @@ |
||
23 | 23 | */ |
24 | 24 | class WearableSizeSystemUK extends MetaJsonLd implements WearableSizeSystemUKInterface, WearableSizeSystemEnumerationInterface, SizeSystemEnumerationInterface, EnumerationInterface, IntangibleInterface, ThingInterface |
25 | 25 | { |
26 | - use WearableSizeSystemUKTrait; |
|
27 | - use WearableSizeSystemEnumerationTrait; |
|
28 | - use SizeSystemEnumerationTrait; |
|
29 | - use EnumerationTrait; |
|
30 | - use IntangibleTrait; |
|
31 | - use ThingTrait; |
|
32 | - |
|
33 | - /** |
|
34 | - * The Schema.org Type Name |
|
35 | - * |
|
36 | - * @var string |
|
37 | - */ |
|
38 | - public static string $schemaTypeName = 'WearableSizeSystemUK'; |
|
39 | - |
|
40 | - /** |
|
41 | - * The Schema.org Type Scope |
|
42 | - * |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - public static string $schemaTypeScope = 'https://schema.org/WearableSizeSystemUK'; |
|
46 | - |
|
47 | - /** |
|
48 | - * The Schema.org Type Extends |
|
49 | - * |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - public static string $schemaTypeExtends = 'WearableSizeSystemEnumeration'; |
|
53 | - |
|
54 | - /** |
|
55 | - * The Schema.org Type Description |
|
56 | - * |
|
57 | - * @var string |
|
58 | - */ |
|
59 | - public static string $schemaTypeDescription = 'United Kingdom size system for wearables.'; |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * @inheritdoc |
|
64 | - */ |
|
65 | - public function getSchemaPropertyNames(): array |
|
66 | - { |
|
67 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * @inheritdoc |
|
73 | - */ |
|
74 | - public function getSchemaPropertyExpectedTypes(): array |
|
75 | - { |
|
76 | - return [ |
|
77 | - 'additionalType' => ['URL'], |
|
78 | - 'alternateName' => ['Text'], |
|
79 | - 'description' => ['Text'], |
|
80 | - 'disambiguatingDescription' => ['Text'], |
|
81 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
82 | - 'image' => ['URL', 'ImageObject'], |
|
83 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
84 | - 'name' => ['Text'], |
|
85 | - 'potentialAction' => ['Action'], |
|
86 | - 'sameAs' => ['URL'], |
|
87 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
88 | - 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
89 | - 'url' => ['URL'] |
|
90 | - ]; |
|
91 | - } |
|
92 | - |
|
93 | - |
|
94 | - /** |
|
95 | - * @inheritdoc |
|
96 | - */ |
|
97 | - public function getSchemaPropertyDescriptions(): array |
|
98 | - { |
|
99 | - return [ |
|
100 | - 'additionalType' => 'An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
101 | - 'alternateName' => 'An alias for the item.', |
|
102 | - 'description' => 'A description of the item.', |
|
103 | - 'disambiguatingDescription' => 'A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.', |
|
104 | - 'identifier' => 'The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details. ', |
|
105 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
106 | - 'mainEntityOfPage' => 'Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.', |
|
107 | - 'name' => 'The name of the item.', |
|
108 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
109 | - 'sameAs' => 'URL of a reference Web page that unambiguously indicates the item\'s identity. E.g. the URL of the item\'s Wikipedia page, Wikidata entry, or official website.', |
|
110 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
111 | - 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
112 | - 'url' => 'URL of the item.' |
|
113 | - ]; |
|
114 | - } |
|
115 | - |
|
116 | - |
|
117 | - /** |
|
118 | - * @inheritdoc |
|
119 | - */ |
|
120 | - public function getGoogleRequiredSchema(): array |
|
121 | - { |
|
122 | - return ['description', 'name']; |
|
123 | - } |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @inheritdoc |
|
128 | - */ |
|
129 | - public function getGoogleRecommendedSchema(): array |
|
130 | - { |
|
131 | - return ['image', 'url']; |
|
132 | - } |
|
133 | - |
|
134 | - |
|
135 | - /** |
|
136 | - * @inheritdoc |
|
137 | - */ |
|
138 | - public function defineRules(): array |
|
139 | - { |
|
140 | - $rules = parent::defineRules(); |
|
141 | - $rules = array_merge($rules, [ |
|
142 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
143 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
144 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
145 | - ]); |
|
146 | - |
|
147 | - return $rules; |
|
148 | - } |
|
26 | + use WearableSizeSystemUKTrait; |
|
27 | + use WearableSizeSystemEnumerationTrait; |
|
28 | + use SizeSystemEnumerationTrait; |
|
29 | + use EnumerationTrait; |
|
30 | + use IntangibleTrait; |
|
31 | + use ThingTrait; |
|
32 | + |
|
33 | + /** |
|
34 | + * The Schema.org Type Name |
|
35 | + * |
|
36 | + * @var string |
|
37 | + */ |
|
38 | + public static string $schemaTypeName = 'WearableSizeSystemUK'; |
|
39 | + |
|
40 | + /** |
|
41 | + * The Schema.org Type Scope |
|
42 | + * |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + public static string $schemaTypeScope = 'https://schema.org/WearableSizeSystemUK'; |
|
46 | + |
|
47 | + /** |
|
48 | + * The Schema.org Type Extends |
|
49 | + * |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + public static string $schemaTypeExtends = 'WearableSizeSystemEnumeration'; |
|
53 | + |
|
54 | + /** |
|
55 | + * The Schema.org Type Description |
|
56 | + * |
|
57 | + * @var string |
|
58 | + */ |
|
59 | + public static string $schemaTypeDescription = 'United Kingdom size system for wearables.'; |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * @inheritdoc |
|
64 | + */ |
|
65 | + public function getSchemaPropertyNames(): array |
|
66 | + { |
|
67 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * @inheritdoc |
|
73 | + */ |
|
74 | + public function getSchemaPropertyExpectedTypes(): array |
|
75 | + { |
|
76 | + return [ |
|
77 | + 'additionalType' => ['URL'], |
|
78 | + 'alternateName' => ['Text'], |
|
79 | + 'description' => ['Text'], |
|
80 | + 'disambiguatingDescription' => ['Text'], |
|
81 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
82 | + 'image' => ['URL', 'ImageObject'], |
|
83 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
84 | + 'name' => ['Text'], |
|
85 | + 'potentialAction' => ['Action'], |
|
86 | + 'sameAs' => ['URL'], |
|
87 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
88 | + 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
89 | + 'url' => ['URL'] |
|
90 | + ]; |
|
91 | + } |
|
92 | + |
|
93 | + |
|
94 | + /** |
|
95 | + * @inheritdoc |
|
96 | + */ |
|
97 | + public function getSchemaPropertyDescriptions(): array |
|
98 | + { |
|
99 | + return [ |
|
100 | + 'additionalType' => 'An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
101 | + 'alternateName' => 'An alias for the item.', |
|
102 | + 'description' => 'A description of the item.', |
|
103 | + 'disambiguatingDescription' => 'A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.', |
|
104 | + 'identifier' => 'The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details. ', |
|
105 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
106 | + 'mainEntityOfPage' => 'Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.', |
|
107 | + 'name' => 'The name of the item.', |
|
108 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
109 | + 'sameAs' => 'URL of a reference Web page that unambiguously indicates the item\'s identity. E.g. the URL of the item\'s Wikipedia page, Wikidata entry, or official website.', |
|
110 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
111 | + 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
112 | + 'url' => 'URL of the item.' |
|
113 | + ]; |
|
114 | + } |
|
115 | + |
|
116 | + |
|
117 | + /** |
|
118 | + * @inheritdoc |
|
119 | + */ |
|
120 | + public function getGoogleRequiredSchema(): array |
|
121 | + { |
|
122 | + return ['description', 'name']; |
|
123 | + } |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @inheritdoc |
|
128 | + */ |
|
129 | + public function getGoogleRecommendedSchema(): array |
|
130 | + { |
|
131 | + return ['image', 'url']; |
|
132 | + } |
|
133 | + |
|
134 | + |
|
135 | + /** |
|
136 | + * @inheritdoc |
|
137 | + */ |
|
138 | + public function defineRules(): array |
|
139 | + { |
|
140 | + $rules = parent::defineRules(); |
|
141 | + $rules = array_merge($rules, [ |
|
142 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
143 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
144 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
145 | + ]); |
|
146 | + |
|
147 | + return $rules; |
|
148 | + } |
|
149 | 149 | } |
@@ -23,127 +23,127 @@ |
||
23 | 23 | */ |
24 | 24 | class EnrollingByInvitation extends MetaJsonLd implements EnrollingByInvitationInterface, MedicalStudyStatusInterface, MedicalEnumerationInterface, EnumerationInterface, IntangibleInterface, ThingInterface |
25 | 25 | { |
26 | - use EnrollingByInvitationTrait; |
|
27 | - use MedicalStudyStatusTrait; |
|
28 | - use MedicalEnumerationTrait; |
|
29 | - use EnumerationTrait; |
|
30 | - use IntangibleTrait; |
|
31 | - use ThingTrait; |
|
32 | - |
|
33 | - /** |
|
34 | - * The Schema.org Type Name |
|
35 | - * |
|
36 | - * @var string |
|
37 | - */ |
|
38 | - public static string $schemaTypeName = 'EnrollingByInvitation'; |
|
39 | - |
|
40 | - /** |
|
41 | - * The Schema.org Type Scope |
|
42 | - * |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - public static string $schemaTypeScope = 'https://schema.org/EnrollingByInvitation'; |
|
46 | - |
|
47 | - /** |
|
48 | - * The Schema.org Type Extends |
|
49 | - * |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - public static string $schemaTypeExtends = 'MedicalStudyStatus'; |
|
53 | - |
|
54 | - /** |
|
55 | - * The Schema.org Type Description |
|
56 | - * |
|
57 | - * @var string |
|
58 | - */ |
|
59 | - public static string $schemaTypeDescription = 'Enrolling participants by invitation only.'; |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * @inheritdoc |
|
64 | - */ |
|
65 | - public function getSchemaPropertyNames(): array |
|
66 | - { |
|
67 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * @inheritdoc |
|
73 | - */ |
|
74 | - public function getSchemaPropertyExpectedTypes(): array |
|
75 | - { |
|
76 | - return [ |
|
77 | - 'additionalType' => ['URL'], |
|
78 | - 'alternateName' => ['Text'], |
|
79 | - 'description' => ['Text'], |
|
80 | - 'disambiguatingDescription' => ['Text'], |
|
81 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
82 | - 'image' => ['URL', 'ImageObject'], |
|
83 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
84 | - 'name' => ['Text'], |
|
85 | - 'potentialAction' => ['Action'], |
|
86 | - 'sameAs' => ['URL'], |
|
87 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
88 | - 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
89 | - 'url' => ['URL'] |
|
90 | - ]; |
|
91 | - } |
|
92 | - |
|
93 | - |
|
94 | - /** |
|
95 | - * @inheritdoc |
|
96 | - */ |
|
97 | - public function getSchemaPropertyDescriptions(): array |
|
98 | - { |
|
99 | - return [ |
|
100 | - 'additionalType' => 'An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
101 | - 'alternateName' => 'An alias for the item.', |
|
102 | - 'description' => 'A description of the item.', |
|
103 | - 'disambiguatingDescription' => 'A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.', |
|
104 | - 'identifier' => 'The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details. ', |
|
105 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
106 | - 'mainEntityOfPage' => 'Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.', |
|
107 | - 'name' => 'The name of the item.', |
|
108 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
109 | - 'sameAs' => 'URL of a reference Web page that unambiguously indicates the item\'s identity. E.g. the URL of the item\'s Wikipedia page, Wikidata entry, or official website.', |
|
110 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
111 | - 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
112 | - 'url' => 'URL of the item.' |
|
113 | - ]; |
|
114 | - } |
|
115 | - |
|
116 | - |
|
117 | - /** |
|
118 | - * @inheritdoc |
|
119 | - */ |
|
120 | - public function getGoogleRequiredSchema(): array |
|
121 | - { |
|
122 | - return ['description', 'name']; |
|
123 | - } |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @inheritdoc |
|
128 | - */ |
|
129 | - public function getGoogleRecommendedSchema(): array |
|
130 | - { |
|
131 | - return ['image', 'url']; |
|
132 | - } |
|
133 | - |
|
134 | - |
|
135 | - /** |
|
136 | - * @inheritdoc |
|
137 | - */ |
|
138 | - public function defineRules(): array |
|
139 | - { |
|
140 | - $rules = parent::defineRules(); |
|
141 | - $rules = array_merge($rules, [ |
|
142 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
143 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
144 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
145 | - ]); |
|
146 | - |
|
147 | - return $rules; |
|
148 | - } |
|
26 | + use EnrollingByInvitationTrait; |
|
27 | + use MedicalStudyStatusTrait; |
|
28 | + use MedicalEnumerationTrait; |
|
29 | + use EnumerationTrait; |
|
30 | + use IntangibleTrait; |
|
31 | + use ThingTrait; |
|
32 | + |
|
33 | + /** |
|
34 | + * The Schema.org Type Name |
|
35 | + * |
|
36 | + * @var string |
|
37 | + */ |
|
38 | + public static string $schemaTypeName = 'EnrollingByInvitation'; |
|
39 | + |
|
40 | + /** |
|
41 | + * The Schema.org Type Scope |
|
42 | + * |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + public static string $schemaTypeScope = 'https://schema.org/EnrollingByInvitation'; |
|
46 | + |
|
47 | + /** |
|
48 | + * The Schema.org Type Extends |
|
49 | + * |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + public static string $schemaTypeExtends = 'MedicalStudyStatus'; |
|
53 | + |
|
54 | + /** |
|
55 | + * The Schema.org Type Description |
|
56 | + * |
|
57 | + * @var string |
|
58 | + */ |
|
59 | + public static string $schemaTypeDescription = 'Enrolling participants by invitation only.'; |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * @inheritdoc |
|
64 | + */ |
|
65 | + public function getSchemaPropertyNames(): array |
|
66 | + { |
|
67 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * @inheritdoc |
|
73 | + */ |
|
74 | + public function getSchemaPropertyExpectedTypes(): array |
|
75 | + { |
|
76 | + return [ |
|
77 | + 'additionalType' => ['URL'], |
|
78 | + 'alternateName' => ['Text'], |
|
79 | + 'description' => ['Text'], |
|
80 | + 'disambiguatingDescription' => ['Text'], |
|
81 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
82 | + 'image' => ['URL', 'ImageObject'], |
|
83 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
84 | + 'name' => ['Text'], |
|
85 | + 'potentialAction' => ['Action'], |
|
86 | + 'sameAs' => ['URL'], |
|
87 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
88 | + 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
89 | + 'url' => ['URL'] |
|
90 | + ]; |
|
91 | + } |
|
92 | + |
|
93 | + |
|
94 | + /** |
|
95 | + * @inheritdoc |
|
96 | + */ |
|
97 | + public function getSchemaPropertyDescriptions(): array |
|
98 | + { |
|
99 | + return [ |
|
100 | + 'additionalType' => 'An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
101 | + 'alternateName' => 'An alias for the item.', |
|
102 | + 'description' => 'A description of the item.', |
|
103 | + 'disambiguatingDescription' => 'A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.', |
|
104 | + 'identifier' => 'The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details. ', |
|
105 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
106 | + 'mainEntityOfPage' => 'Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.', |
|
107 | + 'name' => 'The name of the item.', |
|
108 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
109 | + 'sameAs' => 'URL of a reference Web page that unambiguously indicates the item\'s identity. E.g. the URL of the item\'s Wikipedia page, Wikidata entry, or official website.', |
|
110 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
111 | + 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
112 | + 'url' => 'URL of the item.' |
|
113 | + ]; |
|
114 | + } |
|
115 | + |
|
116 | + |
|
117 | + /** |
|
118 | + * @inheritdoc |
|
119 | + */ |
|
120 | + public function getGoogleRequiredSchema(): array |
|
121 | + { |
|
122 | + return ['description', 'name']; |
|
123 | + } |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @inheritdoc |
|
128 | + */ |
|
129 | + public function getGoogleRecommendedSchema(): array |
|
130 | + { |
|
131 | + return ['image', 'url']; |
|
132 | + } |
|
133 | + |
|
134 | + |
|
135 | + /** |
|
136 | + * @inheritdoc |
|
137 | + */ |
|
138 | + public function defineRules(): array |
|
139 | + { |
|
140 | + $rules = parent::defineRules(); |
|
141 | + $rules = array_merge($rules, [ |
|
142 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
143 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
144 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
145 | + ]); |
|
146 | + |
|
147 | + return $rules; |
|
148 | + } |
|
149 | 149 | } |
@@ -24,175 +24,175 @@ |
||
24 | 24 | */ |
25 | 25 | class GovernmentService extends MetaJsonLd implements GovernmentServiceInterface, ServiceInterface, IntangibleInterface, ThingInterface |
26 | 26 | { |
27 | - use GovernmentServiceTrait; |
|
28 | - use ServiceTrait; |
|
29 | - use IntangibleTrait; |
|
30 | - use ThingTrait; |
|
31 | - |
|
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static string $schemaTypeName = 'GovernmentService'; |
|
38 | - |
|
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static string $schemaTypeScope = 'https://schema.org/GovernmentService'; |
|
45 | - |
|
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static string $schemaTypeExtends = 'Service'; |
|
52 | - |
|
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static string $schemaTypeDescription = 'A service provided by a government organization, e.g. food stamps, veterans benefits, etc.'; |
|
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 | - 'aggregateRating' => ['AggregateRating'], |
|
78 | - 'alternateName' => ['Text'], |
|
79 | - 'areaServed' => ['Text', 'Place', 'GeoShape', 'AdministrativeArea'], |
|
80 | - 'audience' => ['Audience'], |
|
81 | - 'availableChannel' => ['ServiceChannel'], |
|
82 | - 'award' => ['Text'], |
|
83 | - 'brand' => ['Brand', 'Organization'], |
|
84 | - 'broker' => ['Person', 'Organization'], |
|
85 | - 'category' => ['URL', 'CategoryCode', 'Text', 'Thing', 'PhysicalActivityCategory'], |
|
86 | - 'description' => ['Text'], |
|
87 | - 'disambiguatingDescription' => ['Text'], |
|
88 | - 'hasOfferCatalog' => ['OfferCatalog'], |
|
89 | - 'hoursAvailable' => ['OpeningHoursSpecification'], |
|
90 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
91 | - 'image' => ['URL', 'ImageObject'], |
|
92 | - 'isRelatedTo' => ['Product', 'Service'], |
|
93 | - 'isSimilarTo' => ['Product', 'Service'], |
|
94 | - 'jurisdiction' => ['AdministrativeArea', 'Text'], |
|
95 | - 'logo' => ['ImageObject', 'URL'], |
|
96 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
97 | - 'name' => ['Text'], |
|
98 | - 'offers' => ['Demand', 'Offer'], |
|
99 | - 'potentialAction' => ['Action'], |
|
100 | - 'produces' => ['Thing'], |
|
101 | - 'provider' => ['Organization', 'Person'], |
|
102 | - 'providerMobility' => ['Text'], |
|
103 | - 'review' => ['Review'], |
|
104 | - 'sameAs' => ['URL'], |
|
105 | - 'serviceArea' => ['AdministrativeArea', 'Place', 'GeoShape'], |
|
106 | - 'serviceAudience' => ['Audience'], |
|
107 | - 'serviceOperator' => ['Organization'], |
|
108 | - 'serviceOutput' => ['Thing'], |
|
109 | - 'serviceType' => ['Text', 'GovernmentBenefitsType'], |
|
110 | - 'slogan' => ['Text'], |
|
111 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
112 | - 'termsOfService' => ['URL', 'Text'], |
|
113 | - 'url' => ['URL'] |
|
114 | - ]; |
|
115 | - } |
|
116 | - |
|
117 | - |
|
118 | - /** |
|
119 | - * @inheritdoc |
|
120 | - */ |
|
121 | - public function getSchemaPropertyDescriptions(): array |
|
122 | - { |
|
123 | - return [ |
|
124 | - '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.', |
|
125 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
126 | - 'alternateName' => 'An alias for the item.', |
|
127 | - 'areaServed' => 'The geographic area where a service or offered item is provided.', |
|
128 | - 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
129 | - 'availableChannel' => 'A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).', |
|
130 | - 'award' => 'An award won by or for this item.', |
|
131 | - 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
132 | - 'broker' => 'An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.', |
|
133 | - 'category' => 'A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.', |
|
134 | - 'description' => 'A description of the item.', |
|
135 | - '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.', |
|
136 | - 'hasOfferCatalog' => 'Indicates an OfferCatalog listing for this Organization, Person, or Service.', |
|
137 | - 'hoursAvailable' => 'The hours during which this service or contact is available.', |
|
138 | - '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. ', |
|
139 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
140 | - 'isRelatedTo' => 'A pointer to another, somehow related product (or multiple products).', |
|
141 | - 'isSimilarTo' => 'A pointer to another, functionally similar product (or multiple products).', |
|
142 | - 'jurisdiction' => 'Indicates a legal jurisdiction, e.g. of some legislation, or where some government service is based.', |
|
143 | - 'logo' => 'An associated logo.', |
|
144 | - '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.', |
|
145 | - 'name' => 'The name of the item.', |
|
146 | - '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. ', |
|
147 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
148 | - 'produces' => 'The tangible thing generated by the service, e.g. a passport, permit, etc.', |
|
149 | - '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.', |
|
150 | - 'providerMobility' => 'Indicates the mobility of a provided service (e.g. \'static\', \'dynamic\').', |
|
151 | - 'review' => 'A review of the item.', |
|
152 | - '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.', |
|
153 | - 'serviceArea' => 'The geographic area where the service is provided.', |
|
154 | - 'serviceAudience' => 'The audience eligible for this service.', |
|
155 | - 'serviceOperator' => 'The operating organization, if different from the provider. This enables the representation of services that are provided by an organization, but operated by another organization like a subcontractor.', |
|
156 | - 'serviceOutput' => 'The tangible thing generated by the service, e.g. a passport, permit, etc.', |
|
157 | - 'serviceType' => 'The type of service being offered, e.g. veterans\' benefits, emergency relief, etc.', |
|
158 | - 'slogan' => 'A slogan or motto associated with the item.', |
|
159 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
160 | - 'termsOfService' => 'Human-readable terms of service documentation.', |
|
161 | - 'url' => 'URL of the item.' |
|
162 | - ]; |
|
163 | - } |
|
164 | - |
|
165 | - |
|
166 | - /** |
|
167 | - * @inheritdoc |
|
168 | - */ |
|
169 | - public function getGoogleRequiredSchema(): array |
|
170 | - { |
|
171 | - return ['description', 'name']; |
|
172 | - } |
|
173 | - |
|
174 | - |
|
175 | - /** |
|
176 | - * @inheritdoc |
|
177 | - */ |
|
178 | - public function getGoogleRecommendedSchema(): array |
|
179 | - { |
|
180 | - return ['image', 'url']; |
|
181 | - } |
|
182 | - |
|
183 | - |
|
184 | - /** |
|
185 | - * @inheritdoc |
|
186 | - */ |
|
187 | - public function defineRules(): array |
|
188 | - { |
|
189 | - $rules = parent::defineRules(); |
|
190 | - $rules = array_merge($rules, [ |
|
191 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
192 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
193 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
194 | - ]); |
|
195 | - |
|
196 | - return $rules; |
|
197 | - } |
|
27 | + use GovernmentServiceTrait; |
|
28 | + use ServiceTrait; |
|
29 | + use IntangibleTrait; |
|
30 | + use ThingTrait; |
|
31 | + |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static string $schemaTypeName = 'GovernmentService'; |
|
38 | + |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static string $schemaTypeScope = 'https://schema.org/GovernmentService'; |
|
45 | + |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static string $schemaTypeExtends = 'Service'; |
|
52 | + |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static string $schemaTypeDescription = 'A service provided by a government organization, e.g. food stamps, veterans benefits, etc.'; |
|
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 | + 'aggregateRating' => ['AggregateRating'], |
|
78 | + 'alternateName' => ['Text'], |
|
79 | + 'areaServed' => ['Text', 'Place', 'GeoShape', 'AdministrativeArea'], |
|
80 | + 'audience' => ['Audience'], |
|
81 | + 'availableChannel' => ['ServiceChannel'], |
|
82 | + 'award' => ['Text'], |
|
83 | + 'brand' => ['Brand', 'Organization'], |
|
84 | + 'broker' => ['Person', 'Organization'], |
|
85 | + 'category' => ['URL', 'CategoryCode', 'Text', 'Thing', 'PhysicalActivityCategory'], |
|
86 | + 'description' => ['Text'], |
|
87 | + 'disambiguatingDescription' => ['Text'], |
|
88 | + 'hasOfferCatalog' => ['OfferCatalog'], |
|
89 | + 'hoursAvailable' => ['OpeningHoursSpecification'], |
|
90 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
91 | + 'image' => ['URL', 'ImageObject'], |
|
92 | + 'isRelatedTo' => ['Product', 'Service'], |
|
93 | + 'isSimilarTo' => ['Product', 'Service'], |
|
94 | + 'jurisdiction' => ['AdministrativeArea', 'Text'], |
|
95 | + 'logo' => ['ImageObject', 'URL'], |
|
96 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
97 | + 'name' => ['Text'], |
|
98 | + 'offers' => ['Demand', 'Offer'], |
|
99 | + 'potentialAction' => ['Action'], |
|
100 | + 'produces' => ['Thing'], |
|
101 | + 'provider' => ['Organization', 'Person'], |
|
102 | + 'providerMobility' => ['Text'], |
|
103 | + 'review' => ['Review'], |
|
104 | + 'sameAs' => ['URL'], |
|
105 | + 'serviceArea' => ['AdministrativeArea', 'Place', 'GeoShape'], |
|
106 | + 'serviceAudience' => ['Audience'], |
|
107 | + 'serviceOperator' => ['Organization'], |
|
108 | + 'serviceOutput' => ['Thing'], |
|
109 | + 'serviceType' => ['Text', 'GovernmentBenefitsType'], |
|
110 | + 'slogan' => ['Text'], |
|
111 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
112 | + 'termsOfService' => ['URL', 'Text'], |
|
113 | + 'url' => ['URL'] |
|
114 | + ]; |
|
115 | + } |
|
116 | + |
|
117 | + |
|
118 | + /** |
|
119 | + * @inheritdoc |
|
120 | + */ |
|
121 | + public function getSchemaPropertyDescriptions(): array |
|
122 | + { |
|
123 | + return [ |
|
124 | + '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.', |
|
125 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
126 | + 'alternateName' => 'An alias for the item.', |
|
127 | + 'areaServed' => 'The geographic area where a service or offered item is provided.', |
|
128 | + 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
129 | + 'availableChannel' => 'A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).', |
|
130 | + 'award' => 'An award won by or for this item.', |
|
131 | + 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
132 | + 'broker' => 'An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.', |
|
133 | + 'category' => 'A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.', |
|
134 | + 'description' => 'A description of the item.', |
|
135 | + '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.', |
|
136 | + 'hasOfferCatalog' => 'Indicates an OfferCatalog listing for this Organization, Person, or Service.', |
|
137 | + 'hoursAvailable' => 'The hours during which this service or contact is available.', |
|
138 | + '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. ', |
|
139 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
140 | + 'isRelatedTo' => 'A pointer to another, somehow related product (or multiple products).', |
|
141 | + 'isSimilarTo' => 'A pointer to another, functionally similar product (or multiple products).', |
|
142 | + 'jurisdiction' => 'Indicates a legal jurisdiction, e.g. of some legislation, or where some government service is based.', |
|
143 | + 'logo' => 'An associated logo.', |
|
144 | + '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.', |
|
145 | + 'name' => 'The name of the item.', |
|
146 | + '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. ', |
|
147 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
148 | + 'produces' => 'The tangible thing generated by the service, e.g. a passport, permit, etc.', |
|
149 | + '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.', |
|
150 | + 'providerMobility' => 'Indicates the mobility of a provided service (e.g. \'static\', \'dynamic\').', |
|
151 | + 'review' => 'A review of the item.', |
|
152 | + '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.', |
|
153 | + 'serviceArea' => 'The geographic area where the service is provided.', |
|
154 | + 'serviceAudience' => 'The audience eligible for this service.', |
|
155 | + 'serviceOperator' => 'The operating organization, if different from the provider. This enables the representation of services that are provided by an organization, but operated by another organization like a subcontractor.', |
|
156 | + 'serviceOutput' => 'The tangible thing generated by the service, e.g. a passport, permit, etc.', |
|
157 | + 'serviceType' => 'The type of service being offered, e.g. veterans\' benefits, emergency relief, etc.', |
|
158 | + 'slogan' => 'A slogan or motto associated with the item.', |
|
159 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
160 | + 'termsOfService' => 'Human-readable terms of service documentation.', |
|
161 | + 'url' => 'URL of the item.' |
|
162 | + ]; |
|
163 | + } |
|
164 | + |
|
165 | + |
|
166 | + /** |
|
167 | + * @inheritdoc |
|
168 | + */ |
|
169 | + public function getGoogleRequiredSchema(): array |
|
170 | + { |
|
171 | + return ['description', 'name']; |
|
172 | + } |
|
173 | + |
|
174 | + |
|
175 | + /** |
|
176 | + * @inheritdoc |
|
177 | + */ |
|
178 | + public function getGoogleRecommendedSchema(): array |
|
179 | + { |
|
180 | + return ['image', 'url']; |
|
181 | + } |
|
182 | + |
|
183 | + |
|
184 | + /** |
|
185 | + * @inheritdoc |
|
186 | + */ |
|
187 | + public function defineRules(): array |
|
188 | + { |
|
189 | + $rules = parent::defineRules(); |
|
190 | + $rules = array_merge($rules, [ |
|
191 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
192 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
193 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
194 | + ]); |
|
195 | + |
|
196 | + return $rules; |
|
197 | + } |
|
198 | 198 | } |
@@ -23,126 +23,126 @@ |
||
23 | 23 | */ |
24 | 24 | class LowSaltDiet extends MetaJsonLd implements LowSaltDietInterface, RestrictedDietInterface, EnumerationInterface, IntangibleInterface, ThingInterface |
25 | 25 | { |
26 | - use LowSaltDietTrait; |
|
27 | - use RestrictedDietTrait; |
|
28 | - use EnumerationTrait; |
|
29 | - use IntangibleTrait; |
|
30 | - use ThingTrait; |
|
31 | - |
|
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static string $schemaTypeName = 'LowSaltDiet'; |
|
38 | - |
|
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static string $schemaTypeScope = 'https://schema.org/LowSaltDiet'; |
|
45 | - |
|
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static string $schemaTypeExtends = 'RestrictedDiet'; |
|
52 | - |
|
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static string $schemaTypeDescription = 'A diet focused on reduced sodium intake.'; |
|
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 | - 'description' => ['Text'], |
|
79 | - 'disambiguatingDescription' => ['Text'], |
|
80 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
81 | - 'image' => ['URL', 'ImageObject'], |
|
82 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
83 | - 'name' => ['Text'], |
|
84 | - 'potentialAction' => ['Action'], |
|
85 | - 'sameAs' => ['URL'], |
|
86 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
87 | - 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
88 | - 'url' => ['URL'] |
|
89 | - ]; |
|
90 | - } |
|
91 | - |
|
92 | - |
|
93 | - /** |
|
94 | - * @inheritdoc |
|
95 | - */ |
|
96 | - public function getSchemaPropertyDescriptions(): array |
|
97 | - { |
|
98 | - return [ |
|
99 | - '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.', |
|
100 | - 'alternateName' => 'An alias for the item.', |
|
101 | - 'description' => 'A description of the item.', |
|
102 | - '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.', |
|
103 | - '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. ', |
|
104 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
105 | - '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.', |
|
106 | - 'name' => 'The name of the item.', |
|
107 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
108 | - '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.', |
|
109 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
110 | - 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
111 | - 'url' => 'URL of the item.' |
|
112 | - ]; |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * @inheritdoc |
|
118 | - */ |
|
119 | - public function getGoogleRequiredSchema(): array |
|
120 | - { |
|
121 | - return ['description', 'name']; |
|
122 | - } |
|
123 | - |
|
124 | - |
|
125 | - /** |
|
126 | - * @inheritdoc |
|
127 | - */ |
|
128 | - public function getGoogleRecommendedSchema(): array |
|
129 | - { |
|
130 | - return ['image', 'url']; |
|
131 | - } |
|
132 | - |
|
133 | - |
|
134 | - /** |
|
135 | - * @inheritdoc |
|
136 | - */ |
|
137 | - public function defineRules(): array |
|
138 | - { |
|
139 | - $rules = parent::defineRules(); |
|
140 | - $rules = array_merge($rules, [ |
|
141 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
142 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
143 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
144 | - ]); |
|
145 | - |
|
146 | - return $rules; |
|
147 | - } |
|
26 | + use LowSaltDietTrait; |
|
27 | + use RestrictedDietTrait; |
|
28 | + use EnumerationTrait; |
|
29 | + use IntangibleTrait; |
|
30 | + use ThingTrait; |
|
31 | + |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static string $schemaTypeName = 'LowSaltDiet'; |
|
38 | + |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static string $schemaTypeScope = 'https://schema.org/LowSaltDiet'; |
|
45 | + |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static string $schemaTypeExtends = 'RestrictedDiet'; |
|
52 | + |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static string $schemaTypeDescription = 'A diet focused on reduced sodium intake.'; |
|
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 | + 'description' => ['Text'], |
|
79 | + 'disambiguatingDescription' => ['Text'], |
|
80 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
81 | + 'image' => ['URL', 'ImageObject'], |
|
82 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
83 | + 'name' => ['Text'], |
|
84 | + 'potentialAction' => ['Action'], |
|
85 | + 'sameAs' => ['URL'], |
|
86 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
87 | + 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
88 | + 'url' => ['URL'] |
|
89 | + ]; |
|
90 | + } |
|
91 | + |
|
92 | + |
|
93 | + /** |
|
94 | + * @inheritdoc |
|
95 | + */ |
|
96 | + public function getSchemaPropertyDescriptions(): array |
|
97 | + { |
|
98 | + return [ |
|
99 | + '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.', |
|
100 | + 'alternateName' => 'An alias for the item.', |
|
101 | + 'description' => 'A description of the item.', |
|
102 | + '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.', |
|
103 | + '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. ', |
|
104 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
105 | + '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.', |
|
106 | + 'name' => 'The name of the item.', |
|
107 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
108 | + '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.', |
|
109 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
110 | + 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
111 | + 'url' => 'URL of the item.' |
|
112 | + ]; |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * @inheritdoc |
|
118 | + */ |
|
119 | + public function getGoogleRequiredSchema(): array |
|
120 | + { |
|
121 | + return ['description', 'name']; |
|
122 | + } |
|
123 | + |
|
124 | + |
|
125 | + /** |
|
126 | + * @inheritdoc |
|
127 | + */ |
|
128 | + public function getGoogleRecommendedSchema(): array |
|
129 | + { |
|
130 | + return ['image', 'url']; |
|
131 | + } |
|
132 | + |
|
133 | + |
|
134 | + /** |
|
135 | + * @inheritdoc |
|
136 | + */ |
|
137 | + public function defineRules(): array |
|
138 | + { |
|
139 | + $rules = parent::defineRules(); |
|
140 | + $rules = array_merge($rules, [ |
|
141 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
142 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
143 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
144 | + ]); |
|
145 | + |
|
146 | + return $rules; |
|
147 | + } |
|
148 | 148 | } |
@@ -23,366 +23,366 @@ |
||
23 | 23 | */ |
24 | 24 | class MedicalScholarlyArticle extends MetaJsonLd implements MedicalScholarlyArticleInterface, ScholarlyArticleInterface, ArticleInterface, CreativeWorkInterface, ThingInterface |
25 | 25 | { |
26 | - use MedicalScholarlyArticleTrait; |
|
27 | - use ScholarlyArticleTrait; |
|
28 | - use ArticleTrait; |
|
29 | - use CreativeWorkTrait; |
|
30 | - use ThingTrait; |
|
26 | + use MedicalScholarlyArticleTrait; |
|
27 | + use ScholarlyArticleTrait; |
|
28 | + use ArticleTrait; |
|
29 | + use CreativeWorkTrait; |
|
30 | + use ThingTrait; |
|
31 | 31 | |
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static string $schemaTypeName = 'MedicalScholarlyArticle'; |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static string $schemaTypeName = 'MedicalScholarlyArticle'; |
|
38 | 38 | |
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static string $schemaTypeScope = 'https://schema.org/MedicalScholarlyArticle'; |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static string $schemaTypeScope = 'https://schema.org/MedicalScholarlyArticle'; |
|
45 | 45 | |
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static string $schemaTypeExtends = 'ScholarlyArticle'; |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static string $schemaTypeExtends = 'ScholarlyArticle'; |
|
52 | 52 | |
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static string $schemaTypeDescription = 'A scholarly article in the medical domain.'; |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static string $schemaTypeDescription = 'A scholarly article in the medical domain.'; |
|
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 | - 'about' => ['Thing'], |
|
77 | - 'abstract' => ['Text'], |
|
78 | - 'accessMode' => ['Text'], |
|
79 | - 'accessModeSufficient' => ['ItemList'], |
|
80 | - 'accessibilityAPI' => ['Text'], |
|
81 | - 'accessibilityControl' => ['Text'], |
|
82 | - 'accessibilityFeature' => ['Text'], |
|
83 | - 'accessibilityHazard' => ['Text'], |
|
84 | - 'accessibilitySummary' => ['Text'], |
|
85 | - 'accountablePerson' => ['Person'], |
|
86 | - 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
87 | - 'additionalType' => ['URL'], |
|
88 | - 'aggregateRating' => ['AggregateRating'], |
|
89 | - 'alternateName' => ['Text'], |
|
90 | - 'alternativeHeadline' => ['Text'], |
|
91 | - 'archivedAt' => ['WebPage', 'URL'], |
|
92 | - 'articleBody' => ['Text'], |
|
93 | - 'articleSection' => ['Text'], |
|
94 | - 'assesses' => ['DefinedTerm', 'Text'], |
|
95 | - 'associatedMedia' => ['MediaObject'], |
|
96 | - 'audience' => ['Audience'], |
|
97 | - 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
98 | - 'author' => ['Organization', 'Person'], |
|
99 | - 'award' => ['Text'], |
|
100 | - 'awards' => ['Text'], |
|
101 | - 'backstory' => ['CreativeWork', 'Text'], |
|
102 | - 'character' => ['Person'], |
|
103 | - 'citation' => ['CreativeWork', 'Text'], |
|
104 | - 'comment' => ['Comment'], |
|
105 | - 'commentCount' => ['Integer'], |
|
106 | - 'conditionsOfAccess' => ['Text'], |
|
107 | - 'contentLocation' => ['Place'], |
|
108 | - 'contentRating' => ['Text', 'Rating'], |
|
109 | - 'contentReferenceTime' => ['DateTime'], |
|
110 | - 'contributor' => ['Organization', 'Person'], |
|
111 | - 'copyrightHolder' => ['Organization', 'Person'], |
|
112 | - 'copyrightNotice' => ['Text'], |
|
113 | - 'copyrightYear' => ['Number'], |
|
114 | - 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
115 | - 'countryOfOrigin' => ['Country'], |
|
116 | - 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
117 | - 'creator' => ['Person', 'Organization'], |
|
118 | - 'creditText' => ['Text'], |
|
119 | - 'dateCreated' => ['DateTime', 'Date'], |
|
120 | - 'dateModified' => ['DateTime', 'Date'], |
|
121 | - 'datePublished' => ['DateTime', 'Date'], |
|
122 | - 'description' => ['Text'], |
|
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 | - 'exampleOfWork' => ['CreativeWork'], |
|
134 | - 'expires' => ['Date', 'DateTime'], |
|
135 | - 'fileFormat' => ['Text', 'URL'], |
|
136 | - 'funder' => ['Organization', 'Person'], |
|
137 | - 'funding' => ['Grant'], |
|
138 | - 'genre' => ['Text', 'URL'], |
|
139 | - 'hasPart' => ['CreativeWork'], |
|
140 | - 'headline' => ['Text'], |
|
141 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
142 | - 'image' => ['URL', 'ImageObject'], |
|
143 | - 'inLanguage' => ['Text', 'Language'], |
|
144 | - 'interactionStatistic' => ['InteractionCounter'], |
|
145 | - 'interactivityType' => ['Text'], |
|
146 | - 'interpretedAsClaim' => ['Claim'], |
|
147 | - 'isAccessibleForFree' => ['Boolean'], |
|
148 | - 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
149 | - 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
150 | - 'isFamilyFriendly' => ['Boolean'], |
|
151 | - 'isPartOf' => ['URL', 'CreativeWork'], |
|
152 | - 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
153 | - 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
154 | - 'license' => ['URL', 'CreativeWork'], |
|
155 | - 'locationCreated' => ['Place'], |
|
156 | - 'mainEntity' => ['Thing'], |
|
157 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
158 | - 'maintainer' => ['Person', 'Organization'], |
|
159 | - 'material' => ['Product', 'URL', 'Text'], |
|
160 | - 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
161 | - 'mentions' => ['Thing'], |
|
162 | - 'name' => ['Text'], |
|
163 | - 'offers' => ['Demand', 'Offer'], |
|
164 | - 'pageEnd' => ['Integer', 'Text'], |
|
165 | - 'pageStart' => ['Integer', 'Text'], |
|
166 | - 'pagination' => ['Text'], |
|
167 | - 'pattern' => ['DefinedTerm', 'Text'], |
|
168 | - 'position' => ['Text', 'Integer'], |
|
169 | - 'potentialAction' => ['Action'], |
|
170 | - 'producer' => ['Organization', 'Person'], |
|
171 | - 'provider' => ['Organization', 'Person'], |
|
172 | - 'publication' => ['PublicationEvent'], |
|
173 | - 'publicationType' => ['Text'], |
|
174 | - 'publisher' => ['Organization', 'Person'], |
|
175 | - 'publisherImprint' => ['Organization'], |
|
176 | - 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
177 | - 'recordedAt' => ['Event'], |
|
178 | - 'releasedEvent' => ['PublicationEvent'], |
|
179 | - 'review' => ['Review'], |
|
180 | - 'reviews' => ['Review'], |
|
181 | - 'sameAs' => ['URL'], |
|
182 | - 'schemaVersion' => ['URL', 'Text'], |
|
183 | - 'sdDatePublished' => ['Date'], |
|
184 | - 'sdLicense' => ['CreativeWork', 'URL'], |
|
185 | - 'sdPublisher' => ['Organization', 'Person'], |
|
186 | - 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
187 | - 'sourceOrganization' => ['Organization'], |
|
188 | - 'spatial' => ['Place'], |
|
189 | - 'spatialCoverage' => ['Place'], |
|
190 | - 'speakable' => ['SpeakableSpecification', 'URL'], |
|
191 | - 'sponsor' => ['Organization', 'Person'], |
|
192 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
193 | - 'teaches' => ['DefinedTerm', 'Text'], |
|
194 | - 'temporal' => ['DateTime', 'Text'], |
|
195 | - 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
196 | - 'text' => ['Text'], |
|
197 | - 'thumbnailUrl' => ['URL'], |
|
198 | - 'timeRequired' => ['Duration'], |
|
199 | - 'translationOfWork' => ['CreativeWork'], |
|
200 | - 'translator' => ['Organization', 'Person'], |
|
201 | - 'typicalAgeRange' => ['Text'], |
|
202 | - 'url' => ['URL'], |
|
203 | - 'usageInfo' => ['URL', 'CreativeWork'], |
|
204 | - 'version' => ['Number', 'Text'], |
|
205 | - 'video' => ['VideoObject', 'Clip'], |
|
206 | - 'wordCount' => ['Integer'], |
|
207 | - 'workExample' => ['CreativeWork'], |
|
208 | - 'workTranslation' => ['CreativeWork'] |
|
209 | - ]; |
|
210 | - } |
|
70 | + /** |
|
71 | + * @inheritdoc |
|
72 | + */ |
|
73 | + public function getSchemaPropertyExpectedTypes(): array |
|
74 | + { |
|
75 | + return [ |
|
76 | + 'about' => ['Thing'], |
|
77 | + 'abstract' => ['Text'], |
|
78 | + 'accessMode' => ['Text'], |
|
79 | + 'accessModeSufficient' => ['ItemList'], |
|
80 | + 'accessibilityAPI' => ['Text'], |
|
81 | + 'accessibilityControl' => ['Text'], |
|
82 | + 'accessibilityFeature' => ['Text'], |
|
83 | + 'accessibilityHazard' => ['Text'], |
|
84 | + 'accessibilitySummary' => ['Text'], |
|
85 | + 'accountablePerson' => ['Person'], |
|
86 | + 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
87 | + 'additionalType' => ['URL'], |
|
88 | + 'aggregateRating' => ['AggregateRating'], |
|
89 | + 'alternateName' => ['Text'], |
|
90 | + 'alternativeHeadline' => ['Text'], |
|
91 | + 'archivedAt' => ['WebPage', 'URL'], |
|
92 | + 'articleBody' => ['Text'], |
|
93 | + 'articleSection' => ['Text'], |
|
94 | + 'assesses' => ['DefinedTerm', 'Text'], |
|
95 | + 'associatedMedia' => ['MediaObject'], |
|
96 | + 'audience' => ['Audience'], |
|
97 | + 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
98 | + 'author' => ['Organization', 'Person'], |
|
99 | + 'award' => ['Text'], |
|
100 | + 'awards' => ['Text'], |
|
101 | + 'backstory' => ['CreativeWork', 'Text'], |
|
102 | + 'character' => ['Person'], |
|
103 | + 'citation' => ['CreativeWork', 'Text'], |
|
104 | + 'comment' => ['Comment'], |
|
105 | + 'commentCount' => ['Integer'], |
|
106 | + 'conditionsOfAccess' => ['Text'], |
|
107 | + 'contentLocation' => ['Place'], |
|
108 | + 'contentRating' => ['Text', 'Rating'], |
|
109 | + 'contentReferenceTime' => ['DateTime'], |
|
110 | + 'contributor' => ['Organization', 'Person'], |
|
111 | + 'copyrightHolder' => ['Organization', 'Person'], |
|
112 | + 'copyrightNotice' => ['Text'], |
|
113 | + 'copyrightYear' => ['Number'], |
|
114 | + 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
115 | + 'countryOfOrigin' => ['Country'], |
|
116 | + 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
117 | + 'creator' => ['Person', 'Organization'], |
|
118 | + 'creditText' => ['Text'], |
|
119 | + 'dateCreated' => ['DateTime', 'Date'], |
|
120 | + 'dateModified' => ['DateTime', 'Date'], |
|
121 | + 'datePublished' => ['DateTime', 'Date'], |
|
122 | + 'description' => ['Text'], |
|
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 | + 'exampleOfWork' => ['CreativeWork'], |
|
134 | + 'expires' => ['Date', 'DateTime'], |
|
135 | + 'fileFormat' => ['Text', 'URL'], |
|
136 | + 'funder' => ['Organization', 'Person'], |
|
137 | + 'funding' => ['Grant'], |
|
138 | + 'genre' => ['Text', 'URL'], |
|
139 | + 'hasPart' => ['CreativeWork'], |
|
140 | + 'headline' => ['Text'], |
|
141 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
142 | + 'image' => ['URL', 'ImageObject'], |
|
143 | + 'inLanguage' => ['Text', 'Language'], |
|
144 | + 'interactionStatistic' => ['InteractionCounter'], |
|
145 | + 'interactivityType' => ['Text'], |
|
146 | + 'interpretedAsClaim' => ['Claim'], |
|
147 | + 'isAccessibleForFree' => ['Boolean'], |
|
148 | + 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
149 | + 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
150 | + 'isFamilyFriendly' => ['Boolean'], |
|
151 | + 'isPartOf' => ['URL', 'CreativeWork'], |
|
152 | + 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
153 | + 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
154 | + 'license' => ['URL', 'CreativeWork'], |
|
155 | + 'locationCreated' => ['Place'], |
|
156 | + 'mainEntity' => ['Thing'], |
|
157 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
158 | + 'maintainer' => ['Person', 'Organization'], |
|
159 | + 'material' => ['Product', 'URL', 'Text'], |
|
160 | + 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
161 | + 'mentions' => ['Thing'], |
|
162 | + 'name' => ['Text'], |
|
163 | + 'offers' => ['Demand', 'Offer'], |
|
164 | + 'pageEnd' => ['Integer', 'Text'], |
|
165 | + 'pageStart' => ['Integer', 'Text'], |
|
166 | + 'pagination' => ['Text'], |
|
167 | + 'pattern' => ['DefinedTerm', 'Text'], |
|
168 | + 'position' => ['Text', 'Integer'], |
|
169 | + 'potentialAction' => ['Action'], |
|
170 | + 'producer' => ['Organization', 'Person'], |
|
171 | + 'provider' => ['Organization', 'Person'], |
|
172 | + 'publication' => ['PublicationEvent'], |
|
173 | + 'publicationType' => ['Text'], |
|
174 | + 'publisher' => ['Organization', 'Person'], |
|
175 | + 'publisherImprint' => ['Organization'], |
|
176 | + 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
177 | + 'recordedAt' => ['Event'], |
|
178 | + 'releasedEvent' => ['PublicationEvent'], |
|
179 | + 'review' => ['Review'], |
|
180 | + 'reviews' => ['Review'], |
|
181 | + 'sameAs' => ['URL'], |
|
182 | + 'schemaVersion' => ['URL', 'Text'], |
|
183 | + 'sdDatePublished' => ['Date'], |
|
184 | + 'sdLicense' => ['CreativeWork', 'URL'], |
|
185 | + 'sdPublisher' => ['Organization', 'Person'], |
|
186 | + 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
187 | + 'sourceOrganization' => ['Organization'], |
|
188 | + 'spatial' => ['Place'], |
|
189 | + 'spatialCoverage' => ['Place'], |
|
190 | + 'speakable' => ['SpeakableSpecification', 'URL'], |
|
191 | + 'sponsor' => ['Organization', 'Person'], |
|
192 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
193 | + 'teaches' => ['DefinedTerm', 'Text'], |
|
194 | + 'temporal' => ['DateTime', 'Text'], |
|
195 | + 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
196 | + 'text' => ['Text'], |
|
197 | + 'thumbnailUrl' => ['URL'], |
|
198 | + 'timeRequired' => ['Duration'], |
|
199 | + 'translationOfWork' => ['CreativeWork'], |
|
200 | + 'translator' => ['Organization', 'Person'], |
|
201 | + 'typicalAgeRange' => ['Text'], |
|
202 | + 'url' => ['URL'], |
|
203 | + 'usageInfo' => ['URL', 'CreativeWork'], |
|
204 | + 'version' => ['Number', 'Text'], |
|
205 | + 'video' => ['VideoObject', 'Clip'], |
|
206 | + 'wordCount' => ['Integer'], |
|
207 | + 'workExample' => ['CreativeWork'], |
|
208 | + 'workTranslation' => ['CreativeWork'] |
|
209 | + ]; |
|
210 | + } |
|
211 | 211 | |
212 | 212 | |
213 | - /** |
|
214 | - * @inheritdoc |
|
215 | - */ |
|
216 | - public function getSchemaPropertyDescriptions(): array |
|
217 | - { |
|
218 | - return [ |
|
219 | - 'about' => 'The subject matter of the content.', |
|
220 | - 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
221 | - 'accessMode' => 'The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).', |
|
222 | - 'accessModeSufficient' => 'A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).', |
|
223 | - 'accessibilityAPI' => 'Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).', |
|
224 | - 'accessibilityControl' => 'Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).', |
|
225 | - 'accessibilityFeature' => 'Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).', |
|
226 | - 'accessibilityHazard' => 'A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).', |
|
227 | - 'accessibilitySummary' => 'A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."', |
|
228 | - 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
229 | - 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
230 | - 'additionalType' => 'An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
231 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
232 | - 'alternateName' => 'An alias for the item.', |
|
233 | - 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
234 | - 'archivedAt' => 'Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.', |
|
235 | - 'articleBody' => 'The actual body of the article.', |
|
236 | - 'articleSection' => 'Articles may belong to one or more \'sections\' in a magazine or newspaper, such as Sports, Lifestyle, etc.', |
|
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 | - 'backstory' => 'For an [[Article]], typically a [[NewsArticle]], the backstory property provides a textual summary giving a brief explanation of why and how an article was created. In a journalistic setting this could include information about reporting process, methods, interviews, data sources, etc.', |
|
245 | - 'character' => 'Fictional person connected with a creative work.', |
|
246 | - 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
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 | - '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.', |
|
267 | - 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
268 | - '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. ', |
|
269 | - 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
270 | - '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.', |
|
271 | - '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.', |
|
272 | - 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
273 | - 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
274 | - '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.', |
|
275 | - 'encodings' => 'A media object that encodes this CreativeWork.', |
|
276 | - 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
277 | - '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.', |
|
278 | - '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.', |
|
279 | - 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
280 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
281 | - 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
282 | - 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
283 | - 'headline' => 'Headline of the article.', |
|
284 | - '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. ', |
|
285 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
286 | - '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]].', |
|
287 | - 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
288 | - 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
289 | - '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]].', |
|
290 | - 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
291 | - 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
292 | - '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.', |
|
293 | - 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
294 | - 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
295 | - '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.', |
|
296 | - 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
297 | - 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
298 | - 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
299 | - 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
300 | - 'mainEntityOfPage' => 'Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.', |
|
301 | - 'maintainer' => 'A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. ', |
|
302 | - 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
303 | - 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
304 | - 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
305 | - 'name' => 'The name of the item.', |
|
306 | - 'offers' => 'An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. ', |
|
307 | - 'pageEnd' => 'The page on which the work ends; for example "138" or "xvi".', |
|
308 | - 'pageStart' => 'The page on which the work starts; for example "135" or "xiii".', |
|
309 | - 'pagination' => 'Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49".', |
|
310 | - '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.', |
|
311 | - 'position' => 'The position of an item in a series or sequence of items.', |
|
312 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
313 | - 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
314 | - '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.', |
|
315 | - 'publication' => 'A publication event associated with the item.', |
|
316 | - 'publicationType' => 'The type of the medical article, taken from the US NLM MeSH publication type catalog. See also [MeSH documentation](http://www.nlm.nih.gov/mesh/pubtypes.html).', |
|
317 | - 'publisher' => 'The publisher of the creative work.', |
|
318 | - 'publisherImprint' => 'The publishing division which published the comic.', |
|
319 | - '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. ', |
|
320 | - 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
321 | - 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
322 | - 'review' => 'A review of the item.', |
|
323 | - 'reviews' => 'Review of the item.', |
|
324 | - '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.', |
|
325 | - '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.', |
|
326 | - 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
327 | - 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
328 | - '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.', |
|
329 | - '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. ', |
|
330 | - 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
331 | - 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
332 | - '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.', |
|
333 | - 'speakable' => 'Indicates sections of a Web page that are particularly \'speakable\' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the \'speakable\' property serves to indicate the parts most likely to be generally useful for speech. The *speakable* property can be repeated an arbitrary number of times, with three kinds of possible \'content-locator\' values: 1.) *id-value* URL references - uses *id-value* of an element in the page being annotated. The simplest use of *speakable* has (potentially relative) URL values, referencing identified sections of the document concerned. 2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property. 3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property. For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For this we define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the *speakable* property. ', |
|
334 | - '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.', |
|
335 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
336 | - 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
337 | - '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.', |
|
338 | - '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.', |
|
339 | - 'text' => 'The textual content of this CreativeWork.', |
|
340 | - 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
341 | - '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\'.', |
|
342 | - 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
343 | - '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.', |
|
344 | - 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
345 | - 'url' => 'URL of the item.', |
|
346 | - '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.', |
|
347 | - 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
348 | - 'video' => 'An embedded video object.', |
|
349 | - 'wordCount' => 'The number of words in the text of the Article.', |
|
350 | - 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
351 | - '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.' |
|
352 | - ]; |
|
353 | - } |
|
213 | + /** |
|
214 | + * @inheritdoc |
|
215 | + */ |
|
216 | + public function getSchemaPropertyDescriptions(): array |
|
217 | + { |
|
218 | + return [ |
|
219 | + 'about' => 'The subject matter of the content.', |
|
220 | + 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
221 | + 'accessMode' => 'The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).', |
|
222 | + 'accessModeSufficient' => 'A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).', |
|
223 | + 'accessibilityAPI' => 'Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).', |
|
224 | + 'accessibilityControl' => 'Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).', |
|
225 | + 'accessibilityFeature' => 'Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).', |
|
226 | + 'accessibilityHazard' => 'A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).', |
|
227 | + 'accessibilitySummary' => 'A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."', |
|
228 | + 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
229 | + 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
230 | + 'additionalType' => 'An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the \'typeof\' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.', |
|
231 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
232 | + 'alternateName' => 'An alias for the item.', |
|
233 | + 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
234 | + 'archivedAt' => 'Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.', |
|
235 | + 'articleBody' => 'The actual body of the article.', |
|
236 | + 'articleSection' => 'Articles may belong to one or more \'sections\' in a magazine or newspaper, such as Sports, Lifestyle, etc.', |
|
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 | + 'backstory' => 'For an [[Article]], typically a [[NewsArticle]], the backstory property provides a textual summary giving a brief explanation of why and how an article was created. In a journalistic setting this could include information about reporting process, methods, interviews, data sources, etc.', |
|
245 | + 'character' => 'Fictional person connected with a creative work.', |
|
246 | + 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
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 | + '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.', |
|
267 | + 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
268 | + '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. ', |
|
269 | + 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
270 | + '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.', |
|
271 | + '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.', |
|
272 | + 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
273 | + 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
274 | + '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.', |
|
275 | + 'encodings' => 'A media object that encodes this CreativeWork.', |
|
276 | + 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
277 | + '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.', |
|
278 | + '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.', |
|
279 | + 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
280 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
281 | + 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
282 | + 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
283 | + 'headline' => 'Headline of the article.', |
|
284 | + '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. ', |
|
285 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
286 | + '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]].', |
|
287 | + 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
288 | + 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
289 | + '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]].', |
|
290 | + 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
291 | + 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
292 | + '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.', |
|
293 | + 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
294 | + 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
295 | + '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.', |
|
296 | + 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
297 | + 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
298 | + 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
299 | + 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
300 | + 'mainEntityOfPage' => 'Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.', |
|
301 | + 'maintainer' => 'A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. ', |
|
302 | + 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
303 | + 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
304 | + 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
305 | + 'name' => 'The name of the item.', |
|
306 | + 'offers' => 'An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. ', |
|
307 | + 'pageEnd' => 'The page on which the work ends; for example "138" or "xvi".', |
|
308 | + 'pageStart' => 'The page on which the work starts; for example "135" or "xiii".', |
|
309 | + 'pagination' => 'Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49".', |
|
310 | + '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.', |
|
311 | + 'position' => 'The position of an item in a series or sequence of items.', |
|
312 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
313 | + 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
314 | + '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.', |
|
315 | + 'publication' => 'A publication event associated with the item.', |
|
316 | + 'publicationType' => 'The type of the medical article, taken from the US NLM MeSH publication type catalog. See also [MeSH documentation](http://www.nlm.nih.gov/mesh/pubtypes.html).', |
|
317 | + 'publisher' => 'The publisher of the creative work.', |
|
318 | + 'publisherImprint' => 'The publishing division which published the comic.', |
|
319 | + '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. ', |
|
320 | + 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
321 | + 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
322 | + 'review' => 'A review of the item.', |
|
323 | + 'reviews' => 'Review of the item.', |
|
324 | + '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.', |
|
325 | + '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.', |
|
326 | + 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
327 | + 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
328 | + '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.', |
|
329 | + '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. ', |
|
330 | + 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
331 | + 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
332 | + '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.', |
|
333 | + 'speakable' => 'Indicates sections of a Web page that are particularly \'speakable\' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the \'speakable\' property serves to indicate the parts most likely to be generally useful for speech. The *speakable* property can be repeated an arbitrary number of times, with three kinds of possible \'content-locator\' values: 1.) *id-value* URL references - uses *id-value* of an element in the page being annotated. The simplest use of *speakable* has (potentially relative) URL values, referencing identified sections of the document concerned. 2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property. 3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property. For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For this we define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the *speakable* property. ', |
|
334 | + '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.', |
|
335 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
336 | + 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
337 | + '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.', |
|
338 | + '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.', |
|
339 | + 'text' => 'The textual content of this CreativeWork.', |
|
340 | + 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
341 | + '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\'.', |
|
342 | + 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
343 | + '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.', |
|
344 | + 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
345 | + 'url' => 'URL of the item.', |
|
346 | + '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.', |
|
347 | + 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
348 | + 'video' => 'An embedded video object.', |
|
349 | + 'wordCount' => 'The number of words in the text of the Article.', |
|
350 | + 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
351 | + '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.' |
|
352 | + ]; |
|
353 | + } |
|
354 | 354 | |
355 | 355 | |
356 | - /** |
|
357 | - * @inheritdoc |
|
358 | - */ |
|
359 | - public function getGoogleRequiredSchema(): array |
|
360 | - { |
|
361 | - return ['author', 'datePublished', 'description', 'headline', 'image', 'name', 'publisher']; |
|
362 | - } |
|
356 | + /** |
|
357 | + * @inheritdoc |
|
358 | + */ |
|
359 | + public function getGoogleRequiredSchema(): array |
|
360 | + { |
|
361 | + return ['author', 'datePublished', 'description', 'headline', 'image', 'name', 'publisher']; |
|
362 | + } |
|
363 | 363 | |
364 | 364 | |
365 | - /** |
|
366 | - * @inheritdoc |
|
367 | - */ |
|
368 | - public function getGoogleRecommendedSchema(): array |
|
369 | - { |
|
370 | - return ['dateModified', 'image', 'mainEntityOfPage', 'url']; |
|
371 | - } |
|
365 | + /** |
|
366 | + * @inheritdoc |
|
367 | + */ |
|
368 | + public function getGoogleRecommendedSchema(): array |
|
369 | + { |
|
370 | + return ['dateModified', 'image', 'mainEntityOfPage', 'url']; |
|
371 | + } |
|
372 | 372 | |
373 | 373 | |
374 | - /** |
|
375 | - * @inheritdoc |
|
376 | - */ |
|
377 | - public function defineRules(): array |
|
378 | - { |
|
379 | - $rules = parent::defineRules(); |
|
380 | - $rules = array_merge($rules, [ |
|
381 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
382 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
383 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
384 | - ]); |
|
374 | + /** |
|
375 | + * @inheritdoc |
|
376 | + */ |
|
377 | + public function defineRules(): array |
|
378 | + { |
|
379 | + $rules = parent::defineRules(); |
|
380 | + $rules = array_merge($rules, [ |
|
381 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
382 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
383 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
384 | + ]); |
|
385 | 385 | |
386 | - return $rules; |
|
387 | - } |
|
386 | + return $rules; |
|
387 | + } |
|
388 | 388 | } |
@@ -23,126 +23,126 @@ |
||
23 | 23 | */ |
24 | 24 | class OfflineEventAttendanceMode extends MetaJsonLd implements OfflineEventAttendanceModeInterface, EventAttendanceModeEnumerationInterface, EnumerationInterface, IntangibleInterface, ThingInterface |
25 | 25 | { |
26 | - use OfflineEventAttendanceModeTrait; |
|
27 | - use EventAttendanceModeEnumerationTrait; |
|
28 | - use EnumerationTrait; |
|
29 | - use IntangibleTrait; |
|
30 | - use ThingTrait; |
|
31 | - |
|
32 | - /** |
|
33 | - * The Schema.org Type Name |
|
34 | - * |
|
35 | - * @var string |
|
36 | - */ |
|
37 | - public static string $schemaTypeName = 'OfflineEventAttendanceMode'; |
|
38 | - |
|
39 | - /** |
|
40 | - * The Schema.org Type Scope |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - public static string $schemaTypeScope = 'https://schema.org/OfflineEventAttendanceMode'; |
|
45 | - |
|
46 | - /** |
|
47 | - * The Schema.org Type Extends |
|
48 | - * |
|
49 | - * @var string |
|
50 | - */ |
|
51 | - public static string $schemaTypeExtends = 'EventAttendanceModeEnumeration'; |
|
52 | - |
|
53 | - /** |
|
54 | - * The Schema.org Type Description |
|
55 | - * |
|
56 | - * @var string |
|
57 | - */ |
|
58 | - public static string $schemaTypeDescription = 'OfflineEventAttendanceMode - an event that is primarily conducted offline. '; |
|
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 | - 'description' => ['Text'], |
|
79 | - 'disambiguatingDescription' => ['Text'], |
|
80 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
81 | - 'image' => ['URL', 'ImageObject'], |
|
82 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
83 | - 'name' => ['Text'], |
|
84 | - 'potentialAction' => ['Action'], |
|
85 | - 'sameAs' => ['URL'], |
|
86 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
87 | - 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
88 | - 'url' => ['URL'] |
|
89 | - ]; |
|
90 | - } |
|
91 | - |
|
92 | - |
|
93 | - /** |
|
94 | - * @inheritdoc |
|
95 | - */ |
|
96 | - public function getSchemaPropertyDescriptions(): array |
|
97 | - { |
|
98 | - return [ |
|
99 | - '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.', |
|
100 | - 'alternateName' => 'An alias for the item.', |
|
101 | - 'description' => 'A description of the item.', |
|
102 | - '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.', |
|
103 | - '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. ', |
|
104 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
105 | - '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.', |
|
106 | - 'name' => 'The name of the item.', |
|
107 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
108 | - '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.', |
|
109 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
110 | - 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
111 | - 'url' => 'URL of the item.' |
|
112 | - ]; |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * @inheritdoc |
|
118 | - */ |
|
119 | - public function getGoogleRequiredSchema(): array |
|
120 | - { |
|
121 | - return ['description', 'name']; |
|
122 | - } |
|
123 | - |
|
124 | - |
|
125 | - /** |
|
126 | - * @inheritdoc |
|
127 | - */ |
|
128 | - public function getGoogleRecommendedSchema(): array |
|
129 | - { |
|
130 | - return ['image', 'url']; |
|
131 | - } |
|
132 | - |
|
133 | - |
|
134 | - /** |
|
135 | - * @inheritdoc |
|
136 | - */ |
|
137 | - public function defineRules(): array |
|
138 | - { |
|
139 | - $rules = parent::defineRules(); |
|
140 | - $rules = array_merge($rules, [ |
|
141 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
142 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
143 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
144 | - ]); |
|
145 | - |
|
146 | - return $rules; |
|
147 | - } |
|
26 | + use OfflineEventAttendanceModeTrait; |
|
27 | + use EventAttendanceModeEnumerationTrait; |
|
28 | + use EnumerationTrait; |
|
29 | + use IntangibleTrait; |
|
30 | + use ThingTrait; |
|
31 | + |
|
32 | + /** |
|
33 | + * The Schema.org Type Name |
|
34 | + * |
|
35 | + * @var string |
|
36 | + */ |
|
37 | + public static string $schemaTypeName = 'OfflineEventAttendanceMode'; |
|
38 | + |
|
39 | + /** |
|
40 | + * The Schema.org Type Scope |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + public static string $schemaTypeScope = 'https://schema.org/OfflineEventAttendanceMode'; |
|
45 | + |
|
46 | + /** |
|
47 | + * The Schema.org Type Extends |
|
48 | + * |
|
49 | + * @var string |
|
50 | + */ |
|
51 | + public static string $schemaTypeExtends = 'EventAttendanceModeEnumeration'; |
|
52 | + |
|
53 | + /** |
|
54 | + * The Schema.org Type Description |
|
55 | + * |
|
56 | + * @var string |
|
57 | + */ |
|
58 | + public static string $schemaTypeDescription = 'OfflineEventAttendanceMode - an event that is primarily conducted offline. '; |
|
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 | + 'description' => ['Text'], |
|
79 | + 'disambiguatingDescription' => ['Text'], |
|
80 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
81 | + 'image' => ['URL', 'ImageObject'], |
|
82 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
83 | + 'name' => ['Text'], |
|
84 | + 'potentialAction' => ['Action'], |
|
85 | + 'sameAs' => ['URL'], |
|
86 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
87 | + 'supersededBy' => ['Class', 'Property', 'Enumeration'], |
|
88 | + 'url' => ['URL'] |
|
89 | + ]; |
|
90 | + } |
|
91 | + |
|
92 | + |
|
93 | + /** |
|
94 | + * @inheritdoc |
|
95 | + */ |
|
96 | + public function getSchemaPropertyDescriptions(): array |
|
97 | + { |
|
98 | + return [ |
|
99 | + '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.', |
|
100 | + 'alternateName' => 'An alias for the item.', |
|
101 | + 'description' => 'A description of the item.', |
|
102 | + '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.', |
|
103 | + '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. ', |
|
104 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
105 | + '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.', |
|
106 | + 'name' => 'The name of the item.', |
|
107 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
108 | + '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.', |
|
109 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
110 | + 'supersededBy' => 'Relates a term (i.e. a property, class or enumeration) to one that supersedes it.', |
|
111 | + 'url' => 'URL of the item.' |
|
112 | + ]; |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * @inheritdoc |
|
118 | + */ |
|
119 | + public function getGoogleRequiredSchema(): array |
|
120 | + { |
|
121 | + return ['description', 'name']; |
|
122 | + } |
|
123 | + |
|
124 | + |
|
125 | + /** |
|
126 | + * @inheritdoc |
|
127 | + */ |
|
128 | + public function getGoogleRecommendedSchema(): array |
|
129 | + { |
|
130 | + return ['image', 'url']; |
|
131 | + } |
|
132 | + |
|
133 | + |
|
134 | + /** |
|
135 | + * @inheritdoc |
|
136 | + */ |
|
137 | + public function defineRules(): array |
|
138 | + { |
|
139 | + $rules = parent::defineRules(); |
|
140 | + $rules = array_merge($rules, [ |
|
141 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
142 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
143 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
144 | + ]); |
|
145 | + |
|
146 | + return $rules; |
|
147 | + } |
|
148 | 148 | } |
@@ -23,399 +23,399 @@ |
||
23 | 23 | */ |
24 | 24 | class VideoGameSeries extends MetaJsonLd implements VideoGameSeriesInterface, CreativeWorkSeriesInterface, SeriesInterface, IntangibleInterface, ThingInterface, CreativeWorkInterface |
25 | 25 | { |
26 | - use VideoGameSeriesTrait; |
|
27 | - use CreativeWorkSeriesTrait; |
|
28 | - use SeriesTrait; |
|
29 | - use IntangibleTrait; |
|
30 | - use ThingTrait; |
|
31 | - use CreativeWorkTrait; |
|
26 | + use VideoGameSeriesTrait; |
|
27 | + use CreativeWorkSeriesTrait; |
|
28 | + use SeriesTrait; |
|
29 | + use IntangibleTrait; |
|
30 | + use ThingTrait; |
|
31 | + use CreativeWorkTrait; |
|
32 | 32 | |
33 | - /** |
|
34 | - * The Schema.org Type Name |
|
35 | - * |
|
36 | - * @var string |
|
37 | - */ |
|
38 | - public static string $schemaTypeName = 'VideoGameSeries'; |
|
33 | + /** |
|
34 | + * The Schema.org Type Name |
|
35 | + * |
|
36 | + * @var string |
|
37 | + */ |
|
38 | + public static string $schemaTypeName = 'VideoGameSeries'; |
|
39 | 39 | |
40 | - /** |
|
41 | - * The Schema.org Type Scope |
|
42 | - * |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - public static string $schemaTypeScope = 'https://schema.org/VideoGameSeries'; |
|
40 | + /** |
|
41 | + * The Schema.org Type Scope |
|
42 | + * |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + public static string $schemaTypeScope = 'https://schema.org/VideoGameSeries'; |
|
46 | 46 | |
47 | - /** |
|
48 | - * The Schema.org Type Extends |
|
49 | - * |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - public static string $schemaTypeExtends = 'CreativeWorkSeries'; |
|
47 | + /** |
|
48 | + * The Schema.org Type Extends |
|
49 | + * |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + public static string $schemaTypeExtends = 'CreativeWorkSeries'; |
|
53 | 53 | |
54 | - /** |
|
55 | - * The Schema.org Type Description |
|
56 | - * |
|
57 | - * @var string |
|
58 | - */ |
|
59 | - public static string $schemaTypeDescription = 'A video game series.'; |
|
54 | + /** |
|
55 | + * The Schema.org Type Description |
|
56 | + * |
|
57 | + * @var string |
|
58 | + */ |
|
59 | + public static string $schemaTypeDescription = 'A video game series.'; |
|
60 | 60 | |
61 | 61 | |
62 | - /** |
|
63 | - * @inheritdoc |
|
64 | - */ |
|
65 | - public function getSchemaPropertyNames(): array |
|
66 | - { |
|
67 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
68 | - } |
|
62 | + /** |
|
63 | + * @inheritdoc |
|
64 | + */ |
|
65 | + public function getSchemaPropertyNames(): array |
|
66 | + { |
|
67 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
68 | + } |
|
69 | 69 | |
70 | 70 | |
71 | - /** |
|
72 | - * @inheritdoc |
|
73 | - */ |
|
74 | - public function getSchemaPropertyExpectedTypes(): array |
|
75 | - { |
|
76 | - return [ |
|
77 | - 'about' => ['Thing'], |
|
78 | - 'abstract' => ['Text'], |
|
79 | - 'accessMode' => ['Text'], |
|
80 | - 'accessModeSufficient' => ['ItemList'], |
|
81 | - 'accessibilityAPI' => ['Text'], |
|
82 | - 'accessibilityControl' => ['Text'], |
|
83 | - 'accessibilityFeature' => ['Text'], |
|
84 | - 'accessibilityHazard' => ['Text'], |
|
85 | - 'accessibilitySummary' => ['Text'], |
|
86 | - 'accountablePerson' => ['Person'], |
|
87 | - 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
88 | - 'actor' => ['Person'], |
|
89 | - 'actors' => ['Person'], |
|
90 | - 'additionalType' => ['URL'], |
|
91 | - 'aggregateRating' => ['AggregateRating'], |
|
92 | - 'alternateName' => ['Text'], |
|
93 | - 'alternativeHeadline' => ['Text'], |
|
94 | - 'archivedAt' => ['WebPage', 'URL'], |
|
95 | - 'assesses' => ['DefinedTerm', 'Text'], |
|
96 | - 'associatedMedia' => ['MediaObject'], |
|
97 | - 'audience' => ['Audience'], |
|
98 | - 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
99 | - 'author' => ['Organization', 'Person'], |
|
100 | - 'award' => ['Text'], |
|
101 | - 'awards' => ['Text'], |
|
102 | - 'character' => ['Person'], |
|
103 | - 'characterAttribute' => ['Thing'], |
|
104 | - 'cheatCode' => ['CreativeWork'], |
|
105 | - 'citation' => ['CreativeWork', 'Text'], |
|
106 | - 'comment' => ['Comment'], |
|
107 | - 'commentCount' => ['Integer'], |
|
108 | - 'conditionsOfAccess' => ['Text'], |
|
109 | - 'containsSeason' => ['CreativeWorkSeason'], |
|
110 | - 'contentLocation' => ['Place'], |
|
111 | - 'contentRating' => ['Text', 'Rating'], |
|
112 | - 'contentReferenceTime' => ['DateTime'], |
|
113 | - 'contributor' => ['Organization', 'Person'], |
|
114 | - 'copyrightHolder' => ['Organization', 'Person'], |
|
115 | - 'copyrightNotice' => ['Text'], |
|
116 | - 'copyrightYear' => ['Number'], |
|
117 | - 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
118 | - 'countryOfOrigin' => ['Country'], |
|
119 | - 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
120 | - 'creator' => ['Person', 'Organization'], |
|
121 | - 'creditText' => ['Text'], |
|
122 | - 'dateCreated' => ['DateTime', 'Date'], |
|
123 | - 'dateModified' => ['DateTime', 'Date'], |
|
124 | - 'datePublished' => ['DateTime', 'Date'], |
|
125 | - 'description' => ['Text'], |
|
126 | - 'director' => ['Person'], |
|
127 | - 'directors' => ['Person'], |
|
128 | - 'disambiguatingDescription' => ['Text'], |
|
129 | - 'discussionUrl' => ['URL'], |
|
130 | - 'editEIDR' => ['URL', 'Text'], |
|
131 | - 'editor' => ['Person'], |
|
132 | - 'educationalAlignment' => ['AlignmentObject'], |
|
133 | - 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
134 | - 'educationalUse' => ['DefinedTerm', 'Text'], |
|
135 | - 'encoding' => ['MediaObject'], |
|
136 | - 'encodingFormat' => ['URL', 'Text'], |
|
137 | - 'encodings' => ['MediaObject'], |
|
138 | - 'endDate' => ['DateTime', 'Date'], |
|
139 | - 'episode' => ['Episode'], |
|
140 | - 'episodes' => ['Episode'], |
|
141 | - 'exampleOfWork' => ['CreativeWork'], |
|
142 | - 'expires' => ['Date', 'DateTime'], |
|
143 | - 'fileFormat' => ['Text', 'URL'], |
|
144 | - 'funder' => ['Organization', 'Person'], |
|
145 | - 'funding' => ['Grant'], |
|
146 | - 'gameItem' => ['Thing'], |
|
147 | - 'gameLocation' => ['PostalAddress', 'URL', 'Place'], |
|
148 | - 'gamePlatform' => ['Thing', 'URL', 'Text'], |
|
149 | - 'genre' => ['Text', 'URL'], |
|
150 | - 'hasPart' => ['CreativeWork'], |
|
151 | - 'headline' => ['Text'], |
|
152 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
153 | - 'image' => ['URL', 'ImageObject'], |
|
154 | - 'inLanguage' => ['Text', 'Language'], |
|
155 | - 'interactionStatistic' => ['InteractionCounter'], |
|
156 | - 'interactivityType' => ['Text'], |
|
157 | - 'interpretedAsClaim' => ['Claim'], |
|
158 | - 'isAccessibleForFree' => ['Boolean'], |
|
159 | - 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
160 | - 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
161 | - 'isFamilyFriendly' => ['Boolean'], |
|
162 | - 'isPartOf' => ['URL', 'CreativeWork'], |
|
163 | - 'issn' => ['Text'], |
|
164 | - 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
165 | - 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
166 | - 'license' => ['URL', 'CreativeWork'], |
|
167 | - 'locationCreated' => ['Place'], |
|
168 | - 'mainEntity' => ['Thing'], |
|
169 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
170 | - 'maintainer' => ['Person', 'Organization'], |
|
171 | - 'material' => ['Product', 'URL', 'Text'], |
|
172 | - 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
173 | - 'mentions' => ['Thing'], |
|
174 | - 'musicBy' => ['MusicGroup', 'Person'], |
|
175 | - 'name' => ['Text'], |
|
176 | - 'numberOfEpisodes' => ['Integer'], |
|
177 | - 'numberOfPlayers' => ['QuantitativeValue'], |
|
178 | - 'numberOfSeasons' => ['Integer'], |
|
179 | - 'offers' => ['Demand', 'Offer'], |
|
180 | - 'pattern' => ['DefinedTerm', 'Text'], |
|
181 | - 'playMode' => ['GamePlayMode'], |
|
182 | - 'position' => ['Text', 'Integer'], |
|
183 | - 'potentialAction' => ['Action'], |
|
184 | - 'producer' => ['Organization', 'Person'], |
|
185 | - 'productionCompany' => ['Organization'], |
|
186 | - 'provider' => ['Organization', 'Person'], |
|
187 | - 'publication' => ['PublicationEvent'], |
|
188 | - 'publisher' => ['Organization', 'Person'], |
|
189 | - 'publisherImprint' => ['Organization'], |
|
190 | - 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
191 | - 'quest' => ['Thing'], |
|
192 | - 'recordedAt' => ['Event'], |
|
193 | - 'releasedEvent' => ['PublicationEvent'], |
|
194 | - 'review' => ['Review'], |
|
195 | - 'reviews' => ['Review'], |
|
196 | - 'sameAs' => ['URL'], |
|
197 | - 'schemaVersion' => ['URL', 'Text'], |
|
198 | - 'sdDatePublished' => ['Date'], |
|
199 | - 'sdLicense' => ['CreativeWork', 'URL'], |
|
200 | - 'sdPublisher' => ['Organization', 'Person'], |
|
201 | - 'season' => ['URL', 'CreativeWorkSeason'], |
|
202 | - 'seasons' => ['CreativeWorkSeason'], |
|
203 | - 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
204 | - 'sourceOrganization' => ['Organization'], |
|
205 | - 'spatial' => ['Place'], |
|
206 | - 'spatialCoverage' => ['Place'], |
|
207 | - 'sponsor' => ['Organization', 'Person'], |
|
208 | - 'startDate' => ['DateTime', 'Date'], |
|
209 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
210 | - 'teaches' => ['DefinedTerm', 'Text'], |
|
211 | - 'temporal' => ['DateTime', 'Text'], |
|
212 | - 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
213 | - 'text' => ['Text'], |
|
214 | - 'thumbnailUrl' => ['URL'], |
|
215 | - 'timeRequired' => ['Duration'], |
|
216 | - 'trailer' => ['VideoObject'], |
|
217 | - 'translationOfWork' => ['CreativeWork'], |
|
218 | - 'translator' => ['Organization', 'Person'], |
|
219 | - 'typicalAgeRange' => ['Text'], |
|
220 | - 'url' => ['URL'], |
|
221 | - 'usageInfo' => ['URL', 'CreativeWork'], |
|
222 | - 'version' => ['Number', 'Text'], |
|
223 | - 'video' => ['VideoObject', 'Clip'], |
|
224 | - 'workExample' => ['CreativeWork'], |
|
225 | - 'workTranslation' => ['CreativeWork'] |
|
226 | - ]; |
|
227 | - } |
|
71 | + /** |
|
72 | + * @inheritdoc |
|
73 | + */ |
|
74 | + public function getSchemaPropertyExpectedTypes(): array |
|
75 | + { |
|
76 | + return [ |
|
77 | + 'about' => ['Thing'], |
|
78 | + 'abstract' => ['Text'], |
|
79 | + 'accessMode' => ['Text'], |
|
80 | + 'accessModeSufficient' => ['ItemList'], |
|
81 | + 'accessibilityAPI' => ['Text'], |
|
82 | + 'accessibilityControl' => ['Text'], |
|
83 | + 'accessibilityFeature' => ['Text'], |
|
84 | + 'accessibilityHazard' => ['Text'], |
|
85 | + 'accessibilitySummary' => ['Text'], |
|
86 | + 'accountablePerson' => ['Person'], |
|
87 | + 'acquireLicensePage' => ['CreativeWork', 'URL'], |
|
88 | + 'actor' => ['Person'], |
|
89 | + 'actors' => ['Person'], |
|
90 | + 'additionalType' => ['URL'], |
|
91 | + 'aggregateRating' => ['AggregateRating'], |
|
92 | + 'alternateName' => ['Text'], |
|
93 | + 'alternativeHeadline' => ['Text'], |
|
94 | + 'archivedAt' => ['WebPage', 'URL'], |
|
95 | + 'assesses' => ['DefinedTerm', 'Text'], |
|
96 | + 'associatedMedia' => ['MediaObject'], |
|
97 | + 'audience' => ['Audience'], |
|
98 | + 'audio' => ['MusicRecording', 'AudioObject', 'Clip'], |
|
99 | + 'author' => ['Organization', 'Person'], |
|
100 | + 'award' => ['Text'], |
|
101 | + 'awards' => ['Text'], |
|
102 | + 'character' => ['Person'], |
|
103 | + 'characterAttribute' => ['Thing'], |
|
104 | + 'cheatCode' => ['CreativeWork'], |
|
105 | + 'citation' => ['CreativeWork', 'Text'], |
|
106 | + 'comment' => ['Comment'], |
|
107 | + 'commentCount' => ['Integer'], |
|
108 | + 'conditionsOfAccess' => ['Text'], |
|
109 | + 'containsSeason' => ['CreativeWorkSeason'], |
|
110 | + 'contentLocation' => ['Place'], |
|
111 | + 'contentRating' => ['Text', 'Rating'], |
|
112 | + 'contentReferenceTime' => ['DateTime'], |
|
113 | + 'contributor' => ['Organization', 'Person'], |
|
114 | + 'copyrightHolder' => ['Organization', 'Person'], |
|
115 | + 'copyrightNotice' => ['Text'], |
|
116 | + 'copyrightYear' => ['Number'], |
|
117 | + 'correction' => ['URL', 'Text', 'CorrectionComment'], |
|
118 | + 'countryOfOrigin' => ['Country'], |
|
119 | + 'creativeWorkStatus' => ['DefinedTerm', 'Text'], |
|
120 | + 'creator' => ['Person', 'Organization'], |
|
121 | + 'creditText' => ['Text'], |
|
122 | + 'dateCreated' => ['DateTime', 'Date'], |
|
123 | + 'dateModified' => ['DateTime', 'Date'], |
|
124 | + 'datePublished' => ['DateTime', 'Date'], |
|
125 | + 'description' => ['Text'], |
|
126 | + 'director' => ['Person'], |
|
127 | + 'directors' => ['Person'], |
|
128 | + 'disambiguatingDescription' => ['Text'], |
|
129 | + 'discussionUrl' => ['URL'], |
|
130 | + 'editEIDR' => ['URL', 'Text'], |
|
131 | + 'editor' => ['Person'], |
|
132 | + 'educationalAlignment' => ['AlignmentObject'], |
|
133 | + 'educationalLevel' => ['Text', 'URL', 'DefinedTerm'], |
|
134 | + 'educationalUse' => ['DefinedTerm', 'Text'], |
|
135 | + 'encoding' => ['MediaObject'], |
|
136 | + 'encodingFormat' => ['URL', 'Text'], |
|
137 | + 'encodings' => ['MediaObject'], |
|
138 | + 'endDate' => ['DateTime', 'Date'], |
|
139 | + 'episode' => ['Episode'], |
|
140 | + 'episodes' => ['Episode'], |
|
141 | + 'exampleOfWork' => ['CreativeWork'], |
|
142 | + 'expires' => ['Date', 'DateTime'], |
|
143 | + 'fileFormat' => ['Text', 'URL'], |
|
144 | + 'funder' => ['Organization', 'Person'], |
|
145 | + 'funding' => ['Grant'], |
|
146 | + 'gameItem' => ['Thing'], |
|
147 | + 'gameLocation' => ['PostalAddress', 'URL', 'Place'], |
|
148 | + 'gamePlatform' => ['Thing', 'URL', 'Text'], |
|
149 | + 'genre' => ['Text', 'URL'], |
|
150 | + 'hasPart' => ['CreativeWork'], |
|
151 | + 'headline' => ['Text'], |
|
152 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
153 | + 'image' => ['URL', 'ImageObject'], |
|
154 | + 'inLanguage' => ['Text', 'Language'], |
|
155 | + 'interactionStatistic' => ['InteractionCounter'], |
|
156 | + 'interactivityType' => ['Text'], |
|
157 | + 'interpretedAsClaim' => ['Claim'], |
|
158 | + 'isAccessibleForFree' => ['Boolean'], |
|
159 | + 'isBasedOn' => ['URL', 'Product', 'CreativeWork'], |
|
160 | + 'isBasedOnUrl' => ['URL', 'Product', 'CreativeWork'], |
|
161 | + 'isFamilyFriendly' => ['Boolean'], |
|
162 | + 'isPartOf' => ['URL', 'CreativeWork'], |
|
163 | + 'issn' => ['Text'], |
|
164 | + 'keywords' => ['URL', 'DefinedTerm', 'Text'], |
|
165 | + 'learningResourceType' => ['DefinedTerm', 'Text'], |
|
166 | + 'license' => ['URL', 'CreativeWork'], |
|
167 | + 'locationCreated' => ['Place'], |
|
168 | + 'mainEntity' => ['Thing'], |
|
169 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
170 | + 'maintainer' => ['Person', 'Organization'], |
|
171 | + 'material' => ['Product', 'URL', 'Text'], |
|
172 | + 'materialExtent' => ['QuantitativeValue', 'Text'], |
|
173 | + 'mentions' => ['Thing'], |
|
174 | + 'musicBy' => ['MusicGroup', 'Person'], |
|
175 | + 'name' => ['Text'], |
|
176 | + 'numberOfEpisodes' => ['Integer'], |
|
177 | + 'numberOfPlayers' => ['QuantitativeValue'], |
|
178 | + 'numberOfSeasons' => ['Integer'], |
|
179 | + 'offers' => ['Demand', 'Offer'], |
|
180 | + 'pattern' => ['DefinedTerm', 'Text'], |
|
181 | + 'playMode' => ['GamePlayMode'], |
|
182 | + 'position' => ['Text', 'Integer'], |
|
183 | + 'potentialAction' => ['Action'], |
|
184 | + 'producer' => ['Organization', 'Person'], |
|
185 | + 'productionCompany' => ['Organization'], |
|
186 | + 'provider' => ['Organization', 'Person'], |
|
187 | + 'publication' => ['PublicationEvent'], |
|
188 | + 'publisher' => ['Organization', 'Person'], |
|
189 | + 'publisherImprint' => ['Organization'], |
|
190 | + 'publishingPrinciples' => ['CreativeWork', 'URL'], |
|
191 | + 'quest' => ['Thing'], |
|
192 | + 'recordedAt' => ['Event'], |
|
193 | + 'releasedEvent' => ['PublicationEvent'], |
|
194 | + 'review' => ['Review'], |
|
195 | + 'reviews' => ['Review'], |
|
196 | + 'sameAs' => ['URL'], |
|
197 | + 'schemaVersion' => ['URL', 'Text'], |
|
198 | + 'sdDatePublished' => ['Date'], |
|
199 | + 'sdLicense' => ['CreativeWork', 'URL'], |
|
200 | + 'sdPublisher' => ['Organization', 'Person'], |
|
201 | + 'season' => ['URL', 'CreativeWorkSeason'], |
|
202 | + 'seasons' => ['CreativeWorkSeason'], |
|
203 | + 'size' => ['DefinedTerm', 'QuantitativeValue', 'Text', 'SizeSpecification'], |
|
204 | + 'sourceOrganization' => ['Organization'], |
|
205 | + 'spatial' => ['Place'], |
|
206 | + 'spatialCoverage' => ['Place'], |
|
207 | + 'sponsor' => ['Organization', 'Person'], |
|
208 | + 'startDate' => ['DateTime', 'Date'], |
|
209 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
210 | + 'teaches' => ['DefinedTerm', 'Text'], |
|
211 | + 'temporal' => ['DateTime', 'Text'], |
|
212 | + 'temporalCoverage' => ['URL', 'Text', 'DateTime'], |
|
213 | + 'text' => ['Text'], |
|
214 | + 'thumbnailUrl' => ['URL'], |
|
215 | + 'timeRequired' => ['Duration'], |
|
216 | + 'trailer' => ['VideoObject'], |
|
217 | + 'translationOfWork' => ['CreativeWork'], |
|
218 | + 'translator' => ['Organization', 'Person'], |
|
219 | + 'typicalAgeRange' => ['Text'], |
|
220 | + 'url' => ['URL'], |
|
221 | + 'usageInfo' => ['URL', 'CreativeWork'], |
|
222 | + 'version' => ['Number', 'Text'], |
|
223 | + 'video' => ['VideoObject', 'Clip'], |
|
224 | + 'workExample' => ['CreativeWork'], |
|
225 | + 'workTranslation' => ['CreativeWork'] |
|
226 | + ]; |
|
227 | + } |
|
228 | 228 | |
229 | 229 | |
230 | - /** |
|
231 | - * @inheritdoc |
|
232 | - */ |
|
233 | - public function getSchemaPropertyDescriptions(): array |
|
234 | - { |
|
235 | - return [ |
|
236 | - 'about' => 'The subject matter of the content.', |
|
237 | - 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
238 | - '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).', |
|
239 | - '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).', |
|
240 | - '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).', |
|
241 | - '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).', |
|
242 | - '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).', |
|
243 | - '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).', |
|
244 | - '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."', |
|
245 | - 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
246 | - 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
247 | - '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.', |
|
248 | - '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.', |
|
249 | - '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.', |
|
250 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
251 | - 'alternateName' => 'An alias for the item.', |
|
252 | - 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
253 | - '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.', |
|
254 | - 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
255 | - 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
256 | - 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
257 | - 'audio' => 'An embedded audio object.', |
|
258 | - '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.', |
|
259 | - 'award' => 'An award won by or for this item.', |
|
260 | - 'awards' => 'Awards won by or for this item.', |
|
261 | - 'character' => 'Fictional person connected with a creative work.', |
|
262 | - 'characterAttribute' => 'A piece of data that represents a particular aspect of a fictional character (skill, power, character points, advantage, disadvantage).', |
|
263 | - 'cheatCode' => 'Cheat codes to the game.', |
|
264 | - 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
265 | - 'comment' => 'Comments, typically from users.', |
|
266 | - '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.', |
|
267 | - '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 ". ', |
|
268 | - 'containsSeason' => 'A season that is part of the media series.', |
|
269 | - 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
270 | - 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
271 | - '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.', |
|
272 | - 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
273 | - 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
274 | - '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.', |
|
275 | - 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
276 | - 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
277 | - '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.', |
|
278 | - '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.', |
|
279 | - 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
280 | - 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
281 | - 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
282 | - 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
283 | - 'datePublished' => 'Date of first broadcast/publication.', |
|
284 | - 'description' => 'A description of the item.', |
|
285 | - '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.', |
|
286 | - '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.', |
|
287 | - '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.', |
|
288 | - 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
289 | - '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. ', |
|
290 | - 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
291 | - '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.', |
|
292 | - '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.', |
|
293 | - 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
294 | - 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
295 | - '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.', |
|
296 | - 'encodings' => 'A media object that encodes this CreativeWork.', |
|
297 | - 'endDate' => 'The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
298 | - 'episode' => 'An episode of a TV, radio or game media within a series or season.', |
|
299 | - 'episodes' => 'An episode of a TV/radio series or season.', |
|
300 | - 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
301 | - '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.', |
|
302 | - '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.', |
|
303 | - 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
304 | - 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
305 | - 'gameItem' => 'An item is an object within the game world that can be collected by a player or, occasionally, a non-player character.', |
|
306 | - 'gameLocation' => 'Real or fictional location of the game (or part of game).', |
|
307 | - 'gamePlatform' => 'The electronic systems used to play <a href="http://en.wikipedia.org/wiki/Category:Video_game_platforms">video games</a>.', |
|
308 | - 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
309 | - 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
310 | - 'headline' => 'Headline of the article.', |
|
311 | - '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. ', |
|
312 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
313 | - '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]].', |
|
314 | - 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
315 | - 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
316 | - '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]].', |
|
317 | - 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
318 | - 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
319 | - '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.', |
|
320 | - 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
321 | - 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
322 | - '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.', |
|
323 | - '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.', |
|
324 | - 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
325 | - 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
326 | - 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
327 | - 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
328 | - '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.', |
|
329 | - '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. ', |
|
330 | - 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
331 | - 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
332 | - 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
333 | - 'musicBy' => 'The composer of the soundtrack.', |
|
334 | - 'name' => 'The name of the item.', |
|
335 | - 'numberOfEpisodes' => 'The number of episodes in this season or series.', |
|
336 | - 'numberOfPlayers' => 'Indicate how many people can play this game (minimum, maximum, or range).', |
|
337 | - 'numberOfSeasons' => 'The number of seasons in this series.', |
|
338 | - '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. ', |
|
339 | - '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.', |
|
340 | - 'playMode' => 'Indicates whether this game is multi-player, co-op or single-player. The game can be marked as multi-player, co-op and single-player at the same time.', |
|
341 | - 'position' => 'The position of an item in a series or sequence of items.', |
|
342 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
343 | - 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
344 | - 'productionCompany' => 'The production company or studio responsible for the item, e.g. series, video game, episode etc.', |
|
345 | - '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.', |
|
346 | - 'publication' => 'A publication event associated with the item.', |
|
347 | - 'publisher' => 'The publisher of the creative work.', |
|
348 | - 'publisherImprint' => 'The publishing division which published the comic.', |
|
349 | - '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. ', |
|
350 | - 'quest' => 'The task that a player-controlled character, or group of characters may complete in order to gain a reward.', |
|
351 | - 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
352 | - 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
353 | - 'review' => 'A review of the item.', |
|
354 | - 'reviews' => 'Review of the item.', |
|
355 | - '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.', |
|
356 | - '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.', |
|
357 | - 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
358 | - 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
359 | - '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.', |
|
360 | - 'season' => 'A season in a media series.', |
|
361 | - 'seasons' => 'A season in a media series.', |
|
362 | - '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. ', |
|
363 | - 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
364 | - 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
365 | - '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.', |
|
366 | - '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.', |
|
367 | - 'startDate' => 'The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
368 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
369 | - 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
370 | - '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.', |
|
371 | - '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.', |
|
372 | - 'text' => 'The textual content of this CreativeWork.', |
|
373 | - 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
374 | - '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\'.', |
|
375 | - 'trailer' => 'The trailer of a movie or TV/radio series, season, episode, etc.', |
|
376 | - 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
377 | - '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.', |
|
378 | - 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
379 | - 'url' => 'URL of the item.', |
|
380 | - '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.', |
|
381 | - 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
382 | - 'video' => 'An embedded video object.', |
|
383 | - 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
384 | - '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.' |
|
385 | - ]; |
|
386 | - } |
|
230 | + /** |
|
231 | + * @inheritdoc |
|
232 | + */ |
|
233 | + public function getSchemaPropertyDescriptions(): array |
|
234 | + { |
|
235 | + return [ |
|
236 | + 'about' => 'The subject matter of the content.', |
|
237 | + 'abstract' => 'An abstract is a short description that summarizes a [[CreativeWork]].', |
|
238 | + '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).', |
|
239 | + '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).', |
|
240 | + '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).', |
|
241 | + '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).', |
|
242 | + '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).', |
|
243 | + '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).', |
|
244 | + '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."', |
|
245 | + 'accountablePerson' => 'Specifies the Person that is legally accountable for the CreativeWork.', |
|
246 | + 'acquireLicensePage' => 'Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.', |
|
247 | + '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.', |
|
248 | + '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.', |
|
249 | + '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.', |
|
250 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
251 | + 'alternateName' => 'An alias for the item.', |
|
252 | + 'alternativeHeadline' => 'A secondary title of the CreativeWork.', |
|
253 | + '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.', |
|
254 | + 'assesses' => 'The item being described is intended to assess the competency or learning outcome defined by the referenced term.', |
|
255 | + 'associatedMedia' => 'A media object that encodes this CreativeWork. This property is a synonym for encoding.', |
|
256 | + 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
257 | + 'audio' => 'An embedded audio object.', |
|
258 | + '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.', |
|
259 | + 'award' => 'An award won by or for this item.', |
|
260 | + 'awards' => 'Awards won by or for this item.', |
|
261 | + 'character' => 'Fictional person connected with a creative work.', |
|
262 | + 'characterAttribute' => 'A piece of data that represents a particular aspect of a fictional character (skill, power, character points, advantage, disadvantage).', |
|
263 | + 'cheatCode' => 'Cheat codes to the game.', |
|
264 | + 'citation' => 'A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.', |
|
265 | + 'comment' => 'Comments, typically from users.', |
|
266 | + '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.', |
|
267 | + '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 ". ', |
|
268 | + 'containsSeason' => 'A season that is part of the media series.', |
|
269 | + 'contentLocation' => 'The location depicted or described in the content. For example, the location in a photograph or painting.', |
|
270 | + 'contentRating' => 'Official rating of a piece of content—for example, \'MPAA PG-13\'.', |
|
271 | + '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.', |
|
272 | + 'contributor' => 'A secondary contributor to the CreativeWork or Event.', |
|
273 | + 'copyrightHolder' => 'The party holding the legal copyright to the CreativeWork.', |
|
274 | + '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.', |
|
275 | + 'copyrightYear' => 'The year during which the claimed copyright for the CreativeWork was first asserted.', |
|
276 | + 'correction' => 'Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.', |
|
277 | + '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.', |
|
278 | + '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.', |
|
279 | + 'creator' => 'The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.', |
|
280 | + 'creditText' => 'Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.', |
|
281 | + 'dateCreated' => 'The date on which the CreativeWork was created or the item was added to a DataFeed.', |
|
282 | + 'dateModified' => 'The date on which the CreativeWork was most recently modified or when the item\'s entry was modified within a DataFeed.', |
|
283 | + 'datePublished' => 'Date of first broadcast/publication.', |
|
284 | + 'description' => 'A description of the item.', |
|
285 | + '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.', |
|
286 | + '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.', |
|
287 | + '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.', |
|
288 | + 'discussionUrl' => 'A link to the page containing the comments of the CreativeWork.', |
|
289 | + '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. ', |
|
290 | + 'editor' => 'Specifies the Person who edited the CreativeWork.', |
|
291 | + '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.', |
|
292 | + '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.', |
|
293 | + 'educationalUse' => 'The purpose of a work in the context of education; for example, \'assignment\', \'group work\'.', |
|
294 | + 'encoding' => 'A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.', |
|
295 | + '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.', |
|
296 | + 'encodings' => 'A media object that encodes this CreativeWork.', |
|
297 | + 'endDate' => 'The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
298 | + 'episode' => 'An episode of a TV, radio or game media within a series or season.', |
|
299 | + 'episodes' => 'An episode of a TV/radio series or season.', |
|
300 | + 'exampleOfWork' => 'A creative work that this work is an example/instance/realization/derivation of.', |
|
301 | + '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.', |
|
302 | + '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.', |
|
303 | + 'funder' => 'A person or organization that supports (sponsors) something through some kind of financial contribution.', |
|
304 | + 'funding' => 'A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].', |
|
305 | + 'gameItem' => 'An item is an object within the game world that can be collected by a player or, occasionally, a non-player character.', |
|
306 | + 'gameLocation' => 'Real or fictional location of the game (or part of game).', |
|
307 | + 'gamePlatform' => 'The electronic systems used to play <a href="http://en.wikipedia.org/wiki/Category:Video_game_platforms">video games</a>.', |
|
308 | + 'genre' => 'Genre of the creative work, broadcast channel or group.', |
|
309 | + 'hasPart' => 'Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).', |
|
310 | + 'headline' => 'Headline of the article.', |
|
311 | + '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. ', |
|
312 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
313 | + '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]].', |
|
314 | + 'interactionStatistic' => 'The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.', |
|
315 | + 'interactivityType' => 'The predominant mode of learning supported by the learning resource. Acceptable values are \'active\', \'expositive\', or \'mixed\'.', |
|
316 | + '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]].', |
|
317 | + 'isAccessibleForFree' => 'A flag to signal that the item, event, or place is accessible for free.', |
|
318 | + 'isBasedOn' => 'A resource from which this work is derived or from which it is a modification or adaption.', |
|
319 | + '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.', |
|
320 | + 'isFamilyFriendly' => 'Indicates whether this content is family friendly.', |
|
321 | + 'isPartOf' => 'Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.', |
|
322 | + '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.', |
|
323 | + '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.', |
|
324 | + 'learningResourceType' => 'The predominant type or kind characterizing the learning resource. For example, \'presentation\', \'handout\'.', |
|
325 | + 'license' => 'A license document that applies to this content, typically indicated by URL.', |
|
326 | + 'locationCreated' => 'The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.', |
|
327 | + 'mainEntity' => 'Indicates the primary entity described in some page or other CreativeWork.', |
|
328 | + '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.', |
|
329 | + '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. ', |
|
330 | + 'material' => 'A material that something is made from, e.g. leather, wool, cotton, paper.', |
|
331 | + 'materialExtent' => 'The quantity of the materials being described or an expression of the physical space they occupy.', |
|
332 | + 'mentions' => 'Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.', |
|
333 | + 'musicBy' => 'The composer of the soundtrack.', |
|
334 | + 'name' => 'The name of the item.', |
|
335 | + 'numberOfEpisodes' => 'The number of episodes in this season or series.', |
|
336 | + 'numberOfPlayers' => 'Indicate how many people can play this game (minimum, maximum, or range).', |
|
337 | + 'numberOfSeasons' => 'The number of seasons in this series.', |
|
338 | + '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. ', |
|
339 | + '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.', |
|
340 | + 'playMode' => 'Indicates whether this game is multi-player, co-op or single-player. The game can be marked as multi-player, co-op and single-player at the same time.', |
|
341 | + 'position' => 'The position of an item in a series or sequence of items.', |
|
342 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
343 | + 'producer' => 'The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).', |
|
344 | + 'productionCompany' => 'The production company or studio responsible for the item, e.g. series, video game, episode etc.', |
|
345 | + '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.', |
|
346 | + 'publication' => 'A publication event associated with the item.', |
|
347 | + 'publisher' => 'The publisher of the creative work.', |
|
348 | + 'publisherImprint' => 'The publishing division which published the comic.', |
|
349 | + '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. ', |
|
350 | + 'quest' => 'The task that a player-controlled character, or group of characters may complete in order to gain a reward.', |
|
351 | + 'recordedAt' => 'The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.', |
|
352 | + 'releasedEvent' => 'The place and time the release was issued, expressed as a PublicationEvent.', |
|
353 | + 'review' => 'A review of the item.', |
|
354 | + 'reviews' => 'Review of the item.', |
|
355 | + '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.', |
|
356 | + '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.', |
|
357 | + 'sdDatePublished' => 'Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]', |
|
358 | + 'sdLicense' => 'A license document that applies to this structured data, typically indicated by URL.', |
|
359 | + '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.', |
|
360 | + 'season' => 'A season in a media series.', |
|
361 | + 'seasons' => 'A season in a media series.', |
|
362 | + '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. ', |
|
363 | + 'sourceOrganization' => 'The Organization on whose behalf the creator was working.', |
|
364 | + 'spatial' => 'The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.', |
|
365 | + '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.', |
|
366 | + '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.', |
|
367 | + 'startDate' => 'The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).', |
|
368 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
369 | + 'teaches' => 'The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.', |
|
370 | + '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.', |
|
371 | + '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.', |
|
372 | + 'text' => 'The textual content of this CreativeWork.', |
|
373 | + 'thumbnailUrl' => 'A thumbnail image relevant to the Thing.', |
|
374 | + '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\'.', |
|
375 | + 'trailer' => 'The trailer of a movie or TV/radio series, season, episode, etc.', |
|
376 | + 'translationOfWork' => 'The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.', |
|
377 | + '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.', |
|
378 | + 'typicalAgeRange' => 'The typical expected age range, e.g. \'7-9\', \'11-\'.', |
|
379 | + 'url' => 'URL of the item.', |
|
380 | + '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.', |
|
381 | + 'version' => 'The version of the CreativeWork embodied by a specified resource.', |
|
382 | + 'video' => 'An embedded video object.', |
|
383 | + 'workExample' => 'Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.', |
|
384 | + '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.' |
|
385 | + ]; |
|
386 | + } |
|
387 | 387 | |
388 | 388 | |
389 | - /** |
|
390 | - * @inheritdoc |
|
391 | - */ |
|
392 | - public function getGoogleRequiredSchema(): array |
|
393 | - { |
|
394 | - return ['description', 'name']; |
|
395 | - } |
|
389 | + /** |
|
390 | + * @inheritdoc |
|
391 | + */ |
|
392 | + public function getGoogleRequiredSchema(): array |
|
393 | + { |
|
394 | + return ['description', 'name']; |
|
395 | + } |
|
396 | 396 | |
397 | 397 | |
398 | - /** |
|
399 | - * @inheritdoc |
|
400 | - */ |
|
401 | - public function getGoogleRecommendedSchema(): array |
|
402 | - { |
|
403 | - return ['image', 'url']; |
|
404 | - } |
|
398 | + /** |
|
399 | + * @inheritdoc |
|
400 | + */ |
|
401 | + public function getGoogleRecommendedSchema(): array |
|
402 | + { |
|
403 | + return ['image', 'url']; |
|
404 | + } |
|
405 | 405 | |
406 | 406 | |
407 | - /** |
|
408 | - * @inheritdoc |
|
409 | - */ |
|
410 | - public function defineRules(): array |
|
411 | - { |
|
412 | - $rules = parent::defineRules(); |
|
413 | - $rules = array_merge($rules, [ |
|
414 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
415 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
416 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
417 | - ]); |
|
407 | + /** |
|
408 | + * @inheritdoc |
|
409 | + */ |
|
410 | + public function defineRules(): array |
|
411 | + { |
|
412 | + $rules = parent::defineRules(); |
|
413 | + $rules = array_merge($rules, [ |
|
414 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
415 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
416 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
417 | + ]); |
|
418 | 418 | |
419 | - return $rules; |
|
420 | - } |
|
419 | + return $rules; |
|
420 | + } |
|
421 | 421 | } |
@@ -26,177 +26,177 @@ |
||
26 | 26 | */ |
27 | 27 | class FinancialProduct extends MetaJsonLd implements FinancialProductInterface, ServiceInterface, IntangibleInterface, ThingInterface |
28 | 28 | { |
29 | - use FinancialProductTrait; |
|
30 | - use ServiceTrait; |
|
31 | - use IntangibleTrait; |
|
32 | - use ThingTrait; |
|
33 | - |
|
34 | - /** |
|
35 | - * The Schema.org Type Name |
|
36 | - * |
|
37 | - * @var string |
|
38 | - */ |
|
39 | - public static string $schemaTypeName = 'FinancialProduct'; |
|
40 | - |
|
41 | - /** |
|
42 | - * The Schema.org Type Scope |
|
43 | - * |
|
44 | - * @var string |
|
45 | - */ |
|
46 | - public static string $schemaTypeScope = 'https://schema.org/FinancialProduct'; |
|
47 | - |
|
48 | - /** |
|
49 | - * The Schema.org Type Extends |
|
50 | - * |
|
51 | - * @var string |
|
52 | - */ |
|
53 | - public static string $schemaTypeExtends = 'Service'; |
|
54 | - |
|
55 | - /** |
|
56 | - * The Schema.org Type Description |
|
57 | - * |
|
58 | - * @var string |
|
59 | - */ |
|
60 | - public static string $schemaTypeDescription = 'A product provided to consumers and businesses by financial institutions such as banks, insurance companies, brokerage firms, consumer finance companies, and investment companies which comprise the financial services industry.'; |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * @inheritdoc |
|
65 | - */ |
|
66 | - public function getSchemaPropertyNames(): array |
|
67 | - { |
|
68 | - return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
69 | - } |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * @inheritdoc |
|
74 | - */ |
|
75 | - public function getSchemaPropertyExpectedTypes(): array |
|
76 | - { |
|
77 | - return [ |
|
78 | - 'additionalType' => ['URL'], |
|
79 | - 'aggregateRating' => ['AggregateRating'], |
|
80 | - 'alternateName' => ['Text'], |
|
81 | - 'annualPercentageRate' => ['Number', 'QuantitativeValue'], |
|
82 | - 'areaServed' => ['Text', 'Place', 'GeoShape', 'AdministrativeArea'], |
|
83 | - 'audience' => ['Audience'], |
|
84 | - 'availableChannel' => ['ServiceChannel'], |
|
85 | - 'award' => ['Text'], |
|
86 | - 'brand' => ['Brand', 'Organization'], |
|
87 | - 'broker' => ['Person', 'Organization'], |
|
88 | - 'category' => ['URL', 'CategoryCode', 'Text', 'Thing', 'PhysicalActivityCategory'], |
|
89 | - 'description' => ['Text'], |
|
90 | - 'disambiguatingDescription' => ['Text'], |
|
91 | - 'feesAndCommissionsSpecification' => ['URL', 'Text'], |
|
92 | - 'hasOfferCatalog' => ['OfferCatalog'], |
|
93 | - 'hoursAvailable' => ['OpeningHoursSpecification'], |
|
94 | - 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
95 | - 'image' => ['URL', 'ImageObject'], |
|
96 | - 'interestRate' => ['Number', 'QuantitativeValue'], |
|
97 | - 'isRelatedTo' => ['Product', 'Service'], |
|
98 | - 'isSimilarTo' => ['Product', 'Service'], |
|
99 | - 'logo' => ['ImageObject', 'URL'], |
|
100 | - 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
101 | - 'name' => ['Text'], |
|
102 | - 'offers' => ['Demand', 'Offer'], |
|
103 | - 'potentialAction' => ['Action'], |
|
104 | - 'produces' => ['Thing'], |
|
105 | - 'provider' => ['Organization', 'Person'], |
|
106 | - 'providerMobility' => ['Text'], |
|
107 | - 'review' => ['Review'], |
|
108 | - 'sameAs' => ['URL'], |
|
109 | - 'serviceArea' => ['AdministrativeArea', 'Place', 'GeoShape'], |
|
110 | - 'serviceAudience' => ['Audience'], |
|
111 | - 'serviceOutput' => ['Thing'], |
|
112 | - 'serviceType' => ['Text', 'GovernmentBenefitsType'], |
|
113 | - 'slogan' => ['Text'], |
|
114 | - 'subjectOf' => ['Event', 'CreativeWork'], |
|
115 | - 'termsOfService' => ['URL', 'Text'], |
|
116 | - 'url' => ['URL'] |
|
117 | - ]; |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * @inheritdoc |
|
123 | - */ |
|
124 | - public function getSchemaPropertyDescriptions(): array |
|
125 | - { |
|
126 | - return [ |
|
127 | - '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.', |
|
128 | - 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
129 | - 'alternateName' => 'An alias for the item.', |
|
130 | - 'annualPercentageRate' => 'The annual rate that is charged for borrowing (or made by investing), expressed as a single percentage number that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction.', |
|
131 | - 'areaServed' => 'The geographic area where a service or offered item is provided.', |
|
132 | - 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
133 | - 'availableChannel' => 'A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).', |
|
134 | - 'award' => 'An award won by or for this item.', |
|
135 | - 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
136 | - 'broker' => 'An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.', |
|
137 | - 'category' => 'A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.', |
|
138 | - 'description' => 'A description of the item.', |
|
139 | - '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.', |
|
140 | - 'feesAndCommissionsSpecification' => 'Description of fees, commissions, and other terms applied either to a class of financial product, or by a financial service organization.', |
|
141 | - 'hasOfferCatalog' => 'Indicates an OfferCatalog listing for this Organization, Person, or Service.', |
|
142 | - 'hoursAvailable' => 'The hours during which this service or contact is available.', |
|
143 | - '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. ', |
|
144 | - 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
145 | - 'interestRate' => 'The interest rate, charged or paid, applicable to the financial product. Note: This is different from the calculated annualPercentageRate.', |
|
146 | - 'isRelatedTo' => 'A pointer to another, somehow related product (or multiple products).', |
|
147 | - 'isSimilarTo' => 'A pointer to another, functionally similar product (or multiple products).', |
|
148 | - 'logo' => 'An associated logo.', |
|
149 | - '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.', |
|
150 | - 'name' => 'The name of the item.', |
|
151 | - '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. ', |
|
152 | - 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
153 | - 'produces' => 'The tangible thing generated by the service, e.g. a passport, permit, etc.', |
|
154 | - '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.', |
|
155 | - 'providerMobility' => 'Indicates the mobility of a provided service (e.g. \'static\', \'dynamic\').', |
|
156 | - 'review' => 'A review of the item.', |
|
157 | - '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.', |
|
158 | - 'serviceArea' => 'The geographic area where the service is provided.', |
|
159 | - 'serviceAudience' => 'The audience eligible for this service.', |
|
160 | - 'serviceOutput' => 'The tangible thing generated by the service, e.g. a passport, permit, etc.', |
|
161 | - 'serviceType' => 'The type of service being offered, e.g. veterans\' benefits, emergency relief, etc.', |
|
162 | - 'slogan' => 'A slogan or motto associated with the item.', |
|
163 | - 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
164 | - 'termsOfService' => 'Human-readable terms of service documentation.', |
|
165 | - 'url' => 'URL of the item.' |
|
166 | - ]; |
|
167 | - } |
|
168 | - |
|
169 | - |
|
170 | - /** |
|
171 | - * @inheritdoc |
|
172 | - */ |
|
173 | - public function getGoogleRequiredSchema(): array |
|
174 | - { |
|
175 | - return ['description', 'name']; |
|
176 | - } |
|
177 | - |
|
178 | - |
|
179 | - /** |
|
180 | - * @inheritdoc |
|
181 | - */ |
|
182 | - public function getGoogleRecommendedSchema(): array |
|
183 | - { |
|
184 | - return ['image', 'url']; |
|
185 | - } |
|
186 | - |
|
187 | - |
|
188 | - /** |
|
189 | - * @inheritdoc |
|
190 | - */ |
|
191 | - public function defineRules(): array |
|
192 | - { |
|
193 | - $rules = parent::defineRules(); |
|
194 | - $rules = array_merge($rules, [ |
|
195 | - [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
196 | - [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
197 | - [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
198 | - ]); |
|
199 | - |
|
200 | - return $rules; |
|
201 | - } |
|
29 | + use FinancialProductTrait; |
|
30 | + use ServiceTrait; |
|
31 | + use IntangibleTrait; |
|
32 | + use ThingTrait; |
|
33 | + |
|
34 | + /** |
|
35 | + * The Schema.org Type Name |
|
36 | + * |
|
37 | + * @var string |
|
38 | + */ |
|
39 | + public static string $schemaTypeName = 'FinancialProduct'; |
|
40 | + |
|
41 | + /** |
|
42 | + * The Schema.org Type Scope |
|
43 | + * |
|
44 | + * @var string |
|
45 | + */ |
|
46 | + public static string $schemaTypeScope = 'https://schema.org/FinancialProduct'; |
|
47 | + |
|
48 | + /** |
|
49 | + * The Schema.org Type Extends |
|
50 | + * |
|
51 | + * @var string |
|
52 | + */ |
|
53 | + public static string $schemaTypeExtends = 'Service'; |
|
54 | + |
|
55 | + /** |
|
56 | + * The Schema.org Type Description |
|
57 | + * |
|
58 | + * @var string |
|
59 | + */ |
|
60 | + public static string $schemaTypeDescription = 'A product provided to consumers and businesses by financial institutions such as banks, insurance companies, brokerage firms, consumer finance companies, and investment companies which comprise the financial services industry.'; |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * @inheritdoc |
|
65 | + */ |
|
66 | + public function getSchemaPropertyNames(): array |
|
67 | + { |
|
68 | + return array_keys($this->getSchemaPropertyExpectedTypes()); |
|
69 | + } |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * @inheritdoc |
|
74 | + */ |
|
75 | + public function getSchemaPropertyExpectedTypes(): array |
|
76 | + { |
|
77 | + return [ |
|
78 | + 'additionalType' => ['URL'], |
|
79 | + 'aggregateRating' => ['AggregateRating'], |
|
80 | + 'alternateName' => ['Text'], |
|
81 | + 'annualPercentageRate' => ['Number', 'QuantitativeValue'], |
|
82 | + 'areaServed' => ['Text', 'Place', 'GeoShape', 'AdministrativeArea'], |
|
83 | + 'audience' => ['Audience'], |
|
84 | + 'availableChannel' => ['ServiceChannel'], |
|
85 | + 'award' => ['Text'], |
|
86 | + 'brand' => ['Brand', 'Organization'], |
|
87 | + 'broker' => ['Person', 'Organization'], |
|
88 | + 'category' => ['URL', 'CategoryCode', 'Text', 'Thing', 'PhysicalActivityCategory'], |
|
89 | + 'description' => ['Text'], |
|
90 | + 'disambiguatingDescription' => ['Text'], |
|
91 | + 'feesAndCommissionsSpecification' => ['URL', 'Text'], |
|
92 | + 'hasOfferCatalog' => ['OfferCatalog'], |
|
93 | + 'hoursAvailable' => ['OpeningHoursSpecification'], |
|
94 | + 'identifier' => ['PropertyValue', 'URL', 'Text'], |
|
95 | + 'image' => ['URL', 'ImageObject'], |
|
96 | + 'interestRate' => ['Number', 'QuantitativeValue'], |
|
97 | + 'isRelatedTo' => ['Product', 'Service'], |
|
98 | + 'isSimilarTo' => ['Product', 'Service'], |
|
99 | + 'logo' => ['ImageObject', 'URL'], |
|
100 | + 'mainEntityOfPage' => ['URL', 'CreativeWork'], |
|
101 | + 'name' => ['Text'], |
|
102 | + 'offers' => ['Demand', 'Offer'], |
|
103 | + 'potentialAction' => ['Action'], |
|
104 | + 'produces' => ['Thing'], |
|
105 | + 'provider' => ['Organization', 'Person'], |
|
106 | + 'providerMobility' => ['Text'], |
|
107 | + 'review' => ['Review'], |
|
108 | + 'sameAs' => ['URL'], |
|
109 | + 'serviceArea' => ['AdministrativeArea', 'Place', 'GeoShape'], |
|
110 | + 'serviceAudience' => ['Audience'], |
|
111 | + 'serviceOutput' => ['Thing'], |
|
112 | + 'serviceType' => ['Text', 'GovernmentBenefitsType'], |
|
113 | + 'slogan' => ['Text'], |
|
114 | + 'subjectOf' => ['Event', 'CreativeWork'], |
|
115 | + 'termsOfService' => ['URL', 'Text'], |
|
116 | + 'url' => ['URL'] |
|
117 | + ]; |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * @inheritdoc |
|
123 | + */ |
|
124 | + public function getSchemaPropertyDescriptions(): array |
|
125 | + { |
|
126 | + return [ |
|
127 | + '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.', |
|
128 | + 'aggregateRating' => 'The overall rating, based on a collection of reviews or ratings, of the item.', |
|
129 | + 'alternateName' => 'An alias for the item.', |
|
130 | + 'annualPercentageRate' => 'The annual rate that is charged for borrowing (or made by investing), expressed as a single percentage number that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction.', |
|
131 | + 'areaServed' => 'The geographic area where a service or offered item is provided.', |
|
132 | + 'audience' => 'An intended audience, i.e. a group for whom something was created.', |
|
133 | + 'availableChannel' => 'A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).', |
|
134 | + 'award' => 'An award won by or for this item.', |
|
135 | + 'brand' => 'The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.', |
|
136 | + 'broker' => 'An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.', |
|
137 | + 'category' => 'A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.', |
|
138 | + 'description' => 'A description of the item.', |
|
139 | + '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.', |
|
140 | + 'feesAndCommissionsSpecification' => 'Description of fees, commissions, and other terms applied either to a class of financial product, or by a financial service organization.', |
|
141 | + 'hasOfferCatalog' => 'Indicates an OfferCatalog listing for this Organization, Person, or Service.', |
|
142 | + 'hoursAvailable' => 'The hours during which this service or contact is available.', |
|
143 | + '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. ', |
|
144 | + 'image' => 'An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].', |
|
145 | + 'interestRate' => 'The interest rate, charged or paid, applicable to the financial product. Note: This is different from the calculated annualPercentageRate.', |
|
146 | + 'isRelatedTo' => 'A pointer to another, somehow related product (or multiple products).', |
|
147 | + 'isSimilarTo' => 'A pointer to another, functionally similar product (or multiple products).', |
|
148 | + 'logo' => 'An associated logo.', |
|
149 | + '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.', |
|
150 | + 'name' => 'The name of the item.', |
|
151 | + '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. ', |
|
152 | + 'potentialAction' => 'Indicates a potential Action, which describes an idealized action in which this thing would play an \'object\' role.', |
|
153 | + 'produces' => 'The tangible thing generated by the service, e.g. a passport, permit, etc.', |
|
154 | + '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.', |
|
155 | + 'providerMobility' => 'Indicates the mobility of a provided service (e.g. \'static\', \'dynamic\').', |
|
156 | + 'review' => 'A review of the item.', |
|
157 | + '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.', |
|
158 | + 'serviceArea' => 'The geographic area where the service is provided.', |
|
159 | + 'serviceAudience' => 'The audience eligible for this service.', |
|
160 | + 'serviceOutput' => 'The tangible thing generated by the service, e.g. a passport, permit, etc.', |
|
161 | + 'serviceType' => 'The type of service being offered, e.g. veterans\' benefits, emergency relief, etc.', |
|
162 | + 'slogan' => 'A slogan or motto associated with the item.', |
|
163 | + 'subjectOf' => 'A CreativeWork or Event about this Thing.', |
|
164 | + 'termsOfService' => 'Human-readable terms of service documentation.', |
|
165 | + 'url' => 'URL of the item.' |
|
166 | + ]; |
|
167 | + } |
|
168 | + |
|
169 | + |
|
170 | + /** |
|
171 | + * @inheritdoc |
|
172 | + */ |
|
173 | + public function getGoogleRequiredSchema(): array |
|
174 | + { |
|
175 | + return ['description', 'name']; |
|
176 | + } |
|
177 | + |
|
178 | + |
|
179 | + /** |
|
180 | + * @inheritdoc |
|
181 | + */ |
|
182 | + public function getGoogleRecommendedSchema(): array |
|
183 | + { |
|
184 | + return ['image', 'url']; |
|
185 | + } |
|
186 | + |
|
187 | + |
|
188 | + /** |
|
189 | + * @inheritdoc |
|
190 | + */ |
|
191 | + public function defineRules(): array |
|
192 | + { |
|
193 | + $rules = parent::defineRules(); |
|
194 | + $rules = array_merge($rules, [ |
|
195 | + [$this->getSchemaPropertyNames(), 'validateJsonSchema'], |
|
196 | + [$this->getGoogleRequiredSchema(), 'required', 'on' => ['google'], 'message' => 'This property is required by Google.'], |
|
197 | + [$this->getGoogleRecommendedSchema(), 'required', 'on' => ['google'], 'message' => 'This property is recommended by Google.'] |
|
198 | + ]); |
|
199 | + |
|
200 | + return $rules; |
|
201 | + } |
|
202 | 202 | } |