@@ 16-411 (lines=396) @@ | ||
13 | * @see http://schema.org/AddAction |
|
14 | * |
|
15 | */ |
|
16 | class AddAction extends BaseType implements AddActionContract, ActionContract, ThingContract, UpdateActionContract |
|
17 | { |
|
18 | /** |
|
19 | * Indicates the current disposition of the Action. |
|
20 | * |
|
21 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
22 | * |
|
23 | * @return static |
|
24 | * |
|
25 | * @see http://schema.org/actionStatus |
|
26 | */ |
|
27 | public function actionStatus($actionStatus) |
|
28 | { |
|
29 | return $this->setProperty('actionStatus', $actionStatus); |
|
30 | } |
|
31 | ||
32 | /** |
|
33 | * An additional type for the item, typically used for adding more specific |
|
34 | * types from external vocabularies in microdata syntax. This is a |
|
35 | * relationship between something and a class that the thing is in. In RDFa |
|
36 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
37 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
38 | * understanding of extra types, in particular those defined externally. |
|
39 | * |
|
40 | * @param string|string[] $additionalType |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/additionalType |
|
45 | */ |
|
46 | public function additionalType($additionalType) |
|
47 | { |
|
48 | return $this->setProperty('additionalType', $additionalType); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
53 | * *John* wrote a book. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/agent |
|
60 | */ |
|
61 | public function agent($agent) |
|
62 | { |
|
63 | return $this->setProperty('agent', $agent); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * An alias for the item. |
|
68 | * |
|
69 | * @param string|string[] $alternateName |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/alternateName |
|
74 | */ |
|
75 | public function alternateName($alternateName) |
|
76 | { |
|
77 | return $this->setProperty('alternateName', $alternateName); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * A sub property of object. The collection target of the action. |
|
82 | * |
|
83 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $collection |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/collection |
|
88 | */ |
|
89 | public function collection($collection) |
|
90 | { |
|
91 | return $this->setProperty('collection', $collection); |
|
92 | } |
|
93 | ||
94 | /** |
|
95 | * A description of the item. |
|
96 | * |
|
97 | * @param string|string[] $description |
|
98 | * |
|
99 | * @return static |
|
100 | * |
|
101 | * @see http://schema.org/description |
|
102 | */ |
|
103 | public function description($description) |
|
104 | { |
|
105 | return $this->setProperty('description', $description); |
|
106 | } |
|
107 | ||
108 | /** |
|
109 | * A sub property of description. A short description of the item used to |
|
110 | * disambiguate from other, similar items. Information from other properties |
|
111 | * (in particular, name) may be necessary for the description to be useful |
|
112 | * for disambiguation. |
|
113 | * |
|
114 | * @param string|string[] $disambiguatingDescription |
|
115 | * |
|
116 | * @return static |
|
117 | * |
|
118 | * @see http://schema.org/disambiguatingDescription |
|
119 | */ |
|
120 | public function disambiguatingDescription($disambiguatingDescription) |
|
121 | { |
|
122 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
123 | } |
|
124 | ||
125 | /** |
|
126 | * The endTime of something. For a reserved event or service (e.g. |
|
127 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
128 | * actions that span a period of time, when the action was performed. e.g. |
|
129 | * John wrote a book from January to *December*. For media, including audio |
|
130 | * and video, it's the time offset of the end of a clip within a larger |
|
131 | * file. |
|
132 | * |
|
133 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
134 | * when describing dates with times. This situation may be clarified in |
|
135 | * future revisions. |
|
136 | * |
|
137 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
138 | * |
|
139 | * @return static |
|
140 | * |
|
141 | * @see http://schema.org/endTime |
|
142 | */ |
|
143 | public function endTime($endTime) |
|
144 | { |
|
145 | return $this->setProperty('endTime', $endTime); |
|
146 | } |
|
147 | ||
148 | /** |
|
149 | * For failed actions, more information on the cause of the failure. |
|
150 | * |
|
151 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
152 | * |
|
153 | * @return static |
|
154 | * |
|
155 | * @see http://schema.org/error |
|
156 | */ |
|
157 | public function error($error) |
|
158 | { |
|
159 | return $this->setProperty('error', $error); |
|
160 | } |
|
161 | ||
162 | /** |
|
163 | * The identifier property represents any kind of identifier for any kind of |
|
164 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
165 | * dedicated properties for representing many of these, either as textual |
|
166 | * strings or as URL (URI) links. See [background |
|
167 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/identifier |
|
174 | */ |
|
175 | public function identifier($identifier) |
|
176 | { |
|
177 | return $this->setProperty('identifier', $identifier); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * An image of the item. This can be a [[URL]] or a fully described |
|
182 | * [[ImageObject]]. |
|
183 | * |
|
184 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
185 | * |
|
186 | * @return static |
|
187 | * |
|
188 | * @see http://schema.org/image |
|
189 | */ |
|
190 | public function image($image) |
|
191 | { |
|
192 | return $this->setProperty('image', $image); |
|
193 | } |
|
194 | ||
195 | /** |
|
196 | * The object that helped the agent perform the action. e.g. John wrote a |
|
197 | * book with *a pen*. |
|
198 | * |
|
199 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
200 | * |
|
201 | * @return static |
|
202 | * |
|
203 | * @see http://schema.org/instrument |
|
204 | */ |
|
205 | public function instrument($instrument) |
|
206 | { |
|
207 | return $this->setProperty('instrument', $instrument); |
|
208 | } |
|
209 | ||
210 | /** |
|
211 | * The location of for example where the event is happening, an organization |
|
212 | * is located, or where an action takes place. |
|
213 | * |
|
214 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
215 | * |
|
216 | * @return static |
|
217 | * |
|
218 | * @see http://schema.org/location |
|
219 | */ |
|
220 | public function location($location) |
|
221 | { |
|
222 | return $this->setProperty('location', $location); |
|
223 | } |
|
224 | ||
225 | /** |
|
226 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
227 | * entity being described. See [background |
|
228 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
229 | * |
|
230 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
231 | * |
|
232 | * @return static |
|
233 | * |
|
234 | * @see http://schema.org/mainEntityOfPage |
|
235 | */ |
|
236 | public function mainEntityOfPage($mainEntityOfPage) |
|
237 | { |
|
238 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
239 | } |
|
240 | ||
241 | /** |
|
242 | * The name of the item. |
|
243 | * |
|
244 | * @param string|string[] $name |
|
245 | * |
|
246 | * @return static |
|
247 | * |
|
248 | * @see http://schema.org/name |
|
249 | */ |
|
250 | public function name($name) |
|
251 | { |
|
252 | return $this->setProperty('name', $name); |
|
253 | } |
|
254 | ||
255 | /** |
|
256 | * The object upon which the action is carried out, whose state is kept |
|
257 | * intact or changed. Also known as the semantic roles patient, affected or |
|
258 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
259 | * read *a book*. |
|
260 | * |
|
261 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
262 | * |
|
263 | * @return static |
|
264 | * |
|
265 | * @see http://schema.org/object |
|
266 | */ |
|
267 | public function object($object) |
|
268 | { |
|
269 | return $this->setProperty('object', $object); |
|
270 | } |
|
271 | ||
272 | /** |
|
273 | * Other co-agents that participated in the action indirectly. e.g. John |
|
274 | * wrote a book with *Steve*. |
|
275 | * |
|
276 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
277 | * |
|
278 | * @return static |
|
279 | * |
|
280 | * @see http://schema.org/participant |
|
281 | */ |
|
282 | public function participant($participant) |
|
283 | { |
|
284 | return $this->setProperty('participant', $participant); |
|
285 | } |
|
286 | ||
287 | /** |
|
288 | * Indicates a potential Action, which describes an idealized action in |
|
289 | * which this thing would play an 'object' role. |
|
290 | * |
|
291 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
292 | * |
|
293 | * @return static |
|
294 | * |
|
295 | * @see http://schema.org/potentialAction |
|
296 | */ |
|
297 | public function potentialAction($potentialAction) |
|
298 | { |
|
299 | return $this->setProperty('potentialAction', $potentialAction); |
|
300 | } |
|
301 | ||
302 | /** |
|
303 | * The result produced in the action. e.g. John wrote *a book*. |
|
304 | * |
|
305 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
306 | * |
|
307 | * @return static |
|
308 | * |
|
309 | * @see http://schema.org/result |
|
310 | */ |
|
311 | public function result($result) |
|
312 | { |
|
313 | return $this->setProperty('result', $result); |
|
314 | } |
|
315 | ||
316 | /** |
|
317 | * URL of a reference Web page that unambiguously indicates the item's |
|
318 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
319 | * official website. |
|
320 | * |
|
321 | * @param string|string[] $sameAs |
|
322 | * |
|
323 | * @return static |
|
324 | * |
|
325 | * @see http://schema.org/sameAs |
|
326 | */ |
|
327 | public function sameAs($sameAs) |
|
328 | { |
|
329 | return $this->setProperty('sameAs', $sameAs); |
|
330 | } |
|
331 | ||
332 | /** |
|
333 | * The startTime of something. For a reserved event or service (e.g. |
|
334 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
335 | * actions that span a period of time, when the action was performed. e.g. |
|
336 | * John wrote a book from *January* to December. For media, including audio |
|
337 | * and video, it's the time offset of the start of a clip within a larger |
|
338 | * file. |
|
339 | * |
|
340 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
341 | * when describing dates with times. This situation may be clarified in |
|
342 | * future revisions. |
|
343 | * |
|
344 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
345 | * |
|
346 | * @return static |
|
347 | * |
|
348 | * @see http://schema.org/startTime |
|
349 | */ |
|
350 | public function startTime($startTime) |
|
351 | { |
|
352 | return $this->setProperty('startTime', $startTime); |
|
353 | } |
|
354 | ||
355 | /** |
|
356 | * A CreativeWork or Event about this Thing. |
|
357 | * |
|
358 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
359 | * |
|
360 | * @return static |
|
361 | * |
|
362 | * @see http://schema.org/subjectOf |
|
363 | */ |
|
364 | public function subjectOf($subjectOf) |
|
365 | { |
|
366 | return $this->setProperty('subjectOf', $subjectOf); |
|
367 | } |
|
368 | ||
369 | /** |
|
370 | * Indicates a target EntryPoint for an Action. |
|
371 | * |
|
372 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
373 | * |
|
374 | * @return static |
|
375 | * |
|
376 | * @see http://schema.org/target |
|
377 | */ |
|
378 | public function target($target) |
|
379 | { |
|
380 | return $this->setProperty('target', $target); |
|
381 | } |
|
382 | ||
383 | /** |
|
384 | * A sub property of object. The collection target of the action. |
|
385 | * |
|
386 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $targetCollection |
|
387 | * |
|
388 | * @return static |
|
389 | * |
|
390 | * @see http://schema.org/targetCollection |
|
391 | */ |
|
392 | public function targetCollection($targetCollection) |
|
393 | { |
|
394 | return $this->setProperty('targetCollection', $targetCollection); |
|
395 | } |
|
396 | ||
397 | /** |
|
398 | * URL of the item. |
|
399 | * |
|
400 | * @param string|string[] $url |
|
401 | * |
|
402 | * @return static |
|
403 | * |
|
404 | * @see http://schema.org/url |
|
405 | */ |
|
406 | public function url($url) |
|
407 | { |
|
408 | return $this->setProperty('url', $url); |
|
409 | } |
|
410 | ||
411 | } |
|
412 |
@@ 18-428 (lines=411) @@ | ||
15 | * @see http://schema.org/AppendAction |
|
16 | * |
|
17 | */ |
|
18 | class AppendAction extends BaseType implements AppendActionContract, ActionContract, AddActionContract, InsertActionContract, ThingContract, UpdateActionContract |
|
19 | { |
|
20 | /** |
|
21 | * Indicates the current disposition of the Action. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionStatus |
|
28 | */ |
|
29 | public function actionStatus($actionStatus) |
|
30 | { |
|
31 | return $this->setProperty('actionStatus', $actionStatus); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * An additional type for the item, typically used for adding more specific |
|
36 | * types from external vocabularies in microdata syntax. This is a |
|
37 | * relationship between something and a class that the thing is in. In RDFa |
|
38 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
39 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
40 | * understanding of extra types, in particular those defined externally. |
|
41 | * |
|
42 | * @param string|string[] $additionalType |
|
43 | * |
|
44 | * @return static |
|
45 | * |
|
46 | * @see http://schema.org/additionalType |
|
47 | */ |
|
48 | public function additionalType($additionalType) |
|
49 | { |
|
50 | return $this->setProperty('additionalType', $additionalType); |
|
51 | } |
|
52 | ||
53 | /** |
|
54 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
55 | * *John* wrote a book. |
|
56 | * |
|
57 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
58 | * |
|
59 | * @return static |
|
60 | * |
|
61 | * @see http://schema.org/agent |
|
62 | */ |
|
63 | public function agent($agent) |
|
64 | { |
|
65 | return $this->setProperty('agent', $agent); |
|
66 | } |
|
67 | ||
68 | /** |
|
69 | * An alias for the item. |
|
70 | * |
|
71 | * @param string|string[] $alternateName |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/alternateName |
|
76 | */ |
|
77 | public function alternateName($alternateName) |
|
78 | { |
|
79 | return $this->setProperty('alternateName', $alternateName); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * A sub property of object. The collection target of the action. |
|
84 | * |
|
85 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $collection |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/collection |
|
90 | */ |
|
91 | public function collection($collection) |
|
92 | { |
|
93 | return $this->setProperty('collection', $collection); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * The identifier property represents any kind of identifier for any kind of |
|
166 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
167 | * dedicated properties for representing many of these, either as textual |
|
168 | * strings or as URL (URI) links. See [background |
|
169 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/identifier |
|
176 | */ |
|
177 | public function identifier($identifier) |
|
178 | { |
|
179 | return $this->setProperty('identifier', $identifier); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * An image of the item. This can be a [[URL]] or a fully described |
|
184 | * [[ImageObject]]. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/image |
|
191 | */ |
|
192 | public function image($image) |
|
193 | { |
|
194 | return $this->setProperty('image', $image); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The object that helped the agent perform the action. e.g. John wrote a |
|
199 | * book with *a pen*. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/instrument |
|
206 | */ |
|
207 | public function instrument($instrument) |
|
208 | { |
|
209 | return $this->setProperty('instrument', $instrument); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * The location of for example where the event is happening, an organization |
|
214 | * is located, or where an action takes place. |
|
215 | * |
|
216 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
217 | * |
|
218 | * @return static |
|
219 | * |
|
220 | * @see http://schema.org/location |
|
221 | */ |
|
222 | public function location($location) |
|
223 | { |
|
224 | return $this->setProperty('location', $location); |
|
225 | } |
|
226 | ||
227 | /** |
|
228 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
229 | * entity being described. See [background |
|
230 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/mainEntityOfPage |
|
237 | */ |
|
238 | public function mainEntityOfPage($mainEntityOfPage) |
|
239 | { |
|
240 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * The name of the item. |
|
245 | * |
|
246 | * @param string|string[] $name |
|
247 | * |
|
248 | * @return static |
|
249 | * |
|
250 | * @see http://schema.org/name |
|
251 | */ |
|
252 | public function name($name) |
|
253 | { |
|
254 | return $this->setProperty('name', $name); |
|
255 | } |
|
256 | ||
257 | /** |
|
258 | * The object upon which the action is carried out, whose state is kept |
|
259 | * intact or changed. Also known as the semantic roles patient, affected or |
|
260 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
261 | * read *a book*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/object |
|
268 | */ |
|
269 | public function object($object) |
|
270 | { |
|
271 | return $this->setProperty('object', $object); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Other co-agents that participated in the action indirectly. e.g. John |
|
276 | * wrote a book with *Steve*. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/participant |
|
283 | */ |
|
284 | public function participant($participant) |
|
285 | { |
|
286 | return $this->setProperty('participant', $participant); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * Indicates a potential Action, which describes an idealized action in |
|
291 | * which this thing would play an 'object' role. |
|
292 | * |
|
293 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
294 | * |
|
295 | * @return static |
|
296 | * |
|
297 | * @see http://schema.org/potentialAction |
|
298 | */ |
|
299 | public function potentialAction($potentialAction) |
|
300 | { |
|
301 | return $this->setProperty('potentialAction', $potentialAction); |
|
302 | } |
|
303 | ||
304 | /** |
|
305 | * The result produced in the action. e.g. John wrote *a book*. |
|
306 | * |
|
307 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
308 | * |
|
309 | * @return static |
|
310 | * |
|
311 | * @see http://schema.org/result |
|
312 | */ |
|
313 | public function result($result) |
|
314 | { |
|
315 | return $this->setProperty('result', $result); |
|
316 | } |
|
317 | ||
318 | /** |
|
319 | * URL of a reference Web page that unambiguously indicates the item's |
|
320 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
321 | * official website. |
|
322 | * |
|
323 | * @param string|string[] $sameAs |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/sameAs |
|
328 | */ |
|
329 | public function sameAs($sameAs) |
|
330 | { |
|
331 | return $this->setProperty('sameAs', $sameAs); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * The startTime of something. For a reserved event or service (e.g. |
|
336 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
337 | * actions that span a period of time, when the action was performed. e.g. |
|
338 | * John wrote a book from *January* to December. For media, including audio |
|
339 | * and video, it's the time offset of the start of a clip within a larger |
|
340 | * file. |
|
341 | * |
|
342 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
343 | * when describing dates with times. This situation may be clarified in |
|
344 | * future revisions. |
|
345 | * |
|
346 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
347 | * |
|
348 | * @return static |
|
349 | * |
|
350 | * @see http://schema.org/startTime |
|
351 | */ |
|
352 | public function startTime($startTime) |
|
353 | { |
|
354 | return $this->setProperty('startTime', $startTime); |
|
355 | } |
|
356 | ||
357 | /** |
|
358 | * A CreativeWork or Event about this Thing. |
|
359 | * |
|
360 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
361 | * |
|
362 | * @return static |
|
363 | * |
|
364 | * @see http://schema.org/subjectOf |
|
365 | */ |
|
366 | public function subjectOf($subjectOf) |
|
367 | { |
|
368 | return $this->setProperty('subjectOf', $subjectOf); |
|
369 | } |
|
370 | ||
371 | /** |
|
372 | * Indicates a target EntryPoint for an Action. |
|
373 | * |
|
374 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
375 | * |
|
376 | * @return static |
|
377 | * |
|
378 | * @see http://schema.org/target |
|
379 | */ |
|
380 | public function target($target) |
|
381 | { |
|
382 | return $this->setProperty('target', $target); |
|
383 | } |
|
384 | ||
385 | /** |
|
386 | * A sub property of object. The collection target of the action. |
|
387 | * |
|
388 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $targetCollection |
|
389 | * |
|
390 | * @return static |
|
391 | * |
|
392 | * @see http://schema.org/targetCollection |
|
393 | */ |
|
394 | public function targetCollection($targetCollection) |
|
395 | { |
|
396 | return $this->setProperty('targetCollection', $targetCollection); |
|
397 | } |
|
398 | ||
399 | /** |
|
400 | * A sub property of location. The final location of the object or the agent |
|
401 | * after the action. |
|
402 | * |
|
403 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/toLocation |
|
408 | */ |
|
409 | public function toLocation($toLocation) |
|
410 | { |
|
411 | return $this->setProperty('toLocation', $toLocation); |
|
412 | } |
|
413 | ||
414 | /** |
|
415 | * URL of the item. |
|
416 | * |
|
417 | * @param string|string[] $url |
|
418 | * |
|
419 | * @return static |
|
420 | * |
|
421 | * @see http://schema.org/url |
|
422 | */ |
|
423 | public function url($url) |
|
424 | { |
|
425 | return $this->setProperty('url', $url); |
|
426 | } |
|
427 | ||
428 | } |
|
429 |
@@ 17-414 (lines=398) @@ | ||
14 | * @see http://schema.org/ArriveAction |
|
15 | * |
|
16 | */ |
|
17 | class ArriveAction extends BaseType implements ArriveActionContract, ActionContract, MoveActionContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * For failed actions, more information on the cause of the failure. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/error |
|
143 | */ |
|
144 | public function error($error) |
|
145 | { |
|
146 | return $this->setProperty('error', $error); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * A sub property of location. The original location of the object or the |
|
151 | * agent before the action. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/fromLocation |
|
158 | */ |
|
159 | public function fromLocation($fromLocation) |
|
160 | { |
|
161 | return $this->setProperty('fromLocation', $fromLocation); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * The identifier property represents any kind of identifier for any kind of |
|
166 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
167 | * dedicated properties for representing many of these, either as textual |
|
168 | * strings or as URL (URI) links. See [background |
|
169 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/identifier |
|
176 | */ |
|
177 | public function identifier($identifier) |
|
178 | { |
|
179 | return $this->setProperty('identifier', $identifier); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * An image of the item. This can be a [[URL]] or a fully described |
|
184 | * [[ImageObject]]. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/image |
|
191 | */ |
|
192 | public function image($image) |
|
193 | { |
|
194 | return $this->setProperty('image', $image); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The object that helped the agent perform the action. e.g. John wrote a |
|
199 | * book with *a pen*. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/instrument |
|
206 | */ |
|
207 | public function instrument($instrument) |
|
208 | { |
|
209 | return $this->setProperty('instrument', $instrument); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * The location of for example where the event is happening, an organization |
|
214 | * is located, or where an action takes place. |
|
215 | * |
|
216 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
217 | * |
|
218 | * @return static |
|
219 | * |
|
220 | * @see http://schema.org/location |
|
221 | */ |
|
222 | public function location($location) |
|
223 | { |
|
224 | return $this->setProperty('location', $location); |
|
225 | } |
|
226 | ||
227 | /** |
|
228 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
229 | * entity being described. See [background |
|
230 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/mainEntityOfPage |
|
237 | */ |
|
238 | public function mainEntityOfPage($mainEntityOfPage) |
|
239 | { |
|
240 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * The name of the item. |
|
245 | * |
|
246 | * @param string|string[] $name |
|
247 | * |
|
248 | * @return static |
|
249 | * |
|
250 | * @see http://schema.org/name |
|
251 | */ |
|
252 | public function name($name) |
|
253 | { |
|
254 | return $this->setProperty('name', $name); |
|
255 | } |
|
256 | ||
257 | /** |
|
258 | * The object upon which the action is carried out, whose state is kept |
|
259 | * intact or changed. Also known as the semantic roles patient, affected or |
|
260 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
261 | * read *a book*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/object |
|
268 | */ |
|
269 | public function object($object) |
|
270 | { |
|
271 | return $this->setProperty('object', $object); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Other co-agents that participated in the action indirectly. e.g. John |
|
276 | * wrote a book with *Steve*. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/participant |
|
283 | */ |
|
284 | public function participant($participant) |
|
285 | { |
|
286 | return $this->setProperty('participant', $participant); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * Indicates a potential Action, which describes an idealized action in |
|
291 | * which this thing would play an 'object' role. |
|
292 | * |
|
293 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
294 | * |
|
295 | * @return static |
|
296 | * |
|
297 | * @see http://schema.org/potentialAction |
|
298 | */ |
|
299 | public function potentialAction($potentialAction) |
|
300 | { |
|
301 | return $this->setProperty('potentialAction', $potentialAction); |
|
302 | } |
|
303 | ||
304 | /** |
|
305 | * The result produced in the action. e.g. John wrote *a book*. |
|
306 | * |
|
307 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
308 | * |
|
309 | * @return static |
|
310 | * |
|
311 | * @see http://schema.org/result |
|
312 | */ |
|
313 | public function result($result) |
|
314 | { |
|
315 | return $this->setProperty('result', $result); |
|
316 | } |
|
317 | ||
318 | /** |
|
319 | * URL of a reference Web page that unambiguously indicates the item's |
|
320 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
321 | * official website. |
|
322 | * |
|
323 | * @param string|string[] $sameAs |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/sameAs |
|
328 | */ |
|
329 | public function sameAs($sameAs) |
|
330 | { |
|
331 | return $this->setProperty('sameAs', $sameAs); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * The startTime of something. For a reserved event or service (e.g. |
|
336 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
337 | * actions that span a period of time, when the action was performed. e.g. |
|
338 | * John wrote a book from *January* to December. For media, including audio |
|
339 | * and video, it's the time offset of the start of a clip within a larger |
|
340 | * file. |
|
341 | * |
|
342 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
343 | * when describing dates with times. This situation may be clarified in |
|
344 | * future revisions. |
|
345 | * |
|
346 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
347 | * |
|
348 | * @return static |
|
349 | * |
|
350 | * @see http://schema.org/startTime |
|
351 | */ |
|
352 | public function startTime($startTime) |
|
353 | { |
|
354 | return $this->setProperty('startTime', $startTime); |
|
355 | } |
|
356 | ||
357 | /** |
|
358 | * A CreativeWork or Event about this Thing. |
|
359 | * |
|
360 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
361 | * |
|
362 | * @return static |
|
363 | * |
|
364 | * @see http://schema.org/subjectOf |
|
365 | */ |
|
366 | public function subjectOf($subjectOf) |
|
367 | { |
|
368 | return $this->setProperty('subjectOf', $subjectOf); |
|
369 | } |
|
370 | ||
371 | /** |
|
372 | * Indicates a target EntryPoint for an Action. |
|
373 | * |
|
374 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
375 | * |
|
376 | * @return static |
|
377 | * |
|
378 | * @see http://schema.org/target |
|
379 | */ |
|
380 | public function target($target) |
|
381 | { |
|
382 | return $this->setProperty('target', $target); |
|
383 | } |
|
384 | ||
385 | /** |
|
386 | * A sub property of location. The final location of the object or the agent |
|
387 | * after the action. |
|
388 | * |
|
389 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/toLocation |
|
394 | */ |
|
395 | public function toLocation($toLocation) |
|
396 | { |
|
397 | return $this->setProperty('toLocation', $toLocation); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * URL of the item. |
|
402 | * |
|
403 | * @param string|string[] $url |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/url |
|
408 | */ |
|
409 | public function url($url) |
|
410 | { |
|
411 | return $this->setProperty('url', $url); |
|
412 | } |
|
413 | ||
414 | } |
|
415 |
@@ 17-399 (lines=383) @@ | ||
14 | * @see http://schema.org/AuthorizeAction |
|
15 | * |
|
16 | */ |
|
17 | class AuthorizeAction extends BaseType implements AuthorizeActionContract, ActionContract, AllocateActionContract, OrganizeActionContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * For failed actions, more information on the cause of the failure. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/error |
|
143 | */ |
|
144 | public function error($error) |
|
145 | { |
|
146 | return $this->setProperty('error', $error); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * The identifier property represents any kind of identifier for any kind of |
|
151 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
152 | * dedicated properties for representing many of these, either as textual |
|
153 | * strings or as URL (URI) links. See [background |
|
154 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
155 | * |
|
156 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
157 | * |
|
158 | * @return static |
|
159 | * |
|
160 | * @see http://schema.org/identifier |
|
161 | */ |
|
162 | public function identifier($identifier) |
|
163 | { |
|
164 | return $this->setProperty('identifier', $identifier); |
|
165 | } |
|
166 | ||
167 | /** |
|
168 | * An image of the item. This can be a [[URL]] or a fully described |
|
169 | * [[ImageObject]]. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/image |
|
176 | */ |
|
177 | public function image($image) |
|
178 | { |
|
179 | return $this->setProperty('image', $image); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * The object that helped the agent perform the action. e.g. John wrote a |
|
184 | * book with *a pen*. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/instrument |
|
191 | */ |
|
192 | public function instrument($instrument) |
|
193 | { |
|
194 | return $this->setProperty('instrument', $instrument); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The location of for example where the event is happening, an organization |
|
199 | * is located, or where an action takes place. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/location |
|
206 | */ |
|
207 | public function location($location) |
|
208 | { |
|
209 | return $this->setProperty('location', $location); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
214 | * entity being described. See [background |
|
215 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/mainEntityOfPage |
|
222 | */ |
|
223 | public function mainEntityOfPage($mainEntityOfPage) |
|
224 | { |
|
225 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The name of the item. |
|
230 | * |
|
231 | * @param string|string[] $name |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/name |
|
236 | */ |
|
237 | public function name($name) |
|
238 | { |
|
239 | return $this->setProperty('name', $name); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The object upon which the action is carried out, whose state is kept |
|
244 | * intact or changed. Also known as the semantic roles patient, affected or |
|
245 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
246 | * read *a book*. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/object |
|
253 | */ |
|
254 | public function object($object) |
|
255 | { |
|
256 | return $this->setProperty('object', $object); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * Other co-agents that participated in the action indirectly. e.g. John |
|
261 | * wrote a book with *Steve*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/participant |
|
268 | */ |
|
269 | public function participant($participant) |
|
270 | { |
|
271 | return $this->setProperty('participant', $participant); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Indicates a potential Action, which describes an idealized action in |
|
276 | * which this thing would play an 'object' role. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/potentialAction |
|
283 | */ |
|
284 | public function potentialAction($potentialAction) |
|
285 | { |
|
286 | return $this->setProperty('potentialAction', $potentialAction); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * A sub property of participant. The participant who is at the receiving |
|
291 | * end of the action. |
|
292 | * |
|
293 | * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[]|\Spatie\SchemaOrg\Contracts\ContactPointContract|\Spatie\SchemaOrg\Contracts\ContactPointContract[]|\Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $recipient |
|
294 | * |
|
295 | * @return static |
|
296 | * |
|
297 | * @see http://schema.org/recipient |
|
298 | */ |
|
299 | public function recipient($recipient) |
|
300 | { |
|
301 | return $this->setProperty('recipient', $recipient); |
|
302 | } |
|
303 | ||
304 | /** |
|
305 | * The result produced in the action. e.g. John wrote *a book*. |
|
306 | * |
|
307 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
308 | * |
|
309 | * @return static |
|
310 | * |
|
311 | * @see http://schema.org/result |
|
312 | */ |
|
313 | public function result($result) |
|
314 | { |
|
315 | return $this->setProperty('result', $result); |
|
316 | } |
|
317 | ||
318 | /** |
|
319 | * URL of a reference Web page that unambiguously indicates the item's |
|
320 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
321 | * official website. |
|
322 | * |
|
323 | * @param string|string[] $sameAs |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/sameAs |
|
328 | */ |
|
329 | public function sameAs($sameAs) |
|
330 | { |
|
331 | return $this->setProperty('sameAs', $sameAs); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * The startTime of something. For a reserved event or service (e.g. |
|
336 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
337 | * actions that span a period of time, when the action was performed. e.g. |
|
338 | * John wrote a book from *January* to December. For media, including audio |
|
339 | * and video, it's the time offset of the start of a clip within a larger |
|
340 | * file. |
|
341 | * |
|
342 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
343 | * when describing dates with times. This situation may be clarified in |
|
344 | * future revisions. |
|
345 | * |
|
346 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
347 | * |
|
348 | * @return static |
|
349 | * |
|
350 | * @see http://schema.org/startTime |
|
351 | */ |
|
352 | public function startTime($startTime) |
|
353 | { |
|
354 | return $this->setProperty('startTime', $startTime); |
|
355 | } |
|
356 | ||
357 | /** |
|
358 | * A CreativeWork or Event about this Thing. |
|
359 | * |
|
360 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
361 | * |
|
362 | * @return static |
|
363 | * |
|
364 | * @see http://schema.org/subjectOf |
|
365 | */ |
|
366 | public function subjectOf($subjectOf) |
|
367 | { |
|
368 | return $this->setProperty('subjectOf', $subjectOf); |
|
369 | } |
|
370 | ||
371 | /** |
|
372 | * Indicates a target EntryPoint for an Action. |
|
373 | * |
|
374 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
375 | * |
|
376 | * @return static |
|
377 | * |
|
378 | * @see http://schema.org/target |
|
379 | */ |
|
380 | public function target($target) |
|
381 | { |
|
382 | return $this->setProperty('target', $target); |
|
383 | } |
|
384 | ||
385 | /** |
|
386 | * URL of the item. |
|
387 | * |
|
388 | * @param string|string[] $url |
|
389 | * |
|
390 | * @return static |
|
391 | * |
|
392 | * @see http://schema.org/url |
|
393 | */ |
|
394 | public function url($url) |
|
395 | { |
|
396 | return $this->setProperty('url', $url); |
|
397 | } |
|
398 | ||
399 | } |
|
400 |
@@ 21-433 (lines=413) @@ | ||
18 | * @see http://schema.org/BorrowAction |
|
19 | * |
|
20 | */ |
|
21 | class BorrowAction extends BaseType implements BorrowActionContract, ActionContract, ThingContract, TransferActionContract |
|
22 | { |
|
23 | /** |
|
24 | * Indicates the current disposition of the Action. |
|
25 | * |
|
26 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
27 | * |
|
28 | * @return static |
|
29 | * |
|
30 | * @see http://schema.org/actionStatus |
|
31 | */ |
|
32 | public function actionStatus($actionStatus) |
|
33 | { |
|
34 | return $this->setProperty('actionStatus', $actionStatus); |
|
35 | } |
|
36 | ||
37 | /** |
|
38 | * An additional type for the item, typically used for adding more specific |
|
39 | * types from external vocabularies in microdata syntax. This is a |
|
40 | * relationship between something and a class that the thing is in. In RDFa |
|
41 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
42 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
43 | * understanding of extra types, in particular those defined externally. |
|
44 | * |
|
45 | * @param string|string[] $additionalType |
|
46 | * |
|
47 | * @return static |
|
48 | * |
|
49 | * @see http://schema.org/additionalType |
|
50 | */ |
|
51 | public function additionalType($additionalType) |
|
52 | { |
|
53 | return $this->setProperty('additionalType', $additionalType); |
|
54 | } |
|
55 | ||
56 | /** |
|
57 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
58 | * *John* wrote a book. |
|
59 | * |
|
60 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
61 | * |
|
62 | * @return static |
|
63 | * |
|
64 | * @see http://schema.org/agent |
|
65 | */ |
|
66 | public function agent($agent) |
|
67 | { |
|
68 | return $this->setProperty('agent', $agent); |
|
69 | } |
|
70 | ||
71 | /** |
|
72 | * An alias for the item. |
|
73 | * |
|
74 | * @param string|string[] $alternateName |
|
75 | * |
|
76 | * @return static |
|
77 | * |
|
78 | * @see http://schema.org/alternateName |
|
79 | */ |
|
80 | public function alternateName($alternateName) |
|
81 | { |
|
82 | return $this->setProperty('alternateName', $alternateName); |
|
83 | } |
|
84 | ||
85 | /** |
|
86 | * A description of the item. |
|
87 | * |
|
88 | * @param string|string[] $description |
|
89 | * |
|
90 | * @return static |
|
91 | * |
|
92 | * @see http://schema.org/description |
|
93 | */ |
|
94 | public function description($description) |
|
95 | { |
|
96 | return $this->setProperty('description', $description); |
|
97 | } |
|
98 | ||
99 | /** |
|
100 | * A sub property of description. A short description of the item used to |
|
101 | * disambiguate from other, similar items. Information from other properties |
|
102 | * (in particular, name) may be necessary for the description to be useful |
|
103 | * for disambiguation. |
|
104 | * |
|
105 | * @param string|string[] $disambiguatingDescription |
|
106 | * |
|
107 | * @return static |
|
108 | * |
|
109 | * @see http://schema.org/disambiguatingDescription |
|
110 | */ |
|
111 | public function disambiguatingDescription($disambiguatingDescription) |
|
112 | { |
|
113 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
114 | } |
|
115 | ||
116 | /** |
|
117 | * The endTime of something. For a reserved event or service (e.g. |
|
118 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
119 | * actions that span a period of time, when the action was performed. e.g. |
|
120 | * John wrote a book from January to *December*. For media, including audio |
|
121 | * and video, it's the time offset of the end of a clip within a larger |
|
122 | * file. |
|
123 | * |
|
124 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
125 | * when describing dates with times. This situation may be clarified in |
|
126 | * future revisions. |
|
127 | * |
|
128 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
129 | * |
|
130 | * @return static |
|
131 | * |
|
132 | * @see http://schema.org/endTime |
|
133 | */ |
|
134 | public function endTime($endTime) |
|
135 | { |
|
136 | return $this->setProperty('endTime', $endTime); |
|
137 | } |
|
138 | ||
139 | /** |
|
140 | * For failed actions, more information on the cause of the failure. |
|
141 | * |
|
142 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
143 | * |
|
144 | * @return static |
|
145 | * |
|
146 | * @see http://schema.org/error |
|
147 | */ |
|
148 | public function error($error) |
|
149 | { |
|
150 | return $this->setProperty('error', $error); |
|
151 | } |
|
152 | ||
153 | /** |
|
154 | * A sub property of location. The original location of the object or the |
|
155 | * agent before the action. |
|
156 | * |
|
157 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
158 | * |
|
159 | * @return static |
|
160 | * |
|
161 | * @see http://schema.org/fromLocation |
|
162 | */ |
|
163 | public function fromLocation($fromLocation) |
|
164 | { |
|
165 | return $this->setProperty('fromLocation', $fromLocation); |
|
166 | } |
|
167 | ||
168 | /** |
|
169 | * The identifier property represents any kind of identifier for any kind of |
|
170 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
171 | * dedicated properties for representing many of these, either as textual |
|
172 | * strings or as URL (URI) links. See [background |
|
173 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
174 | * |
|
175 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
176 | * |
|
177 | * @return static |
|
178 | * |
|
179 | * @see http://schema.org/identifier |
|
180 | */ |
|
181 | public function identifier($identifier) |
|
182 | { |
|
183 | return $this->setProperty('identifier', $identifier); |
|
184 | } |
|
185 | ||
186 | /** |
|
187 | * An image of the item. This can be a [[URL]] or a fully described |
|
188 | * [[ImageObject]]. |
|
189 | * |
|
190 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
191 | * |
|
192 | * @return static |
|
193 | * |
|
194 | * @see http://schema.org/image |
|
195 | */ |
|
196 | public function image($image) |
|
197 | { |
|
198 | return $this->setProperty('image', $image); |
|
199 | } |
|
200 | ||
201 | /** |
|
202 | * The object that helped the agent perform the action. e.g. John wrote a |
|
203 | * book with *a pen*. |
|
204 | * |
|
205 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
206 | * |
|
207 | * @return static |
|
208 | * |
|
209 | * @see http://schema.org/instrument |
|
210 | */ |
|
211 | public function instrument($instrument) |
|
212 | { |
|
213 | return $this->setProperty('instrument', $instrument); |
|
214 | } |
|
215 | ||
216 | /** |
|
217 | * A sub property of participant. The person that lends the object being |
|
218 | * borrowed. |
|
219 | * |
|
220 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $lender |
|
221 | * |
|
222 | * @return static |
|
223 | * |
|
224 | * @see http://schema.org/lender |
|
225 | */ |
|
226 | public function lender($lender) |
|
227 | { |
|
228 | return $this->setProperty('lender', $lender); |
|
229 | } |
|
230 | ||
231 | /** |
|
232 | * The location of for example where the event is happening, an organization |
|
233 | * is located, or where an action takes place. |
|
234 | * |
|
235 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
236 | * |
|
237 | * @return static |
|
238 | * |
|
239 | * @see http://schema.org/location |
|
240 | */ |
|
241 | public function location($location) |
|
242 | { |
|
243 | return $this->setProperty('location', $location); |
|
244 | } |
|
245 | ||
246 | /** |
|
247 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
248 | * entity being described. See [background |
|
249 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
250 | * |
|
251 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
252 | * |
|
253 | * @return static |
|
254 | * |
|
255 | * @see http://schema.org/mainEntityOfPage |
|
256 | */ |
|
257 | public function mainEntityOfPage($mainEntityOfPage) |
|
258 | { |
|
259 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
260 | } |
|
261 | ||
262 | /** |
|
263 | * The name of the item. |
|
264 | * |
|
265 | * @param string|string[] $name |
|
266 | * |
|
267 | * @return static |
|
268 | * |
|
269 | * @see http://schema.org/name |
|
270 | */ |
|
271 | public function name($name) |
|
272 | { |
|
273 | return $this->setProperty('name', $name); |
|
274 | } |
|
275 | ||
276 | /** |
|
277 | * The object upon which the action is carried out, whose state is kept |
|
278 | * intact or changed. Also known as the semantic roles patient, affected or |
|
279 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
280 | * read *a book*. |
|
281 | * |
|
282 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
283 | * |
|
284 | * @return static |
|
285 | * |
|
286 | * @see http://schema.org/object |
|
287 | */ |
|
288 | public function object($object) |
|
289 | { |
|
290 | return $this->setProperty('object', $object); |
|
291 | } |
|
292 | ||
293 | /** |
|
294 | * Other co-agents that participated in the action indirectly. e.g. John |
|
295 | * wrote a book with *Steve*. |
|
296 | * |
|
297 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
298 | * |
|
299 | * @return static |
|
300 | * |
|
301 | * @see http://schema.org/participant |
|
302 | */ |
|
303 | public function participant($participant) |
|
304 | { |
|
305 | return $this->setProperty('participant', $participant); |
|
306 | } |
|
307 | ||
308 | /** |
|
309 | * Indicates a potential Action, which describes an idealized action in |
|
310 | * which this thing would play an 'object' role. |
|
311 | * |
|
312 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
313 | * |
|
314 | * @return static |
|
315 | * |
|
316 | * @see http://schema.org/potentialAction |
|
317 | */ |
|
318 | public function potentialAction($potentialAction) |
|
319 | { |
|
320 | return $this->setProperty('potentialAction', $potentialAction); |
|
321 | } |
|
322 | ||
323 | /** |
|
324 | * The result produced in the action. e.g. John wrote *a book*. |
|
325 | * |
|
326 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
327 | * |
|
328 | * @return static |
|
329 | * |
|
330 | * @see http://schema.org/result |
|
331 | */ |
|
332 | public function result($result) |
|
333 | { |
|
334 | return $this->setProperty('result', $result); |
|
335 | } |
|
336 | ||
337 | /** |
|
338 | * URL of a reference Web page that unambiguously indicates the item's |
|
339 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
340 | * official website. |
|
341 | * |
|
342 | * @param string|string[] $sameAs |
|
343 | * |
|
344 | * @return static |
|
345 | * |
|
346 | * @see http://schema.org/sameAs |
|
347 | */ |
|
348 | public function sameAs($sameAs) |
|
349 | { |
|
350 | return $this->setProperty('sameAs', $sameAs); |
|
351 | } |
|
352 | ||
353 | /** |
|
354 | * The startTime of something. For a reserved event or service (e.g. |
|
355 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
356 | * actions that span a period of time, when the action was performed. e.g. |
|
357 | * John wrote a book from *January* to December. For media, including audio |
|
358 | * and video, it's the time offset of the start of a clip within a larger |
|
359 | * file. |
|
360 | * |
|
361 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
362 | * when describing dates with times. This situation may be clarified in |
|
363 | * future revisions. |
|
364 | * |
|
365 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
366 | * |
|
367 | * @return static |
|
368 | * |
|
369 | * @see http://schema.org/startTime |
|
370 | */ |
|
371 | public function startTime($startTime) |
|
372 | { |
|
373 | return $this->setProperty('startTime', $startTime); |
|
374 | } |
|
375 | ||
376 | /** |
|
377 | * A CreativeWork or Event about this Thing. |
|
378 | * |
|
379 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
380 | * |
|
381 | * @return static |
|
382 | * |
|
383 | * @see http://schema.org/subjectOf |
|
384 | */ |
|
385 | public function subjectOf($subjectOf) |
|
386 | { |
|
387 | return $this->setProperty('subjectOf', $subjectOf); |
|
388 | } |
|
389 | ||
390 | /** |
|
391 | * Indicates a target EntryPoint for an Action. |
|
392 | * |
|
393 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
394 | * |
|
395 | * @return static |
|
396 | * |
|
397 | * @see http://schema.org/target |
|
398 | */ |
|
399 | public function target($target) |
|
400 | { |
|
401 | return $this->setProperty('target', $target); |
|
402 | } |
|
403 | ||
404 | /** |
|
405 | * A sub property of location. The final location of the object or the agent |
|
406 | * after the action. |
|
407 | * |
|
408 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
409 | * |
|
410 | * @return static |
|
411 | * |
|
412 | * @see http://schema.org/toLocation |
|
413 | */ |
|
414 | public function toLocation($toLocation) |
|
415 | { |
|
416 | return $this->setProperty('toLocation', $toLocation); |
|
417 | } |
|
418 | ||
419 | /** |
|
420 | * URL of the item. |
|
421 | * |
|
422 | * @param string|string[] $url |
|
423 | * |
|
424 | * @return static |
|
425 | * |
|
426 | * @see http://schema.org/url |
|
427 | */ |
|
428 | public function url($url) |
|
429 | { |
|
430 | return $this->setProperty('url', $url); |
|
431 | } |
|
432 | ||
433 | } |
|
434 |
@@ 20-414 (lines=395) @@ | ||
17 | * @see http://schema.org/BusReservation |
|
18 | * |
|
19 | */ |
|
20 | class BusReservation extends BaseType implements BusReservationContract, IntangibleContract, ReservationContract, ThingContract |
|
21 | { |
|
22 | /** |
|
23 | * An additional type for the item, typically used for adding more specific |
|
24 | * types from external vocabularies in microdata syntax. This is a |
|
25 | * relationship between something and a class that the thing is in. In RDFa |
|
26 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
27 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
28 | * understanding of extra types, in particular those defined externally. |
|
29 | * |
|
30 | * @param string|string[] $additionalType |
|
31 | * |
|
32 | * @return static |
|
33 | * |
|
34 | * @see http://schema.org/additionalType |
|
35 | */ |
|
36 | public function additionalType($additionalType) |
|
37 | { |
|
38 | return $this->setProperty('additionalType', $additionalType); |
|
39 | } |
|
40 | ||
41 | /** |
|
42 | * An alias for the item. |
|
43 | * |
|
44 | * @param string|string[] $alternateName |
|
45 | * |
|
46 | * @return static |
|
47 | * |
|
48 | * @see http://schema.org/alternateName |
|
49 | */ |
|
50 | public function alternateName($alternateName) |
|
51 | { |
|
52 | return $this->setProperty('alternateName', $alternateName); |
|
53 | } |
|
54 | ||
55 | /** |
|
56 | * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as |
|
57 | * a booking agent. |
|
58 | * |
|
59 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $bookingAgent |
|
60 | * |
|
61 | * @return static |
|
62 | * |
|
63 | * @see http://schema.org/bookingAgent |
|
64 | */ |
|
65 | public function bookingAgent($bookingAgent) |
|
66 | { |
|
67 | return $this->setProperty('bookingAgent', $bookingAgent); |
|
68 | } |
|
69 | ||
70 | /** |
|
71 | * The date and time the reservation was booked. |
|
72 | * |
|
73 | * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime |
|
74 | * |
|
75 | * @return static |
|
76 | * |
|
77 | * @see http://schema.org/bookingTime |
|
78 | */ |
|
79 | public function bookingTime($bookingTime) |
|
80 | { |
|
81 | return $this->setProperty('bookingTime', $bookingTime); |
|
82 | } |
|
83 | ||
84 | /** |
|
85 | * An entity that arranges for an exchange between a buyer and a seller. In |
|
86 | * most cases a broker never acquires or releases ownership of a product or |
|
87 | * service involved in an exchange. If it is not clear whether an entity is |
|
88 | * a broker, seller, or buyer, the latter two terms are preferred. |
|
89 | * |
|
90 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $broker |
|
91 | * |
|
92 | * @return static |
|
93 | * |
|
94 | * @see http://schema.org/broker |
|
95 | */ |
|
96 | public function broker($broker) |
|
97 | { |
|
98 | return $this->setProperty('broker', $broker); |
|
99 | } |
|
100 | ||
101 | /** |
|
102 | * A description of the item. |
|
103 | * |
|
104 | * @param string|string[] $description |
|
105 | * |
|
106 | * @return static |
|
107 | * |
|
108 | * @see http://schema.org/description |
|
109 | */ |
|
110 | public function description($description) |
|
111 | { |
|
112 | return $this->setProperty('description', $description); |
|
113 | } |
|
114 | ||
115 | /** |
|
116 | * A sub property of description. A short description of the item used to |
|
117 | * disambiguate from other, similar items. Information from other properties |
|
118 | * (in particular, name) may be necessary for the description to be useful |
|
119 | * for disambiguation. |
|
120 | * |
|
121 | * @param string|string[] $disambiguatingDescription |
|
122 | * |
|
123 | * @return static |
|
124 | * |
|
125 | * @see http://schema.org/disambiguatingDescription |
|
126 | */ |
|
127 | public function disambiguatingDescription($disambiguatingDescription) |
|
128 | { |
|
129 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
130 | } |
|
131 | ||
132 | /** |
|
133 | * The identifier property represents any kind of identifier for any kind of |
|
134 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
135 | * dedicated properties for representing many of these, either as textual |
|
136 | * strings or as URL (URI) links. See [background |
|
137 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
138 | * |
|
139 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/identifier |
|
144 | */ |
|
145 | public function identifier($identifier) |
|
146 | { |
|
147 | return $this->setProperty('identifier', $identifier); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * An image of the item. This can be a [[URL]] or a fully described |
|
152 | * [[ImageObject]]. |
|
153 | * |
|
154 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
155 | * |
|
156 | * @return static |
|
157 | * |
|
158 | * @see http://schema.org/image |
|
159 | */ |
|
160 | public function image($image) |
|
161 | { |
|
162 | return $this->setProperty('image', $image); |
|
163 | } |
|
164 | ||
165 | /** |
|
166 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
167 | * entity being described. See [background |
|
168 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/mainEntityOfPage |
|
175 | */ |
|
176 | public function mainEntityOfPage($mainEntityOfPage) |
|
177 | { |
|
178 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * The date and time the reservation was modified. |
|
183 | * |
|
184 | * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime |
|
185 | * |
|
186 | * @return static |
|
187 | * |
|
188 | * @see http://schema.org/modifiedTime |
|
189 | */ |
|
190 | public function modifiedTime($modifiedTime) |
|
191 | { |
|
192 | return $this->setProperty('modifiedTime', $modifiedTime); |
|
193 | } |
|
194 | ||
195 | /** |
|
196 | * The name of the item. |
|
197 | * |
|
198 | * @param string|string[] $name |
|
199 | * |
|
200 | * @return static |
|
201 | * |
|
202 | * @see http://schema.org/name |
|
203 | */ |
|
204 | public function name($name) |
|
205 | { |
|
206 | return $this->setProperty('name', $name); |
|
207 | } |
|
208 | ||
209 | /** |
|
210 | * Indicates a potential Action, which describes an idealized action in |
|
211 | * which this thing would play an 'object' role. |
|
212 | * |
|
213 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
214 | * |
|
215 | * @return static |
|
216 | * |
|
217 | * @see http://schema.org/potentialAction |
|
218 | */ |
|
219 | public function potentialAction($potentialAction) |
|
220 | { |
|
221 | return $this->setProperty('potentialAction', $potentialAction); |
|
222 | } |
|
223 | ||
224 | /** |
|
225 | * The currency of the price, or a price component when attached to |
|
226 | * [[PriceSpecification]] and its subtypes. |
|
227 | * |
|
228 | * Use standard formats: [ISO 4217 currency |
|
229 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
230 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
231 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
232 | * Tradings |
|
233 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
234 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
235 | * |
|
236 | * @param string|string[] $priceCurrency |
|
237 | * |
|
238 | * @return static |
|
239 | * |
|
240 | * @see http://schema.org/priceCurrency |
|
241 | */ |
|
242 | public function priceCurrency($priceCurrency) |
|
243 | { |
|
244 | return $this->setProperty('priceCurrency', $priceCurrency); |
|
245 | } |
|
246 | ||
247 | /** |
|
248 | * Any membership in a frequent flyer, hotel loyalty program, etc. being |
|
249 | * applied to the reservation. |
|
250 | * |
|
251 | * @param \Spatie\SchemaOrg\Contracts\ProgramMembershipContract|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract[] $programMembershipUsed |
|
252 | * |
|
253 | * @return static |
|
254 | * |
|
255 | * @see http://schema.org/programMembershipUsed |
|
256 | */ |
|
257 | public function programMembershipUsed($programMembershipUsed) |
|
258 | { |
|
259 | return $this->setProperty('programMembershipUsed', $programMembershipUsed); |
|
260 | } |
|
261 | ||
262 | /** |
|
263 | * The service provider, service operator, or service performer; the goods |
|
264 | * producer. Another party (a seller) may offer those services or goods on |
|
265 | * behalf of the provider. A provider may also serve as the seller. |
|
266 | * |
|
267 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider |
|
268 | * |
|
269 | * @return static |
|
270 | * |
|
271 | * @see http://schema.org/provider |
|
272 | */ |
|
273 | public function provider($provider) |
|
274 | { |
|
275 | return $this->setProperty('provider', $provider); |
|
276 | } |
|
277 | ||
278 | /** |
|
279 | * The thing -- flight, event, restaurant,etc. being reserved. |
|
280 | * |
|
281 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $reservationFor |
|
282 | * |
|
283 | * @return static |
|
284 | * |
|
285 | * @see http://schema.org/reservationFor |
|
286 | */ |
|
287 | public function reservationFor($reservationFor) |
|
288 | { |
|
289 | return $this->setProperty('reservationFor', $reservationFor); |
|
290 | } |
|
291 | ||
292 | /** |
|
293 | * A unique identifier for the reservation. |
|
294 | * |
|
295 | * @param string|string[] $reservationId |
|
296 | * |
|
297 | * @return static |
|
298 | * |
|
299 | * @see http://schema.org/reservationId |
|
300 | */ |
|
301 | public function reservationId($reservationId) |
|
302 | { |
|
303 | return $this->setProperty('reservationId', $reservationId); |
|
304 | } |
|
305 | ||
306 | /** |
|
307 | * The current status of the reservation. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ReservationStatusTypeContract|\Spatie\SchemaOrg\Contracts\ReservationStatusTypeContract[] $reservationStatus |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/reservationStatus |
|
314 | */ |
|
315 | public function reservationStatus($reservationStatus) |
|
316 | { |
|
317 | return $this->setProperty('reservationStatus', $reservationStatus); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * A ticket associated with the reservation. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\TicketContract|\Spatie\SchemaOrg\Contracts\TicketContract[] $reservedTicket |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/reservedTicket |
|
328 | */ |
|
329 | public function reservedTicket($reservedTicket) |
|
330 | { |
|
331 | return $this->setProperty('reservedTicket', $reservedTicket); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * A CreativeWork or Event about this Thing. |
|
352 | * |
|
353 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
354 | * |
|
355 | * @return static |
|
356 | * |
|
357 | * @see http://schema.org/subjectOf |
|
358 | */ |
|
359 | public function subjectOf($subjectOf) |
|
360 | { |
|
361 | return $this->setProperty('subjectOf', $subjectOf); |
|
362 | } |
|
363 | ||
364 | /** |
|
365 | * The total price for the reservation or ticket, including applicable |
|
366 | * taxes, shipping, etc. |
|
367 | * |
|
368 | * Usage guidelines: |
|
369 | * |
|
370 | * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT |
|
371 | * NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
|
372 | * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a |
|
373 | * decimal point. Avoid using these symbols as a readability separator. |
|
374 | * |
|
375 | * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[]|float|float[]|int|int[]|string|string[] $totalPrice |
|
376 | * |
|
377 | * @return static |
|
378 | * |
|
379 | * @see http://schema.org/totalPrice |
|
380 | */ |
|
381 | public function totalPrice($totalPrice) |
|
382 | { |
|
383 | return $this->setProperty('totalPrice', $totalPrice); |
|
384 | } |
|
385 | ||
386 | /** |
|
387 | * The person or organization the reservation or ticket is for. |
|
388 | * |
|
389 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $underName |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/underName |
|
394 | */ |
|
395 | public function underName($underName) |
|
396 | { |
|
397 | return $this->setProperty('underName', $underName); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * URL of the item. |
|
402 | * |
|
403 | * @param string|string[] $url |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/url |
|
408 | */ |
|
409 | public function url($url) |
|
410 | { |
|
411 | return $this->setProperty('url', $url); |
|
412 | } |
|
413 | ||
414 | } |
|
415 |
@@ 21-402 (lines=382) @@ | ||
18 | * @see http://schema.org/CancelAction |
|
19 | * |
|
20 | */ |
|
21 | class CancelAction extends BaseType implements CancelActionContract, ActionContract, OrganizeActionContract, PlanActionContract, ThingContract |
|
22 | { |
|
23 | /** |
|
24 | * Indicates the current disposition of the Action. |
|
25 | * |
|
26 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
27 | * |
|
28 | * @return static |
|
29 | * |
|
30 | * @see http://schema.org/actionStatus |
|
31 | */ |
|
32 | public function actionStatus($actionStatus) |
|
33 | { |
|
34 | return $this->setProperty('actionStatus', $actionStatus); |
|
35 | } |
|
36 | ||
37 | /** |
|
38 | * An additional type for the item, typically used for adding more specific |
|
39 | * types from external vocabularies in microdata syntax. This is a |
|
40 | * relationship between something and a class that the thing is in. In RDFa |
|
41 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
42 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
43 | * understanding of extra types, in particular those defined externally. |
|
44 | * |
|
45 | * @param string|string[] $additionalType |
|
46 | * |
|
47 | * @return static |
|
48 | * |
|
49 | * @see http://schema.org/additionalType |
|
50 | */ |
|
51 | public function additionalType($additionalType) |
|
52 | { |
|
53 | return $this->setProperty('additionalType', $additionalType); |
|
54 | } |
|
55 | ||
56 | /** |
|
57 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
58 | * *John* wrote a book. |
|
59 | * |
|
60 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
61 | * |
|
62 | * @return static |
|
63 | * |
|
64 | * @see http://schema.org/agent |
|
65 | */ |
|
66 | public function agent($agent) |
|
67 | { |
|
68 | return $this->setProperty('agent', $agent); |
|
69 | } |
|
70 | ||
71 | /** |
|
72 | * An alias for the item. |
|
73 | * |
|
74 | * @param string|string[] $alternateName |
|
75 | * |
|
76 | * @return static |
|
77 | * |
|
78 | * @see http://schema.org/alternateName |
|
79 | */ |
|
80 | public function alternateName($alternateName) |
|
81 | { |
|
82 | return $this->setProperty('alternateName', $alternateName); |
|
83 | } |
|
84 | ||
85 | /** |
|
86 | * A description of the item. |
|
87 | * |
|
88 | * @param string|string[] $description |
|
89 | * |
|
90 | * @return static |
|
91 | * |
|
92 | * @see http://schema.org/description |
|
93 | */ |
|
94 | public function description($description) |
|
95 | { |
|
96 | return $this->setProperty('description', $description); |
|
97 | } |
|
98 | ||
99 | /** |
|
100 | * A sub property of description. A short description of the item used to |
|
101 | * disambiguate from other, similar items. Information from other properties |
|
102 | * (in particular, name) may be necessary for the description to be useful |
|
103 | * for disambiguation. |
|
104 | * |
|
105 | * @param string|string[] $disambiguatingDescription |
|
106 | * |
|
107 | * @return static |
|
108 | * |
|
109 | * @see http://schema.org/disambiguatingDescription |
|
110 | */ |
|
111 | public function disambiguatingDescription($disambiguatingDescription) |
|
112 | { |
|
113 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
114 | } |
|
115 | ||
116 | /** |
|
117 | * The endTime of something. For a reserved event or service (e.g. |
|
118 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
119 | * actions that span a period of time, when the action was performed. e.g. |
|
120 | * John wrote a book from January to *December*. For media, including audio |
|
121 | * and video, it's the time offset of the end of a clip within a larger |
|
122 | * file. |
|
123 | * |
|
124 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
125 | * when describing dates with times. This situation may be clarified in |
|
126 | * future revisions. |
|
127 | * |
|
128 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
129 | * |
|
130 | * @return static |
|
131 | * |
|
132 | * @see http://schema.org/endTime |
|
133 | */ |
|
134 | public function endTime($endTime) |
|
135 | { |
|
136 | return $this->setProperty('endTime', $endTime); |
|
137 | } |
|
138 | ||
139 | /** |
|
140 | * For failed actions, more information on the cause of the failure. |
|
141 | * |
|
142 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
143 | * |
|
144 | * @return static |
|
145 | * |
|
146 | * @see http://schema.org/error |
|
147 | */ |
|
148 | public function error($error) |
|
149 | { |
|
150 | return $this->setProperty('error', $error); |
|
151 | } |
|
152 | ||
153 | /** |
|
154 | * The identifier property represents any kind of identifier for any kind of |
|
155 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
156 | * dedicated properties for representing many of these, either as textual |
|
157 | * strings or as URL (URI) links. See [background |
|
158 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
159 | * |
|
160 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
161 | * |
|
162 | * @return static |
|
163 | * |
|
164 | * @see http://schema.org/identifier |
|
165 | */ |
|
166 | public function identifier($identifier) |
|
167 | { |
|
168 | return $this->setProperty('identifier', $identifier); |
|
169 | } |
|
170 | ||
171 | /** |
|
172 | * An image of the item. This can be a [[URL]] or a fully described |
|
173 | * [[ImageObject]]. |
|
174 | * |
|
175 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
176 | * |
|
177 | * @return static |
|
178 | * |
|
179 | * @see http://schema.org/image |
|
180 | */ |
|
181 | public function image($image) |
|
182 | { |
|
183 | return $this->setProperty('image', $image); |
|
184 | } |
|
185 | ||
186 | /** |
|
187 | * The object that helped the agent perform the action. e.g. John wrote a |
|
188 | * book with *a pen*. |
|
189 | * |
|
190 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
191 | * |
|
192 | * @return static |
|
193 | * |
|
194 | * @see http://schema.org/instrument |
|
195 | */ |
|
196 | public function instrument($instrument) |
|
197 | { |
|
198 | return $this->setProperty('instrument', $instrument); |
|
199 | } |
|
200 | ||
201 | /** |
|
202 | * The location of for example where the event is happening, an organization |
|
203 | * is located, or where an action takes place. |
|
204 | * |
|
205 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
206 | * |
|
207 | * @return static |
|
208 | * |
|
209 | * @see http://schema.org/location |
|
210 | */ |
|
211 | public function location($location) |
|
212 | { |
|
213 | return $this->setProperty('location', $location); |
|
214 | } |
|
215 | ||
216 | /** |
|
217 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
218 | * entity being described. See [background |
|
219 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
220 | * |
|
221 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
222 | * |
|
223 | * @return static |
|
224 | * |
|
225 | * @see http://schema.org/mainEntityOfPage |
|
226 | */ |
|
227 | public function mainEntityOfPage($mainEntityOfPage) |
|
228 | { |
|
229 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
230 | } |
|
231 | ||
232 | /** |
|
233 | * The name of the item. |
|
234 | * |
|
235 | * @param string|string[] $name |
|
236 | * |
|
237 | * @return static |
|
238 | * |
|
239 | * @see http://schema.org/name |
|
240 | */ |
|
241 | public function name($name) |
|
242 | { |
|
243 | return $this->setProperty('name', $name); |
|
244 | } |
|
245 | ||
246 | /** |
|
247 | * The object upon which the action is carried out, whose state is kept |
|
248 | * intact or changed. Also known as the semantic roles patient, affected or |
|
249 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
250 | * read *a book*. |
|
251 | * |
|
252 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
253 | * |
|
254 | * @return static |
|
255 | * |
|
256 | * @see http://schema.org/object |
|
257 | */ |
|
258 | public function object($object) |
|
259 | { |
|
260 | return $this->setProperty('object', $object); |
|
261 | } |
|
262 | ||
263 | /** |
|
264 | * Other co-agents that participated in the action indirectly. e.g. John |
|
265 | * wrote a book with *Steve*. |
|
266 | * |
|
267 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
268 | * |
|
269 | * @return static |
|
270 | * |
|
271 | * @see http://schema.org/participant |
|
272 | */ |
|
273 | public function participant($participant) |
|
274 | { |
|
275 | return $this->setProperty('participant', $participant); |
|
276 | } |
|
277 | ||
278 | /** |
|
279 | * Indicates a potential Action, which describes an idealized action in |
|
280 | * which this thing would play an 'object' role. |
|
281 | * |
|
282 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
283 | * |
|
284 | * @return static |
|
285 | * |
|
286 | * @see http://schema.org/potentialAction |
|
287 | */ |
|
288 | public function potentialAction($potentialAction) |
|
289 | { |
|
290 | return $this->setProperty('potentialAction', $potentialAction); |
|
291 | } |
|
292 | ||
293 | /** |
|
294 | * The result produced in the action. e.g. John wrote *a book*. |
|
295 | * |
|
296 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
297 | * |
|
298 | * @return static |
|
299 | * |
|
300 | * @see http://schema.org/result |
|
301 | */ |
|
302 | public function result($result) |
|
303 | { |
|
304 | return $this->setProperty('result', $result); |
|
305 | } |
|
306 | ||
307 | /** |
|
308 | * URL of a reference Web page that unambiguously indicates the item's |
|
309 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
310 | * official website. |
|
311 | * |
|
312 | * @param string|string[] $sameAs |
|
313 | * |
|
314 | * @return static |
|
315 | * |
|
316 | * @see http://schema.org/sameAs |
|
317 | */ |
|
318 | public function sameAs($sameAs) |
|
319 | { |
|
320 | return $this->setProperty('sameAs', $sameAs); |
|
321 | } |
|
322 | ||
323 | /** |
|
324 | * The time the object is scheduled to. |
|
325 | * |
|
326 | * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime |
|
327 | * |
|
328 | * @return static |
|
329 | * |
|
330 | * @see http://schema.org/scheduledTime |
|
331 | */ |
|
332 | public function scheduledTime($scheduledTime) |
|
333 | { |
|
334 | return $this->setProperty('scheduledTime', $scheduledTime); |
|
335 | } |
|
336 | ||
337 | /** |
|
338 | * The startTime of something. For a reserved event or service (e.g. |
|
339 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
340 | * actions that span a period of time, when the action was performed. e.g. |
|
341 | * John wrote a book from *January* to December. For media, including audio |
|
342 | * and video, it's the time offset of the start of a clip within a larger |
|
343 | * file. |
|
344 | * |
|
345 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
346 | * when describing dates with times. This situation may be clarified in |
|
347 | * future revisions. |
|
348 | * |
|
349 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
350 | * |
|
351 | * @return static |
|
352 | * |
|
353 | * @see http://schema.org/startTime |
|
354 | */ |
|
355 | public function startTime($startTime) |
|
356 | { |
|
357 | return $this->setProperty('startTime', $startTime); |
|
358 | } |
|
359 | ||
360 | /** |
|
361 | * A CreativeWork or Event about this Thing. |
|
362 | * |
|
363 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
364 | * |
|
365 | * @return static |
|
366 | * |
|
367 | * @see http://schema.org/subjectOf |
|
368 | */ |
|
369 | public function subjectOf($subjectOf) |
|
370 | { |
|
371 | return $this->setProperty('subjectOf', $subjectOf); |
|
372 | } |
|
373 | ||
374 | /** |
|
375 | * Indicates a target EntryPoint for an Action. |
|
376 | * |
|
377 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
378 | * |
|
379 | * @return static |
|
380 | * |
|
381 | * @see http://schema.org/target |
|
382 | */ |
|
383 | public function target($target) |
|
384 | { |
|
385 | return $this->setProperty('target', $target); |
|
386 | } |
|
387 | ||
388 | /** |
|
389 | * URL of the item. |
|
390 | * |
|
391 | * @param string|string[] $url |
|
392 | * |
|
393 | * @return static |
|
394 | * |
|
395 | * @see http://schema.org/url |
|
396 | */ |
|
397 | public function url($url) |
|
398 | { |
|
399 | return $this->setProperty('url', $url); |
|
400 | } |
|
401 | ||
402 | } |
|
403 |
@@ 17-412 (lines=396) @@ | ||
14 | * @see http://schema.org/ChooseAction |
|
15 | * |
|
16 | */ |
|
17 | class ChooseAction extends BaseType implements ChooseActionContract, ActionContract, AssessActionContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * A sub property of object. The options subject to this action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $actionOption |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionOption |
|
27 | */ |
|
28 | public function actionOption($actionOption) |
|
29 | { |
|
30 | return $this->setProperty('actionOption', $actionOption); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * Indicates the current disposition of the Action. |
|
35 | * |
|
36 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
37 | * |
|
38 | * @return static |
|
39 | * |
|
40 | * @see http://schema.org/actionStatus |
|
41 | */ |
|
42 | public function actionStatus($actionStatus) |
|
43 | { |
|
44 | return $this->setProperty('actionStatus', $actionStatus); |
|
45 | } |
|
46 | ||
47 | /** |
|
48 | * An additional type for the item, typically used for adding more specific |
|
49 | * types from external vocabularies in microdata syntax. This is a |
|
50 | * relationship between something and a class that the thing is in. In RDFa |
|
51 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
52 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
53 | * understanding of extra types, in particular those defined externally. |
|
54 | * |
|
55 | * @param string|string[] $additionalType |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/additionalType |
|
60 | */ |
|
61 | public function additionalType($additionalType) |
|
62 | { |
|
63 | return $this->setProperty('additionalType', $additionalType); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
68 | * *John* wrote a book. |
|
69 | * |
|
70 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/agent |
|
75 | */ |
|
76 | public function agent($agent) |
|
77 | { |
|
78 | return $this->setProperty('agent', $agent); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * An alias for the item. |
|
83 | * |
|
84 | * @param string|string[] $alternateName |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/alternateName |
|
89 | */ |
|
90 | public function alternateName($alternateName) |
|
91 | { |
|
92 | return $this->setProperty('alternateName', $alternateName); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A description of the item. |
|
97 | * |
|
98 | * @param string|string[] $description |
|
99 | * |
|
100 | * @return static |
|
101 | * |
|
102 | * @see http://schema.org/description |
|
103 | */ |
|
104 | public function description($description) |
|
105 | { |
|
106 | return $this->setProperty('description', $description); |
|
107 | } |
|
108 | ||
109 | /** |
|
110 | * A sub property of description. A short description of the item used to |
|
111 | * disambiguate from other, similar items. Information from other properties |
|
112 | * (in particular, name) may be necessary for the description to be useful |
|
113 | * for disambiguation. |
|
114 | * |
|
115 | * @param string|string[] $disambiguatingDescription |
|
116 | * |
|
117 | * @return static |
|
118 | * |
|
119 | * @see http://schema.org/disambiguatingDescription |
|
120 | */ |
|
121 | public function disambiguatingDescription($disambiguatingDescription) |
|
122 | { |
|
123 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
124 | } |
|
125 | ||
126 | /** |
|
127 | * The endTime of something. For a reserved event or service (e.g. |
|
128 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
129 | * actions that span a period of time, when the action was performed. e.g. |
|
130 | * John wrote a book from January to *December*. For media, including audio |
|
131 | * and video, it's the time offset of the end of a clip within a larger |
|
132 | * file. |
|
133 | * |
|
134 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
135 | * when describing dates with times. This situation may be clarified in |
|
136 | * future revisions. |
|
137 | * |
|
138 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/endTime |
|
143 | */ |
|
144 | public function endTime($endTime) |
|
145 | { |
|
146 | return $this->setProperty('endTime', $endTime); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * For failed actions, more information on the cause of the failure. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/error |
|
157 | */ |
|
158 | public function error($error) |
|
159 | { |
|
160 | return $this->setProperty('error', $error); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * The identifier property represents any kind of identifier for any kind of |
|
165 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
166 | * dedicated properties for representing many of these, either as textual |
|
167 | * strings or as URL (URI) links. See [background |
|
168 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/identifier |
|
175 | */ |
|
176 | public function identifier($identifier) |
|
177 | { |
|
178 | return $this->setProperty('identifier', $identifier); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * An image of the item. This can be a [[URL]] or a fully described |
|
183 | * [[ImageObject]]. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/image |
|
190 | */ |
|
191 | public function image($image) |
|
192 | { |
|
193 | return $this->setProperty('image', $image); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * The object that helped the agent perform the action. e.g. John wrote a |
|
198 | * book with *a pen*. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/instrument |
|
205 | */ |
|
206 | public function instrument($instrument) |
|
207 | { |
|
208 | return $this->setProperty('instrument', $instrument); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * The location of for example where the event is happening, an organization |
|
213 | * is located, or where an action takes place. |
|
214 | * |
|
215 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
216 | * |
|
217 | * @return static |
|
218 | * |
|
219 | * @see http://schema.org/location |
|
220 | */ |
|
221 | public function location($location) |
|
222 | { |
|
223 | return $this->setProperty('location', $location); |
|
224 | } |
|
225 | ||
226 | /** |
|
227 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
228 | * entity being described. See [background |
|
229 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
230 | * |
|
231 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/mainEntityOfPage |
|
236 | */ |
|
237 | public function mainEntityOfPage($mainEntityOfPage) |
|
238 | { |
|
239 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The name of the item. |
|
244 | * |
|
245 | * @param string|string[] $name |
|
246 | * |
|
247 | * @return static |
|
248 | * |
|
249 | * @see http://schema.org/name |
|
250 | */ |
|
251 | public function name($name) |
|
252 | { |
|
253 | return $this->setProperty('name', $name); |
|
254 | } |
|
255 | ||
256 | /** |
|
257 | * The object upon which the action is carried out, whose state is kept |
|
258 | * intact or changed. Also known as the semantic roles patient, affected or |
|
259 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
260 | * read *a book*. |
|
261 | * |
|
262 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/object |
|
267 | */ |
|
268 | public function object($object) |
|
269 | { |
|
270 | return $this->setProperty('object', $object); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * A sub property of object. The options subject to this action. |
|
275 | * |
|
276 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $option |
|
277 | * |
|
278 | * @return static |
|
279 | * |
|
280 | * @see http://schema.org/option |
|
281 | */ |
|
282 | public function option($option) |
|
283 | { |
|
284 | return $this->setProperty('option', $option); |
|
285 | } |
|
286 | ||
287 | /** |
|
288 | * Other co-agents that participated in the action indirectly. e.g. John |
|
289 | * wrote a book with *Steve*. |
|
290 | * |
|
291 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
292 | * |
|
293 | * @return static |
|
294 | * |
|
295 | * @see http://schema.org/participant |
|
296 | */ |
|
297 | public function participant($participant) |
|
298 | { |
|
299 | return $this->setProperty('participant', $participant); |
|
300 | } |
|
301 | ||
302 | /** |
|
303 | * Indicates a potential Action, which describes an idealized action in |
|
304 | * which this thing would play an 'object' role. |
|
305 | * |
|
306 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
307 | * |
|
308 | * @return static |
|
309 | * |
|
310 | * @see http://schema.org/potentialAction |
|
311 | */ |
|
312 | public function potentialAction($potentialAction) |
|
313 | { |
|
314 | return $this->setProperty('potentialAction', $potentialAction); |
|
315 | } |
|
316 | ||
317 | /** |
|
318 | * The result produced in the action. e.g. John wrote *a book*. |
|
319 | * |
|
320 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
321 | * |
|
322 | * @return static |
|
323 | * |
|
324 | * @see http://schema.org/result |
|
325 | */ |
|
326 | public function result($result) |
|
327 | { |
|
328 | return $this->setProperty('result', $result); |
|
329 | } |
|
330 | ||
331 | /** |
|
332 | * URL of a reference Web page that unambiguously indicates the item's |
|
333 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
334 | * official website. |
|
335 | * |
|
336 | * @param string|string[] $sameAs |
|
337 | * |
|
338 | * @return static |
|
339 | * |
|
340 | * @see http://schema.org/sameAs |
|
341 | */ |
|
342 | public function sameAs($sameAs) |
|
343 | { |
|
344 | return $this->setProperty('sameAs', $sameAs); |
|
345 | } |
|
346 | ||
347 | /** |
|
348 | * The startTime of something. For a reserved event or service (e.g. |
|
349 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
350 | * actions that span a period of time, when the action was performed. e.g. |
|
351 | * John wrote a book from *January* to December. For media, including audio |
|
352 | * and video, it's the time offset of the start of a clip within a larger |
|
353 | * file. |
|
354 | * |
|
355 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
356 | * when describing dates with times. This situation may be clarified in |
|
357 | * future revisions. |
|
358 | * |
|
359 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
360 | * |
|
361 | * @return static |
|
362 | * |
|
363 | * @see http://schema.org/startTime |
|
364 | */ |
|
365 | public function startTime($startTime) |
|
366 | { |
|
367 | return $this->setProperty('startTime', $startTime); |
|
368 | } |
|
369 | ||
370 | /** |
|
371 | * A CreativeWork or Event about this Thing. |
|
372 | * |
|
373 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
374 | * |
|
375 | * @return static |
|
376 | * |
|
377 | * @see http://schema.org/subjectOf |
|
378 | */ |
|
379 | public function subjectOf($subjectOf) |
|
380 | { |
|
381 | return $this->setProperty('subjectOf', $subjectOf); |
|
382 | } |
|
383 | ||
384 | /** |
|
385 | * Indicates a target EntryPoint for an Action. |
|
386 | * |
|
387 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
388 | * |
|
389 | * @return static |
|
390 | * |
|
391 | * @see http://schema.org/target |
|
392 | */ |
|
393 | public function target($target) |
|
394 | { |
|
395 | return $this->setProperty('target', $target); |
|
396 | } |
|
397 | ||
398 | /** |
|
399 | * URL of the item. |
|
400 | * |
|
401 | * @param string|string[] $url |
|
402 | * |
|
403 | * @return static |
|
404 | * |
|
405 | * @see http://schema.org/url |
|
406 | */ |
|
407 | public function url($url) |
|
408 | { |
|
409 | return $this->setProperty('url', $url); |
|
410 | } |
|
411 | ||
412 | } |
|
413 |
@@ 15-414 (lines=400) @@ | ||
12 | * @see http://schema.org/ConsumeAction |
|
13 | * |
|
14 | */ |
|
15 | class ConsumeAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract |
|
16 | { |
|
17 | /** |
|
18 | * A set of requirements that a must be fulfilled in order to perform an |
|
19 | * Action. If more than one value is specied, fulfilling one set of |
|
20 | * requirements will allow the Action to be performed. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionAccessibilityRequirement |
|
27 | */ |
|
28 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
29 | { |
|
30 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * Indicates the current disposition of the Action. |
|
35 | * |
|
36 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
37 | * |
|
38 | * @return static |
|
39 | * |
|
40 | * @see http://schema.org/actionStatus |
|
41 | */ |
|
42 | public function actionStatus($actionStatus) |
|
43 | { |
|
44 | return $this->setProperty('actionStatus', $actionStatus); |
|
45 | } |
|
46 | ||
47 | /** |
|
48 | * An additional type for the item, typically used for adding more specific |
|
49 | * types from external vocabularies in microdata syntax. This is a |
|
50 | * relationship between something and a class that the thing is in. In RDFa |
|
51 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
52 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
53 | * understanding of extra types, in particular those defined externally. |
|
54 | * |
|
55 | * @param string|string[] $additionalType |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/additionalType |
|
60 | */ |
|
61 | public function additionalType($additionalType) |
|
62 | { |
|
63 | return $this->setProperty('additionalType', $additionalType); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
68 | * *John* wrote a book. |
|
69 | * |
|
70 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/agent |
|
75 | */ |
|
76 | public function agent($agent) |
|
77 | { |
|
78 | return $this->setProperty('agent', $agent); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * An alias for the item. |
|
83 | * |
|
84 | * @param string|string[] $alternateName |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/alternateName |
|
89 | */ |
|
90 | public function alternateName($alternateName) |
|
91 | { |
|
92 | return $this->setProperty('alternateName', $alternateName); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A description of the item. |
|
97 | * |
|
98 | * @param string|string[] $description |
|
99 | * |
|
100 | * @return static |
|
101 | * |
|
102 | * @see http://schema.org/description |
|
103 | */ |
|
104 | public function description($description) |
|
105 | { |
|
106 | return $this->setProperty('description', $description); |
|
107 | } |
|
108 | ||
109 | /** |
|
110 | * A sub property of description. A short description of the item used to |
|
111 | * disambiguate from other, similar items. Information from other properties |
|
112 | * (in particular, name) may be necessary for the description to be useful |
|
113 | * for disambiguation. |
|
114 | * |
|
115 | * @param string|string[] $disambiguatingDescription |
|
116 | * |
|
117 | * @return static |
|
118 | * |
|
119 | * @see http://schema.org/disambiguatingDescription |
|
120 | */ |
|
121 | public function disambiguatingDescription($disambiguatingDescription) |
|
122 | { |
|
123 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
124 | } |
|
125 | ||
126 | /** |
|
127 | * The endTime of something. For a reserved event or service (e.g. |
|
128 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
129 | * actions that span a period of time, when the action was performed. e.g. |
|
130 | * John wrote a book from January to *December*. For media, including audio |
|
131 | * and video, it's the time offset of the end of a clip within a larger |
|
132 | * file. |
|
133 | * |
|
134 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
135 | * when describing dates with times. This situation may be clarified in |
|
136 | * future revisions. |
|
137 | * |
|
138 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/endTime |
|
143 | */ |
|
144 | public function endTime($endTime) |
|
145 | { |
|
146 | return $this->setProperty('endTime', $endTime); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * For failed actions, more information on the cause of the failure. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/error |
|
157 | */ |
|
158 | public function error($error) |
|
159 | { |
|
160 | return $this->setProperty('error', $error); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * An Offer which must be accepted before the user can perform the Action. |
|
165 | * For example, the user may need to buy a movie before being able to watch |
|
166 | * it. |
|
167 | * |
|
168 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
169 | * |
|
170 | * @return static |
|
171 | * |
|
172 | * @see http://schema.org/expectsAcceptanceOf |
|
173 | */ |
|
174 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
175 | { |
|
176 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
177 | } |
|
178 | ||
179 | /** |
|
180 | * The identifier property represents any kind of identifier for any kind of |
|
181 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
182 | * dedicated properties for representing many of these, either as textual |
|
183 | * strings or as URL (URI) links. See [background |
|
184 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/identifier |
|
191 | */ |
|
192 | public function identifier($identifier) |
|
193 | { |
|
194 | return $this->setProperty('identifier', $identifier); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * An image of the item. This can be a [[URL]] or a fully described |
|
199 | * [[ImageObject]]. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/image |
|
206 | */ |
|
207 | public function image($image) |
|
208 | { |
|
209 | return $this->setProperty('image', $image); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * The object that helped the agent perform the action. e.g. John wrote a |
|
214 | * book with *a pen*. |
|
215 | * |
|
216 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
217 | * |
|
218 | * @return static |
|
219 | * |
|
220 | * @see http://schema.org/instrument |
|
221 | */ |
|
222 | public function instrument($instrument) |
|
223 | { |
|
224 | return $this->setProperty('instrument', $instrument); |
|
225 | } |
|
226 | ||
227 | /** |
|
228 | * The location of for example where the event is happening, an organization |
|
229 | * is located, or where an action takes place. |
|
230 | * |
|
231 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/location |
|
236 | */ |
|
237 | public function location($location) |
|
238 | { |
|
239 | return $this->setProperty('location', $location); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
244 | * entity being described. See [background |
|
245 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
246 | * |
|
247 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
248 | * |
|
249 | * @return static |
|
250 | * |
|
251 | * @see http://schema.org/mainEntityOfPage |
|
252 | */ |
|
253 | public function mainEntityOfPage($mainEntityOfPage) |
|
254 | { |
|
255 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
256 | } |
|
257 | ||
258 | /** |
|
259 | * The name of the item. |
|
260 | * |
|
261 | * @param string|string[] $name |
|
262 | * |
|
263 | * @return static |
|
264 | * |
|
265 | * @see http://schema.org/name |
|
266 | */ |
|
267 | public function name($name) |
|
268 | { |
|
269 | return $this->setProperty('name', $name); |
|
270 | } |
|
271 | ||
272 | /** |
|
273 | * The object upon which the action is carried out, whose state is kept |
|
274 | * intact or changed. Also known as the semantic roles patient, affected or |
|
275 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
276 | * read *a book*. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/object |
|
283 | */ |
|
284 | public function object($object) |
|
285 | { |
|
286 | return $this->setProperty('object', $object); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * Other co-agents that participated in the action indirectly. e.g. John |
|
291 | * wrote a book with *Steve*. |
|
292 | * |
|
293 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
294 | * |
|
295 | * @return static |
|
296 | * |
|
297 | * @see http://schema.org/participant |
|
298 | */ |
|
299 | public function participant($participant) |
|
300 | { |
|
301 | return $this->setProperty('participant', $participant); |
|
302 | } |
|
303 | ||
304 | /** |
|
305 | * Indicates a potential Action, which describes an idealized action in |
|
306 | * which this thing would play an 'object' role. |
|
307 | * |
|
308 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
309 | * |
|
310 | * @return static |
|
311 | * |
|
312 | * @see http://schema.org/potentialAction |
|
313 | */ |
|
314 | public function potentialAction($potentialAction) |
|
315 | { |
|
316 | return $this->setProperty('potentialAction', $potentialAction); |
|
317 | } |
|
318 | ||
319 | /** |
|
320 | * The result produced in the action. e.g. John wrote *a book*. |
|
321 | * |
|
322 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
323 | * |
|
324 | * @return static |
|
325 | * |
|
326 | * @see http://schema.org/result |
|
327 | */ |
|
328 | public function result($result) |
|
329 | { |
|
330 | return $this->setProperty('result', $result); |
|
331 | } |
|
332 | ||
333 | /** |
|
334 | * URL of a reference Web page that unambiguously indicates the item's |
|
335 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
336 | * official website. |
|
337 | * |
|
338 | * @param string|string[] $sameAs |
|
339 | * |
|
340 | * @return static |
|
341 | * |
|
342 | * @see http://schema.org/sameAs |
|
343 | */ |
|
344 | public function sameAs($sameAs) |
|
345 | { |
|
346 | return $this->setProperty('sameAs', $sameAs); |
|
347 | } |
|
348 | ||
349 | /** |
|
350 | * The startTime of something. For a reserved event or service (e.g. |
|
351 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
352 | * actions that span a period of time, when the action was performed. e.g. |
|
353 | * John wrote a book from *January* to December. For media, including audio |
|
354 | * and video, it's the time offset of the start of a clip within a larger |
|
355 | * file. |
|
356 | * |
|
357 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
358 | * when describing dates with times. This situation may be clarified in |
|
359 | * future revisions. |
|
360 | * |
|
361 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
362 | * |
|
363 | * @return static |
|
364 | * |
|
365 | * @see http://schema.org/startTime |
|
366 | */ |
|
367 | public function startTime($startTime) |
|
368 | { |
|
369 | return $this->setProperty('startTime', $startTime); |
|
370 | } |
|
371 | ||
372 | /** |
|
373 | * A CreativeWork or Event about this Thing. |
|
374 | * |
|
375 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
376 | * |
|
377 | * @return static |
|
378 | * |
|
379 | * @see http://schema.org/subjectOf |
|
380 | */ |
|
381 | public function subjectOf($subjectOf) |
|
382 | { |
|
383 | return $this->setProperty('subjectOf', $subjectOf); |
|
384 | } |
|
385 | ||
386 | /** |
|
387 | * Indicates a target EntryPoint for an Action. |
|
388 | * |
|
389 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/target |
|
394 | */ |
|
395 | public function target($target) |
|
396 | { |
|
397 | return $this->setProperty('target', $target); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * URL of the item. |
|
402 | * |
|
403 | * @param string|string[] $url |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/url |
|
408 | */ |
|
409 | public function url($url) |
|
410 | { |
|
411 | return $this->setProperty('url', $url); |
|
412 | } |
|
413 | ||
414 | } |
|
415 |
@@ 16-428 (lines=413) @@ | ||
13 | * @see http://schema.org/CookAction |
|
14 | * |
|
15 | */ |
|
16 | class CookAction extends BaseType implements CookActionContract, ActionContract, CreateActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * Indicates the current disposition of the Action. |
|
20 | * |
|
21 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
22 | * |
|
23 | * @return static |
|
24 | * |
|
25 | * @see http://schema.org/actionStatus |
|
26 | */ |
|
27 | public function actionStatus($actionStatus) |
|
28 | { |
|
29 | return $this->setProperty('actionStatus', $actionStatus); |
|
30 | } |
|
31 | ||
32 | /** |
|
33 | * An additional type for the item, typically used for adding more specific |
|
34 | * types from external vocabularies in microdata syntax. This is a |
|
35 | * relationship between something and a class that the thing is in. In RDFa |
|
36 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
37 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
38 | * understanding of extra types, in particular those defined externally. |
|
39 | * |
|
40 | * @param string|string[] $additionalType |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/additionalType |
|
45 | */ |
|
46 | public function additionalType($additionalType) |
|
47 | { |
|
48 | return $this->setProperty('additionalType', $additionalType); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
53 | * *John* wrote a book. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/agent |
|
60 | */ |
|
61 | public function agent($agent) |
|
62 | { |
|
63 | return $this->setProperty('agent', $agent); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * An alias for the item. |
|
68 | * |
|
69 | * @param string|string[] $alternateName |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/alternateName |
|
74 | */ |
|
75 | public function alternateName($alternateName) |
|
76 | { |
|
77 | return $this->setProperty('alternateName', $alternateName); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * A description of the item. |
|
82 | * |
|
83 | * @param string|string[] $description |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/description |
|
88 | */ |
|
89 | public function description($description) |
|
90 | { |
|
91 | return $this->setProperty('description', $description); |
|
92 | } |
|
93 | ||
94 | /** |
|
95 | * A sub property of description. A short description of the item used to |
|
96 | * disambiguate from other, similar items. Information from other properties |
|
97 | * (in particular, name) may be necessary for the description to be useful |
|
98 | * for disambiguation. |
|
99 | * |
|
100 | * @param string|string[] $disambiguatingDescription |
|
101 | * |
|
102 | * @return static |
|
103 | * |
|
104 | * @see http://schema.org/disambiguatingDescription |
|
105 | */ |
|
106 | public function disambiguatingDescription($disambiguatingDescription) |
|
107 | { |
|
108 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
109 | } |
|
110 | ||
111 | /** |
|
112 | * The endTime of something. For a reserved event or service (e.g. |
|
113 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
114 | * actions that span a period of time, when the action was performed. e.g. |
|
115 | * John wrote a book from January to *December*. For media, including audio |
|
116 | * and video, it's the time offset of the end of a clip within a larger |
|
117 | * file. |
|
118 | * |
|
119 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
120 | * when describing dates with times. This situation may be clarified in |
|
121 | * future revisions. |
|
122 | * |
|
123 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
124 | * |
|
125 | * @return static |
|
126 | * |
|
127 | * @see http://schema.org/endTime |
|
128 | */ |
|
129 | public function endTime($endTime) |
|
130 | { |
|
131 | return $this->setProperty('endTime', $endTime); |
|
132 | } |
|
133 | ||
134 | /** |
|
135 | * For failed actions, more information on the cause of the failure. |
|
136 | * |
|
137 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
138 | * |
|
139 | * @return static |
|
140 | * |
|
141 | * @see http://schema.org/error |
|
142 | */ |
|
143 | public function error($error) |
|
144 | { |
|
145 | return $this->setProperty('error', $error); |
|
146 | } |
|
147 | ||
148 | /** |
|
149 | * A sub property of location. The specific food establishment where the |
|
150 | * action occurred. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract|\Spatie\SchemaOrg\Contracts\FoodEstablishmentContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $foodEstablishment |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/foodEstablishment |
|
157 | */ |
|
158 | public function foodEstablishment($foodEstablishment) |
|
159 | { |
|
160 | return $this->setProperty('foodEstablishment', $foodEstablishment); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * A sub property of location. The specific food event where the action |
|
165 | * occurred. |
|
166 | * |
|
167 | * @param \Spatie\SchemaOrg\Contracts\FoodEventContract|\Spatie\SchemaOrg\Contracts\FoodEventContract[] $foodEvent |
|
168 | * |
|
169 | * @return static |
|
170 | * |
|
171 | * @see http://schema.org/foodEvent |
|
172 | */ |
|
173 | public function foodEvent($foodEvent) |
|
174 | { |
|
175 | return $this->setProperty('foodEvent', $foodEvent); |
|
176 | } |
|
177 | ||
178 | /** |
|
179 | * The identifier property represents any kind of identifier for any kind of |
|
180 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
181 | * dedicated properties for representing many of these, either as textual |
|
182 | * strings or as URL (URI) links. See [background |
|
183 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/identifier |
|
190 | */ |
|
191 | public function identifier($identifier) |
|
192 | { |
|
193 | return $this->setProperty('identifier', $identifier); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * An image of the item. This can be a [[URL]] or a fully described |
|
198 | * [[ImageObject]]. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/image |
|
205 | */ |
|
206 | public function image($image) |
|
207 | { |
|
208 | return $this->setProperty('image', $image); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * The object that helped the agent perform the action. e.g. John wrote a |
|
213 | * book with *a pen*. |
|
214 | * |
|
215 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
216 | * |
|
217 | * @return static |
|
218 | * |
|
219 | * @see http://schema.org/instrument |
|
220 | */ |
|
221 | public function instrument($instrument) |
|
222 | { |
|
223 | return $this->setProperty('instrument', $instrument); |
|
224 | } |
|
225 | ||
226 | /** |
|
227 | * The location of for example where the event is happening, an organization |
|
228 | * is located, or where an action takes place. |
|
229 | * |
|
230 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
231 | * |
|
232 | * @return static |
|
233 | * |
|
234 | * @see http://schema.org/location |
|
235 | */ |
|
236 | public function location($location) |
|
237 | { |
|
238 | return $this->setProperty('location', $location); |
|
239 | } |
|
240 | ||
241 | /** |
|
242 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
243 | * entity being described. See [background |
|
244 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
245 | * |
|
246 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
247 | * |
|
248 | * @return static |
|
249 | * |
|
250 | * @see http://schema.org/mainEntityOfPage |
|
251 | */ |
|
252 | public function mainEntityOfPage($mainEntityOfPage) |
|
253 | { |
|
254 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
255 | } |
|
256 | ||
257 | /** |
|
258 | * The name of the item. |
|
259 | * |
|
260 | * @param string|string[] $name |
|
261 | * |
|
262 | * @return static |
|
263 | * |
|
264 | * @see http://schema.org/name |
|
265 | */ |
|
266 | public function name($name) |
|
267 | { |
|
268 | return $this->setProperty('name', $name); |
|
269 | } |
|
270 | ||
271 | /** |
|
272 | * The object upon which the action is carried out, whose state is kept |
|
273 | * intact or changed. Also known as the semantic roles patient, affected or |
|
274 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
275 | * read *a book*. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/object |
|
282 | */ |
|
283 | public function object($object) |
|
284 | { |
|
285 | return $this->setProperty('object', $object); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * Other co-agents that participated in the action indirectly. e.g. John |
|
290 | * wrote a book with *Steve*. |
|
291 | * |
|
292 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
293 | * |
|
294 | * @return static |
|
295 | * |
|
296 | * @see http://schema.org/participant |
|
297 | */ |
|
298 | public function participant($participant) |
|
299 | { |
|
300 | return $this->setProperty('participant', $participant); |
|
301 | } |
|
302 | ||
303 | /** |
|
304 | * Indicates a potential Action, which describes an idealized action in |
|
305 | * which this thing would play an 'object' role. |
|
306 | * |
|
307 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
308 | * |
|
309 | * @return static |
|
310 | * |
|
311 | * @see http://schema.org/potentialAction |
|
312 | */ |
|
313 | public function potentialAction($potentialAction) |
|
314 | { |
|
315 | return $this->setProperty('potentialAction', $potentialAction); |
|
316 | } |
|
317 | ||
318 | /** |
|
319 | * A sub property of instrument. The recipe/instructions used to perform the |
|
320 | * action. |
|
321 | * |
|
322 | * @param \Spatie\SchemaOrg\Contracts\RecipeContract|\Spatie\SchemaOrg\Contracts\RecipeContract[] $recipe |
|
323 | * |
|
324 | * @return static |
|
325 | * |
|
326 | * @see http://schema.org/recipe |
|
327 | */ |
|
328 | public function recipe($recipe) |
|
329 | { |
|
330 | return $this->setProperty('recipe', $recipe); |
|
331 | } |
|
332 | ||
333 | /** |
|
334 | * The result produced in the action. e.g. John wrote *a book*. |
|
335 | * |
|
336 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
337 | * |
|
338 | * @return static |
|
339 | * |
|
340 | * @see http://schema.org/result |
|
341 | */ |
|
342 | public function result($result) |
|
343 | { |
|
344 | return $this->setProperty('result', $result); |
|
345 | } |
|
346 | ||
347 | /** |
|
348 | * URL of a reference Web page that unambiguously indicates the item's |
|
349 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
350 | * official website. |
|
351 | * |
|
352 | * @param string|string[] $sameAs |
|
353 | * |
|
354 | * @return static |
|
355 | * |
|
356 | * @see http://schema.org/sameAs |
|
357 | */ |
|
358 | public function sameAs($sameAs) |
|
359 | { |
|
360 | return $this->setProperty('sameAs', $sameAs); |
|
361 | } |
|
362 | ||
363 | /** |
|
364 | * The startTime of something. For a reserved event or service (e.g. |
|
365 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
366 | * actions that span a period of time, when the action was performed. e.g. |
|
367 | * John wrote a book from *January* to December. For media, including audio |
|
368 | * and video, it's the time offset of the start of a clip within a larger |
|
369 | * file. |
|
370 | * |
|
371 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
372 | * when describing dates with times. This situation may be clarified in |
|
373 | * future revisions. |
|
374 | * |
|
375 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
376 | * |
|
377 | * @return static |
|
378 | * |
|
379 | * @see http://schema.org/startTime |
|
380 | */ |
|
381 | public function startTime($startTime) |
|
382 | { |
|
383 | return $this->setProperty('startTime', $startTime); |
|
384 | } |
|
385 | ||
386 | /** |
|
387 | * A CreativeWork or Event about this Thing. |
|
388 | * |
|
389 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/subjectOf |
|
394 | */ |
|
395 | public function subjectOf($subjectOf) |
|
396 | { |
|
397 | return $this->setProperty('subjectOf', $subjectOf); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * Indicates a target EntryPoint for an Action. |
|
402 | * |
|
403 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/target |
|
408 | */ |
|
409 | public function target($target) |
|
410 | { |
|
411 | return $this->setProperty('target', $target); |
|
412 | } |
|
413 | ||
414 | /** |
|
415 | * URL of the item. |
|
416 | * |
|
417 | * @param string|string[] $url |
|
418 | * |
|
419 | * @return static |
|
420 | * |
|
421 | * @see http://schema.org/url |
|
422 | */ |
|
423 | public function url($url) |
|
424 | { |
|
425 | return $this->setProperty('url', $url); |
|
426 | } |
|
427 | ||
428 | } |
|
429 |
@@ 16-411 (lines=396) @@ | ||
13 | * @see http://schema.org/DeleteAction |
|
14 | * |
|
15 | */ |
|
16 | class DeleteAction extends BaseType implements DeleteActionContract, ActionContract, ThingContract, UpdateActionContract |
|
17 | { |
|
18 | /** |
|
19 | * Indicates the current disposition of the Action. |
|
20 | * |
|
21 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
22 | * |
|
23 | * @return static |
|
24 | * |
|
25 | * @see http://schema.org/actionStatus |
|
26 | */ |
|
27 | public function actionStatus($actionStatus) |
|
28 | { |
|
29 | return $this->setProperty('actionStatus', $actionStatus); |
|
30 | } |
|
31 | ||
32 | /** |
|
33 | * An additional type for the item, typically used for adding more specific |
|
34 | * types from external vocabularies in microdata syntax. This is a |
|
35 | * relationship between something and a class that the thing is in. In RDFa |
|
36 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
37 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
38 | * understanding of extra types, in particular those defined externally. |
|
39 | * |
|
40 | * @param string|string[] $additionalType |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/additionalType |
|
45 | */ |
|
46 | public function additionalType($additionalType) |
|
47 | { |
|
48 | return $this->setProperty('additionalType', $additionalType); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
53 | * *John* wrote a book. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/agent |
|
60 | */ |
|
61 | public function agent($agent) |
|
62 | { |
|
63 | return $this->setProperty('agent', $agent); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * An alias for the item. |
|
68 | * |
|
69 | * @param string|string[] $alternateName |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/alternateName |
|
74 | */ |
|
75 | public function alternateName($alternateName) |
|
76 | { |
|
77 | return $this->setProperty('alternateName', $alternateName); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * A sub property of object. The collection target of the action. |
|
82 | * |
|
83 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $collection |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/collection |
|
88 | */ |
|
89 | public function collection($collection) |
|
90 | { |
|
91 | return $this->setProperty('collection', $collection); |
|
92 | } |
|
93 | ||
94 | /** |
|
95 | * A description of the item. |
|
96 | * |
|
97 | * @param string|string[] $description |
|
98 | * |
|
99 | * @return static |
|
100 | * |
|
101 | * @see http://schema.org/description |
|
102 | */ |
|
103 | public function description($description) |
|
104 | { |
|
105 | return $this->setProperty('description', $description); |
|
106 | } |
|
107 | ||
108 | /** |
|
109 | * A sub property of description. A short description of the item used to |
|
110 | * disambiguate from other, similar items. Information from other properties |
|
111 | * (in particular, name) may be necessary for the description to be useful |
|
112 | * for disambiguation. |
|
113 | * |
|
114 | * @param string|string[] $disambiguatingDescription |
|
115 | * |
|
116 | * @return static |
|
117 | * |
|
118 | * @see http://schema.org/disambiguatingDescription |
|
119 | */ |
|
120 | public function disambiguatingDescription($disambiguatingDescription) |
|
121 | { |
|
122 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
123 | } |
|
124 | ||
125 | /** |
|
126 | * The endTime of something. For a reserved event or service (e.g. |
|
127 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
128 | * actions that span a period of time, when the action was performed. e.g. |
|
129 | * John wrote a book from January to *December*. For media, including audio |
|
130 | * and video, it's the time offset of the end of a clip within a larger |
|
131 | * file. |
|
132 | * |
|
133 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
134 | * when describing dates with times. This situation may be clarified in |
|
135 | * future revisions. |
|
136 | * |
|
137 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
138 | * |
|
139 | * @return static |
|
140 | * |
|
141 | * @see http://schema.org/endTime |
|
142 | */ |
|
143 | public function endTime($endTime) |
|
144 | { |
|
145 | return $this->setProperty('endTime', $endTime); |
|
146 | } |
|
147 | ||
148 | /** |
|
149 | * For failed actions, more information on the cause of the failure. |
|
150 | * |
|
151 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
152 | * |
|
153 | * @return static |
|
154 | * |
|
155 | * @see http://schema.org/error |
|
156 | */ |
|
157 | public function error($error) |
|
158 | { |
|
159 | return $this->setProperty('error', $error); |
|
160 | } |
|
161 | ||
162 | /** |
|
163 | * The identifier property represents any kind of identifier for any kind of |
|
164 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
165 | * dedicated properties for representing many of these, either as textual |
|
166 | * strings or as URL (URI) links. See [background |
|
167 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/identifier |
|
174 | */ |
|
175 | public function identifier($identifier) |
|
176 | { |
|
177 | return $this->setProperty('identifier', $identifier); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * An image of the item. This can be a [[URL]] or a fully described |
|
182 | * [[ImageObject]]. |
|
183 | * |
|
184 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
185 | * |
|
186 | * @return static |
|
187 | * |
|
188 | * @see http://schema.org/image |
|
189 | */ |
|
190 | public function image($image) |
|
191 | { |
|
192 | return $this->setProperty('image', $image); |
|
193 | } |
|
194 | ||
195 | /** |
|
196 | * The object that helped the agent perform the action. e.g. John wrote a |
|
197 | * book with *a pen*. |
|
198 | * |
|
199 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
200 | * |
|
201 | * @return static |
|
202 | * |
|
203 | * @see http://schema.org/instrument |
|
204 | */ |
|
205 | public function instrument($instrument) |
|
206 | { |
|
207 | return $this->setProperty('instrument', $instrument); |
|
208 | } |
|
209 | ||
210 | /** |
|
211 | * The location of for example where the event is happening, an organization |
|
212 | * is located, or where an action takes place. |
|
213 | * |
|
214 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
215 | * |
|
216 | * @return static |
|
217 | * |
|
218 | * @see http://schema.org/location |
|
219 | */ |
|
220 | public function location($location) |
|
221 | { |
|
222 | return $this->setProperty('location', $location); |
|
223 | } |
|
224 | ||
225 | /** |
|
226 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
227 | * entity being described. See [background |
|
228 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
229 | * |
|
230 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
231 | * |
|
232 | * @return static |
|
233 | * |
|
234 | * @see http://schema.org/mainEntityOfPage |
|
235 | */ |
|
236 | public function mainEntityOfPage($mainEntityOfPage) |
|
237 | { |
|
238 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
239 | } |
|
240 | ||
241 | /** |
|
242 | * The name of the item. |
|
243 | * |
|
244 | * @param string|string[] $name |
|
245 | * |
|
246 | * @return static |
|
247 | * |
|
248 | * @see http://schema.org/name |
|
249 | */ |
|
250 | public function name($name) |
|
251 | { |
|
252 | return $this->setProperty('name', $name); |
|
253 | } |
|
254 | ||
255 | /** |
|
256 | * The object upon which the action is carried out, whose state is kept |
|
257 | * intact or changed. Also known as the semantic roles patient, affected or |
|
258 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
259 | * read *a book*. |
|
260 | * |
|
261 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
262 | * |
|
263 | * @return static |
|
264 | * |
|
265 | * @see http://schema.org/object |
|
266 | */ |
|
267 | public function object($object) |
|
268 | { |
|
269 | return $this->setProperty('object', $object); |
|
270 | } |
|
271 | ||
272 | /** |
|
273 | * Other co-agents that participated in the action indirectly. e.g. John |
|
274 | * wrote a book with *Steve*. |
|
275 | * |
|
276 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
277 | * |
|
278 | * @return static |
|
279 | * |
|
280 | * @see http://schema.org/participant |
|
281 | */ |
|
282 | public function participant($participant) |
|
283 | { |
|
284 | return $this->setProperty('participant', $participant); |
|
285 | } |
|
286 | ||
287 | /** |
|
288 | * Indicates a potential Action, which describes an idealized action in |
|
289 | * which this thing would play an 'object' role. |
|
290 | * |
|
291 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
292 | * |
|
293 | * @return static |
|
294 | * |
|
295 | * @see http://schema.org/potentialAction |
|
296 | */ |
|
297 | public function potentialAction($potentialAction) |
|
298 | { |
|
299 | return $this->setProperty('potentialAction', $potentialAction); |
|
300 | } |
|
301 | ||
302 | /** |
|
303 | * The result produced in the action. e.g. John wrote *a book*. |
|
304 | * |
|
305 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
306 | * |
|
307 | * @return static |
|
308 | * |
|
309 | * @see http://schema.org/result |
|
310 | */ |
|
311 | public function result($result) |
|
312 | { |
|
313 | return $this->setProperty('result', $result); |
|
314 | } |
|
315 | ||
316 | /** |
|
317 | * URL of a reference Web page that unambiguously indicates the item's |
|
318 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
319 | * official website. |
|
320 | * |
|
321 | * @param string|string[] $sameAs |
|
322 | * |
|
323 | * @return static |
|
324 | * |
|
325 | * @see http://schema.org/sameAs |
|
326 | */ |
|
327 | public function sameAs($sameAs) |
|
328 | { |
|
329 | return $this->setProperty('sameAs', $sameAs); |
|
330 | } |
|
331 | ||
332 | /** |
|
333 | * The startTime of something. For a reserved event or service (e.g. |
|
334 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
335 | * actions that span a period of time, when the action was performed. e.g. |
|
336 | * John wrote a book from *January* to December. For media, including audio |
|
337 | * and video, it's the time offset of the start of a clip within a larger |
|
338 | * file. |
|
339 | * |
|
340 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
341 | * when describing dates with times. This situation may be clarified in |
|
342 | * future revisions. |
|
343 | * |
|
344 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
345 | * |
|
346 | * @return static |
|
347 | * |
|
348 | * @see http://schema.org/startTime |
|
349 | */ |
|
350 | public function startTime($startTime) |
|
351 | { |
|
352 | return $this->setProperty('startTime', $startTime); |
|
353 | } |
|
354 | ||
355 | /** |
|
356 | * A CreativeWork or Event about this Thing. |
|
357 | * |
|
358 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
359 | * |
|
360 | * @return static |
|
361 | * |
|
362 | * @see http://schema.org/subjectOf |
|
363 | */ |
|
364 | public function subjectOf($subjectOf) |
|
365 | { |
|
366 | return $this->setProperty('subjectOf', $subjectOf); |
|
367 | } |
|
368 | ||
369 | /** |
|
370 | * Indicates a target EntryPoint for an Action. |
|
371 | * |
|
372 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
373 | * |
|
374 | * @return static |
|
375 | * |
|
376 | * @see http://schema.org/target |
|
377 | */ |
|
378 | public function target($target) |
|
379 | { |
|
380 | return $this->setProperty('target', $target); |
|
381 | } |
|
382 | ||
383 | /** |
|
384 | * A sub property of object. The collection target of the action. |
|
385 | * |
|
386 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $targetCollection |
|
387 | * |
|
388 | * @return static |
|
389 | * |
|
390 | * @see http://schema.org/targetCollection |
|
391 | */ |
|
392 | public function targetCollection($targetCollection) |
|
393 | { |
|
394 | return $this->setProperty('targetCollection', $targetCollection); |
|
395 | } |
|
396 | ||
397 | /** |
|
398 | * URL of the item. |
|
399 | * |
|
400 | * @param string|string[] $url |
|
401 | * |
|
402 | * @return static |
|
403 | * |
|
404 | * @see http://schema.org/url |
|
405 | */ |
|
406 | public function url($url) |
|
407 | { |
|
408 | return $this->setProperty('url', $url); |
|
409 | } |
|
410 | ||
411 | } |
|
412 |
@@ 17-436 (lines=420) @@ | ||
14 | * @see http://schema.org/DeliveryChargeSpecification |
|
15 | * |
|
16 | */ |
|
17 | class DeliveryChargeSpecification extends BaseType implements DeliveryChargeSpecificationContract, IntangibleContract, PriceSpecificationContract, StructuredValueContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * An additional type for the item, typically used for adding more specific |
|
21 | * types from external vocabularies in microdata syntax. This is a |
|
22 | * relationship between something and a class that the thing is in. In RDFa |
|
23 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
24 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
25 | * understanding of extra types, in particular those defined externally. |
|
26 | * |
|
27 | * @param string|string[] $additionalType |
|
28 | * |
|
29 | * @return static |
|
30 | * |
|
31 | * @see http://schema.org/additionalType |
|
32 | */ |
|
33 | public function additionalType($additionalType) |
|
34 | { |
|
35 | return $this->setProperty('additionalType', $additionalType); |
|
36 | } |
|
37 | ||
38 | /** |
|
39 | * An alias for the item. |
|
40 | * |
|
41 | * @param string|string[] $alternateName |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/alternateName |
|
46 | */ |
|
47 | public function alternateName($alternateName) |
|
48 | { |
|
49 | return $this->setProperty('alternateName', $alternateName); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The delivery method(s) to which the delivery charge or payment charge |
|
54 | * specification applies. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\DeliveryMethodContract|\Spatie\SchemaOrg\Contracts\DeliveryMethodContract[] $appliesToDeliveryMethod |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/appliesToDeliveryMethod |
|
61 | */ |
|
62 | public function appliesToDeliveryMethod($appliesToDeliveryMethod) |
|
63 | { |
|
64 | return $this->setProperty('appliesToDeliveryMethod', $appliesToDeliveryMethod); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The geographic area where a service or offered item is provided. |
|
69 | * |
|
70 | * @param \Spatie\SchemaOrg\Contracts\AdministrativeAreaContract|\Spatie\SchemaOrg\Contracts\AdministrativeAreaContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|string|string[] $areaServed |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/areaServed |
|
75 | */ |
|
76 | public function areaServed($areaServed) |
|
77 | { |
|
78 | return $this->setProperty('areaServed', $areaServed); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The interval and unit of measurement of ordering quantities for which the |
|
114 | * offer or price specification is valid. This allows e.g. specifying that a |
|
115 | * certain freight charge is valid only for a certain quantity. |
|
116 | * |
|
117 | * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $eligibleQuantity |
|
118 | * |
|
119 | * @return static |
|
120 | * |
|
121 | * @see http://schema.org/eligibleQuantity |
|
122 | */ |
|
123 | public function eligibleQuantity($eligibleQuantity) |
|
124 | { |
|
125 | return $this->setProperty('eligibleQuantity', $eligibleQuantity); |
|
126 | } |
|
127 | ||
128 | /** |
|
129 | * The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the |
|
130 | * GeoShape for the geo-political region(s) for which the offer or delivery |
|
131 | * charge specification is valid. |
|
132 | * |
|
133 | * See also [[ineligibleRegion]]. |
|
134 | * |
|
135 | * @param \Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|string|string[] $eligibleRegion |
|
136 | * |
|
137 | * @return static |
|
138 | * |
|
139 | * @see http://schema.org/eligibleRegion |
|
140 | */ |
|
141 | public function eligibleRegion($eligibleRegion) |
|
142 | { |
|
143 | return $this->setProperty('eligibleRegion', $eligibleRegion); |
|
144 | } |
|
145 | ||
146 | /** |
|
147 | * The transaction volume, in a monetary unit, for which the offer or price |
|
148 | * specification is valid, e.g. for indicating a minimal purchasing volume, |
|
149 | * to express free shipping above a certain order volume, or to limit the |
|
150 | * acceptance of credit cards to purchases to a certain minimal amount. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[] $eligibleTransactionVolume |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/eligibleTransactionVolume |
|
157 | */ |
|
158 | public function eligibleTransactionVolume($eligibleTransactionVolume) |
|
159 | { |
|
160 | return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * The identifier property represents any kind of identifier for any kind of |
|
165 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
166 | * dedicated properties for representing many of these, either as textual |
|
167 | * strings or as URL (URI) links. See [background |
|
168 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/identifier |
|
175 | */ |
|
176 | public function identifier($identifier) |
|
177 | { |
|
178 | return $this->setProperty('identifier', $identifier); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * An image of the item. This can be a [[URL]] or a fully described |
|
183 | * [[ImageObject]]. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/image |
|
190 | */ |
|
191 | public function image($image) |
|
192 | { |
|
193 | return $this->setProperty('image', $image); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the |
|
198 | * GeoShape for the geo-political region(s) for which the offer or delivery |
|
199 | * charge specification is not valid, e.g. a region where the transaction is |
|
200 | * not allowed. |
|
201 | * |
|
202 | * See also [[eligibleRegion]]. |
|
203 | * |
|
204 | * @param \Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|string|string[] $ineligibleRegion |
|
205 | * |
|
206 | * @return static |
|
207 | * |
|
208 | * @see http://schema.org/ineligibleRegion |
|
209 | */ |
|
210 | public function ineligibleRegion($ineligibleRegion) |
|
211 | { |
|
212 | return $this->setProperty('ineligibleRegion', $ineligibleRegion); |
|
213 | } |
|
214 | ||
215 | /** |
|
216 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
217 | * entity being described. See [background |
|
218 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
219 | * |
|
220 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
221 | * |
|
222 | * @return static |
|
223 | * |
|
224 | * @see http://schema.org/mainEntityOfPage |
|
225 | */ |
|
226 | public function mainEntityOfPage($mainEntityOfPage) |
|
227 | { |
|
228 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
229 | } |
|
230 | ||
231 | /** |
|
232 | * The highest price if the price is a range. |
|
233 | * |
|
234 | * @param float|float[]|int|int[] $maxPrice |
|
235 | * |
|
236 | * @return static |
|
237 | * |
|
238 | * @see http://schema.org/maxPrice |
|
239 | */ |
|
240 | public function maxPrice($maxPrice) |
|
241 | { |
|
242 | return $this->setProperty('maxPrice', $maxPrice); |
|
243 | } |
|
244 | ||
245 | /** |
|
246 | * The lowest price if the price is a range. |
|
247 | * |
|
248 | * @param float|float[]|int|int[] $minPrice |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/minPrice |
|
253 | */ |
|
254 | public function minPrice($minPrice) |
|
255 | { |
|
256 | return $this->setProperty('minPrice', $minPrice); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The name of the item. |
|
261 | * |
|
262 | * @param string|string[] $name |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/name |
|
267 | */ |
|
268 | public function name($name) |
|
269 | { |
|
270 | return $this->setProperty('name', $name); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * Indicates a potential Action, which describes an idealized action in |
|
275 | * which this thing would play an 'object' role. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/potentialAction |
|
282 | */ |
|
283 | public function potentialAction($potentialAction) |
|
284 | { |
|
285 | return $this->setProperty('potentialAction', $potentialAction); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * The offer price of a product, or of a price component when attached to |
|
290 | * PriceSpecification and its subtypes. |
|
291 | * |
|
292 | * Usage guidelines: |
|
293 | * |
|
294 | * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 |
|
295 | * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; |
|
296 | * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) |
|
297 | * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
298 | * Tradings |
|
299 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
300 | * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including |
|
301 | * [ambiguous |
|
302 | * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) |
|
303 | * such as '$' in the value. |
|
304 | * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a |
|
305 | * decimal point. Avoid using these symbols as a readability separator. |
|
306 | * * Note that both |
|
307 | * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) |
|
308 | * and Microdata syntax allow the use of a "content=" attribute for |
|
309 | * publishing simple machine-readable values alongside more human-friendly |
|
310 | * formatting. |
|
311 | * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT |
|
312 | * NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
|
313 | * |
|
314 | * @param float|float[]|int|int[]|string|string[] $price |
|
315 | * |
|
316 | * @return static |
|
317 | * |
|
318 | * @see http://schema.org/price |
|
319 | */ |
|
320 | public function price($price) |
|
321 | { |
|
322 | return $this->setProperty('price', $price); |
|
323 | } |
|
324 | ||
325 | /** |
|
326 | * The currency of the price, or a price component when attached to |
|
327 | * [[PriceSpecification]] and its subtypes. |
|
328 | * |
|
329 | * Use standard formats: [ISO 4217 currency |
|
330 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
331 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
332 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
333 | * Tradings |
|
334 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
335 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
336 | * |
|
337 | * @param string|string[] $priceCurrency |
|
338 | * |
|
339 | * @return static |
|
340 | * |
|
341 | * @see http://schema.org/priceCurrency |
|
342 | */ |
|
343 | public function priceCurrency($priceCurrency) |
|
344 | { |
|
345 | return $this->setProperty('priceCurrency', $priceCurrency); |
|
346 | } |
|
347 | ||
348 | /** |
|
349 | * URL of a reference Web page that unambiguously indicates the item's |
|
350 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
351 | * official website. |
|
352 | * |
|
353 | * @param string|string[] $sameAs |
|
354 | * |
|
355 | * @return static |
|
356 | * |
|
357 | * @see http://schema.org/sameAs |
|
358 | */ |
|
359 | public function sameAs($sameAs) |
|
360 | { |
|
361 | return $this->setProperty('sameAs', $sameAs); |
|
362 | } |
|
363 | ||
364 | /** |
|
365 | * A CreativeWork or Event about this Thing. |
|
366 | * |
|
367 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
368 | * |
|
369 | * @return static |
|
370 | * |
|
371 | * @see http://schema.org/subjectOf |
|
372 | */ |
|
373 | public function subjectOf($subjectOf) |
|
374 | { |
|
375 | return $this->setProperty('subjectOf', $subjectOf); |
|
376 | } |
|
377 | ||
378 | /** |
|
379 | * URL of the item. |
|
380 | * |
|
381 | * @param string|string[] $url |
|
382 | * |
|
383 | * @return static |
|
384 | * |
|
385 | * @see http://schema.org/url |
|
386 | */ |
|
387 | public function url($url) |
|
388 | { |
|
389 | return $this->setProperty('url', $url); |
|
390 | } |
|
391 | ||
392 | /** |
|
393 | * The date when the item becomes valid. |
|
394 | * |
|
395 | * @param \DateTimeInterface|\DateTimeInterface[] $validFrom |
|
396 | * |
|
397 | * @return static |
|
398 | * |
|
399 | * @see http://schema.org/validFrom |
|
400 | */ |
|
401 | public function validFrom($validFrom) |
|
402 | { |
|
403 | return $this->setProperty('validFrom', $validFrom); |
|
404 | } |
|
405 | ||
406 | /** |
|
407 | * The date after when the item is not valid. For example the end of an |
|
408 | * offer, salary period, or a period of opening hours. |
|
409 | * |
|
410 | * @param \DateTimeInterface|\DateTimeInterface[] $validThrough |
|
411 | * |
|
412 | * @return static |
|
413 | * |
|
414 | * @see http://schema.org/validThrough |
|
415 | */ |
|
416 | public function validThrough($validThrough) |
|
417 | { |
|
418 | return $this->setProperty('validThrough', $validThrough); |
|
419 | } |
|
420 | ||
421 | /** |
|
422 | * Specifies whether the applicable value-added tax (VAT) is included in the |
|
423 | * price specification or not. |
|
424 | * |
|
425 | * @param bool|bool[] $valueAddedTaxIncluded |
|
426 | * |
|
427 | * @return static |
|
428 | * |
|
429 | * @see http://schema.org/valueAddedTaxIncluded |
|
430 | */ |
|
431 | public function valueAddedTaxIncluded($valueAddedTaxIncluded) |
|
432 | { |
|
433 | return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); |
|
434 | } |
|
435 | ||
436 | } |
|
437 |
@@ 17-414 (lines=398) @@ | ||
14 | * @see http://schema.org/DepartAction |
|
15 | * |
|
16 | */ |
|
17 | class DepartAction extends BaseType implements DepartActionContract, ActionContract, MoveActionContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * For failed actions, more information on the cause of the failure. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/error |
|
143 | */ |
|
144 | public function error($error) |
|
145 | { |
|
146 | return $this->setProperty('error', $error); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * A sub property of location. The original location of the object or the |
|
151 | * agent before the action. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/fromLocation |
|
158 | */ |
|
159 | public function fromLocation($fromLocation) |
|
160 | { |
|
161 | return $this->setProperty('fromLocation', $fromLocation); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * The identifier property represents any kind of identifier for any kind of |
|
166 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
167 | * dedicated properties for representing many of these, either as textual |
|
168 | * strings or as URL (URI) links. See [background |
|
169 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/identifier |
|
176 | */ |
|
177 | public function identifier($identifier) |
|
178 | { |
|
179 | return $this->setProperty('identifier', $identifier); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * An image of the item. This can be a [[URL]] or a fully described |
|
184 | * [[ImageObject]]. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/image |
|
191 | */ |
|
192 | public function image($image) |
|
193 | { |
|
194 | return $this->setProperty('image', $image); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The object that helped the agent perform the action. e.g. John wrote a |
|
199 | * book with *a pen*. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/instrument |
|
206 | */ |
|
207 | public function instrument($instrument) |
|
208 | { |
|
209 | return $this->setProperty('instrument', $instrument); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * The location of for example where the event is happening, an organization |
|
214 | * is located, or where an action takes place. |
|
215 | * |
|
216 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
217 | * |
|
218 | * @return static |
|
219 | * |
|
220 | * @see http://schema.org/location |
|
221 | */ |
|
222 | public function location($location) |
|
223 | { |
|
224 | return $this->setProperty('location', $location); |
|
225 | } |
|
226 | ||
227 | /** |
|
228 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
229 | * entity being described. See [background |
|
230 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/mainEntityOfPage |
|
237 | */ |
|
238 | public function mainEntityOfPage($mainEntityOfPage) |
|
239 | { |
|
240 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * The name of the item. |
|
245 | * |
|
246 | * @param string|string[] $name |
|
247 | * |
|
248 | * @return static |
|
249 | * |
|
250 | * @see http://schema.org/name |
|
251 | */ |
|
252 | public function name($name) |
|
253 | { |
|
254 | return $this->setProperty('name', $name); |
|
255 | } |
|
256 | ||
257 | /** |
|
258 | * The object upon which the action is carried out, whose state is kept |
|
259 | * intact or changed. Also known as the semantic roles patient, affected or |
|
260 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
261 | * read *a book*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/object |
|
268 | */ |
|
269 | public function object($object) |
|
270 | { |
|
271 | return $this->setProperty('object', $object); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Other co-agents that participated in the action indirectly. e.g. John |
|
276 | * wrote a book with *Steve*. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/participant |
|
283 | */ |
|
284 | public function participant($participant) |
|
285 | { |
|
286 | return $this->setProperty('participant', $participant); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * Indicates a potential Action, which describes an idealized action in |
|
291 | * which this thing would play an 'object' role. |
|
292 | * |
|
293 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
294 | * |
|
295 | * @return static |
|
296 | * |
|
297 | * @see http://schema.org/potentialAction |
|
298 | */ |
|
299 | public function potentialAction($potentialAction) |
|
300 | { |
|
301 | return $this->setProperty('potentialAction', $potentialAction); |
|
302 | } |
|
303 | ||
304 | /** |
|
305 | * The result produced in the action. e.g. John wrote *a book*. |
|
306 | * |
|
307 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
308 | * |
|
309 | * @return static |
|
310 | * |
|
311 | * @see http://schema.org/result |
|
312 | */ |
|
313 | public function result($result) |
|
314 | { |
|
315 | return $this->setProperty('result', $result); |
|
316 | } |
|
317 | ||
318 | /** |
|
319 | * URL of a reference Web page that unambiguously indicates the item's |
|
320 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
321 | * official website. |
|
322 | * |
|
323 | * @param string|string[] $sameAs |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/sameAs |
|
328 | */ |
|
329 | public function sameAs($sameAs) |
|
330 | { |
|
331 | return $this->setProperty('sameAs', $sameAs); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * The startTime of something. For a reserved event or service (e.g. |
|
336 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
337 | * actions that span a period of time, when the action was performed. e.g. |
|
338 | * John wrote a book from *January* to December. For media, including audio |
|
339 | * and video, it's the time offset of the start of a clip within a larger |
|
340 | * file. |
|
341 | * |
|
342 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
343 | * when describing dates with times. This situation may be clarified in |
|
344 | * future revisions. |
|
345 | * |
|
346 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
347 | * |
|
348 | * @return static |
|
349 | * |
|
350 | * @see http://schema.org/startTime |
|
351 | */ |
|
352 | public function startTime($startTime) |
|
353 | { |
|
354 | return $this->setProperty('startTime', $startTime); |
|
355 | } |
|
356 | ||
357 | /** |
|
358 | * A CreativeWork or Event about this Thing. |
|
359 | * |
|
360 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
361 | * |
|
362 | * @return static |
|
363 | * |
|
364 | * @see http://schema.org/subjectOf |
|
365 | */ |
|
366 | public function subjectOf($subjectOf) |
|
367 | { |
|
368 | return $this->setProperty('subjectOf', $subjectOf); |
|
369 | } |
|
370 | ||
371 | /** |
|
372 | * Indicates a target EntryPoint for an Action. |
|
373 | * |
|
374 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
375 | * |
|
376 | * @return static |
|
377 | * |
|
378 | * @see http://schema.org/target |
|
379 | */ |
|
380 | public function target($target) |
|
381 | { |
|
382 | return $this->setProperty('target', $target); |
|
383 | } |
|
384 | ||
385 | /** |
|
386 | * A sub property of location. The final location of the object or the agent |
|
387 | * after the action. |
|
388 | * |
|
389 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/toLocation |
|
394 | */ |
|
395 | public function toLocation($toLocation) |
|
396 | { |
|
397 | return $this->setProperty('toLocation', $toLocation); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * URL of the item. |
|
402 | * |
|
403 | * @param string|string[] $url |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/url |
|
408 | */ |
|
409 | public function url($url) |
|
410 | { |
|
411 | return $this->setProperty('url', $url); |
|
412 | } |
|
413 | ||
414 | } |
|
415 |
@@ 16-413 (lines=398) @@ | ||
13 | * @see http://schema.org/DownloadAction |
|
14 | * |
|
15 | */ |
|
16 | class DownloadAction extends BaseType implements DownloadActionContract, ActionContract, ThingContract, TransferActionContract |
|
17 | { |
|
18 | /** |
|
19 | * Indicates the current disposition of the Action. |
|
20 | * |
|
21 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
22 | * |
|
23 | * @return static |
|
24 | * |
|
25 | * @see http://schema.org/actionStatus |
|
26 | */ |
|
27 | public function actionStatus($actionStatus) |
|
28 | { |
|
29 | return $this->setProperty('actionStatus', $actionStatus); |
|
30 | } |
|
31 | ||
32 | /** |
|
33 | * An additional type for the item, typically used for adding more specific |
|
34 | * types from external vocabularies in microdata syntax. This is a |
|
35 | * relationship between something and a class that the thing is in. In RDFa |
|
36 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
37 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
38 | * understanding of extra types, in particular those defined externally. |
|
39 | * |
|
40 | * @param string|string[] $additionalType |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/additionalType |
|
45 | */ |
|
46 | public function additionalType($additionalType) |
|
47 | { |
|
48 | return $this->setProperty('additionalType', $additionalType); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
53 | * *John* wrote a book. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/agent |
|
60 | */ |
|
61 | public function agent($agent) |
|
62 | { |
|
63 | return $this->setProperty('agent', $agent); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * An alias for the item. |
|
68 | * |
|
69 | * @param string|string[] $alternateName |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/alternateName |
|
74 | */ |
|
75 | public function alternateName($alternateName) |
|
76 | { |
|
77 | return $this->setProperty('alternateName', $alternateName); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * A description of the item. |
|
82 | * |
|
83 | * @param string|string[] $description |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/description |
|
88 | */ |
|
89 | public function description($description) |
|
90 | { |
|
91 | return $this->setProperty('description', $description); |
|
92 | } |
|
93 | ||
94 | /** |
|
95 | * A sub property of description. A short description of the item used to |
|
96 | * disambiguate from other, similar items. Information from other properties |
|
97 | * (in particular, name) may be necessary for the description to be useful |
|
98 | * for disambiguation. |
|
99 | * |
|
100 | * @param string|string[] $disambiguatingDescription |
|
101 | * |
|
102 | * @return static |
|
103 | * |
|
104 | * @see http://schema.org/disambiguatingDescription |
|
105 | */ |
|
106 | public function disambiguatingDescription($disambiguatingDescription) |
|
107 | { |
|
108 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
109 | } |
|
110 | ||
111 | /** |
|
112 | * The endTime of something. For a reserved event or service (e.g. |
|
113 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
114 | * actions that span a period of time, when the action was performed. e.g. |
|
115 | * John wrote a book from January to *December*. For media, including audio |
|
116 | * and video, it's the time offset of the end of a clip within a larger |
|
117 | * file. |
|
118 | * |
|
119 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
120 | * when describing dates with times. This situation may be clarified in |
|
121 | * future revisions. |
|
122 | * |
|
123 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
124 | * |
|
125 | * @return static |
|
126 | * |
|
127 | * @see http://schema.org/endTime |
|
128 | */ |
|
129 | public function endTime($endTime) |
|
130 | { |
|
131 | return $this->setProperty('endTime', $endTime); |
|
132 | } |
|
133 | ||
134 | /** |
|
135 | * For failed actions, more information on the cause of the failure. |
|
136 | * |
|
137 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
138 | * |
|
139 | * @return static |
|
140 | * |
|
141 | * @see http://schema.org/error |
|
142 | */ |
|
143 | public function error($error) |
|
144 | { |
|
145 | return $this->setProperty('error', $error); |
|
146 | } |
|
147 | ||
148 | /** |
|
149 | * A sub property of location. The original location of the object or the |
|
150 | * agent before the action. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/fromLocation |
|
157 | */ |
|
158 | public function fromLocation($fromLocation) |
|
159 | { |
|
160 | return $this->setProperty('fromLocation', $fromLocation); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * The identifier property represents any kind of identifier for any kind of |
|
165 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
166 | * dedicated properties for representing many of these, either as textual |
|
167 | * strings or as URL (URI) links. See [background |
|
168 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/identifier |
|
175 | */ |
|
176 | public function identifier($identifier) |
|
177 | { |
|
178 | return $this->setProperty('identifier', $identifier); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * An image of the item. This can be a [[URL]] or a fully described |
|
183 | * [[ImageObject]]. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/image |
|
190 | */ |
|
191 | public function image($image) |
|
192 | { |
|
193 | return $this->setProperty('image', $image); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * The object that helped the agent perform the action. e.g. John wrote a |
|
198 | * book with *a pen*. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/instrument |
|
205 | */ |
|
206 | public function instrument($instrument) |
|
207 | { |
|
208 | return $this->setProperty('instrument', $instrument); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * The location of for example where the event is happening, an organization |
|
213 | * is located, or where an action takes place. |
|
214 | * |
|
215 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
216 | * |
|
217 | * @return static |
|
218 | * |
|
219 | * @see http://schema.org/location |
|
220 | */ |
|
221 | public function location($location) |
|
222 | { |
|
223 | return $this->setProperty('location', $location); |
|
224 | } |
|
225 | ||
226 | /** |
|
227 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
228 | * entity being described. See [background |
|
229 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
230 | * |
|
231 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/mainEntityOfPage |
|
236 | */ |
|
237 | public function mainEntityOfPage($mainEntityOfPage) |
|
238 | { |
|
239 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The name of the item. |
|
244 | * |
|
245 | * @param string|string[] $name |
|
246 | * |
|
247 | * @return static |
|
248 | * |
|
249 | * @see http://schema.org/name |
|
250 | */ |
|
251 | public function name($name) |
|
252 | { |
|
253 | return $this->setProperty('name', $name); |
|
254 | } |
|
255 | ||
256 | /** |
|
257 | * The object upon which the action is carried out, whose state is kept |
|
258 | * intact or changed. Also known as the semantic roles patient, affected or |
|
259 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
260 | * read *a book*. |
|
261 | * |
|
262 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/object |
|
267 | */ |
|
268 | public function object($object) |
|
269 | { |
|
270 | return $this->setProperty('object', $object); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * Other co-agents that participated in the action indirectly. e.g. John |
|
275 | * wrote a book with *Steve*. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/participant |
|
282 | */ |
|
283 | public function participant($participant) |
|
284 | { |
|
285 | return $this->setProperty('participant', $participant); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * Indicates a potential Action, which describes an idealized action in |
|
290 | * which this thing would play an 'object' role. |
|
291 | * |
|
292 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
293 | * |
|
294 | * @return static |
|
295 | * |
|
296 | * @see http://schema.org/potentialAction |
|
297 | */ |
|
298 | public function potentialAction($potentialAction) |
|
299 | { |
|
300 | return $this->setProperty('potentialAction', $potentialAction); |
|
301 | } |
|
302 | ||
303 | /** |
|
304 | * The result produced in the action. e.g. John wrote *a book*. |
|
305 | * |
|
306 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
307 | * |
|
308 | * @return static |
|
309 | * |
|
310 | * @see http://schema.org/result |
|
311 | */ |
|
312 | public function result($result) |
|
313 | { |
|
314 | return $this->setProperty('result', $result); |
|
315 | } |
|
316 | ||
317 | /** |
|
318 | * URL of a reference Web page that unambiguously indicates the item's |
|
319 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
320 | * official website. |
|
321 | * |
|
322 | * @param string|string[] $sameAs |
|
323 | * |
|
324 | * @return static |
|
325 | * |
|
326 | * @see http://schema.org/sameAs |
|
327 | */ |
|
328 | public function sameAs($sameAs) |
|
329 | { |
|
330 | return $this->setProperty('sameAs', $sameAs); |
|
331 | } |
|
332 | ||
333 | /** |
|
334 | * The startTime of something. For a reserved event or service (e.g. |
|
335 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
336 | * actions that span a period of time, when the action was performed. e.g. |
|
337 | * John wrote a book from *January* to December. For media, including audio |
|
338 | * and video, it's the time offset of the start of a clip within a larger |
|
339 | * file. |
|
340 | * |
|
341 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
342 | * when describing dates with times. This situation may be clarified in |
|
343 | * future revisions. |
|
344 | * |
|
345 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
346 | * |
|
347 | * @return static |
|
348 | * |
|
349 | * @see http://schema.org/startTime |
|
350 | */ |
|
351 | public function startTime($startTime) |
|
352 | { |
|
353 | return $this->setProperty('startTime', $startTime); |
|
354 | } |
|
355 | ||
356 | /** |
|
357 | * A CreativeWork or Event about this Thing. |
|
358 | * |
|
359 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
360 | * |
|
361 | * @return static |
|
362 | * |
|
363 | * @see http://schema.org/subjectOf |
|
364 | */ |
|
365 | public function subjectOf($subjectOf) |
|
366 | { |
|
367 | return $this->setProperty('subjectOf', $subjectOf); |
|
368 | } |
|
369 | ||
370 | /** |
|
371 | * Indicates a target EntryPoint for an Action. |
|
372 | * |
|
373 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
374 | * |
|
375 | * @return static |
|
376 | * |
|
377 | * @see http://schema.org/target |
|
378 | */ |
|
379 | public function target($target) |
|
380 | { |
|
381 | return $this->setProperty('target', $target); |
|
382 | } |
|
383 | ||
384 | /** |
|
385 | * A sub property of location. The final location of the object or the agent |
|
386 | * after the action. |
|
387 | * |
|
388 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
389 | * |
|
390 | * @return static |
|
391 | * |
|
392 | * @see http://schema.org/toLocation |
|
393 | */ |
|
394 | public function toLocation($toLocation) |
|
395 | { |
|
396 | return $this->setProperty('toLocation', $toLocation); |
|
397 | } |
|
398 | ||
399 | /** |
|
400 | * URL of the item. |
|
401 | * |
|
402 | * @param string|string[] $url |
|
403 | * |
|
404 | * @return static |
|
405 | * |
|
406 | * @see http://schema.org/url |
|
407 | */ |
|
408 | public function url($url) |
|
409 | { |
|
410 | return $this->setProperty('url', $url); |
|
411 | } |
|
412 | ||
413 | } |
|
414 |
@@ 16-415 (lines=400) @@ | ||
13 | * @see http://schema.org/DrinkAction |
|
14 | * |
|
15 | */ |
|
16 | class DrinkAction extends BaseType implements DrinkActionContract, ActionContract, ConsumeActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * A set of requirements that a must be fulfilled in order to perform an |
|
20 | * Action. If more than one value is specied, fulfilling one set of |
|
21 | * requirements will allow the Action to be performed. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionAccessibilityRequirement |
|
28 | */ |
|
29 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
30 | { |
|
31 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * Indicates the current disposition of the Action. |
|
36 | * |
|
37 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
38 | * |
|
39 | * @return static |
|
40 | * |
|
41 | * @see http://schema.org/actionStatus |
|
42 | */ |
|
43 | public function actionStatus($actionStatus) |
|
44 | { |
|
45 | return $this->setProperty('actionStatus', $actionStatus); |
|
46 | } |
|
47 | ||
48 | /** |
|
49 | * An additional type for the item, typically used for adding more specific |
|
50 | * types from external vocabularies in microdata syntax. This is a |
|
51 | * relationship between something and a class that the thing is in. In RDFa |
|
52 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
53 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
54 | * understanding of extra types, in particular those defined externally. |
|
55 | * |
|
56 | * @param string|string[] $additionalType |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/additionalType |
|
61 | */ |
|
62 | public function additionalType($additionalType) |
|
63 | { |
|
64 | return $this->setProperty('additionalType', $additionalType); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
69 | * *John* wrote a book. |
|
70 | * |
|
71 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/agent |
|
76 | */ |
|
77 | public function agent($agent) |
|
78 | { |
|
79 | return $this->setProperty('agent', $agent); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * An alias for the item. |
|
84 | * |
|
85 | * @param string|string[] $alternateName |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/alternateName |
|
90 | */ |
|
91 | public function alternateName($alternateName) |
|
92 | { |
|
93 | return $this->setProperty('alternateName', $alternateName); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * An Offer which must be accepted before the user can perform the Action. |
|
166 | * For example, the user may need to buy a movie before being able to watch |
|
167 | * it. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/expectsAcceptanceOf |
|
174 | */ |
|
175 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
176 | { |
|
177 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * The identifier property represents any kind of identifier for any kind of |
|
182 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
183 | * dedicated properties for representing many of these, either as textual |
|
184 | * strings or as URL (URI) links. See [background |
|
185 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
186 | * |
|
187 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
188 | * |
|
189 | * @return static |
|
190 | * |
|
191 | * @see http://schema.org/identifier |
|
192 | */ |
|
193 | public function identifier($identifier) |
|
194 | { |
|
195 | return $this->setProperty('identifier', $identifier); |
|
196 | } |
|
197 | ||
198 | /** |
|
199 | * An image of the item. This can be a [[URL]] or a fully described |
|
200 | * [[ImageObject]]. |
|
201 | * |
|
202 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
203 | * |
|
204 | * @return static |
|
205 | * |
|
206 | * @see http://schema.org/image |
|
207 | */ |
|
208 | public function image($image) |
|
209 | { |
|
210 | return $this->setProperty('image', $image); |
|
211 | } |
|
212 | ||
213 | /** |
|
214 | * The object that helped the agent perform the action. e.g. John wrote a |
|
215 | * book with *a pen*. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/instrument |
|
222 | */ |
|
223 | public function instrument($instrument) |
|
224 | { |
|
225 | return $this->setProperty('instrument', $instrument); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The location of for example where the event is happening, an organization |
|
230 | * is located, or where an action takes place. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/location |
|
237 | */ |
|
238 | public function location($location) |
|
239 | { |
|
240 | return $this->setProperty('location', $location); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
245 | * entity being described. See [background |
|
246 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/mainEntityOfPage |
|
253 | */ |
|
254 | public function mainEntityOfPage($mainEntityOfPage) |
|
255 | { |
|
256 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The name of the item. |
|
261 | * |
|
262 | * @param string|string[] $name |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/name |
|
267 | */ |
|
268 | public function name($name) |
|
269 | { |
|
270 | return $this->setProperty('name', $name); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * The object upon which the action is carried out, whose state is kept |
|
275 | * intact or changed. Also known as the semantic roles patient, affected or |
|
276 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
277 | * read *a book*. |
|
278 | * |
|
279 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
280 | * |
|
281 | * @return static |
|
282 | * |
|
283 | * @see http://schema.org/object |
|
284 | */ |
|
285 | public function object($object) |
|
286 | { |
|
287 | return $this->setProperty('object', $object); |
|
288 | } |
|
289 | ||
290 | /** |
|
291 | * Other co-agents that participated in the action indirectly. e.g. John |
|
292 | * wrote a book with *Steve*. |
|
293 | * |
|
294 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
295 | * |
|
296 | * @return static |
|
297 | * |
|
298 | * @see http://schema.org/participant |
|
299 | */ |
|
300 | public function participant($participant) |
|
301 | { |
|
302 | return $this->setProperty('participant', $participant); |
|
303 | } |
|
304 | ||
305 | /** |
|
306 | * Indicates a potential Action, which describes an idealized action in |
|
307 | * which this thing would play an 'object' role. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/potentialAction |
|
314 | */ |
|
315 | public function potentialAction($potentialAction) |
|
316 | { |
|
317 | return $this->setProperty('potentialAction', $potentialAction); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * The result produced in the action. e.g. John wrote *a book*. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/result |
|
328 | */ |
|
329 | public function result($result) |
|
330 | { |
|
331 | return $this->setProperty('result', $result); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * The startTime of something. For a reserved event or service (e.g. |
|
352 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
353 | * actions that span a period of time, when the action was performed. e.g. |
|
354 | * John wrote a book from *January* to December. For media, including audio |
|
355 | * and video, it's the time offset of the start of a clip within a larger |
|
356 | * file. |
|
357 | * |
|
358 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
359 | * when describing dates with times. This situation may be clarified in |
|
360 | * future revisions. |
|
361 | * |
|
362 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
363 | * |
|
364 | * @return static |
|
365 | * |
|
366 | * @see http://schema.org/startTime |
|
367 | */ |
|
368 | public function startTime($startTime) |
|
369 | { |
|
370 | return $this->setProperty('startTime', $startTime); |
|
371 | } |
|
372 | ||
373 | /** |
|
374 | * A CreativeWork or Event about this Thing. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/subjectOf |
|
381 | */ |
|
382 | public function subjectOf($subjectOf) |
|
383 | { |
|
384 | return $this->setProperty('subjectOf', $subjectOf); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * Indicates a target EntryPoint for an Action. |
|
389 | * |
|
390 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/target |
|
395 | */ |
|
396 | public function target($target) |
|
397 | { |
|
398 | return $this->setProperty('target', $target); |
|
399 | } |
|
400 | ||
401 | /** |
|
402 | * URL of the item. |
|
403 | * |
|
404 | * @param string|string[] $url |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/url |
|
409 | */ |
|
410 | public function url($url) |
|
411 | { |
|
412 | return $this->setProperty('url', $url); |
|
413 | } |
|
414 | ||
415 | } |
|
416 |
@@ 16-415 (lines=400) @@ | ||
13 | * @see http://schema.org/EatAction |
|
14 | * |
|
15 | */ |
|
16 | class EatAction extends BaseType implements EatActionContract, ActionContract, ConsumeActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * A set of requirements that a must be fulfilled in order to perform an |
|
20 | * Action. If more than one value is specied, fulfilling one set of |
|
21 | * requirements will allow the Action to be performed. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionAccessibilityRequirement |
|
28 | */ |
|
29 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
30 | { |
|
31 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * Indicates the current disposition of the Action. |
|
36 | * |
|
37 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
38 | * |
|
39 | * @return static |
|
40 | * |
|
41 | * @see http://schema.org/actionStatus |
|
42 | */ |
|
43 | public function actionStatus($actionStatus) |
|
44 | { |
|
45 | return $this->setProperty('actionStatus', $actionStatus); |
|
46 | } |
|
47 | ||
48 | /** |
|
49 | * An additional type for the item, typically used for adding more specific |
|
50 | * types from external vocabularies in microdata syntax. This is a |
|
51 | * relationship between something and a class that the thing is in. In RDFa |
|
52 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
53 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
54 | * understanding of extra types, in particular those defined externally. |
|
55 | * |
|
56 | * @param string|string[] $additionalType |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/additionalType |
|
61 | */ |
|
62 | public function additionalType($additionalType) |
|
63 | { |
|
64 | return $this->setProperty('additionalType', $additionalType); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
69 | * *John* wrote a book. |
|
70 | * |
|
71 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/agent |
|
76 | */ |
|
77 | public function agent($agent) |
|
78 | { |
|
79 | return $this->setProperty('agent', $agent); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * An alias for the item. |
|
84 | * |
|
85 | * @param string|string[] $alternateName |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/alternateName |
|
90 | */ |
|
91 | public function alternateName($alternateName) |
|
92 | { |
|
93 | return $this->setProperty('alternateName', $alternateName); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * An Offer which must be accepted before the user can perform the Action. |
|
166 | * For example, the user may need to buy a movie before being able to watch |
|
167 | * it. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/expectsAcceptanceOf |
|
174 | */ |
|
175 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
176 | { |
|
177 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * The identifier property represents any kind of identifier for any kind of |
|
182 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
183 | * dedicated properties for representing many of these, either as textual |
|
184 | * strings or as URL (URI) links. See [background |
|
185 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
186 | * |
|
187 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
188 | * |
|
189 | * @return static |
|
190 | * |
|
191 | * @see http://schema.org/identifier |
|
192 | */ |
|
193 | public function identifier($identifier) |
|
194 | { |
|
195 | return $this->setProperty('identifier', $identifier); |
|
196 | } |
|
197 | ||
198 | /** |
|
199 | * An image of the item. This can be a [[URL]] or a fully described |
|
200 | * [[ImageObject]]. |
|
201 | * |
|
202 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
203 | * |
|
204 | * @return static |
|
205 | * |
|
206 | * @see http://schema.org/image |
|
207 | */ |
|
208 | public function image($image) |
|
209 | { |
|
210 | return $this->setProperty('image', $image); |
|
211 | } |
|
212 | ||
213 | /** |
|
214 | * The object that helped the agent perform the action. e.g. John wrote a |
|
215 | * book with *a pen*. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/instrument |
|
222 | */ |
|
223 | public function instrument($instrument) |
|
224 | { |
|
225 | return $this->setProperty('instrument', $instrument); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The location of for example where the event is happening, an organization |
|
230 | * is located, or where an action takes place. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/location |
|
237 | */ |
|
238 | public function location($location) |
|
239 | { |
|
240 | return $this->setProperty('location', $location); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
245 | * entity being described. See [background |
|
246 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/mainEntityOfPage |
|
253 | */ |
|
254 | public function mainEntityOfPage($mainEntityOfPage) |
|
255 | { |
|
256 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The name of the item. |
|
261 | * |
|
262 | * @param string|string[] $name |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/name |
|
267 | */ |
|
268 | public function name($name) |
|
269 | { |
|
270 | return $this->setProperty('name', $name); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * The object upon which the action is carried out, whose state is kept |
|
275 | * intact or changed. Also known as the semantic roles patient, affected or |
|
276 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
277 | * read *a book*. |
|
278 | * |
|
279 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
280 | * |
|
281 | * @return static |
|
282 | * |
|
283 | * @see http://schema.org/object |
|
284 | */ |
|
285 | public function object($object) |
|
286 | { |
|
287 | return $this->setProperty('object', $object); |
|
288 | } |
|
289 | ||
290 | /** |
|
291 | * Other co-agents that participated in the action indirectly. e.g. John |
|
292 | * wrote a book with *Steve*. |
|
293 | * |
|
294 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
295 | * |
|
296 | * @return static |
|
297 | * |
|
298 | * @see http://schema.org/participant |
|
299 | */ |
|
300 | public function participant($participant) |
|
301 | { |
|
302 | return $this->setProperty('participant', $participant); |
|
303 | } |
|
304 | ||
305 | /** |
|
306 | * Indicates a potential Action, which describes an idealized action in |
|
307 | * which this thing would play an 'object' role. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/potentialAction |
|
314 | */ |
|
315 | public function potentialAction($potentialAction) |
|
316 | { |
|
317 | return $this->setProperty('potentialAction', $potentialAction); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * The result produced in the action. e.g. John wrote *a book*. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/result |
|
328 | */ |
|
329 | public function result($result) |
|
330 | { |
|
331 | return $this->setProperty('result', $result); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * The startTime of something. For a reserved event or service (e.g. |
|
352 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
353 | * actions that span a period of time, when the action was performed. e.g. |
|
354 | * John wrote a book from *January* to December. For media, including audio |
|
355 | * and video, it's the time offset of the start of a clip within a larger |
|
356 | * file. |
|
357 | * |
|
358 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
359 | * when describing dates with times. This situation may be clarified in |
|
360 | * future revisions. |
|
361 | * |
|
362 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
363 | * |
|
364 | * @return static |
|
365 | * |
|
366 | * @see http://schema.org/startTime |
|
367 | */ |
|
368 | public function startTime($startTime) |
|
369 | { |
|
370 | return $this->setProperty('startTime', $startTime); |
|
371 | } |
|
372 | ||
373 | /** |
|
374 | * A CreativeWork or Event about this Thing. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/subjectOf |
|
381 | */ |
|
382 | public function subjectOf($subjectOf) |
|
383 | { |
|
384 | return $this->setProperty('subjectOf', $subjectOf); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * Indicates a target EntryPoint for an Action. |
|
389 | * |
|
390 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/target |
|
395 | */ |
|
396 | public function target($target) |
|
397 | { |
|
398 | return $this->setProperty('target', $target); |
|
399 | } |
|
400 | ||
401 | /** |
|
402 | * URL of the item. |
|
403 | * |
|
404 | * @param string|string[] $url |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/url |
|
409 | */ |
|
410 | public function url($url) |
|
411 | { |
|
412 | return $this->setProperty('url', $url); |
|
413 | } |
|
414 | ||
415 | } |
|
416 |
@@ 17-398 (lines=382) @@ | ||
14 | * @see http://schema.org/EndorseAction |
|
15 | * |
|
16 | */ |
|
17 | class EndorseAction extends BaseType implements EndorseActionContract, ActionContract, AssessActionContract, ReactActionContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * A sub property of participant. The person/organization being supported. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $endorsee |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/endorsee |
|
143 | */ |
|
144 | public function endorsee($endorsee) |
|
145 | { |
|
146 | return $this->setProperty('endorsee', $endorsee); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * For failed actions, more information on the cause of the failure. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/error |
|
157 | */ |
|
158 | public function error($error) |
|
159 | { |
|
160 | return $this->setProperty('error', $error); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * The identifier property represents any kind of identifier for any kind of |
|
165 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
166 | * dedicated properties for representing many of these, either as textual |
|
167 | * strings or as URL (URI) links. See [background |
|
168 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/identifier |
|
175 | */ |
|
176 | public function identifier($identifier) |
|
177 | { |
|
178 | return $this->setProperty('identifier', $identifier); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * An image of the item. This can be a [[URL]] or a fully described |
|
183 | * [[ImageObject]]. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/image |
|
190 | */ |
|
191 | public function image($image) |
|
192 | { |
|
193 | return $this->setProperty('image', $image); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * The object that helped the agent perform the action. e.g. John wrote a |
|
198 | * book with *a pen*. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/instrument |
|
205 | */ |
|
206 | public function instrument($instrument) |
|
207 | { |
|
208 | return $this->setProperty('instrument', $instrument); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * The location of for example where the event is happening, an organization |
|
213 | * is located, or where an action takes place. |
|
214 | * |
|
215 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
216 | * |
|
217 | * @return static |
|
218 | * |
|
219 | * @see http://schema.org/location |
|
220 | */ |
|
221 | public function location($location) |
|
222 | { |
|
223 | return $this->setProperty('location', $location); |
|
224 | } |
|
225 | ||
226 | /** |
|
227 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
228 | * entity being described. See [background |
|
229 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
230 | * |
|
231 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/mainEntityOfPage |
|
236 | */ |
|
237 | public function mainEntityOfPage($mainEntityOfPage) |
|
238 | { |
|
239 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The name of the item. |
|
244 | * |
|
245 | * @param string|string[] $name |
|
246 | * |
|
247 | * @return static |
|
248 | * |
|
249 | * @see http://schema.org/name |
|
250 | */ |
|
251 | public function name($name) |
|
252 | { |
|
253 | return $this->setProperty('name', $name); |
|
254 | } |
|
255 | ||
256 | /** |
|
257 | * The object upon which the action is carried out, whose state is kept |
|
258 | * intact or changed. Also known as the semantic roles patient, affected or |
|
259 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
260 | * read *a book*. |
|
261 | * |
|
262 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/object |
|
267 | */ |
|
268 | public function object($object) |
|
269 | { |
|
270 | return $this->setProperty('object', $object); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * Other co-agents that participated in the action indirectly. e.g. John |
|
275 | * wrote a book with *Steve*. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/participant |
|
282 | */ |
|
283 | public function participant($participant) |
|
284 | { |
|
285 | return $this->setProperty('participant', $participant); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * Indicates a potential Action, which describes an idealized action in |
|
290 | * which this thing would play an 'object' role. |
|
291 | * |
|
292 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
293 | * |
|
294 | * @return static |
|
295 | * |
|
296 | * @see http://schema.org/potentialAction |
|
297 | */ |
|
298 | public function potentialAction($potentialAction) |
|
299 | { |
|
300 | return $this->setProperty('potentialAction', $potentialAction); |
|
301 | } |
|
302 | ||
303 | /** |
|
304 | * The result produced in the action. e.g. John wrote *a book*. |
|
305 | * |
|
306 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
307 | * |
|
308 | * @return static |
|
309 | * |
|
310 | * @see http://schema.org/result |
|
311 | */ |
|
312 | public function result($result) |
|
313 | { |
|
314 | return $this->setProperty('result', $result); |
|
315 | } |
|
316 | ||
317 | /** |
|
318 | * URL of a reference Web page that unambiguously indicates the item's |
|
319 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
320 | * official website. |
|
321 | * |
|
322 | * @param string|string[] $sameAs |
|
323 | * |
|
324 | * @return static |
|
325 | * |
|
326 | * @see http://schema.org/sameAs |
|
327 | */ |
|
328 | public function sameAs($sameAs) |
|
329 | { |
|
330 | return $this->setProperty('sameAs', $sameAs); |
|
331 | } |
|
332 | ||
333 | /** |
|
334 | * The startTime of something. For a reserved event or service (e.g. |
|
335 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
336 | * actions that span a period of time, when the action was performed. e.g. |
|
337 | * John wrote a book from *January* to December. For media, including audio |
|
338 | * and video, it's the time offset of the start of a clip within a larger |
|
339 | * file. |
|
340 | * |
|
341 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
342 | * when describing dates with times. This situation may be clarified in |
|
343 | * future revisions. |
|
344 | * |
|
345 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
346 | * |
|
347 | * @return static |
|
348 | * |
|
349 | * @see http://schema.org/startTime |
|
350 | */ |
|
351 | public function startTime($startTime) |
|
352 | { |
|
353 | return $this->setProperty('startTime', $startTime); |
|
354 | } |
|
355 | ||
356 | /** |
|
357 | * A CreativeWork or Event about this Thing. |
|
358 | * |
|
359 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
360 | * |
|
361 | * @return static |
|
362 | * |
|
363 | * @see http://schema.org/subjectOf |
|
364 | */ |
|
365 | public function subjectOf($subjectOf) |
|
366 | { |
|
367 | return $this->setProperty('subjectOf', $subjectOf); |
|
368 | } |
|
369 | ||
370 | /** |
|
371 | * Indicates a target EntryPoint for an Action. |
|
372 | * |
|
373 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
374 | * |
|
375 | * @return static |
|
376 | * |
|
377 | * @see http://schema.org/target |
|
378 | */ |
|
379 | public function target($target) |
|
380 | { |
|
381 | return $this->setProperty('target', $target); |
|
382 | } |
|
383 | ||
384 | /** |
|
385 | * URL of the item. |
|
386 | * |
|
387 | * @param string|string[] $url |
|
388 | * |
|
389 | * @return static |
|
390 | * |
|
391 | * @see http://schema.org/url |
|
392 | */ |
|
393 | public function url($url) |
|
394 | { |
|
395 | return $this->setProperty('url', $url); |
|
396 | } |
|
397 | ||
398 | } |
|
399 |
@@ 20-414 (lines=395) @@ | ||
17 | * @see http://schema.org/EventReservation |
|
18 | * |
|
19 | */ |
|
20 | class EventReservation extends BaseType implements EventReservationContract, IntangibleContract, ReservationContract, ThingContract |
|
21 | { |
|
22 | /** |
|
23 | * An additional type for the item, typically used for adding more specific |
|
24 | * types from external vocabularies in microdata syntax. This is a |
|
25 | * relationship between something and a class that the thing is in. In RDFa |
|
26 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
27 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
28 | * understanding of extra types, in particular those defined externally. |
|
29 | * |
|
30 | * @param string|string[] $additionalType |
|
31 | * |
|
32 | * @return static |
|
33 | * |
|
34 | * @see http://schema.org/additionalType |
|
35 | */ |
|
36 | public function additionalType($additionalType) |
|
37 | { |
|
38 | return $this->setProperty('additionalType', $additionalType); |
|
39 | } |
|
40 | ||
41 | /** |
|
42 | * An alias for the item. |
|
43 | * |
|
44 | * @param string|string[] $alternateName |
|
45 | * |
|
46 | * @return static |
|
47 | * |
|
48 | * @see http://schema.org/alternateName |
|
49 | */ |
|
50 | public function alternateName($alternateName) |
|
51 | { |
|
52 | return $this->setProperty('alternateName', $alternateName); |
|
53 | } |
|
54 | ||
55 | /** |
|
56 | * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as |
|
57 | * a booking agent. |
|
58 | * |
|
59 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $bookingAgent |
|
60 | * |
|
61 | * @return static |
|
62 | * |
|
63 | * @see http://schema.org/bookingAgent |
|
64 | */ |
|
65 | public function bookingAgent($bookingAgent) |
|
66 | { |
|
67 | return $this->setProperty('bookingAgent', $bookingAgent); |
|
68 | } |
|
69 | ||
70 | /** |
|
71 | * The date and time the reservation was booked. |
|
72 | * |
|
73 | * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime |
|
74 | * |
|
75 | * @return static |
|
76 | * |
|
77 | * @see http://schema.org/bookingTime |
|
78 | */ |
|
79 | public function bookingTime($bookingTime) |
|
80 | { |
|
81 | return $this->setProperty('bookingTime', $bookingTime); |
|
82 | } |
|
83 | ||
84 | /** |
|
85 | * An entity that arranges for an exchange between a buyer and a seller. In |
|
86 | * most cases a broker never acquires or releases ownership of a product or |
|
87 | * service involved in an exchange. If it is not clear whether an entity is |
|
88 | * a broker, seller, or buyer, the latter two terms are preferred. |
|
89 | * |
|
90 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $broker |
|
91 | * |
|
92 | * @return static |
|
93 | * |
|
94 | * @see http://schema.org/broker |
|
95 | */ |
|
96 | public function broker($broker) |
|
97 | { |
|
98 | return $this->setProperty('broker', $broker); |
|
99 | } |
|
100 | ||
101 | /** |
|
102 | * A description of the item. |
|
103 | * |
|
104 | * @param string|string[] $description |
|
105 | * |
|
106 | * @return static |
|
107 | * |
|
108 | * @see http://schema.org/description |
|
109 | */ |
|
110 | public function description($description) |
|
111 | { |
|
112 | return $this->setProperty('description', $description); |
|
113 | } |
|
114 | ||
115 | /** |
|
116 | * A sub property of description. A short description of the item used to |
|
117 | * disambiguate from other, similar items. Information from other properties |
|
118 | * (in particular, name) may be necessary for the description to be useful |
|
119 | * for disambiguation. |
|
120 | * |
|
121 | * @param string|string[] $disambiguatingDescription |
|
122 | * |
|
123 | * @return static |
|
124 | * |
|
125 | * @see http://schema.org/disambiguatingDescription |
|
126 | */ |
|
127 | public function disambiguatingDescription($disambiguatingDescription) |
|
128 | { |
|
129 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
130 | } |
|
131 | ||
132 | /** |
|
133 | * The identifier property represents any kind of identifier for any kind of |
|
134 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
135 | * dedicated properties for representing many of these, either as textual |
|
136 | * strings or as URL (URI) links. See [background |
|
137 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
138 | * |
|
139 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/identifier |
|
144 | */ |
|
145 | public function identifier($identifier) |
|
146 | { |
|
147 | return $this->setProperty('identifier', $identifier); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * An image of the item. This can be a [[URL]] or a fully described |
|
152 | * [[ImageObject]]. |
|
153 | * |
|
154 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
155 | * |
|
156 | * @return static |
|
157 | * |
|
158 | * @see http://schema.org/image |
|
159 | */ |
|
160 | public function image($image) |
|
161 | { |
|
162 | return $this->setProperty('image', $image); |
|
163 | } |
|
164 | ||
165 | /** |
|
166 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
167 | * entity being described. See [background |
|
168 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/mainEntityOfPage |
|
175 | */ |
|
176 | public function mainEntityOfPage($mainEntityOfPage) |
|
177 | { |
|
178 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * The date and time the reservation was modified. |
|
183 | * |
|
184 | * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime |
|
185 | * |
|
186 | * @return static |
|
187 | * |
|
188 | * @see http://schema.org/modifiedTime |
|
189 | */ |
|
190 | public function modifiedTime($modifiedTime) |
|
191 | { |
|
192 | return $this->setProperty('modifiedTime', $modifiedTime); |
|
193 | } |
|
194 | ||
195 | /** |
|
196 | * The name of the item. |
|
197 | * |
|
198 | * @param string|string[] $name |
|
199 | * |
|
200 | * @return static |
|
201 | * |
|
202 | * @see http://schema.org/name |
|
203 | */ |
|
204 | public function name($name) |
|
205 | { |
|
206 | return $this->setProperty('name', $name); |
|
207 | } |
|
208 | ||
209 | /** |
|
210 | * Indicates a potential Action, which describes an idealized action in |
|
211 | * which this thing would play an 'object' role. |
|
212 | * |
|
213 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
214 | * |
|
215 | * @return static |
|
216 | * |
|
217 | * @see http://schema.org/potentialAction |
|
218 | */ |
|
219 | public function potentialAction($potentialAction) |
|
220 | { |
|
221 | return $this->setProperty('potentialAction', $potentialAction); |
|
222 | } |
|
223 | ||
224 | /** |
|
225 | * The currency of the price, or a price component when attached to |
|
226 | * [[PriceSpecification]] and its subtypes. |
|
227 | * |
|
228 | * Use standard formats: [ISO 4217 currency |
|
229 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
230 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
231 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
232 | * Tradings |
|
233 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
234 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
235 | * |
|
236 | * @param string|string[] $priceCurrency |
|
237 | * |
|
238 | * @return static |
|
239 | * |
|
240 | * @see http://schema.org/priceCurrency |
|
241 | */ |
|
242 | public function priceCurrency($priceCurrency) |
|
243 | { |
|
244 | return $this->setProperty('priceCurrency', $priceCurrency); |
|
245 | } |
|
246 | ||
247 | /** |
|
248 | * Any membership in a frequent flyer, hotel loyalty program, etc. being |
|
249 | * applied to the reservation. |
|
250 | * |
|
251 | * @param \Spatie\SchemaOrg\Contracts\ProgramMembershipContract|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract[] $programMembershipUsed |
|
252 | * |
|
253 | * @return static |
|
254 | * |
|
255 | * @see http://schema.org/programMembershipUsed |
|
256 | */ |
|
257 | public function programMembershipUsed($programMembershipUsed) |
|
258 | { |
|
259 | return $this->setProperty('programMembershipUsed', $programMembershipUsed); |
|
260 | } |
|
261 | ||
262 | /** |
|
263 | * The service provider, service operator, or service performer; the goods |
|
264 | * producer. Another party (a seller) may offer those services or goods on |
|
265 | * behalf of the provider. A provider may also serve as the seller. |
|
266 | * |
|
267 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider |
|
268 | * |
|
269 | * @return static |
|
270 | * |
|
271 | * @see http://schema.org/provider |
|
272 | */ |
|
273 | public function provider($provider) |
|
274 | { |
|
275 | return $this->setProperty('provider', $provider); |
|
276 | } |
|
277 | ||
278 | /** |
|
279 | * The thing -- flight, event, restaurant,etc. being reserved. |
|
280 | * |
|
281 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $reservationFor |
|
282 | * |
|
283 | * @return static |
|
284 | * |
|
285 | * @see http://schema.org/reservationFor |
|
286 | */ |
|
287 | public function reservationFor($reservationFor) |
|
288 | { |
|
289 | return $this->setProperty('reservationFor', $reservationFor); |
|
290 | } |
|
291 | ||
292 | /** |
|
293 | * A unique identifier for the reservation. |
|
294 | * |
|
295 | * @param string|string[] $reservationId |
|
296 | * |
|
297 | * @return static |
|
298 | * |
|
299 | * @see http://schema.org/reservationId |
|
300 | */ |
|
301 | public function reservationId($reservationId) |
|
302 | { |
|
303 | return $this->setProperty('reservationId', $reservationId); |
|
304 | } |
|
305 | ||
306 | /** |
|
307 | * The current status of the reservation. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ReservationStatusTypeContract|\Spatie\SchemaOrg\Contracts\ReservationStatusTypeContract[] $reservationStatus |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/reservationStatus |
|
314 | */ |
|
315 | public function reservationStatus($reservationStatus) |
|
316 | { |
|
317 | return $this->setProperty('reservationStatus', $reservationStatus); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * A ticket associated with the reservation. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\TicketContract|\Spatie\SchemaOrg\Contracts\TicketContract[] $reservedTicket |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/reservedTicket |
|
328 | */ |
|
329 | public function reservedTicket($reservedTicket) |
|
330 | { |
|
331 | return $this->setProperty('reservedTicket', $reservedTicket); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * A CreativeWork or Event about this Thing. |
|
352 | * |
|
353 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
354 | * |
|
355 | * @return static |
|
356 | * |
|
357 | * @see http://schema.org/subjectOf |
|
358 | */ |
|
359 | public function subjectOf($subjectOf) |
|
360 | { |
|
361 | return $this->setProperty('subjectOf', $subjectOf); |
|
362 | } |
|
363 | ||
364 | /** |
|
365 | * The total price for the reservation or ticket, including applicable |
|
366 | * taxes, shipping, etc. |
|
367 | * |
|
368 | * Usage guidelines: |
|
369 | * |
|
370 | * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT |
|
371 | * NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
|
372 | * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a |
|
373 | * decimal point. Avoid using these symbols as a readability separator. |
|
374 | * |
|
375 | * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[]|float|float[]|int|int[]|string|string[] $totalPrice |
|
376 | * |
|
377 | * @return static |
|
378 | * |
|
379 | * @see http://schema.org/totalPrice |
|
380 | */ |
|
381 | public function totalPrice($totalPrice) |
|
382 | { |
|
383 | return $this->setProperty('totalPrice', $totalPrice); |
|
384 | } |
|
385 | ||
386 | /** |
|
387 | * The person or organization the reservation or ticket is for. |
|
388 | * |
|
389 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $underName |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/underName |
|
394 | */ |
|
395 | public function underName($underName) |
|
396 | { |
|
397 | return $this->setProperty('underName', $underName); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * URL of the item. |
|
402 | * |
|
403 | * @param string|string[] $url |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/url |
|
408 | */ |
|
409 | public function url($url) |
|
410 | { |
|
411 | return $this->setProperty('url', $url); |
|
412 | } |
|
413 | ||
414 | } |
|
415 |
@@ 31-412 (lines=382) @@ | ||
28 | * @see http://schema.org/FollowAction |
|
29 | * |
|
30 | */ |
|
31 | class FollowAction extends BaseType implements FollowActionContract, ActionContract, InteractActionContract, ThingContract |
|
32 | { |
|
33 | /** |
|
34 | * Indicates the current disposition of the Action. |
|
35 | * |
|
36 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
37 | * |
|
38 | * @return static |
|
39 | * |
|
40 | * @see http://schema.org/actionStatus |
|
41 | */ |
|
42 | public function actionStatus($actionStatus) |
|
43 | { |
|
44 | return $this->setProperty('actionStatus', $actionStatus); |
|
45 | } |
|
46 | ||
47 | /** |
|
48 | * An additional type for the item, typically used for adding more specific |
|
49 | * types from external vocabularies in microdata syntax. This is a |
|
50 | * relationship between something and a class that the thing is in. In RDFa |
|
51 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
52 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
53 | * understanding of extra types, in particular those defined externally. |
|
54 | * |
|
55 | * @param string|string[] $additionalType |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/additionalType |
|
60 | */ |
|
61 | public function additionalType($additionalType) |
|
62 | { |
|
63 | return $this->setProperty('additionalType', $additionalType); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
68 | * *John* wrote a book. |
|
69 | * |
|
70 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/agent |
|
75 | */ |
|
76 | public function agent($agent) |
|
77 | { |
|
78 | return $this->setProperty('agent', $agent); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * An alias for the item. |
|
83 | * |
|
84 | * @param string|string[] $alternateName |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/alternateName |
|
89 | */ |
|
90 | public function alternateName($alternateName) |
|
91 | { |
|
92 | return $this->setProperty('alternateName', $alternateName); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A description of the item. |
|
97 | * |
|
98 | * @param string|string[] $description |
|
99 | * |
|
100 | * @return static |
|
101 | * |
|
102 | * @see http://schema.org/description |
|
103 | */ |
|
104 | public function description($description) |
|
105 | { |
|
106 | return $this->setProperty('description', $description); |
|
107 | } |
|
108 | ||
109 | /** |
|
110 | * A sub property of description. A short description of the item used to |
|
111 | * disambiguate from other, similar items. Information from other properties |
|
112 | * (in particular, name) may be necessary for the description to be useful |
|
113 | * for disambiguation. |
|
114 | * |
|
115 | * @param string|string[] $disambiguatingDescription |
|
116 | * |
|
117 | * @return static |
|
118 | * |
|
119 | * @see http://schema.org/disambiguatingDescription |
|
120 | */ |
|
121 | public function disambiguatingDescription($disambiguatingDescription) |
|
122 | { |
|
123 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
124 | } |
|
125 | ||
126 | /** |
|
127 | * The endTime of something. For a reserved event or service (e.g. |
|
128 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
129 | * actions that span a period of time, when the action was performed. e.g. |
|
130 | * John wrote a book from January to *December*. For media, including audio |
|
131 | * and video, it's the time offset of the end of a clip within a larger |
|
132 | * file. |
|
133 | * |
|
134 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
135 | * when describing dates with times. This situation may be clarified in |
|
136 | * future revisions. |
|
137 | * |
|
138 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/endTime |
|
143 | */ |
|
144 | public function endTime($endTime) |
|
145 | { |
|
146 | return $this->setProperty('endTime', $endTime); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * For failed actions, more information on the cause of the failure. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/error |
|
157 | */ |
|
158 | public function error($error) |
|
159 | { |
|
160 | return $this->setProperty('error', $error); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * A sub property of object. The person or organization being followed. |
|
165 | * |
|
166 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $followee |
|
167 | * |
|
168 | * @return static |
|
169 | * |
|
170 | * @see http://schema.org/followee |
|
171 | */ |
|
172 | public function followee($followee) |
|
173 | { |
|
174 | return $this->setProperty('followee', $followee); |
|
175 | } |
|
176 | ||
177 | /** |
|
178 | * The identifier property represents any kind of identifier for any kind of |
|
179 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
180 | * dedicated properties for representing many of these, either as textual |
|
181 | * strings or as URL (URI) links. See [background |
|
182 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
183 | * |
|
184 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
185 | * |
|
186 | * @return static |
|
187 | * |
|
188 | * @see http://schema.org/identifier |
|
189 | */ |
|
190 | public function identifier($identifier) |
|
191 | { |
|
192 | return $this->setProperty('identifier', $identifier); |
|
193 | } |
|
194 | ||
195 | /** |
|
196 | * An image of the item. This can be a [[URL]] or a fully described |
|
197 | * [[ImageObject]]. |
|
198 | * |
|
199 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
200 | * |
|
201 | * @return static |
|
202 | * |
|
203 | * @see http://schema.org/image |
|
204 | */ |
|
205 | public function image($image) |
|
206 | { |
|
207 | return $this->setProperty('image', $image); |
|
208 | } |
|
209 | ||
210 | /** |
|
211 | * The object that helped the agent perform the action. e.g. John wrote a |
|
212 | * book with *a pen*. |
|
213 | * |
|
214 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
215 | * |
|
216 | * @return static |
|
217 | * |
|
218 | * @see http://schema.org/instrument |
|
219 | */ |
|
220 | public function instrument($instrument) |
|
221 | { |
|
222 | return $this->setProperty('instrument', $instrument); |
|
223 | } |
|
224 | ||
225 | /** |
|
226 | * The location of for example where the event is happening, an organization |
|
227 | * is located, or where an action takes place. |
|
228 | * |
|
229 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
230 | * |
|
231 | * @return static |
|
232 | * |
|
233 | * @see http://schema.org/location |
|
234 | */ |
|
235 | public function location($location) |
|
236 | { |
|
237 | return $this->setProperty('location', $location); |
|
238 | } |
|
239 | ||
240 | /** |
|
241 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
242 | * entity being described. See [background |
|
243 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
244 | * |
|
245 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
246 | * |
|
247 | * @return static |
|
248 | * |
|
249 | * @see http://schema.org/mainEntityOfPage |
|
250 | */ |
|
251 | public function mainEntityOfPage($mainEntityOfPage) |
|
252 | { |
|
253 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
254 | } |
|
255 | ||
256 | /** |
|
257 | * The name of the item. |
|
258 | * |
|
259 | * @param string|string[] $name |
|
260 | * |
|
261 | * @return static |
|
262 | * |
|
263 | * @see http://schema.org/name |
|
264 | */ |
|
265 | public function name($name) |
|
266 | { |
|
267 | return $this->setProperty('name', $name); |
|
268 | } |
|
269 | ||
270 | /** |
|
271 | * The object upon which the action is carried out, whose state is kept |
|
272 | * intact or changed. Also known as the semantic roles patient, affected or |
|
273 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
274 | * read *a book*. |
|
275 | * |
|
276 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
277 | * |
|
278 | * @return static |
|
279 | * |
|
280 | * @see http://schema.org/object |
|
281 | */ |
|
282 | public function object($object) |
|
283 | { |
|
284 | return $this->setProperty('object', $object); |
|
285 | } |
|
286 | ||
287 | /** |
|
288 | * Other co-agents that participated in the action indirectly. e.g. John |
|
289 | * wrote a book with *Steve*. |
|
290 | * |
|
291 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
292 | * |
|
293 | * @return static |
|
294 | * |
|
295 | * @see http://schema.org/participant |
|
296 | */ |
|
297 | public function participant($participant) |
|
298 | { |
|
299 | return $this->setProperty('participant', $participant); |
|
300 | } |
|
301 | ||
302 | /** |
|
303 | * Indicates a potential Action, which describes an idealized action in |
|
304 | * which this thing would play an 'object' role. |
|
305 | * |
|
306 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
307 | * |
|
308 | * @return static |
|
309 | * |
|
310 | * @see http://schema.org/potentialAction |
|
311 | */ |
|
312 | public function potentialAction($potentialAction) |
|
313 | { |
|
314 | return $this->setProperty('potentialAction', $potentialAction); |
|
315 | } |
|
316 | ||
317 | /** |
|
318 | * The result produced in the action. e.g. John wrote *a book*. |
|
319 | * |
|
320 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
321 | * |
|
322 | * @return static |
|
323 | * |
|
324 | * @see http://schema.org/result |
|
325 | */ |
|
326 | public function result($result) |
|
327 | { |
|
328 | return $this->setProperty('result', $result); |
|
329 | } |
|
330 | ||
331 | /** |
|
332 | * URL of a reference Web page that unambiguously indicates the item's |
|
333 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
334 | * official website. |
|
335 | * |
|
336 | * @param string|string[] $sameAs |
|
337 | * |
|
338 | * @return static |
|
339 | * |
|
340 | * @see http://schema.org/sameAs |
|
341 | */ |
|
342 | public function sameAs($sameAs) |
|
343 | { |
|
344 | return $this->setProperty('sameAs', $sameAs); |
|
345 | } |
|
346 | ||
347 | /** |
|
348 | * The startTime of something. For a reserved event or service (e.g. |
|
349 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
350 | * actions that span a period of time, when the action was performed. e.g. |
|
351 | * John wrote a book from *January* to December. For media, including audio |
|
352 | * and video, it's the time offset of the start of a clip within a larger |
|
353 | * file. |
|
354 | * |
|
355 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
356 | * when describing dates with times. This situation may be clarified in |
|
357 | * future revisions. |
|
358 | * |
|
359 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
360 | * |
|
361 | * @return static |
|
362 | * |
|
363 | * @see http://schema.org/startTime |
|
364 | */ |
|
365 | public function startTime($startTime) |
|
366 | { |
|
367 | return $this->setProperty('startTime', $startTime); |
|
368 | } |
|
369 | ||
370 | /** |
|
371 | * A CreativeWork or Event about this Thing. |
|
372 | * |
|
373 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
374 | * |
|
375 | * @return static |
|
376 | * |
|
377 | * @see http://schema.org/subjectOf |
|
378 | */ |
|
379 | public function subjectOf($subjectOf) |
|
380 | { |
|
381 | return $this->setProperty('subjectOf', $subjectOf); |
|
382 | } |
|
383 | ||
384 | /** |
|
385 | * Indicates a target EntryPoint for an Action. |
|
386 | * |
|
387 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
388 | * |
|
389 | * @return static |
|
390 | * |
|
391 | * @see http://schema.org/target |
|
392 | */ |
|
393 | public function target($target) |
|
394 | { |
|
395 | return $this->setProperty('target', $target); |
|
396 | } |
|
397 | ||
398 | /** |
|
399 | * URL of the item. |
|
400 | * |
|
401 | * @param string|string[] $url |
|
402 | * |
|
403 | * @return static |
|
404 | * |
|
405 | * @see http://schema.org/url |
|
406 | */ |
|
407 | public function url($url) |
|
408 | { |
|
409 | return $this->setProperty('url', $url); |
|
410 | } |
|
411 | ||
412 | } |
|
413 |
@@ 24-436 (lines=413) @@ | ||
21 | * @see http://schema.org/GiveAction |
|
22 | * |
|
23 | */ |
|
24 | class GiveAction extends BaseType implements GiveActionContract, ActionContract, ThingContract, TransferActionContract |
|
25 | { |
|
26 | /** |
|
27 | * Indicates the current disposition of the Action. |
|
28 | * |
|
29 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
30 | * |
|
31 | * @return static |
|
32 | * |
|
33 | * @see http://schema.org/actionStatus |
|
34 | */ |
|
35 | public function actionStatus($actionStatus) |
|
36 | { |
|
37 | return $this->setProperty('actionStatus', $actionStatus); |
|
38 | } |
|
39 | ||
40 | /** |
|
41 | * An additional type for the item, typically used for adding more specific |
|
42 | * types from external vocabularies in microdata syntax. This is a |
|
43 | * relationship between something and a class that the thing is in. In RDFa |
|
44 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
45 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
46 | * understanding of extra types, in particular those defined externally. |
|
47 | * |
|
48 | * @param string|string[] $additionalType |
|
49 | * |
|
50 | * @return static |
|
51 | * |
|
52 | * @see http://schema.org/additionalType |
|
53 | */ |
|
54 | public function additionalType($additionalType) |
|
55 | { |
|
56 | return $this->setProperty('additionalType', $additionalType); |
|
57 | } |
|
58 | ||
59 | /** |
|
60 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
61 | * *John* wrote a book. |
|
62 | * |
|
63 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
64 | * |
|
65 | * @return static |
|
66 | * |
|
67 | * @see http://schema.org/agent |
|
68 | */ |
|
69 | public function agent($agent) |
|
70 | { |
|
71 | return $this->setProperty('agent', $agent); |
|
72 | } |
|
73 | ||
74 | /** |
|
75 | * An alias for the item. |
|
76 | * |
|
77 | * @param string|string[] $alternateName |
|
78 | * |
|
79 | * @return static |
|
80 | * |
|
81 | * @see http://schema.org/alternateName |
|
82 | */ |
|
83 | public function alternateName($alternateName) |
|
84 | { |
|
85 | return $this->setProperty('alternateName', $alternateName); |
|
86 | } |
|
87 | ||
88 | /** |
|
89 | * A description of the item. |
|
90 | * |
|
91 | * @param string|string[] $description |
|
92 | * |
|
93 | * @return static |
|
94 | * |
|
95 | * @see http://schema.org/description |
|
96 | */ |
|
97 | public function description($description) |
|
98 | { |
|
99 | return $this->setProperty('description', $description); |
|
100 | } |
|
101 | ||
102 | /** |
|
103 | * A sub property of description. A short description of the item used to |
|
104 | * disambiguate from other, similar items. Information from other properties |
|
105 | * (in particular, name) may be necessary for the description to be useful |
|
106 | * for disambiguation. |
|
107 | * |
|
108 | * @param string|string[] $disambiguatingDescription |
|
109 | * |
|
110 | * @return static |
|
111 | * |
|
112 | * @see http://schema.org/disambiguatingDescription |
|
113 | */ |
|
114 | public function disambiguatingDescription($disambiguatingDescription) |
|
115 | { |
|
116 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
117 | } |
|
118 | ||
119 | /** |
|
120 | * The endTime of something. For a reserved event or service (e.g. |
|
121 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
122 | * actions that span a period of time, when the action was performed. e.g. |
|
123 | * John wrote a book from January to *December*. For media, including audio |
|
124 | * and video, it's the time offset of the end of a clip within a larger |
|
125 | * file. |
|
126 | * |
|
127 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
128 | * when describing dates with times. This situation may be clarified in |
|
129 | * future revisions. |
|
130 | * |
|
131 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
132 | * |
|
133 | * @return static |
|
134 | * |
|
135 | * @see http://schema.org/endTime |
|
136 | */ |
|
137 | public function endTime($endTime) |
|
138 | { |
|
139 | return $this->setProperty('endTime', $endTime); |
|
140 | } |
|
141 | ||
142 | /** |
|
143 | * For failed actions, more information on the cause of the failure. |
|
144 | * |
|
145 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
146 | * |
|
147 | * @return static |
|
148 | * |
|
149 | * @see http://schema.org/error |
|
150 | */ |
|
151 | public function error($error) |
|
152 | { |
|
153 | return $this->setProperty('error', $error); |
|
154 | } |
|
155 | ||
156 | /** |
|
157 | * A sub property of location. The original location of the object or the |
|
158 | * agent before the action. |
|
159 | * |
|
160 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
161 | * |
|
162 | * @return static |
|
163 | * |
|
164 | * @see http://schema.org/fromLocation |
|
165 | */ |
|
166 | public function fromLocation($fromLocation) |
|
167 | { |
|
168 | return $this->setProperty('fromLocation', $fromLocation); |
|
169 | } |
|
170 | ||
171 | /** |
|
172 | * The identifier property represents any kind of identifier for any kind of |
|
173 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
174 | * dedicated properties for representing many of these, either as textual |
|
175 | * strings or as URL (URI) links. See [background |
|
176 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
177 | * |
|
178 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
179 | * |
|
180 | * @return static |
|
181 | * |
|
182 | * @see http://schema.org/identifier |
|
183 | */ |
|
184 | public function identifier($identifier) |
|
185 | { |
|
186 | return $this->setProperty('identifier', $identifier); |
|
187 | } |
|
188 | ||
189 | /** |
|
190 | * An image of the item. This can be a [[URL]] or a fully described |
|
191 | * [[ImageObject]]. |
|
192 | * |
|
193 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
194 | * |
|
195 | * @return static |
|
196 | * |
|
197 | * @see http://schema.org/image |
|
198 | */ |
|
199 | public function image($image) |
|
200 | { |
|
201 | return $this->setProperty('image', $image); |
|
202 | } |
|
203 | ||
204 | /** |
|
205 | * The object that helped the agent perform the action. e.g. John wrote a |
|
206 | * book with *a pen*. |
|
207 | * |
|
208 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
209 | * |
|
210 | * @return static |
|
211 | * |
|
212 | * @see http://schema.org/instrument |
|
213 | */ |
|
214 | public function instrument($instrument) |
|
215 | { |
|
216 | return $this->setProperty('instrument', $instrument); |
|
217 | } |
|
218 | ||
219 | /** |
|
220 | * The location of for example where the event is happening, an organization |
|
221 | * is located, or where an action takes place. |
|
222 | * |
|
223 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
224 | * |
|
225 | * @return static |
|
226 | * |
|
227 | * @see http://schema.org/location |
|
228 | */ |
|
229 | public function location($location) |
|
230 | { |
|
231 | return $this->setProperty('location', $location); |
|
232 | } |
|
233 | ||
234 | /** |
|
235 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
236 | * entity being described. See [background |
|
237 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
238 | * |
|
239 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
240 | * |
|
241 | * @return static |
|
242 | * |
|
243 | * @see http://schema.org/mainEntityOfPage |
|
244 | */ |
|
245 | public function mainEntityOfPage($mainEntityOfPage) |
|
246 | { |
|
247 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
248 | } |
|
249 | ||
250 | /** |
|
251 | * The name of the item. |
|
252 | * |
|
253 | * @param string|string[] $name |
|
254 | * |
|
255 | * @return static |
|
256 | * |
|
257 | * @see http://schema.org/name |
|
258 | */ |
|
259 | public function name($name) |
|
260 | { |
|
261 | return $this->setProperty('name', $name); |
|
262 | } |
|
263 | ||
264 | /** |
|
265 | * The object upon which the action is carried out, whose state is kept |
|
266 | * intact or changed. Also known as the semantic roles patient, affected or |
|
267 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
268 | * read *a book*. |
|
269 | * |
|
270 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
271 | * |
|
272 | * @return static |
|
273 | * |
|
274 | * @see http://schema.org/object |
|
275 | */ |
|
276 | public function object($object) |
|
277 | { |
|
278 | return $this->setProperty('object', $object); |
|
279 | } |
|
280 | ||
281 | /** |
|
282 | * Other co-agents that participated in the action indirectly. e.g. John |
|
283 | * wrote a book with *Steve*. |
|
284 | * |
|
285 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
286 | * |
|
287 | * @return static |
|
288 | * |
|
289 | * @see http://schema.org/participant |
|
290 | */ |
|
291 | public function participant($participant) |
|
292 | { |
|
293 | return $this->setProperty('participant', $participant); |
|
294 | } |
|
295 | ||
296 | /** |
|
297 | * Indicates a potential Action, which describes an idealized action in |
|
298 | * which this thing would play an 'object' role. |
|
299 | * |
|
300 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
301 | * |
|
302 | * @return static |
|
303 | * |
|
304 | * @see http://schema.org/potentialAction |
|
305 | */ |
|
306 | public function potentialAction($potentialAction) |
|
307 | { |
|
308 | return $this->setProperty('potentialAction', $potentialAction); |
|
309 | } |
|
310 | ||
311 | /** |
|
312 | * A sub property of participant. The participant who is at the receiving |
|
313 | * end of the action. |
|
314 | * |
|
315 | * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[]|\Spatie\SchemaOrg\Contracts\ContactPointContract|\Spatie\SchemaOrg\Contracts\ContactPointContract[]|\Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $recipient |
|
316 | * |
|
317 | * @return static |
|
318 | * |
|
319 | * @see http://schema.org/recipient |
|
320 | */ |
|
321 | public function recipient($recipient) |
|
322 | { |
|
323 | return $this->setProperty('recipient', $recipient); |
|
324 | } |
|
325 | ||
326 | /** |
|
327 | * The result produced in the action. e.g. John wrote *a book*. |
|
328 | * |
|
329 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
330 | * |
|
331 | * @return static |
|
332 | * |
|
333 | * @see http://schema.org/result |
|
334 | */ |
|
335 | public function result($result) |
|
336 | { |
|
337 | return $this->setProperty('result', $result); |
|
338 | } |
|
339 | ||
340 | /** |
|
341 | * URL of a reference Web page that unambiguously indicates the item's |
|
342 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
343 | * official website. |
|
344 | * |
|
345 | * @param string|string[] $sameAs |
|
346 | * |
|
347 | * @return static |
|
348 | * |
|
349 | * @see http://schema.org/sameAs |
|
350 | */ |
|
351 | public function sameAs($sameAs) |
|
352 | { |
|
353 | return $this->setProperty('sameAs', $sameAs); |
|
354 | } |
|
355 | ||
356 | /** |
|
357 | * The startTime of something. For a reserved event or service (e.g. |
|
358 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
359 | * actions that span a period of time, when the action was performed. e.g. |
|
360 | * John wrote a book from *January* to December. For media, including audio |
|
361 | * and video, it's the time offset of the start of a clip within a larger |
|
362 | * file. |
|
363 | * |
|
364 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
365 | * when describing dates with times. This situation may be clarified in |
|
366 | * future revisions. |
|
367 | * |
|
368 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
369 | * |
|
370 | * @return static |
|
371 | * |
|
372 | * @see http://schema.org/startTime |
|
373 | */ |
|
374 | public function startTime($startTime) |
|
375 | { |
|
376 | return $this->setProperty('startTime', $startTime); |
|
377 | } |
|
378 | ||
379 | /** |
|
380 | * A CreativeWork or Event about this Thing. |
|
381 | * |
|
382 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
383 | * |
|
384 | * @return static |
|
385 | * |
|
386 | * @see http://schema.org/subjectOf |
|
387 | */ |
|
388 | public function subjectOf($subjectOf) |
|
389 | { |
|
390 | return $this->setProperty('subjectOf', $subjectOf); |
|
391 | } |
|
392 | ||
393 | /** |
|
394 | * Indicates a target EntryPoint for an Action. |
|
395 | * |
|
396 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
397 | * |
|
398 | * @return static |
|
399 | * |
|
400 | * @see http://schema.org/target |
|
401 | */ |
|
402 | public function target($target) |
|
403 | { |
|
404 | return $this->setProperty('target', $target); |
|
405 | } |
|
406 | ||
407 | /** |
|
408 | * A sub property of location. The final location of the object or the agent |
|
409 | * after the action. |
|
410 | * |
|
411 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
412 | * |
|
413 | * @return static |
|
414 | * |
|
415 | * @see http://schema.org/toLocation |
|
416 | */ |
|
417 | public function toLocation($toLocation) |
|
418 | { |
|
419 | return $this->setProperty('toLocation', $toLocation); |
|
420 | } |
|
421 | ||
422 | /** |
|
423 | * URL of the item. |
|
424 | * |
|
425 | * @param string|string[] $url |
|
426 | * |
|
427 | * @return static |
|
428 | * |
|
429 | * @see http://schema.org/url |
|
430 | */ |
|
431 | public function url($url) |
|
432 | { |
|
433 | return $this->setProperty('url', $url); |
|
434 | } |
|
435 | ||
436 | } |
|
437 |
@@ 17-427 (lines=411) @@ | ||
14 | * @see http://schema.org/InsertAction |
|
15 | * |
|
16 | */ |
|
17 | class InsertAction extends BaseType implements InsertActionContract, ActionContract, AddActionContract, ThingContract, UpdateActionContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A sub property of object. The collection target of the action. |
|
83 | * |
|
84 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $collection |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/collection |
|
89 | */ |
|
90 | public function collection($collection) |
|
91 | { |
|
92 | return $this->setProperty('collection', $collection); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A description of the item. |
|
97 | * |
|
98 | * @param string|string[] $description |
|
99 | * |
|
100 | * @return static |
|
101 | * |
|
102 | * @see http://schema.org/description |
|
103 | */ |
|
104 | public function description($description) |
|
105 | { |
|
106 | return $this->setProperty('description', $description); |
|
107 | } |
|
108 | ||
109 | /** |
|
110 | * A sub property of description. A short description of the item used to |
|
111 | * disambiguate from other, similar items. Information from other properties |
|
112 | * (in particular, name) may be necessary for the description to be useful |
|
113 | * for disambiguation. |
|
114 | * |
|
115 | * @param string|string[] $disambiguatingDescription |
|
116 | * |
|
117 | * @return static |
|
118 | * |
|
119 | * @see http://schema.org/disambiguatingDescription |
|
120 | */ |
|
121 | public function disambiguatingDescription($disambiguatingDescription) |
|
122 | { |
|
123 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
124 | } |
|
125 | ||
126 | /** |
|
127 | * The endTime of something. For a reserved event or service (e.g. |
|
128 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
129 | * actions that span a period of time, when the action was performed. e.g. |
|
130 | * John wrote a book from January to *December*. For media, including audio |
|
131 | * and video, it's the time offset of the end of a clip within a larger |
|
132 | * file. |
|
133 | * |
|
134 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
135 | * when describing dates with times. This situation may be clarified in |
|
136 | * future revisions. |
|
137 | * |
|
138 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/endTime |
|
143 | */ |
|
144 | public function endTime($endTime) |
|
145 | { |
|
146 | return $this->setProperty('endTime', $endTime); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * For failed actions, more information on the cause of the failure. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/error |
|
157 | */ |
|
158 | public function error($error) |
|
159 | { |
|
160 | return $this->setProperty('error', $error); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * The identifier property represents any kind of identifier for any kind of |
|
165 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
166 | * dedicated properties for representing many of these, either as textual |
|
167 | * strings or as URL (URI) links. See [background |
|
168 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/identifier |
|
175 | */ |
|
176 | public function identifier($identifier) |
|
177 | { |
|
178 | return $this->setProperty('identifier', $identifier); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * An image of the item. This can be a [[URL]] or a fully described |
|
183 | * [[ImageObject]]. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/image |
|
190 | */ |
|
191 | public function image($image) |
|
192 | { |
|
193 | return $this->setProperty('image', $image); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * The object that helped the agent perform the action. e.g. John wrote a |
|
198 | * book with *a pen*. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/instrument |
|
205 | */ |
|
206 | public function instrument($instrument) |
|
207 | { |
|
208 | return $this->setProperty('instrument', $instrument); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * The location of for example where the event is happening, an organization |
|
213 | * is located, or where an action takes place. |
|
214 | * |
|
215 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
216 | * |
|
217 | * @return static |
|
218 | * |
|
219 | * @see http://schema.org/location |
|
220 | */ |
|
221 | public function location($location) |
|
222 | { |
|
223 | return $this->setProperty('location', $location); |
|
224 | } |
|
225 | ||
226 | /** |
|
227 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
228 | * entity being described. See [background |
|
229 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
230 | * |
|
231 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/mainEntityOfPage |
|
236 | */ |
|
237 | public function mainEntityOfPage($mainEntityOfPage) |
|
238 | { |
|
239 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The name of the item. |
|
244 | * |
|
245 | * @param string|string[] $name |
|
246 | * |
|
247 | * @return static |
|
248 | * |
|
249 | * @see http://schema.org/name |
|
250 | */ |
|
251 | public function name($name) |
|
252 | { |
|
253 | return $this->setProperty('name', $name); |
|
254 | } |
|
255 | ||
256 | /** |
|
257 | * The object upon which the action is carried out, whose state is kept |
|
258 | * intact or changed. Also known as the semantic roles patient, affected or |
|
259 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
260 | * read *a book*. |
|
261 | * |
|
262 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/object |
|
267 | */ |
|
268 | public function object($object) |
|
269 | { |
|
270 | return $this->setProperty('object', $object); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * Other co-agents that participated in the action indirectly. e.g. John |
|
275 | * wrote a book with *Steve*. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/participant |
|
282 | */ |
|
283 | public function participant($participant) |
|
284 | { |
|
285 | return $this->setProperty('participant', $participant); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * Indicates a potential Action, which describes an idealized action in |
|
290 | * which this thing would play an 'object' role. |
|
291 | * |
|
292 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
293 | * |
|
294 | * @return static |
|
295 | * |
|
296 | * @see http://schema.org/potentialAction |
|
297 | */ |
|
298 | public function potentialAction($potentialAction) |
|
299 | { |
|
300 | return $this->setProperty('potentialAction', $potentialAction); |
|
301 | } |
|
302 | ||
303 | /** |
|
304 | * The result produced in the action. e.g. John wrote *a book*. |
|
305 | * |
|
306 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
307 | * |
|
308 | * @return static |
|
309 | * |
|
310 | * @see http://schema.org/result |
|
311 | */ |
|
312 | public function result($result) |
|
313 | { |
|
314 | return $this->setProperty('result', $result); |
|
315 | } |
|
316 | ||
317 | /** |
|
318 | * URL of a reference Web page that unambiguously indicates the item's |
|
319 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
320 | * official website. |
|
321 | * |
|
322 | * @param string|string[] $sameAs |
|
323 | * |
|
324 | * @return static |
|
325 | * |
|
326 | * @see http://schema.org/sameAs |
|
327 | */ |
|
328 | public function sameAs($sameAs) |
|
329 | { |
|
330 | return $this->setProperty('sameAs', $sameAs); |
|
331 | } |
|
332 | ||
333 | /** |
|
334 | * The startTime of something. For a reserved event or service (e.g. |
|
335 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
336 | * actions that span a period of time, when the action was performed. e.g. |
|
337 | * John wrote a book from *January* to December. For media, including audio |
|
338 | * and video, it's the time offset of the start of a clip within a larger |
|
339 | * file. |
|
340 | * |
|
341 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
342 | * when describing dates with times. This situation may be clarified in |
|
343 | * future revisions. |
|
344 | * |
|
345 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
346 | * |
|
347 | * @return static |
|
348 | * |
|
349 | * @see http://schema.org/startTime |
|
350 | */ |
|
351 | public function startTime($startTime) |
|
352 | { |
|
353 | return $this->setProperty('startTime', $startTime); |
|
354 | } |
|
355 | ||
356 | /** |
|
357 | * A CreativeWork or Event about this Thing. |
|
358 | * |
|
359 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
360 | * |
|
361 | * @return static |
|
362 | * |
|
363 | * @see http://schema.org/subjectOf |
|
364 | */ |
|
365 | public function subjectOf($subjectOf) |
|
366 | { |
|
367 | return $this->setProperty('subjectOf', $subjectOf); |
|
368 | } |
|
369 | ||
370 | /** |
|
371 | * Indicates a target EntryPoint for an Action. |
|
372 | * |
|
373 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
374 | * |
|
375 | * @return static |
|
376 | * |
|
377 | * @see http://schema.org/target |
|
378 | */ |
|
379 | public function target($target) |
|
380 | { |
|
381 | return $this->setProperty('target', $target); |
|
382 | } |
|
383 | ||
384 | /** |
|
385 | * A sub property of object. The collection target of the action. |
|
386 | * |
|
387 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $targetCollection |
|
388 | * |
|
389 | * @return static |
|
390 | * |
|
391 | * @see http://schema.org/targetCollection |
|
392 | */ |
|
393 | public function targetCollection($targetCollection) |
|
394 | { |
|
395 | return $this->setProperty('targetCollection', $targetCollection); |
|
396 | } |
|
397 | ||
398 | /** |
|
399 | * A sub property of location. The final location of the object or the agent |
|
400 | * after the action. |
|
401 | * |
|
402 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
403 | * |
|
404 | * @return static |
|
405 | * |
|
406 | * @see http://schema.org/toLocation |
|
407 | */ |
|
408 | public function toLocation($toLocation) |
|
409 | { |
|
410 | return $this->setProperty('toLocation', $toLocation); |
|
411 | } |
|
412 | ||
413 | /** |
|
414 | * URL of the item. |
|
415 | * |
|
416 | * @param string|string[] $url |
|
417 | * |
|
418 | * @return static |
|
419 | * |
|
420 | * @see http://schema.org/url |
|
421 | */ |
|
422 | public function url($url) |
|
423 | { |
|
424 | return $this->setProperty('url', $url); |
|
425 | } |
|
426 | ||
427 | } |
|
428 |
@@ 16-415 (lines=400) @@ | ||
13 | * @see http://schema.org/InstallAction |
|
14 | * |
|
15 | */ |
|
16 | class InstallAction extends BaseType implements InstallActionContract, ActionContract, ConsumeActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * A set of requirements that a must be fulfilled in order to perform an |
|
20 | * Action. If more than one value is specied, fulfilling one set of |
|
21 | * requirements will allow the Action to be performed. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionAccessibilityRequirement |
|
28 | */ |
|
29 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
30 | { |
|
31 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * Indicates the current disposition of the Action. |
|
36 | * |
|
37 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
38 | * |
|
39 | * @return static |
|
40 | * |
|
41 | * @see http://schema.org/actionStatus |
|
42 | */ |
|
43 | public function actionStatus($actionStatus) |
|
44 | { |
|
45 | return $this->setProperty('actionStatus', $actionStatus); |
|
46 | } |
|
47 | ||
48 | /** |
|
49 | * An additional type for the item, typically used for adding more specific |
|
50 | * types from external vocabularies in microdata syntax. This is a |
|
51 | * relationship between something and a class that the thing is in. In RDFa |
|
52 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
53 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
54 | * understanding of extra types, in particular those defined externally. |
|
55 | * |
|
56 | * @param string|string[] $additionalType |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/additionalType |
|
61 | */ |
|
62 | public function additionalType($additionalType) |
|
63 | { |
|
64 | return $this->setProperty('additionalType', $additionalType); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
69 | * *John* wrote a book. |
|
70 | * |
|
71 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/agent |
|
76 | */ |
|
77 | public function agent($agent) |
|
78 | { |
|
79 | return $this->setProperty('agent', $agent); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * An alias for the item. |
|
84 | * |
|
85 | * @param string|string[] $alternateName |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/alternateName |
|
90 | */ |
|
91 | public function alternateName($alternateName) |
|
92 | { |
|
93 | return $this->setProperty('alternateName', $alternateName); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * An Offer which must be accepted before the user can perform the Action. |
|
166 | * For example, the user may need to buy a movie before being able to watch |
|
167 | * it. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/expectsAcceptanceOf |
|
174 | */ |
|
175 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
176 | { |
|
177 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * The identifier property represents any kind of identifier for any kind of |
|
182 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
183 | * dedicated properties for representing many of these, either as textual |
|
184 | * strings or as URL (URI) links. See [background |
|
185 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
186 | * |
|
187 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
188 | * |
|
189 | * @return static |
|
190 | * |
|
191 | * @see http://schema.org/identifier |
|
192 | */ |
|
193 | public function identifier($identifier) |
|
194 | { |
|
195 | return $this->setProperty('identifier', $identifier); |
|
196 | } |
|
197 | ||
198 | /** |
|
199 | * An image of the item. This can be a [[URL]] or a fully described |
|
200 | * [[ImageObject]]. |
|
201 | * |
|
202 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
203 | * |
|
204 | * @return static |
|
205 | * |
|
206 | * @see http://schema.org/image |
|
207 | */ |
|
208 | public function image($image) |
|
209 | { |
|
210 | return $this->setProperty('image', $image); |
|
211 | } |
|
212 | ||
213 | /** |
|
214 | * The object that helped the agent perform the action. e.g. John wrote a |
|
215 | * book with *a pen*. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/instrument |
|
222 | */ |
|
223 | public function instrument($instrument) |
|
224 | { |
|
225 | return $this->setProperty('instrument', $instrument); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The location of for example where the event is happening, an organization |
|
230 | * is located, or where an action takes place. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/location |
|
237 | */ |
|
238 | public function location($location) |
|
239 | { |
|
240 | return $this->setProperty('location', $location); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
245 | * entity being described. See [background |
|
246 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/mainEntityOfPage |
|
253 | */ |
|
254 | public function mainEntityOfPage($mainEntityOfPage) |
|
255 | { |
|
256 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The name of the item. |
|
261 | * |
|
262 | * @param string|string[] $name |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/name |
|
267 | */ |
|
268 | public function name($name) |
|
269 | { |
|
270 | return $this->setProperty('name', $name); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * The object upon which the action is carried out, whose state is kept |
|
275 | * intact or changed. Also known as the semantic roles patient, affected or |
|
276 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
277 | * read *a book*. |
|
278 | * |
|
279 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
280 | * |
|
281 | * @return static |
|
282 | * |
|
283 | * @see http://schema.org/object |
|
284 | */ |
|
285 | public function object($object) |
|
286 | { |
|
287 | return $this->setProperty('object', $object); |
|
288 | } |
|
289 | ||
290 | /** |
|
291 | * Other co-agents that participated in the action indirectly. e.g. John |
|
292 | * wrote a book with *Steve*. |
|
293 | * |
|
294 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
295 | * |
|
296 | * @return static |
|
297 | * |
|
298 | * @see http://schema.org/participant |
|
299 | */ |
|
300 | public function participant($participant) |
|
301 | { |
|
302 | return $this->setProperty('participant', $participant); |
|
303 | } |
|
304 | ||
305 | /** |
|
306 | * Indicates a potential Action, which describes an idealized action in |
|
307 | * which this thing would play an 'object' role. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/potentialAction |
|
314 | */ |
|
315 | public function potentialAction($potentialAction) |
|
316 | { |
|
317 | return $this->setProperty('potentialAction', $potentialAction); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * The result produced in the action. e.g. John wrote *a book*. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/result |
|
328 | */ |
|
329 | public function result($result) |
|
330 | { |
|
331 | return $this->setProperty('result', $result); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * The startTime of something. For a reserved event or service (e.g. |
|
352 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
353 | * actions that span a period of time, when the action was performed. e.g. |
|
354 | * John wrote a book from *January* to December. For media, including audio |
|
355 | * and video, it's the time offset of the start of a clip within a larger |
|
356 | * file. |
|
357 | * |
|
358 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
359 | * when describing dates with times. This situation may be clarified in |
|
360 | * future revisions. |
|
361 | * |
|
362 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
363 | * |
|
364 | * @return static |
|
365 | * |
|
366 | * @see http://schema.org/startTime |
|
367 | */ |
|
368 | public function startTime($startTime) |
|
369 | { |
|
370 | return $this->setProperty('startTime', $startTime); |
|
371 | } |
|
372 | ||
373 | /** |
|
374 | * A CreativeWork or Event about this Thing. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/subjectOf |
|
381 | */ |
|
382 | public function subjectOf($subjectOf) |
|
383 | { |
|
384 | return $this->setProperty('subjectOf', $subjectOf); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * Indicates a target EntryPoint for an Action. |
|
389 | * |
|
390 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/target |
|
395 | */ |
|
396 | public function target($target) |
|
397 | { |
|
398 | return $this->setProperty('target', $target); |
|
399 | } |
|
400 | ||
401 | /** |
|
402 | * URL of the item. |
|
403 | * |
|
404 | * @param string|string[] $url |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/url |
|
409 | */ |
|
410 | public function url($url) |
|
411 | { |
|
412 | return $this->setProperty('url', $url); |
|
413 | } |
|
414 | ||
415 | } |
|
416 |
@@ 25-407 (lines=383) @@ | ||
22 | * @see http://schema.org/JoinAction |
|
23 | * |
|
24 | */ |
|
25 | class JoinAction extends BaseType implements JoinActionContract, ActionContract, InteractActionContract, ThingContract |
|
26 | { |
|
27 | /** |
|
28 | * Indicates the current disposition of the Action. |
|
29 | * |
|
30 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
31 | * |
|
32 | * @return static |
|
33 | * |
|
34 | * @see http://schema.org/actionStatus |
|
35 | */ |
|
36 | public function actionStatus($actionStatus) |
|
37 | { |
|
38 | return $this->setProperty('actionStatus', $actionStatus); |
|
39 | } |
|
40 | ||
41 | /** |
|
42 | * An additional type for the item, typically used for adding more specific |
|
43 | * types from external vocabularies in microdata syntax. This is a |
|
44 | * relationship between something and a class that the thing is in. In RDFa |
|
45 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
46 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
47 | * understanding of extra types, in particular those defined externally. |
|
48 | * |
|
49 | * @param string|string[] $additionalType |
|
50 | * |
|
51 | * @return static |
|
52 | * |
|
53 | * @see http://schema.org/additionalType |
|
54 | */ |
|
55 | public function additionalType($additionalType) |
|
56 | { |
|
57 | return $this->setProperty('additionalType', $additionalType); |
|
58 | } |
|
59 | ||
60 | /** |
|
61 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
62 | * *John* wrote a book. |
|
63 | * |
|
64 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
65 | * |
|
66 | * @return static |
|
67 | * |
|
68 | * @see http://schema.org/agent |
|
69 | */ |
|
70 | public function agent($agent) |
|
71 | { |
|
72 | return $this->setProperty('agent', $agent); |
|
73 | } |
|
74 | ||
75 | /** |
|
76 | * An alias for the item. |
|
77 | * |
|
78 | * @param string|string[] $alternateName |
|
79 | * |
|
80 | * @return static |
|
81 | * |
|
82 | * @see http://schema.org/alternateName |
|
83 | */ |
|
84 | public function alternateName($alternateName) |
|
85 | { |
|
86 | return $this->setProperty('alternateName', $alternateName); |
|
87 | } |
|
88 | ||
89 | /** |
|
90 | * A description of the item. |
|
91 | * |
|
92 | * @param string|string[] $description |
|
93 | * |
|
94 | * @return static |
|
95 | * |
|
96 | * @see http://schema.org/description |
|
97 | */ |
|
98 | public function description($description) |
|
99 | { |
|
100 | return $this->setProperty('description', $description); |
|
101 | } |
|
102 | ||
103 | /** |
|
104 | * A sub property of description. A short description of the item used to |
|
105 | * disambiguate from other, similar items. Information from other properties |
|
106 | * (in particular, name) may be necessary for the description to be useful |
|
107 | * for disambiguation. |
|
108 | * |
|
109 | * @param string|string[] $disambiguatingDescription |
|
110 | * |
|
111 | * @return static |
|
112 | * |
|
113 | * @see http://schema.org/disambiguatingDescription |
|
114 | */ |
|
115 | public function disambiguatingDescription($disambiguatingDescription) |
|
116 | { |
|
117 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
118 | } |
|
119 | ||
120 | /** |
|
121 | * The endTime of something. For a reserved event or service (e.g. |
|
122 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
123 | * actions that span a period of time, when the action was performed. e.g. |
|
124 | * John wrote a book from January to *December*. For media, including audio |
|
125 | * and video, it's the time offset of the end of a clip within a larger |
|
126 | * file. |
|
127 | * |
|
128 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
129 | * when describing dates with times. This situation may be clarified in |
|
130 | * future revisions. |
|
131 | * |
|
132 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
133 | * |
|
134 | * @return static |
|
135 | * |
|
136 | * @see http://schema.org/endTime |
|
137 | */ |
|
138 | public function endTime($endTime) |
|
139 | { |
|
140 | return $this->setProperty('endTime', $endTime); |
|
141 | } |
|
142 | ||
143 | /** |
|
144 | * For failed actions, more information on the cause of the failure. |
|
145 | * |
|
146 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
147 | * |
|
148 | * @return static |
|
149 | * |
|
150 | * @see http://schema.org/error |
|
151 | */ |
|
152 | public function error($error) |
|
153 | { |
|
154 | return $this->setProperty('error', $error); |
|
155 | } |
|
156 | ||
157 | /** |
|
158 | * Upcoming or past event associated with this place, organization, or |
|
159 | * action. |
|
160 | * |
|
161 | * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event |
|
162 | * |
|
163 | * @return static |
|
164 | * |
|
165 | * @see http://schema.org/event |
|
166 | */ |
|
167 | public function event($event) |
|
168 | { |
|
169 | return $this->setProperty('event', $event); |
|
170 | } |
|
171 | ||
172 | /** |
|
173 | * The identifier property represents any kind of identifier for any kind of |
|
174 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
175 | * dedicated properties for representing many of these, either as textual |
|
176 | * strings or as URL (URI) links. See [background |
|
177 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
178 | * |
|
179 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
180 | * |
|
181 | * @return static |
|
182 | * |
|
183 | * @see http://schema.org/identifier |
|
184 | */ |
|
185 | public function identifier($identifier) |
|
186 | { |
|
187 | return $this->setProperty('identifier', $identifier); |
|
188 | } |
|
189 | ||
190 | /** |
|
191 | * An image of the item. This can be a [[URL]] or a fully described |
|
192 | * [[ImageObject]]. |
|
193 | * |
|
194 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
195 | * |
|
196 | * @return static |
|
197 | * |
|
198 | * @see http://schema.org/image |
|
199 | */ |
|
200 | public function image($image) |
|
201 | { |
|
202 | return $this->setProperty('image', $image); |
|
203 | } |
|
204 | ||
205 | /** |
|
206 | * The object that helped the agent perform the action. e.g. John wrote a |
|
207 | * book with *a pen*. |
|
208 | * |
|
209 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
210 | * |
|
211 | * @return static |
|
212 | * |
|
213 | * @see http://schema.org/instrument |
|
214 | */ |
|
215 | public function instrument($instrument) |
|
216 | { |
|
217 | return $this->setProperty('instrument', $instrument); |
|
218 | } |
|
219 | ||
220 | /** |
|
221 | * The location of for example where the event is happening, an organization |
|
222 | * is located, or where an action takes place. |
|
223 | * |
|
224 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
225 | * |
|
226 | * @return static |
|
227 | * |
|
228 | * @see http://schema.org/location |
|
229 | */ |
|
230 | public function location($location) |
|
231 | { |
|
232 | return $this->setProperty('location', $location); |
|
233 | } |
|
234 | ||
235 | /** |
|
236 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
237 | * entity being described. See [background |
|
238 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
239 | * |
|
240 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
241 | * |
|
242 | * @return static |
|
243 | * |
|
244 | * @see http://schema.org/mainEntityOfPage |
|
245 | */ |
|
246 | public function mainEntityOfPage($mainEntityOfPage) |
|
247 | { |
|
248 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
249 | } |
|
250 | ||
251 | /** |
|
252 | * The name of the item. |
|
253 | * |
|
254 | * @param string|string[] $name |
|
255 | * |
|
256 | * @return static |
|
257 | * |
|
258 | * @see http://schema.org/name |
|
259 | */ |
|
260 | public function name($name) |
|
261 | { |
|
262 | return $this->setProperty('name', $name); |
|
263 | } |
|
264 | ||
265 | /** |
|
266 | * The object upon which the action is carried out, whose state is kept |
|
267 | * intact or changed. Also known as the semantic roles patient, affected or |
|
268 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
269 | * read *a book*. |
|
270 | * |
|
271 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
272 | * |
|
273 | * @return static |
|
274 | * |
|
275 | * @see http://schema.org/object |
|
276 | */ |
|
277 | public function object($object) |
|
278 | { |
|
279 | return $this->setProperty('object', $object); |
|
280 | } |
|
281 | ||
282 | /** |
|
283 | * Other co-agents that participated in the action indirectly. e.g. John |
|
284 | * wrote a book with *Steve*. |
|
285 | * |
|
286 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
287 | * |
|
288 | * @return static |
|
289 | * |
|
290 | * @see http://schema.org/participant |
|
291 | */ |
|
292 | public function participant($participant) |
|
293 | { |
|
294 | return $this->setProperty('participant', $participant); |
|
295 | } |
|
296 | ||
297 | /** |
|
298 | * Indicates a potential Action, which describes an idealized action in |
|
299 | * which this thing would play an 'object' role. |
|
300 | * |
|
301 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
302 | * |
|
303 | * @return static |
|
304 | * |
|
305 | * @see http://schema.org/potentialAction |
|
306 | */ |
|
307 | public function potentialAction($potentialAction) |
|
308 | { |
|
309 | return $this->setProperty('potentialAction', $potentialAction); |
|
310 | } |
|
311 | ||
312 | /** |
|
313 | * The result produced in the action. e.g. John wrote *a book*. |
|
314 | * |
|
315 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
316 | * |
|
317 | * @return static |
|
318 | * |
|
319 | * @see http://schema.org/result |
|
320 | */ |
|
321 | public function result($result) |
|
322 | { |
|
323 | return $this->setProperty('result', $result); |
|
324 | } |
|
325 | ||
326 | /** |
|
327 | * URL of a reference Web page that unambiguously indicates the item's |
|
328 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
329 | * official website. |
|
330 | * |
|
331 | * @param string|string[] $sameAs |
|
332 | * |
|
333 | * @return static |
|
334 | * |
|
335 | * @see http://schema.org/sameAs |
|
336 | */ |
|
337 | public function sameAs($sameAs) |
|
338 | { |
|
339 | return $this->setProperty('sameAs', $sameAs); |
|
340 | } |
|
341 | ||
342 | /** |
|
343 | * The startTime of something. For a reserved event or service (e.g. |
|
344 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
345 | * actions that span a period of time, when the action was performed. e.g. |
|
346 | * John wrote a book from *January* to December. For media, including audio |
|
347 | * and video, it's the time offset of the start of a clip within a larger |
|
348 | * file. |
|
349 | * |
|
350 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
351 | * when describing dates with times. This situation may be clarified in |
|
352 | * future revisions. |
|
353 | * |
|
354 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
355 | * |
|
356 | * @return static |
|
357 | * |
|
358 | * @see http://schema.org/startTime |
|
359 | */ |
|
360 | public function startTime($startTime) |
|
361 | { |
|
362 | return $this->setProperty('startTime', $startTime); |
|
363 | } |
|
364 | ||
365 | /** |
|
366 | * A CreativeWork or Event about this Thing. |
|
367 | * |
|
368 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
369 | * |
|
370 | * @return static |
|
371 | * |
|
372 | * @see http://schema.org/subjectOf |
|
373 | */ |
|
374 | public function subjectOf($subjectOf) |
|
375 | { |
|
376 | return $this->setProperty('subjectOf', $subjectOf); |
|
377 | } |
|
378 | ||
379 | /** |
|
380 | * Indicates a target EntryPoint for an Action. |
|
381 | * |
|
382 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
383 | * |
|
384 | * @return static |
|
385 | * |
|
386 | * @see http://schema.org/target |
|
387 | */ |
|
388 | public function target($target) |
|
389 | { |
|
390 | return $this->setProperty('target', $target); |
|
391 | } |
|
392 | ||
393 | /** |
|
394 | * URL of the item. |
|
395 | * |
|
396 | * @param string|string[] $url |
|
397 | * |
|
398 | * @return static |
|
399 | * |
|
400 | * @see http://schema.org/url |
|
401 | */ |
|
402 | public function url($url) |
|
403 | { |
|
404 | return $this->setProperty('url', $url); |
|
405 | } |
|
406 | ||
407 | } |
|
408 |
@@ 22-404 (lines=383) @@ | ||
19 | * @see http://schema.org/LeaveAction |
|
20 | * |
|
21 | */ |
|
22 | class LeaveAction extends BaseType implements LeaveActionContract, ActionContract, InteractActionContract, ThingContract |
|
23 | { |
|
24 | /** |
|
25 | * Indicates the current disposition of the Action. |
|
26 | * |
|
27 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
28 | * |
|
29 | * @return static |
|
30 | * |
|
31 | * @see http://schema.org/actionStatus |
|
32 | */ |
|
33 | public function actionStatus($actionStatus) |
|
34 | { |
|
35 | return $this->setProperty('actionStatus', $actionStatus); |
|
36 | } |
|
37 | ||
38 | /** |
|
39 | * An additional type for the item, typically used for adding more specific |
|
40 | * types from external vocabularies in microdata syntax. This is a |
|
41 | * relationship between something and a class that the thing is in. In RDFa |
|
42 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
43 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
44 | * understanding of extra types, in particular those defined externally. |
|
45 | * |
|
46 | * @param string|string[] $additionalType |
|
47 | * |
|
48 | * @return static |
|
49 | * |
|
50 | * @see http://schema.org/additionalType |
|
51 | */ |
|
52 | public function additionalType($additionalType) |
|
53 | { |
|
54 | return $this->setProperty('additionalType', $additionalType); |
|
55 | } |
|
56 | ||
57 | /** |
|
58 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
59 | * *John* wrote a book. |
|
60 | * |
|
61 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
62 | * |
|
63 | * @return static |
|
64 | * |
|
65 | * @see http://schema.org/agent |
|
66 | */ |
|
67 | public function agent($agent) |
|
68 | { |
|
69 | return $this->setProperty('agent', $agent); |
|
70 | } |
|
71 | ||
72 | /** |
|
73 | * An alias for the item. |
|
74 | * |
|
75 | * @param string|string[] $alternateName |
|
76 | * |
|
77 | * @return static |
|
78 | * |
|
79 | * @see http://schema.org/alternateName |
|
80 | */ |
|
81 | public function alternateName($alternateName) |
|
82 | { |
|
83 | return $this->setProperty('alternateName', $alternateName); |
|
84 | } |
|
85 | ||
86 | /** |
|
87 | * A description of the item. |
|
88 | * |
|
89 | * @param string|string[] $description |
|
90 | * |
|
91 | * @return static |
|
92 | * |
|
93 | * @see http://schema.org/description |
|
94 | */ |
|
95 | public function description($description) |
|
96 | { |
|
97 | return $this->setProperty('description', $description); |
|
98 | } |
|
99 | ||
100 | /** |
|
101 | * A sub property of description. A short description of the item used to |
|
102 | * disambiguate from other, similar items. Information from other properties |
|
103 | * (in particular, name) may be necessary for the description to be useful |
|
104 | * for disambiguation. |
|
105 | * |
|
106 | * @param string|string[] $disambiguatingDescription |
|
107 | * |
|
108 | * @return static |
|
109 | * |
|
110 | * @see http://schema.org/disambiguatingDescription |
|
111 | */ |
|
112 | public function disambiguatingDescription($disambiguatingDescription) |
|
113 | { |
|
114 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
115 | } |
|
116 | ||
117 | /** |
|
118 | * The endTime of something. For a reserved event or service (e.g. |
|
119 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
120 | * actions that span a period of time, when the action was performed. e.g. |
|
121 | * John wrote a book from January to *December*. For media, including audio |
|
122 | * and video, it's the time offset of the end of a clip within a larger |
|
123 | * file. |
|
124 | * |
|
125 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
126 | * when describing dates with times. This situation may be clarified in |
|
127 | * future revisions. |
|
128 | * |
|
129 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
130 | * |
|
131 | * @return static |
|
132 | * |
|
133 | * @see http://schema.org/endTime |
|
134 | */ |
|
135 | public function endTime($endTime) |
|
136 | { |
|
137 | return $this->setProperty('endTime', $endTime); |
|
138 | } |
|
139 | ||
140 | /** |
|
141 | * For failed actions, more information on the cause of the failure. |
|
142 | * |
|
143 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
144 | * |
|
145 | * @return static |
|
146 | * |
|
147 | * @see http://schema.org/error |
|
148 | */ |
|
149 | public function error($error) |
|
150 | { |
|
151 | return $this->setProperty('error', $error); |
|
152 | } |
|
153 | ||
154 | /** |
|
155 | * Upcoming or past event associated with this place, organization, or |
|
156 | * action. |
|
157 | * |
|
158 | * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event |
|
159 | * |
|
160 | * @return static |
|
161 | * |
|
162 | * @see http://schema.org/event |
|
163 | */ |
|
164 | public function event($event) |
|
165 | { |
|
166 | return $this->setProperty('event', $event); |
|
167 | } |
|
168 | ||
169 | /** |
|
170 | * The identifier property represents any kind of identifier for any kind of |
|
171 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
172 | * dedicated properties for representing many of these, either as textual |
|
173 | * strings or as URL (URI) links. See [background |
|
174 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
175 | * |
|
176 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
177 | * |
|
178 | * @return static |
|
179 | * |
|
180 | * @see http://schema.org/identifier |
|
181 | */ |
|
182 | public function identifier($identifier) |
|
183 | { |
|
184 | return $this->setProperty('identifier', $identifier); |
|
185 | } |
|
186 | ||
187 | /** |
|
188 | * An image of the item. This can be a [[URL]] or a fully described |
|
189 | * [[ImageObject]]. |
|
190 | * |
|
191 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
192 | * |
|
193 | * @return static |
|
194 | * |
|
195 | * @see http://schema.org/image |
|
196 | */ |
|
197 | public function image($image) |
|
198 | { |
|
199 | return $this->setProperty('image', $image); |
|
200 | } |
|
201 | ||
202 | /** |
|
203 | * The object that helped the agent perform the action. e.g. John wrote a |
|
204 | * book with *a pen*. |
|
205 | * |
|
206 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
207 | * |
|
208 | * @return static |
|
209 | * |
|
210 | * @see http://schema.org/instrument |
|
211 | */ |
|
212 | public function instrument($instrument) |
|
213 | { |
|
214 | return $this->setProperty('instrument', $instrument); |
|
215 | } |
|
216 | ||
217 | /** |
|
218 | * The location of for example where the event is happening, an organization |
|
219 | * is located, or where an action takes place. |
|
220 | * |
|
221 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
222 | * |
|
223 | * @return static |
|
224 | * |
|
225 | * @see http://schema.org/location |
|
226 | */ |
|
227 | public function location($location) |
|
228 | { |
|
229 | return $this->setProperty('location', $location); |
|
230 | } |
|
231 | ||
232 | /** |
|
233 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
234 | * entity being described. See [background |
|
235 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
236 | * |
|
237 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
238 | * |
|
239 | * @return static |
|
240 | * |
|
241 | * @see http://schema.org/mainEntityOfPage |
|
242 | */ |
|
243 | public function mainEntityOfPage($mainEntityOfPage) |
|
244 | { |
|
245 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
246 | } |
|
247 | ||
248 | /** |
|
249 | * The name of the item. |
|
250 | * |
|
251 | * @param string|string[] $name |
|
252 | * |
|
253 | * @return static |
|
254 | * |
|
255 | * @see http://schema.org/name |
|
256 | */ |
|
257 | public function name($name) |
|
258 | { |
|
259 | return $this->setProperty('name', $name); |
|
260 | } |
|
261 | ||
262 | /** |
|
263 | * The object upon which the action is carried out, whose state is kept |
|
264 | * intact or changed. Also known as the semantic roles patient, affected or |
|
265 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
266 | * read *a book*. |
|
267 | * |
|
268 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
269 | * |
|
270 | * @return static |
|
271 | * |
|
272 | * @see http://schema.org/object |
|
273 | */ |
|
274 | public function object($object) |
|
275 | { |
|
276 | return $this->setProperty('object', $object); |
|
277 | } |
|
278 | ||
279 | /** |
|
280 | * Other co-agents that participated in the action indirectly. e.g. John |
|
281 | * wrote a book with *Steve*. |
|
282 | * |
|
283 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
284 | * |
|
285 | * @return static |
|
286 | * |
|
287 | * @see http://schema.org/participant |
|
288 | */ |
|
289 | public function participant($participant) |
|
290 | { |
|
291 | return $this->setProperty('participant', $participant); |
|
292 | } |
|
293 | ||
294 | /** |
|
295 | * Indicates a potential Action, which describes an idealized action in |
|
296 | * which this thing would play an 'object' role. |
|
297 | * |
|
298 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
299 | * |
|
300 | * @return static |
|
301 | * |
|
302 | * @see http://schema.org/potentialAction |
|
303 | */ |
|
304 | public function potentialAction($potentialAction) |
|
305 | { |
|
306 | return $this->setProperty('potentialAction', $potentialAction); |
|
307 | } |
|
308 | ||
309 | /** |
|
310 | * The result produced in the action. e.g. John wrote *a book*. |
|
311 | * |
|
312 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
313 | * |
|
314 | * @return static |
|
315 | * |
|
316 | * @see http://schema.org/result |
|
317 | */ |
|
318 | public function result($result) |
|
319 | { |
|
320 | return $this->setProperty('result', $result); |
|
321 | } |
|
322 | ||
323 | /** |
|
324 | * URL of a reference Web page that unambiguously indicates the item's |
|
325 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
326 | * official website. |
|
327 | * |
|
328 | * @param string|string[] $sameAs |
|
329 | * |
|
330 | * @return static |
|
331 | * |
|
332 | * @see http://schema.org/sameAs |
|
333 | */ |
|
334 | public function sameAs($sameAs) |
|
335 | { |
|
336 | return $this->setProperty('sameAs', $sameAs); |
|
337 | } |
|
338 | ||
339 | /** |
|
340 | * The startTime of something. For a reserved event or service (e.g. |
|
341 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
342 | * actions that span a period of time, when the action was performed. e.g. |
|
343 | * John wrote a book from *January* to December. For media, including audio |
|
344 | * and video, it's the time offset of the start of a clip within a larger |
|
345 | * file. |
|
346 | * |
|
347 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
348 | * when describing dates with times. This situation may be clarified in |
|
349 | * future revisions. |
|
350 | * |
|
351 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
352 | * |
|
353 | * @return static |
|
354 | * |
|
355 | * @see http://schema.org/startTime |
|
356 | */ |
|
357 | public function startTime($startTime) |
|
358 | { |
|
359 | return $this->setProperty('startTime', $startTime); |
|
360 | } |
|
361 | ||
362 | /** |
|
363 | * A CreativeWork or Event about this Thing. |
|
364 | * |
|
365 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
366 | * |
|
367 | * @return static |
|
368 | * |
|
369 | * @see http://schema.org/subjectOf |
|
370 | */ |
|
371 | public function subjectOf($subjectOf) |
|
372 | { |
|
373 | return $this->setProperty('subjectOf', $subjectOf); |
|
374 | } |
|
375 | ||
376 | /** |
|
377 | * Indicates a target EntryPoint for an Action. |
|
378 | * |
|
379 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
380 | * |
|
381 | * @return static |
|
382 | * |
|
383 | * @see http://schema.org/target |
|
384 | */ |
|
385 | public function target($target) |
|
386 | { |
|
387 | return $this->setProperty('target', $target); |
|
388 | } |
|
389 | ||
390 | /** |
|
391 | * URL of the item. |
|
392 | * |
|
393 | * @param string|string[] $url |
|
394 | * |
|
395 | * @return static |
|
396 | * |
|
397 | * @see http://schema.org/url |
|
398 | */ |
|
399 | public function url($url) |
|
400 | { |
|
401 | return $this->setProperty('url', $url); |
|
402 | } |
|
403 | ||
404 | } |
|
405 |
@@ 21-433 (lines=413) @@ | ||
18 | * @see http://schema.org/LendAction |
|
19 | * |
|
20 | */ |
|
21 | class LendAction extends BaseType implements LendActionContract, ActionContract, ThingContract, TransferActionContract |
|
22 | { |
|
23 | /** |
|
24 | * Indicates the current disposition of the Action. |
|
25 | * |
|
26 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
27 | * |
|
28 | * @return static |
|
29 | * |
|
30 | * @see http://schema.org/actionStatus |
|
31 | */ |
|
32 | public function actionStatus($actionStatus) |
|
33 | { |
|
34 | return $this->setProperty('actionStatus', $actionStatus); |
|
35 | } |
|
36 | ||
37 | /** |
|
38 | * An additional type for the item, typically used for adding more specific |
|
39 | * types from external vocabularies in microdata syntax. This is a |
|
40 | * relationship between something and a class that the thing is in. In RDFa |
|
41 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
42 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
43 | * understanding of extra types, in particular those defined externally. |
|
44 | * |
|
45 | * @param string|string[] $additionalType |
|
46 | * |
|
47 | * @return static |
|
48 | * |
|
49 | * @see http://schema.org/additionalType |
|
50 | */ |
|
51 | public function additionalType($additionalType) |
|
52 | { |
|
53 | return $this->setProperty('additionalType', $additionalType); |
|
54 | } |
|
55 | ||
56 | /** |
|
57 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
58 | * *John* wrote a book. |
|
59 | * |
|
60 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
61 | * |
|
62 | * @return static |
|
63 | * |
|
64 | * @see http://schema.org/agent |
|
65 | */ |
|
66 | public function agent($agent) |
|
67 | { |
|
68 | return $this->setProperty('agent', $agent); |
|
69 | } |
|
70 | ||
71 | /** |
|
72 | * An alias for the item. |
|
73 | * |
|
74 | * @param string|string[] $alternateName |
|
75 | * |
|
76 | * @return static |
|
77 | * |
|
78 | * @see http://schema.org/alternateName |
|
79 | */ |
|
80 | public function alternateName($alternateName) |
|
81 | { |
|
82 | return $this->setProperty('alternateName', $alternateName); |
|
83 | } |
|
84 | ||
85 | /** |
|
86 | * A sub property of participant. The person that borrows the object being |
|
87 | * lent. |
|
88 | * |
|
89 | * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $borrower |
|
90 | * |
|
91 | * @return static |
|
92 | * |
|
93 | * @see http://schema.org/borrower |
|
94 | */ |
|
95 | public function borrower($borrower) |
|
96 | { |
|
97 | return $this->setProperty('borrower', $borrower); |
|
98 | } |
|
99 | ||
100 | /** |
|
101 | * A description of the item. |
|
102 | * |
|
103 | * @param string|string[] $description |
|
104 | * |
|
105 | * @return static |
|
106 | * |
|
107 | * @see http://schema.org/description |
|
108 | */ |
|
109 | public function description($description) |
|
110 | { |
|
111 | return $this->setProperty('description', $description); |
|
112 | } |
|
113 | ||
114 | /** |
|
115 | * A sub property of description. A short description of the item used to |
|
116 | * disambiguate from other, similar items. Information from other properties |
|
117 | * (in particular, name) may be necessary for the description to be useful |
|
118 | * for disambiguation. |
|
119 | * |
|
120 | * @param string|string[] $disambiguatingDescription |
|
121 | * |
|
122 | * @return static |
|
123 | * |
|
124 | * @see http://schema.org/disambiguatingDescription |
|
125 | */ |
|
126 | public function disambiguatingDescription($disambiguatingDescription) |
|
127 | { |
|
128 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
129 | } |
|
130 | ||
131 | /** |
|
132 | * The endTime of something. For a reserved event or service (e.g. |
|
133 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
134 | * actions that span a period of time, when the action was performed. e.g. |
|
135 | * John wrote a book from January to *December*. For media, including audio |
|
136 | * and video, it's the time offset of the end of a clip within a larger |
|
137 | * file. |
|
138 | * |
|
139 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
140 | * when describing dates with times. This situation may be clarified in |
|
141 | * future revisions. |
|
142 | * |
|
143 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
144 | * |
|
145 | * @return static |
|
146 | * |
|
147 | * @see http://schema.org/endTime |
|
148 | */ |
|
149 | public function endTime($endTime) |
|
150 | { |
|
151 | return $this->setProperty('endTime', $endTime); |
|
152 | } |
|
153 | ||
154 | /** |
|
155 | * For failed actions, more information on the cause of the failure. |
|
156 | * |
|
157 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
158 | * |
|
159 | * @return static |
|
160 | * |
|
161 | * @see http://schema.org/error |
|
162 | */ |
|
163 | public function error($error) |
|
164 | { |
|
165 | return $this->setProperty('error', $error); |
|
166 | } |
|
167 | ||
168 | /** |
|
169 | * A sub property of location. The original location of the object or the |
|
170 | * agent before the action. |
|
171 | * |
|
172 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
173 | * |
|
174 | * @return static |
|
175 | * |
|
176 | * @see http://schema.org/fromLocation |
|
177 | */ |
|
178 | public function fromLocation($fromLocation) |
|
179 | { |
|
180 | return $this->setProperty('fromLocation', $fromLocation); |
|
181 | } |
|
182 | ||
183 | /** |
|
184 | * The identifier property represents any kind of identifier for any kind of |
|
185 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
186 | * dedicated properties for representing many of these, either as textual |
|
187 | * strings or as URL (URI) links. See [background |
|
188 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
189 | * |
|
190 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
191 | * |
|
192 | * @return static |
|
193 | * |
|
194 | * @see http://schema.org/identifier |
|
195 | */ |
|
196 | public function identifier($identifier) |
|
197 | { |
|
198 | return $this->setProperty('identifier', $identifier); |
|
199 | } |
|
200 | ||
201 | /** |
|
202 | * An image of the item. This can be a [[URL]] or a fully described |
|
203 | * [[ImageObject]]. |
|
204 | * |
|
205 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
206 | * |
|
207 | * @return static |
|
208 | * |
|
209 | * @see http://schema.org/image |
|
210 | */ |
|
211 | public function image($image) |
|
212 | { |
|
213 | return $this->setProperty('image', $image); |
|
214 | } |
|
215 | ||
216 | /** |
|
217 | * The object that helped the agent perform the action. e.g. John wrote a |
|
218 | * book with *a pen*. |
|
219 | * |
|
220 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
221 | * |
|
222 | * @return static |
|
223 | * |
|
224 | * @see http://schema.org/instrument |
|
225 | */ |
|
226 | public function instrument($instrument) |
|
227 | { |
|
228 | return $this->setProperty('instrument', $instrument); |
|
229 | } |
|
230 | ||
231 | /** |
|
232 | * The location of for example where the event is happening, an organization |
|
233 | * is located, or where an action takes place. |
|
234 | * |
|
235 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
236 | * |
|
237 | * @return static |
|
238 | * |
|
239 | * @see http://schema.org/location |
|
240 | */ |
|
241 | public function location($location) |
|
242 | { |
|
243 | return $this->setProperty('location', $location); |
|
244 | } |
|
245 | ||
246 | /** |
|
247 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
248 | * entity being described. See [background |
|
249 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
250 | * |
|
251 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
252 | * |
|
253 | * @return static |
|
254 | * |
|
255 | * @see http://schema.org/mainEntityOfPage |
|
256 | */ |
|
257 | public function mainEntityOfPage($mainEntityOfPage) |
|
258 | { |
|
259 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
260 | } |
|
261 | ||
262 | /** |
|
263 | * The name of the item. |
|
264 | * |
|
265 | * @param string|string[] $name |
|
266 | * |
|
267 | * @return static |
|
268 | * |
|
269 | * @see http://schema.org/name |
|
270 | */ |
|
271 | public function name($name) |
|
272 | { |
|
273 | return $this->setProperty('name', $name); |
|
274 | } |
|
275 | ||
276 | /** |
|
277 | * The object upon which the action is carried out, whose state is kept |
|
278 | * intact or changed. Also known as the semantic roles patient, affected or |
|
279 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
280 | * read *a book*. |
|
281 | * |
|
282 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
283 | * |
|
284 | * @return static |
|
285 | * |
|
286 | * @see http://schema.org/object |
|
287 | */ |
|
288 | public function object($object) |
|
289 | { |
|
290 | return $this->setProperty('object', $object); |
|
291 | } |
|
292 | ||
293 | /** |
|
294 | * Other co-agents that participated in the action indirectly. e.g. John |
|
295 | * wrote a book with *Steve*. |
|
296 | * |
|
297 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
298 | * |
|
299 | * @return static |
|
300 | * |
|
301 | * @see http://schema.org/participant |
|
302 | */ |
|
303 | public function participant($participant) |
|
304 | { |
|
305 | return $this->setProperty('participant', $participant); |
|
306 | } |
|
307 | ||
308 | /** |
|
309 | * Indicates a potential Action, which describes an idealized action in |
|
310 | * which this thing would play an 'object' role. |
|
311 | * |
|
312 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
313 | * |
|
314 | * @return static |
|
315 | * |
|
316 | * @see http://schema.org/potentialAction |
|
317 | */ |
|
318 | public function potentialAction($potentialAction) |
|
319 | { |
|
320 | return $this->setProperty('potentialAction', $potentialAction); |
|
321 | } |
|
322 | ||
323 | /** |
|
324 | * The result produced in the action. e.g. John wrote *a book*. |
|
325 | * |
|
326 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
327 | * |
|
328 | * @return static |
|
329 | * |
|
330 | * @see http://schema.org/result |
|
331 | */ |
|
332 | public function result($result) |
|
333 | { |
|
334 | return $this->setProperty('result', $result); |
|
335 | } |
|
336 | ||
337 | /** |
|
338 | * URL of a reference Web page that unambiguously indicates the item's |
|
339 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
340 | * official website. |
|
341 | * |
|
342 | * @param string|string[] $sameAs |
|
343 | * |
|
344 | * @return static |
|
345 | * |
|
346 | * @see http://schema.org/sameAs |
|
347 | */ |
|
348 | public function sameAs($sameAs) |
|
349 | { |
|
350 | return $this->setProperty('sameAs', $sameAs); |
|
351 | } |
|
352 | ||
353 | /** |
|
354 | * The startTime of something. For a reserved event or service (e.g. |
|
355 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
356 | * actions that span a period of time, when the action was performed. e.g. |
|
357 | * John wrote a book from *January* to December. For media, including audio |
|
358 | * and video, it's the time offset of the start of a clip within a larger |
|
359 | * file. |
|
360 | * |
|
361 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
362 | * when describing dates with times. This situation may be clarified in |
|
363 | * future revisions. |
|
364 | * |
|
365 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
366 | * |
|
367 | * @return static |
|
368 | * |
|
369 | * @see http://schema.org/startTime |
|
370 | */ |
|
371 | public function startTime($startTime) |
|
372 | { |
|
373 | return $this->setProperty('startTime', $startTime); |
|
374 | } |
|
375 | ||
376 | /** |
|
377 | * A CreativeWork or Event about this Thing. |
|
378 | * |
|
379 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
380 | * |
|
381 | * @return static |
|
382 | * |
|
383 | * @see http://schema.org/subjectOf |
|
384 | */ |
|
385 | public function subjectOf($subjectOf) |
|
386 | { |
|
387 | return $this->setProperty('subjectOf', $subjectOf); |
|
388 | } |
|
389 | ||
390 | /** |
|
391 | * Indicates a target EntryPoint for an Action. |
|
392 | * |
|
393 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
394 | * |
|
395 | * @return static |
|
396 | * |
|
397 | * @see http://schema.org/target |
|
398 | */ |
|
399 | public function target($target) |
|
400 | { |
|
401 | return $this->setProperty('target', $target); |
|
402 | } |
|
403 | ||
404 | /** |
|
405 | * A sub property of location. The final location of the object or the agent |
|
406 | * after the action. |
|
407 | * |
|
408 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
409 | * |
|
410 | * @return static |
|
411 | * |
|
412 | * @see http://schema.org/toLocation |
|
413 | */ |
|
414 | public function toLocation($toLocation) |
|
415 | { |
|
416 | return $this->setProperty('toLocation', $toLocation); |
|
417 | } |
|
418 | ||
419 | /** |
|
420 | * URL of the item. |
|
421 | * |
|
422 | * @param string|string[] $url |
|
423 | * |
|
424 | * @return static |
|
425 | * |
|
426 | * @see http://schema.org/url |
|
427 | */ |
|
428 | public function url($url) |
|
429 | { |
|
430 | return $this->setProperty('url', $url); |
|
431 | } |
|
432 | ||
433 | } |
|
434 |
@@ 16-415 (lines=400) @@ | ||
13 | * @see http://schema.org/ListenAction |
|
14 | * |
|
15 | */ |
|
16 | class ListenAction extends BaseType implements ListenActionContract, ActionContract, ConsumeActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * A set of requirements that a must be fulfilled in order to perform an |
|
20 | * Action. If more than one value is specied, fulfilling one set of |
|
21 | * requirements will allow the Action to be performed. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionAccessibilityRequirement |
|
28 | */ |
|
29 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
30 | { |
|
31 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * Indicates the current disposition of the Action. |
|
36 | * |
|
37 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
38 | * |
|
39 | * @return static |
|
40 | * |
|
41 | * @see http://schema.org/actionStatus |
|
42 | */ |
|
43 | public function actionStatus($actionStatus) |
|
44 | { |
|
45 | return $this->setProperty('actionStatus', $actionStatus); |
|
46 | } |
|
47 | ||
48 | /** |
|
49 | * An additional type for the item, typically used for adding more specific |
|
50 | * types from external vocabularies in microdata syntax. This is a |
|
51 | * relationship between something and a class that the thing is in. In RDFa |
|
52 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
53 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
54 | * understanding of extra types, in particular those defined externally. |
|
55 | * |
|
56 | * @param string|string[] $additionalType |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/additionalType |
|
61 | */ |
|
62 | public function additionalType($additionalType) |
|
63 | { |
|
64 | return $this->setProperty('additionalType', $additionalType); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
69 | * *John* wrote a book. |
|
70 | * |
|
71 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/agent |
|
76 | */ |
|
77 | public function agent($agent) |
|
78 | { |
|
79 | return $this->setProperty('agent', $agent); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * An alias for the item. |
|
84 | * |
|
85 | * @param string|string[] $alternateName |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/alternateName |
|
90 | */ |
|
91 | public function alternateName($alternateName) |
|
92 | { |
|
93 | return $this->setProperty('alternateName', $alternateName); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * An Offer which must be accepted before the user can perform the Action. |
|
166 | * For example, the user may need to buy a movie before being able to watch |
|
167 | * it. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/expectsAcceptanceOf |
|
174 | */ |
|
175 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
176 | { |
|
177 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * The identifier property represents any kind of identifier for any kind of |
|
182 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
183 | * dedicated properties for representing many of these, either as textual |
|
184 | * strings or as URL (URI) links. See [background |
|
185 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
186 | * |
|
187 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
188 | * |
|
189 | * @return static |
|
190 | * |
|
191 | * @see http://schema.org/identifier |
|
192 | */ |
|
193 | public function identifier($identifier) |
|
194 | { |
|
195 | return $this->setProperty('identifier', $identifier); |
|
196 | } |
|
197 | ||
198 | /** |
|
199 | * An image of the item. This can be a [[URL]] or a fully described |
|
200 | * [[ImageObject]]. |
|
201 | * |
|
202 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
203 | * |
|
204 | * @return static |
|
205 | * |
|
206 | * @see http://schema.org/image |
|
207 | */ |
|
208 | public function image($image) |
|
209 | { |
|
210 | return $this->setProperty('image', $image); |
|
211 | } |
|
212 | ||
213 | /** |
|
214 | * The object that helped the agent perform the action. e.g. John wrote a |
|
215 | * book with *a pen*. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/instrument |
|
222 | */ |
|
223 | public function instrument($instrument) |
|
224 | { |
|
225 | return $this->setProperty('instrument', $instrument); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The location of for example where the event is happening, an organization |
|
230 | * is located, or where an action takes place. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/location |
|
237 | */ |
|
238 | public function location($location) |
|
239 | { |
|
240 | return $this->setProperty('location', $location); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
245 | * entity being described. See [background |
|
246 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/mainEntityOfPage |
|
253 | */ |
|
254 | public function mainEntityOfPage($mainEntityOfPage) |
|
255 | { |
|
256 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The name of the item. |
|
261 | * |
|
262 | * @param string|string[] $name |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/name |
|
267 | */ |
|
268 | public function name($name) |
|
269 | { |
|
270 | return $this->setProperty('name', $name); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * The object upon which the action is carried out, whose state is kept |
|
275 | * intact or changed. Also known as the semantic roles patient, affected or |
|
276 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
277 | * read *a book*. |
|
278 | * |
|
279 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
280 | * |
|
281 | * @return static |
|
282 | * |
|
283 | * @see http://schema.org/object |
|
284 | */ |
|
285 | public function object($object) |
|
286 | { |
|
287 | return $this->setProperty('object', $object); |
|
288 | } |
|
289 | ||
290 | /** |
|
291 | * Other co-agents that participated in the action indirectly. e.g. John |
|
292 | * wrote a book with *Steve*. |
|
293 | * |
|
294 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
295 | * |
|
296 | * @return static |
|
297 | * |
|
298 | * @see http://schema.org/participant |
|
299 | */ |
|
300 | public function participant($participant) |
|
301 | { |
|
302 | return $this->setProperty('participant', $participant); |
|
303 | } |
|
304 | ||
305 | /** |
|
306 | * Indicates a potential Action, which describes an idealized action in |
|
307 | * which this thing would play an 'object' role. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/potentialAction |
|
314 | */ |
|
315 | public function potentialAction($potentialAction) |
|
316 | { |
|
317 | return $this->setProperty('potentialAction', $potentialAction); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * The result produced in the action. e.g. John wrote *a book*. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/result |
|
328 | */ |
|
329 | public function result($result) |
|
330 | { |
|
331 | return $this->setProperty('result', $result); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * The startTime of something. For a reserved event or service (e.g. |
|
352 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
353 | * actions that span a period of time, when the action was performed. e.g. |
|
354 | * John wrote a book from *January* to December. For media, including audio |
|
355 | * and video, it's the time offset of the start of a clip within a larger |
|
356 | * file. |
|
357 | * |
|
358 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
359 | * when describing dates with times. This situation may be clarified in |
|
360 | * future revisions. |
|
361 | * |
|
362 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
363 | * |
|
364 | * @return static |
|
365 | * |
|
366 | * @see http://schema.org/startTime |
|
367 | */ |
|
368 | public function startTime($startTime) |
|
369 | { |
|
370 | return $this->setProperty('startTime', $startTime); |
|
371 | } |
|
372 | ||
373 | /** |
|
374 | * A CreativeWork or Event about this Thing. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/subjectOf |
|
381 | */ |
|
382 | public function subjectOf($subjectOf) |
|
383 | { |
|
384 | return $this->setProperty('subjectOf', $subjectOf); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * Indicates a target EntryPoint for an Action. |
|
389 | * |
|
390 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/target |
|
395 | */ |
|
396 | public function target($target) |
|
397 | { |
|
398 | return $this->setProperty('target', $target); |
|
399 | } |
|
400 | ||
401 | /** |
|
402 | * URL of the item. |
|
403 | * |
|
404 | * @param string|string[] $url |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/url |
|
409 | */ |
|
410 | public function url($url) |
|
411 | { |
|
412 | return $this->setProperty('url', $url); |
|
413 | } |
|
414 | ||
415 | } |
|
416 |
@@ 16-397 (lines=382) @@ | ||
13 | * @see http://schema.org/LoseAction |
|
14 | * |
|
15 | */ |
|
16 | class LoseAction extends BaseType implements LoseActionContract, AchieveActionContract, ActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * Indicates the current disposition of the Action. |
|
20 | * |
|
21 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
22 | * |
|
23 | * @return static |
|
24 | * |
|
25 | * @see http://schema.org/actionStatus |
|
26 | */ |
|
27 | public function actionStatus($actionStatus) |
|
28 | { |
|
29 | return $this->setProperty('actionStatus', $actionStatus); |
|
30 | } |
|
31 | ||
32 | /** |
|
33 | * An additional type for the item, typically used for adding more specific |
|
34 | * types from external vocabularies in microdata syntax. This is a |
|
35 | * relationship between something and a class that the thing is in. In RDFa |
|
36 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
37 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
38 | * understanding of extra types, in particular those defined externally. |
|
39 | * |
|
40 | * @param string|string[] $additionalType |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/additionalType |
|
45 | */ |
|
46 | public function additionalType($additionalType) |
|
47 | { |
|
48 | return $this->setProperty('additionalType', $additionalType); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
53 | * *John* wrote a book. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/agent |
|
60 | */ |
|
61 | public function agent($agent) |
|
62 | { |
|
63 | return $this->setProperty('agent', $agent); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * An alias for the item. |
|
68 | * |
|
69 | * @param string|string[] $alternateName |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/alternateName |
|
74 | */ |
|
75 | public function alternateName($alternateName) |
|
76 | { |
|
77 | return $this->setProperty('alternateName', $alternateName); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * A description of the item. |
|
82 | * |
|
83 | * @param string|string[] $description |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/description |
|
88 | */ |
|
89 | public function description($description) |
|
90 | { |
|
91 | return $this->setProperty('description', $description); |
|
92 | } |
|
93 | ||
94 | /** |
|
95 | * A sub property of description. A short description of the item used to |
|
96 | * disambiguate from other, similar items. Information from other properties |
|
97 | * (in particular, name) may be necessary for the description to be useful |
|
98 | * for disambiguation. |
|
99 | * |
|
100 | * @param string|string[] $disambiguatingDescription |
|
101 | * |
|
102 | * @return static |
|
103 | * |
|
104 | * @see http://schema.org/disambiguatingDescription |
|
105 | */ |
|
106 | public function disambiguatingDescription($disambiguatingDescription) |
|
107 | { |
|
108 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
109 | } |
|
110 | ||
111 | /** |
|
112 | * The endTime of something. For a reserved event or service (e.g. |
|
113 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
114 | * actions that span a period of time, when the action was performed. e.g. |
|
115 | * John wrote a book from January to *December*. For media, including audio |
|
116 | * and video, it's the time offset of the end of a clip within a larger |
|
117 | * file. |
|
118 | * |
|
119 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
120 | * when describing dates with times. This situation may be clarified in |
|
121 | * future revisions. |
|
122 | * |
|
123 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
124 | * |
|
125 | * @return static |
|
126 | * |
|
127 | * @see http://schema.org/endTime |
|
128 | */ |
|
129 | public function endTime($endTime) |
|
130 | { |
|
131 | return $this->setProperty('endTime', $endTime); |
|
132 | } |
|
133 | ||
134 | /** |
|
135 | * For failed actions, more information on the cause of the failure. |
|
136 | * |
|
137 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
138 | * |
|
139 | * @return static |
|
140 | * |
|
141 | * @see http://schema.org/error |
|
142 | */ |
|
143 | public function error($error) |
|
144 | { |
|
145 | return $this->setProperty('error', $error); |
|
146 | } |
|
147 | ||
148 | /** |
|
149 | * The identifier property represents any kind of identifier for any kind of |
|
150 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
151 | * dedicated properties for representing many of these, either as textual |
|
152 | * strings or as URL (URI) links. See [background |
|
153 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
154 | * |
|
155 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
156 | * |
|
157 | * @return static |
|
158 | * |
|
159 | * @see http://schema.org/identifier |
|
160 | */ |
|
161 | public function identifier($identifier) |
|
162 | { |
|
163 | return $this->setProperty('identifier', $identifier); |
|
164 | } |
|
165 | ||
166 | /** |
|
167 | * An image of the item. This can be a [[URL]] or a fully described |
|
168 | * [[ImageObject]]. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/image |
|
175 | */ |
|
176 | public function image($image) |
|
177 | { |
|
178 | return $this->setProperty('image', $image); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * The object that helped the agent perform the action. e.g. John wrote a |
|
183 | * book with *a pen*. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/instrument |
|
190 | */ |
|
191 | public function instrument($instrument) |
|
192 | { |
|
193 | return $this->setProperty('instrument', $instrument); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * The location of for example where the event is happening, an organization |
|
198 | * is located, or where an action takes place. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/location |
|
205 | */ |
|
206 | public function location($location) |
|
207 | { |
|
208 | return $this->setProperty('location', $location); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
213 | * entity being described. See [background |
|
214 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
215 | * |
|
216 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
217 | * |
|
218 | * @return static |
|
219 | * |
|
220 | * @see http://schema.org/mainEntityOfPage |
|
221 | */ |
|
222 | public function mainEntityOfPage($mainEntityOfPage) |
|
223 | { |
|
224 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
225 | } |
|
226 | ||
227 | /** |
|
228 | * The name of the item. |
|
229 | * |
|
230 | * @param string|string[] $name |
|
231 | * |
|
232 | * @return static |
|
233 | * |
|
234 | * @see http://schema.org/name |
|
235 | */ |
|
236 | public function name($name) |
|
237 | { |
|
238 | return $this->setProperty('name', $name); |
|
239 | } |
|
240 | ||
241 | /** |
|
242 | * The object upon which the action is carried out, whose state is kept |
|
243 | * intact or changed. Also known as the semantic roles patient, affected or |
|
244 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
245 | * read *a book*. |
|
246 | * |
|
247 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
248 | * |
|
249 | * @return static |
|
250 | * |
|
251 | * @see http://schema.org/object |
|
252 | */ |
|
253 | public function object($object) |
|
254 | { |
|
255 | return $this->setProperty('object', $object); |
|
256 | } |
|
257 | ||
258 | /** |
|
259 | * Other co-agents that participated in the action indirectly. e.g. John |
|
260 | * wrote a book with *Steve*. |
|
261 | * |
|
262 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/participant |
|
267 | */ |
|
268 | public function participant($participant) |
|
269 | { |
|
270 | return $this->setProperty('participant', $participant); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * Indicates a potential Action, which describes an idealized action in |
|
275 | * which this thing would play an 'object' role. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/potentialAction |
|
282 | */ |
|
283 | public function potentialAction($potentialAction) |
|
284 | { |
|
285 | return $this->setProperty('potentialAction', $potentialAction); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * The result produced in the action. e.g. John wrote *a book*. |
|
290 | * |
|
291 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
292 | * |
|
293 | * @return static |
|
294 | * |
|
295 | * @see http://schema.org/result |
|
296 | */ |
|
297 | public function result($result) |
|
298 | { |
|
299 | return $this->setProperty('result', $result); |
|
300 | } |
|
301 | ||
302 | /** |
|
303 | * URL of a reference Web page that unambiguously indicates the item's |
|
304 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
305 | * official website. |
|
306 | * |
|
307 | * @param string|string[] $sameAs |
|
308 | * |
|
309 | * @return static |
|
310 | * |
|
311 | * @see http://schema.org/sameAs |
|
312 | */ |
|
313 | public function sameAs($sameAs) |
|
314 | { |
|
315 | return $this->setProperty('sameAs', $sameAs); |
|
316 | } |
|
317 | ||
318 | /** |
|
319 | * The startTime of something. For a reserved event or service (e.g. |
|
320 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
321 | * actions that span a period of time, when the action was performed. e.g. |
|
322 | * John wrote a book from *January* to December. For media, including audio |
|
323 | * and video, it's the time offset of the start of a clip within a larger |
|
324 | * file. |
|
325 | * |
|
326 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
327 | * when describing dates with times. This situation may be clarified in |
|
328 | * future revisions. |
|
329 | * |
|
330 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
331 | * |
|
332 | * @return static |
|
333 | * |
|
334 | * @see http://schema.org/startTime |
|
335 | */ |
|
336 | public function startTime($startTime) |
|
337 | { |
|
338 | return $this->setProperty('startTime', $startTime); |
|
339 | } |
|
340 | ||
341 | /** |
|
342 | * A CreativeWork or Event about this Thing. |
|
343 | * |
|
344 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
345 | * |
|
346 | * @return static |
|
347 | * |
|
348 | * @see http://schema.org/subjectOf |
|
349 | */ |
|
350 | public function subjectOf($subjectOf) |
|
351 | { |
|
352 | return $this->setProperty('subjectOf', $subjectOf); |
|
353 | } |
|
354 | ||
355 | /** |
|
356 | * Indicates a target EntryPoint for an Action. |
|
357 | * |
|
358 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
359 | * |
|
360 | * @return static |
|
361 | * |
|
362 | * @see http://schema.org/target |
|
363 | */ |
|
364 | public function target($target) |
|
365 | { |
|
366 | return $this->setProperty('target', $target); |
|
367 | } |
|
368 | ||
369 | /** |
|
370 | * URL of the item. |
|
371 | * |
|
372 | * @param string|string[] $url |
|
373 | * |
|
374 | * @return static |
|
375 | * |
|
376 | * @see http://schema.org/url |
|
377 | */ |
|
378 | public function url($url) |
|
379 | { |
|
380 | return $this->setProperty('url', $url); |
|
381 | } |
|
382 | ||
383 | /** |
|
384 | * A sub property of participant. The winner of the action. |
|
385 | * |
|
386 | * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $winner |
|
387 | * |
|
388 | * @return static |
|
389 | * |
|
390 | * @see http://schema.org/winner |
|
391 | */ |
|
392 | public function winner($winner) |
|
393 | { |
|
394 | return $this->setProperty('winner', $winner); |
|
395 | } |
|
396 | ||
397 | } |
|
398 |
@@ 20-417 (lines=398) @@ | ||
17 | * @see http://schema.org/MoveAction |
|
18 | * |
|
19 | */ |
|
20 | class MoveAction extends BaseType implements MoveActionContract, ActionContract, ThingContract |
|
21 | { |
|
22 | /** |
|
23 | * Indicates the current disposition of the Action. |
|
24 | * |
|
25 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
26 | * |
|
27 | * @return static |
|
28 | * |
|
29 | * @see http://schema.org/actionStatus |
|
30 | */ |
|
31 | public function actionStatus($actionStatus) |
|
32 | { |
|
33 | return $this->setProperty('actionStatus', $actionStatus); |
|
34 | } |
|
35 | ||
36 | /** |
|
37 | * An additional type for the item, typically used for adding more specific |
|
38 | * types from external vocabularies in microdata syntax. This is a |
|
39 | * relationship between something and a class that the thing is in. In RDFa |
|
40 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
41 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
42 | * understanding of extra types, in particular those defined externally. |
|
43 | * |
|
44 | * @param string|string[] $additionalType |
|
45 | * |
|
46 | * @return static |
|
47 | * |
|
48 | * @see http://schema.org/additionalType |
|
49 | */ |
|
50 | public function additionalType($additionalType) |
|
51 | { |
|
52 | return $this->setProperty('additionalType', $additionalType); |
|
53 | } |
|
54 | ||
55 | /** |
|
56 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
57 | * *John* wrote a book. |
|
58 | * |
|
59 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
60 | * |
|
61 | * @return static |
|
62 | * |
|
63 | * @see http://schema.org/agent |
|
64 | */ |
|
65 | public function agent($agent) |
|
66 | { |
|
67 | return $this->setProperty('agent', $agent); |
|
68 | } |
|
69 | ||
70 | /** |
|
71 | * An alias for the item. |
|
72 | * |
|
73 | * @param string|string[] $alternateName |
|
74 | * |
|
75 | * @return static |
|
76 | * |
|
77 | * @see http://schema.org/alternateName |
|
78 | */ |
|
79 | public function alternateName($alternateName) |
|
80 | { |
|
81 | return $this->setProperty('alternateName', $alternateName); |
|
82 | } |
|
83 | ||
84 | /** |
|
85 | * A description of the item. |
|
86 | * |
|
87 | * @param string|string[] $description |
|
88 | * |
|
89 | * @return static |
|
90 | * |
|
91 | * @see http://schema.org/description |
|
92 | */ |
|
93 | public function description($description) |
|
94 | { |
|
95 | return $this->setProperty('description', $description); |
|
96 | } |
|
97 | ||
98 | /** |
|
99 | * A sub property of description. A short description of the item used to |
|
100 | * disambiguate from other, similar items. Information from other properties |
|
101 | * (in particular, name) may be necessary for the description to be useful |
|
102 | * for disambiguation. |
|
103 | * |
|
104 | * @param string|string[] $disambiguatingDescription |
|
105 | * |
|
106 | * @return static |
|
107 | * |
|
108 | * @see http://schema.org/disambiguatingDescription |
|
109 | */ |
|
110 | public function disambiguatingDescription($disambiguatingDescription) |
|
111 | { |
|
112 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
113 | } |
|
114 | ||
115 | /** |
|
116 | * The endTime of something. For a reserved event or service (e.g. |
|
117 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
118 | * actions that span a period of time, when the action was performed. e.g. |
|
119 | * John wrote a book from January to *December*. For media, including audio |
|
120 | * and video, it's the time offset of the end of a clip within a larger |
|
121 | * file. |
|
122 | * |
|
123 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
124 | * when describing dates with times. This situation may be clarified in |
|
125 | * future revisions. |
|
126 | * |
|
127 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
128 | * |
|
129 | * @return static |
|
130 | * |
|
131 | * @see http://schema.org/endTime |
|
132 | */ |
|
133 | public function endTime($endTime) |
|
134 | { |
|
135 | return $this->setProperty('endTime', $endTime); |
|
136 | } |
|
137 | ||
138 | /** |
|
139 | * For failed actions, more information on the cause of the failure. |
|
140 | * |
|
141 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
142 | * |
|
143 | * @return static |
|
144 | * |
|
145 | * @see http://schema.org/error |
|
146 | */ |
|
147 | public function error($error) |
|
148 | { |
|
149 | return $this->setProperty('error', $error); |
|
150 | } |
|
151 | ||
152 | /** |
|
153 | * A sub property of location. The original location of the object or the |
|
154 | * agent before the action. |
|
155 | * |
|
156 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
157 | * |
|
158 | * @return static |
|
159 | * |
|
160 | * @see http://schema.org/fromLocation |
|
161 | */ |
|
162 | public function fromLocation($fromLocation) |
|
163 | { |
|
164 | return $this->setProperty('fromLocation', $fromLocation); |
|
165 | } |
|
166 | ||
167 | /** |
|
168 | * The identifier property represents any kind of identifier for any kind of |
|
169 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
170 | * dedicated properties for representing many of these, either as textual |
|
171 | * strings or as URL (URI) links. See [background |
|
172 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
173 | * |
|
174 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
175 | * |
|
176 | * @return static |
|
177 | * |
|
178 | * @see http://schema.org/identifier |
|
179 | */ |
|
180 | public function identifier($identifier) |
|
181 | { |
|
182 | return $this->setProperty('identifier', $identifier); |
|
183 | } |
|
184 | ||
185 | /** |
|
186 | * An image of the item. This can be a [[URL]] or a fully described |
|
187 | * [[ImageObject]]. |
|
188 | * |
|
189 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
190 | * |
|
191 | * @return static |
|
192 | * |
|
193 | * @see http://schema.org/image |
|
194 | */ |
|
195 | public function image($image) |
|
196 | { |
|
197 | return $this->setProperty('image', $image); |
|
198 | } |
|
199 | ||
200 | /** |
|
201 | * The object that helped the agent perform the action. e.g. John wrote a |
|
202 | * book with *a pen*. |
|
203 | * |
|
204 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
205 | * |
|
206 | * @return static |
|
207 | * |
|
208 | * @see http://schema.org/instrument |
|
209 | */ |
|
210 | public function instrument($instrument) |
|
211 | { |
|
212 | return $this->setProperty('instrument', $instrument); |
|
213 | } |
|
214 | ||
215 | /** |
|
216 | * The location of for example where the event is happening, an organization |
|
217 | * is located, or where an action takes place. |
|
218 | * |
|
219 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
220 | * |
|
221 | * @return static |
|
222 | * |
|
223 | * @see http://schema.org/location |
|
224 | */ |
|
225 | public function location($location) |
|
226 | { |
|
227 | return $this->setProperty('location', $location); |
|
228 | } |
|
229 | ||
230 | /** |
|
231 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
232 | * entity being described. See [background |
|
233 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
234 | * |
|
235 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
236 | * |
|
237 | * @return static |
|
238 | * |
|
239 | * @see http://schema.org/mainEntityOfPage |
|
240 | */ |
|
241 | public function mainEntityOfPage($mainEntityOfPage) |
|
242 | { |
|
243 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
244 | } |
|
245 | ||
246 | /** |
|
247 | * The name of the item. |
|
248 | * |
|
249 | * @param string|string[] $name |
|
250 | * |
|
251 | * @return static |
|
252 | * |
|
253 | * @see http://schema.org/name |
|
254 | */ |
|
255 | public function name($name) |
|
256 | { |
|
257 | return $this->setProperty('name', $name); |
|
258 | } |
|
259 | ||
260 | /** |
|
261 | * The object upon which the action is carried out, whose state is kept |
|
262 | * intact or changed. Also known as the semantic roles patient, affected or |
|
263 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
264 | * read *a book*. |
|
265 | * |
|
266 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
267 | * |
|
268 | * @return static |
|
269 | * |
|
270 | * @see http://schema.org/object |
|
271 | */ |
|
272 | public function object($object) |
|
273 | { |
|
274 | return $this->setProperty('object', $object); |
|
275 | } |
|
276 | ||
277 | /** |
|
278 | * Other co-agents that participated in the action indirectly. e.g. John |
|
279 | * wrote a book with *Steve*. |
|
280 | * |
|
281 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
282 | * |
|
283 | * @return static |
|
284 | * |
|
285 | * @see http://schema.org/participant |
|
286 | */ |
|
287 | public function participant($participant) |
|
288 | { |
|
289 | return $this->setProperty('participant', $participant); |
|
290 | } |
|
291 | ||
292 | /** |
|
293 | * Indicates a potential Action, which describes an idealized action in |
|
294 | * which this thing would play an 'object' role. |
|
295 | * |
|
296 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
297 | * |
|
298 | * @return static |
|
299 | * |
|
300 | * @see http://schema.org/potentialAction |
|
301 | */ |
|
302 | public function potentialAction($potentialAction) |
|
303 | { |
|
304 | return $this->setProperty('potentialAction', $potentialAction); |
|
305 | } |
|
306 | ||
307 | /** |
|
308 | * The result produced in the action. e.g. John wrote *a book*. |
|
309 | * |
|
310 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
311 | * |
|
312 | * @return static |
|
313 | * |
|
314 | * @see http://schema.org/result |
|
315 | */ |
|
316 | public function result($result) |
|
317 | { |
|
318 | return $this->setProperty('result', $result); |
|
319 | } |
|
320 | ||
321 | /** |
|
322 | * URL of a reference Web page that unambiguously indicates the item's |
|
323 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
324 | * official website. |
|
325 | * |
|
326 | * @param string|string[] $sameAs |
|
327 | * |
|
328 | * @return static |
|
329 | * |
|
330 | * @see http://schema.org/sameAs |
|
331 | */ |
|
332 | public function sameAs($sameAs) |
|
333 | { |
|
334 | return $this->setProperty('sameAs', $sameAs); |
|
335 | } |
|
336 | ||
337 | /** |
|
338 | * The startTime of something. For a reserved event or service (e.g. |
|
339 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
340 | * actions that span a period of time, when the action was performed. e.g. |
|
341 | * John wrote a book from *January* to December. For media, including audio |
|
342 | * and video, it's the time offset of the start of a clip within a larger |
|
343 | * file. |
|
344 | * |
|
345 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
346 | * when describing dates with times. This situation may be clarified in |
|
347 | * future revisions. |
|
348 | * |
|
349 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
350 | * |
|
351 | * @return static |
|
352 | * |
|
353 | * @see http://schema.org/startTime |
|
354 | */ |
|
355 | public function startTime($startTime) |
|
356 | { |
|
357 | return $this->setProperty('startTime', $startTime); |
|
358 | } |
|
359 | ||
360 | /** |
|
361 | * A CreativeWork or Event about this Thing. |
|
362 | * |
|
363 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
364 | * |
|
365 | * @return static |
|
366 | * |
|
367 | * @see http://schema.org/subjectOf |
|
368 | */ |
|
369 | public function subjectOf($subjectOf) |
|
370 | { |
|
371 | return $this->setProperty('subjectOf', $subjectOf); |
|
372 | } |
|
373 | ||
374 | /** |
|
375 | * Indicates a target EntryPoint for an Action. |
|
376 | * |
|
377 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
378 | * |
|
379 | * @return static |
|
380 | * |
|
381 | * @see http://schema.org/target |
|
382 | */ |
|
383 | public function target($target) |
|
384 | { |
|
385 | return $this->setProperty('target', $target); |
|
386 | } |
|
387 | ||
388 | /** |
|
389 | * A sub property of location. The final location of the object or the agent |
|
390 | * after the action. |
|
391 | * |
|
392 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
393 | * |
|
394 | * @return static |
|
395 | * |
|
396 | * @see http://schema.org/toLocation |
|
397 | */ |
|
398 | public function toLocation($toLocation) |
|
399 | { |
|
400 | return $this->setProperty('toLocation', $toLocation); |
|
401 | } |
|
402 | ||
403 | /** |
|
404 | * URL of the item. |
|
405 | * |
|
406 | * @param string|string[] $url |
|
407 | * |
|
408 | * @return static |
|
409 | * |
|
410 | * @see http://schema.org/url |
|
411 | */ |
|
412 | public function url($url) |
|
413 | { |
|
414 | return $this->setProperty('url', $url); |
|
415 | } |
|
416 | ||
417 | } |
|
418 |
@@ 16-372 (lines=357) @@ | ||
13 | * @see http://schema.org/NutritionInformation |
|
14 | * |
|
15 | */ |
|
16 | class NutritionInformation extends BaseType implements NutritionInformationContract, IntangibleContract, StructuredValueContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * An additional type for the item, typically used for adding more specific |
|
20 | * types from external vocabularies in microdata syntax. This is a |
|
21 | * relationship between something and a class that the thing is in. In RDFa |
|
22 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
23 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
24 | * understanding of extra types, in particular those defined externally. |
|
25 | * |
|
26 | * @param string|string[] $additionalType |
|
27 | * |
|
28 | * @return static |
|
29 | * |
|
30 | * @see http://schema.org/additionalType |
|
31 | */ |
|
32 | public function additionalType($additionalType) |
|
33 | { |
|
34 | return $this->setProperty('additionalType', $additionalType); |
|
35 | } |
|
36 | ||
37 | /** |
|
38 | * An alias for the item. |
|
39 | * |
|
40 | * @param string|string[] $alternateName |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/alternateName |
|
45 | */ |
|
46 | public function alternateName($alternateName) |
|
47 | { |
|
48 | return $this->setProperty('alternateName', $alternateName); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The number of calories. |
|
53 | * |
|
54 | * @param \Spatie\SchemaOrg\Contracts\EnergyContract|\Spatie\SchemaOrg\Contracts\EnergyContract[] $calories |
|
55 | * |
|
56 | * @return static |
|
57 | * |
|
58 | * @see http://schema.org/calories |
|
59 | */ |
|
60 | public function calories($calories) |
|
61 | { |
|
62 | return $this->setProperty('calories', $calories); |
|
63 | } |
|
64 | ||
65 | /** |
|
66 | * The number of grams of carbohydrates. |
|
67 | * |
|
68 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $carbohydrateContent |
|
69 | * |
|
70 | * @return static |
|
71 | * |
|
72 | * @see http://schema.org/carbohydrateContent |
|
73 | */ |
|
74 | public function carbohydrateContent($carbohydrateContent) |
|
75 | { |
|
76 | return $this->setProperty('carbohydrateContent', $carbohydrateContent); |
|
77 | } |
|
78 | ||
79 | /** |
|
80 | * The number of milligrams of cholesterol. |
|
81 | * |
|
82 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $cholesterolContent |
|
83 | * |
|
84 | * @return static |
|
85 | * |
|
86 | * @see http://schema.org/cholesterolContent |
|
87 | */ |
|
88 | public function cholesterolContent($cholesterolContent) |
|
89 | { |
|
90 | return $this->setProperty('cholesterolContent', $cholesterolContent); |
|
91 | } |
|
92 | ||
93 | /** |
|
94 | * A description of the item. |
|
95 | * |
|
96 | * @param string|string[] $description |
|
97 | * |
|
98 | * @return static |
|
99 | * |
|
100 | * @see http://schema.org/description |
|
101 | */ |
|
102 | public function description($description) |
|
103 | { |
|
104 | return $this->setProperty('description', $description); |
|
105 | } |
|
106 | ||
107 | /** |
|
108 | * A sub property of description. A short description of the item used to |
|
109 | * disambiguate from other, similar items. Information from other properties |
|
110 | * (in particular, name) may be necessary for the description to be useful |
|
111 | * for disambiguation. |
|
112 | * |
|
113 | * @param string|string[] $disambiguatingDescription |
|
114 | * |
|
115 | * @return static |
|
116 | * |
|
117 | * @see http://schema.org/disambiguatingDescription |
|
118 | */ |
|
119 | public function disambiguatingDescription($disambiguatingDescription) |
|
120 | { |
|
121 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
122 | } |
|
123 | ||
124 | /** |
|
125 | * The number of grams of fat. |
|
126 | * |
|
127 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $fatContent |
|
128 | * |
|
129 | * @return static |
|
130 | * |
|
131 | * @see http://schema.org/fatContent |
|
132 | */ |
|
133 | public function fatContent($fatContent) |
|
134 | { |
|
135 | return $this->setProperty('fatContent', $fatContent); |
|
136 | } |
|
137 | ||
138 | /** |
|
139 | * The number of grams of fiber. |
|
140 | * |
|
141 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $fiberContent |
|
142 | * |
|
143 | * @return static |
|
144 | * |
|
145 | * @see http://schema.org/fiberContent |
|
146 | */ |
|
147 | public function fiberContent($fiberContent) |
|
148 | { |
|
149 | return $this->setProperty('fiberContent', $fiberContent); |
|
150 | } |
|
151 | ||
152 | /** |
|
153 | * The identifier property represents any kind of identifier for any kind of |
|
154 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
155 | * dedicated properties for representing many of these, either as textual |
|
156 | * strings or as URL (URI) links. See [background |
|
157 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
158 | * |
|
159 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
160 | * |
|
161 | * @return static |
|
162 | * |
|
163 | * @see http://schema.org/identifier |
|
164 | */ |
|
165 | public function identifier($identifier) |
|
166 | { |
|
167 | return $this->setProperty('identifier', $identifier); |
|
168 | } |
|
169 | ||
170 | /** |
|
171 | * An image of the item. This can be a [[URL]] or a fully described |
|
172 | * [[ImageObject]]. |
|
173 | * |
|
174 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
175 | * |
|
176 | * @return static |
|
177 | * |
|
178 | * @see http://schema.org/image |
|
179 | */ |
|
180 | public function image($image) |
|
181 | { |
|
182 | return $this->setProperty('image', $image); |
|
183 | } |
|
184 | ||
185 | /** |
|
186 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
187 | * entity being described. See [background |
|
188 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
189 | * |
|
190 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
191 | * |
|
192 | * @return static |
|
193 | * |
|
194 | * @see http://schema.org/mainEntityOfPage |
|
195 | */ |
|
196 | public function mainEntityOfPage($mainEntityOfPage) |
|
197 | { |
|
198 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
199 | } |
|
200 | ||
201 | /** |
|
202 | * The name of the item. |
|
203 | * |
|
204 | * @param string|string[] $name |
|
205 | * |
|
206 | * @return static |
|
207 | * |
|
208 | * @see http://schema.org/name |
|
209 | */ |
|
210 | public function name($name) |
|
211 | { |
|
212 | return $this->setProperty('name', $name); |
|
213 | } |
|
214 | ||
215 | /** |
|
216 | * Indicates a potential Action, which describes an idealized action in |
|
217 | * which this thing would play an 'object' role. |
|
218 | * |
|
219 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
220 | * |
|
221 | * @return static |
|
222 | * |
|
223 | * @see http://schema.org/potentialAction |
|
224 | */ |
|
225 | public function potentialAction($potentialAction) |
|
226 | { |
|
227 | return $this->setProperty('potentialAction', $potentialAction); |
|
228 | } |
|
229 | ||
230 | /** |
|
231 | * The number of grams of protein. |
|
232 | * |
|
233 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $proteinContent |
|
234 | * |
|
235 | * @return static |
|
236 | * |
|
237 | * @see http://schema.org/proteinContent |
|
238 | */ |
|
239 | public function proteinContent($proteinContent) |
|
240 | { |
|
241 | return $this->setProperty('proteinContent', $proteinContent); |
|
242 | } |
|
243 | ||
244 | /** |
|
245 | * URL of a reference Web page that unambiguously indicates the item's |
|
246 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
247 | * official website. |
|
248 | * |
|
249 | * @param string|string[] $sameAs |
|
250 | * |
|
251 | * @return static |
|
252 | * |
|
253 | * @see http://schema.org/sameAs |
|
254 | */ |
|
255 | public function sameAs($sameAs) |
|
256 | { |
|
257 | return $this->setProperty('sameAs', $sameAs); |
|
258 | } |
|
259 | ||
260 | /** |
|
261 | * The number of grams of saturated fat. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $saturatedFatContent |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/saturatedFatContent |
|
268 | */ |
|
269 | public function saturatedFatContent($saturatedFatContent) |
|
270 | { |
|
271 | return $this->setProperty('saturatedFatContent', $saturatedFatContent); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * The serving size, in terms of the number of volume or mass. |
|
276 | * |
|
277 | * @param string|string[] $servingSize |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/servingSize |
|
282 | */ |
|
283 | public function servingSize($servingSize) |
|
284 | { |
|
285 | return $this->setProperty('servingSize', $servingSize); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * The number of milligrams of sodium. |
|
290 | * |
|
291 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $sodiumContent |
|
292 | * |
|
293 | * @return static |
|
294 | * |
|
295 | * @see http://schema.org/sodiumContent |
|
296 | */ |
|
297 | public function sodiumContent($sodiumContent) |
|
298 | { |
|
299 | return $this->setProperty('sodiumContent', $sodiumContent); |
|
300 | } |
|
301 | ||
302 | /** |
|
303 | * A CreativeWork or Event about this Thing. |
|
304 | * |
|
305 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
306 | * |
|
307 | * @return static |
|
308 | * |
|
309 | * @see http://schema.org/subjectOf |
|
310 | */ |
|
311 | public function subjectOf($subjectOf) |
|
312 | { |
|
313 | return $this->setProperty('subjectOf', $subjectOf); |
|
314 | } |
|
315 | ||
316 | /** |
|
317 | * The number of grams of sugar. |
|
318 | * |
|
319 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $sugarContent |
|
320 | * |
|
321 | * @return static |
|
322 | * |
|
323 | * @see http://schema.org/sugarContent |
|
324 | */ |
|
325 | public function sugarContent($sugarContent) |
|
326 | { |
|
327 | return $this->setProperty('sugarContent', $sugarContent); |
|
328 | } |
|
329 | ||
330 | /** |
|
331 | * The number of grams of trans fat. |
|
332 | * |
|
333 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $transFatContent |
|
334 | * |
|
335 | * @return static |
|
336 | * |
|
337 | * @see http://schema.org/transFatContent |
|
338 | */ |
|
339 | public function transFatContent($transFatContent) |
|
340 | { |
|
341 | return $this->setProperty('transFatContent', $transFatContent); |
|
342 | } |
|
343 | ||
344 | /** |
|
345 | * The number of grams of unsaturated fat. |
|
346 | * |
|
347 | * @param \Spatie\SchemaOrg\Contracts\MassContract|\Spatie\SchemaOrg\Contracts\MassContract[] $unsaturatedFatContent |
|
348 | * |
|
349 | * @return static |
|
350 | * |
|
351 | * @see http://schema.org/unsaturatedFatContent |
|
352 | */ |
|
353 | public function unsaturatedFatContent($unsaturatedFatContent) |
|
354 | { |
|
355 | return $this->setProperty('unsaturatedFatContent', $unsaturatedFatContent); |
|
356 | } |
|
357 | ||
358 | /** |
|
359 | * URL of the item. |
|
360 | * |
|
361 | * @param string|string[] $url |
|
362 | * |
|
363 | * @return static |
|
364 | * |
|
365 | * @see http://schema.org/url |
|
366 | */ |
|
367 | public function url($url) |
|
368 | { |
|
369 | return $this->setProperty('url', $url); |
|
370 | } |
|
371 | ||
372 | } |
|
373 |
@@ 16-376 (lines=361) @@ | ||
13 | * @see http://schema.org/ParcelDelivery |
|
14 | * |
|
15 | */ |
|
16 | class ParcelDelivery extends BaseType implements ParcelDeliveryContract, IntangibleContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * An additional type for the item, typically used for adding more specific |
|
20 | * types from external vocabularies in microdata syntax. This is a |
|
21 | * relationship between something and a class that the thing is in. In RDFa |
|
22 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
23 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
24 | * understanding of extra types, in particular those defined externally. |
|
25 | * |
|
26 | * @param string|string[] $additionalType |
|
27 | * |
|
28 | * @return static |
|
29 | * |
|
30 | * @see http://schema.org/additionalType |
|
31 | */ |
|
32 | public function additionalType($additionalType) |
|
33 | { |
|
34 | return $this->setProperty('additionalType', $additionalType); |
|
35 | } |
|
36 | ||
37 | /** |
|
38 | * An alias for the item. |
|
39 | * |
|
40 | * @param string|string[] $alternateName |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/alternateName |
|
45 | */ |
|
46 | public function alternateName($alternateName) |
|
47 | { |
|
48 | return $this->setProperty('alternateName', $alternateName); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * 'carrier' is an out-dated term indicating the 'provider' for parcel |
|
53 | * delivery and flights. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $carrier |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/carrier |
|
60 | */ |
|
61 | public function carrier($carrier) |
|
62 | { |
|
63 | return $this->setProperty('carrier', $carrier); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * Destination address. |
|
68 | * |
|
69 | * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[] $deliveryAddress |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/deliveryAddress |
|
74 | */ |
|
75 | public function deliveryAddress($deliveryAddress) |
|
76 | { |
|
77 | return $this->setProperty('deliveryAddress', $deliveryAddress); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * New entry added as the package passes through each leg of its journey |
|
82 | * (from shipment to final delivery). |
|
83 | * |
|
84 | * @param \Spatie\SchemaOrg\Contracts\DeliveryEventContract|\Spatie\SchemaOrg\Contracts\DeliveryEventContract[] $deliveryStatus |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/deliveryStatus |
|
89 | */ |
|
90 | public function deliveryStatus($deliveryStatus) |
|
91 | { |
|
92 | return $this->setProperty('deliveryStatus', $deliveryStatus); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A description of the item. |
|
97 | * |
|
98 | * @param string|string[] $description |
|
99 | * |
|
100 | * @return static |
|
101 | * |
|
102 | * @see http://schema.org/description |
|
103 | */ |
|
104 | public function description($description) |
|
105 | { |
|
106 | return $this->setProperty('description', $description); |
|
107 | } |
|
108 | ||
109 | /** |
|
110 | * A sub property of description. A short description of the item used to |
|
111 | * disambiguate from other, similar items. Information from other properties |
|
112 | * (in particular, name) may be necessary for the description to be useful |
|
113 | * for disambiguation. |
|
114 | * |
|
115 | * @param string|string[] $disambiguatingDescription |
|
116 | * |
|
117 | * @return static |
|
118 | * |
|
119 | * @see http://schema.org/disambiguatingDescription |
|
120 | */ |
|
121 | public function disambiguatingDescription($disambiguatingDescription) |
|
122 | { |
|
123 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
124 | } |
|
125 | ||
126 | /** |
|
127 | * The earliest date the package may arrive. |
|
128 | * |
|
129 | * @param \DateTimeInterface|\DateTimeInterface[] $expectedArrivalFrom |
|
130 | * |
|
131 | * @return static |
|
132 | * |
|
133 | * @see http://schema.org/expectedArrivalFrom |
|
134 | */ |
|
135 | public function expectedArrivalFrom($expectedArrivalFrom) |
|
136 | { |
|
137 | return $this->setProperty('expectedArrivalFrom', $expectedArrivalFrom); |
|
138 | } |
|
139 | ||
140 | /** |
|
141 | * The latest date the package may arrive. |
|
142 | * |
|
143 | * @param \DateTimeInterface|\DateTimeInterface[] $expectedArrivalUntil |
|
144 | * |
|
145 | * @return static |
|
146 | * |
|
147 | * @see http://schema.org/expectedArrivalUntil |
|
148 | */ |
|
149 | public function expectedArrivalUntil($expectedArrivalUntil) |
|
150 | { |
|
151 | return $this->setProperty('expectedArrivalUntil', $expectedArrivalUntil); |
|
152 | } |
|
153 | ||
154 | /** |
|
155 | * Method used for delivery or shipping. |
|
156 | * |
|
157 | * @param \Spatie\SchemaOrg\Contracts\DeliveryMethodContract|\Spatie\SchemaOrg\Contracts\DeliveryMethodContract[] $hasDeliveryMethod |
|
158 | * |
|
159 | * @return static |
|
160 | * |
|
161 | * @see http://schema.org/hasDeliveryMethod |
|
162 | */ |
|
163 | public function hasDeliveryMethod($hasDeliveryMethod) |
|
164 | { |
|
165 | return $this->setProperty('hasDeliveryMethod', $hasDeliveryMethod); |
|
166 | } |
|
167 | ||
168 | /** |
|
169 | * The identifier property represents any kind of identifier for any kind of |
|
170 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
171 | * dedicated properties for representing many of these, either as textual |
|
172 | * strings or as URL (URI) links. See [background |
|
173 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
174 | * |
|
175 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
176 | * |
|
177 | * @return static |
|
178 | * |
|
179 | * @see http://schema.org/identifier |
|
180 | */ |
|
181 | public function identifier($identifier) |
|
182 | { |
|
183 | return $this->setProperty('identifier', $identifier); |
|
184 | } |
|
185 | ||
186 | /** |
|
187 | * An image of the item. This can be a [[URL]] or a fully described |
|
188 | * [[ImageObject]]. |
|
189 | * |
|
190 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
191 | * |
|
192 | * @return static |
|
193 | * |
|
194 | * @see http://schema.org/image |
|
195 | */ |
|
196 | public function image($image) |
|
197 | { |
|
198 | return $this->setProperty('image', $image); |
|
199 | } |
|
200 | ||
201 | /** |
|
202 | * Item(s) being shipped. |
|
203 | * |
|
204 | * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[] $itemShipped |
|
205 | * |
|
206 | * @return static |
|
207 | * |
|
208 | * @see http://schema.org/itemShipped |
|
209 | */ |
|
210 | public function itemShipped($itemShipped) |
|
211 | { |
|
212 | return $this->setProperty('itemShipped', $itemShipped); |
|
213 | } |
|
214 | ||
215 | /** |
|
216 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
217 | * entity being described. See [background |
|
218 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
219 | * |
|
220 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
221 | * |
|
222 | * @return static |
|
223 | * |
|
224 | * @see http://schema.org/mainEntityOfPage |
|
225 | */ |
|
226 | public function mainEntityOfPage($mainEntityOfPage) |
|
227 | { |
|
228 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
229 | } |
|
230 | ||
231 | /** |
|
232 | * The name of the item. |
|
233 | * |
|
234 | * @param string|string[] $name |
|
235 | * |
|
236 | * @return static |
|
237 | * |
|
238 | * @see http://schema.org/name |
|
239 | */ |
|
240 | public function name($name) |
|
241 | { |
|
242 | return $this->setProperty('name', $name); |
|
243 | } |
|
244 | ||
245 | /** |
|
246 | * Shipper's address. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[] $originAddress |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/originAddress |
|
253 | */ |
|
254 | public function originAddress($originAddress) |
|
255 | { |
|
256 | return $this->setProperty('originAddress', $originAddress); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The overall order the items in this delivery were included in. |
|
261 | * |
|
262 | * @param \Spatie\SchemaOrg\Contracts\OrderContract|\Spatie\SchemaOrg\Contracts\OrderContract[] $partOfOrder |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/partOfOrder |
|
267 | */ |
|
268 | public function partOfOrder($partOfOrder) |
|
269 | { |
|
270 | return $this->setProperty('partOfOrder', $partOfOrder); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * Indicates a potential Action, which describes an idealized action in |
|
275 | * which this thing would play an 'object' role. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/potentialAction |
|
282 | */ |
|
283 | public function potentialAction($potentialAction) |
|
284 | { |
|
285 | return $this->setProperty('potentialAction', $potentialAction); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * The service provider, service operator, or service performer; the goods |
|
290 | * producer. Another party (a seller) may offer those services or goods on |
|
291 | * behalf of the provider. A provider may also serve as the seller. |
|
292 | * |
|
293 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider |
|
294 | * |
|
295 | * @return static |
|
296 | * |
|
297 | * @see http://schema.org/provider |
|
298 | */ |
|
299 | public function provider($provider) |
|
300 | { |
|
301 | return $this->setProperty('provider', $provider); |
|
302 | } |
|
303 | ||
304 | /** |
|
305 | * URL of a reference Web page that unambiguously indicates the item's |
|
306 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
307 | * official website. |
|
308 | * |
|
309 | * @param string|string[] $sameAs |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/sameAs |
|
314 | */ |
|
315 | public function sameAs($sameAs) |
|
316 | { |
|
317 | return $this->setProperty('sameAs', $sameAs); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * A CreativeWork or Event about this Thing. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/subjectOf |
|
328 | */ |
|
329 | public function subjectOf($subjectOf) |
|
330 | { |
|
331 | return $this->setProperty('subjectOf', $subjectOf); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * Shipper tracking number. |
|
336 | * |
|
337 | * @param string|string[] $trackingNumber |
|
338 | * |
|
339 | * @return static |
|
340 | * |
|
341 | * @see http://schema.org/trackingNumber |
|
342 | */ |
|
343 | public function trackingNumber($trackingNumber) |
|
344 | { |
|
345 | return $this->setProperty('trackingNumber', $trackingNumber); |
|
346 | } |
|
347 | ||
348 | /** |
|
349 | * Tracking url for the parcel delivery. |
|
350 | * |
|
351 | * @param string|string[] $trackingUrl |
|
352 | * |
|
353 | * @return static |
|
354 | * |
|
355 | * @see http://schema.org/trackingUrl |
|
356 | */ |
|
357 | public function trackingUrl($trackingUrl) |
|
358 | { |
|
359 | return $this->setProperty('trackingUrl', $trackingUrl); |
|
360 | } |
|
361 | ||
362 | /** |
|
363 | * URL of the item. |
|
364 | * |
|
365 | * @param string|string[] $url |
|
366 | * |
|
367 | * @return static |
|
368 | * |
|
369 | * @see http://schema.org/url |
|
370 | */ |
|
371 | public function url($url) |
|
372 | { |
|
373 | return $this->setProperty('url', $url); |
|
374 | } |
|
375 | ||
376 | } |
|
377 |
@@ 16-427 (lines=412) @@ | ||
13 | * @see http://schema.org/PerformAction |
|
14 | * |
|
15 | */ |
|
16 | class PerformAction extends BaseType implements PerformActionContract, ActionContract, PlayActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * Indicates the current disposition of the Action. |
|
20 | * |
|
21 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
22 | * |
|
23 | * @return static |
|
24 | * |
|
25 | * @see http://schema.org/actionStatus |
|
26 | */ |
|
27 | public function actionStatus($actionStatus) |
|
28 | { |
|
29 | return $this->setProperty('actionStatus', $actionStatus); |
|
30 | } |
|
31 | ||
32 | /** |
|
33 | * An additional type for the item, typically used for adding more specific |
|
34 | * types from external vocabularies in microdata syntax. This is a |
|
35 | * relationship between something and a class that the thing is in. In RDFa |
|
36 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
37 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
38 | * understanding of extra types, in particular those defined externally. |
|
39 | * |
|
40 | * @param string|string[] $additionalType |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/additionalType |
|
45 | */ |
|
46 | public function additionalType($additionalType) |
|
47 | { |
|
48 | return $this->setProperty('additionalType', $additionalType); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
53 | * *John* wrote a book. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/agent |
|
60 | */ |
|
61 | public function agent($agent) |
|
62 | { |
|
63 | return $this->setProperty('agent', $agent); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * An alias for the item. |
|
68 | * |
|
69 | * @param string|string[] $alternateName |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/alternateName |
|
74 | */ |
|
75 | public function alternateName($alternateName) |
|
76 | { |
|
77 | return $this->setProperty('alternateName', $alternateName); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * An intended audience, i.e. a group for whom something was created. |
|
82 | * |
|
83 | * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/audience |
|
88 | */ |
|
89 | public function audience($audience) |
|
90 | { |
|
91 | return $this->setProperty('audience', $audience); |
|
92 | } |
|
93 | ||
94 | /** |
|
95 | * A description of the item. |
|
96 | * |
|
97 | * @param string|string[] $description |
|
98 | * |
|
99 | * @return static |
|
100 | * |
|
101 | * @see http://schema.org/description |
|
102 | */ |
|
103 | public function description($description) |
|
104 | { |
|
105 | return $this->setProperty('description', $description); |
|
106 | } |
|
107 | ||
108 | /** |
|
109 | * A sub property of description. A short description of the item used to |
|
110 | * disambiguate from other, similar items. Information from other properties |
|
111 | * (in particular, name) may be necessary for the description to be useful |
|
112 | * for disambiguation. |
|
113 | * |
|
114 | * @param string|string[] $disambiguatingDescription |
|
115 | * |
|
116 | * @return static |
|
117 | * |
|
118 | * @see http://schema.org/disambiguatingDescription |
|
119 | */ |
|
120 | public function disambiguatingDescription($disambiguatingDescription) |
|
121 | { |
|
122 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
123 | } |
|
124 | ||
125 | /** |
|
126 | * The endTime of something. For a reserved event or service (e.g. |
|
127 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
128 | * actions that span a period of time, when the action was performed. e.g. |
|
129 | * John wrote a book from January to *December*. For media, including audio |
|
130 | * and video, it's the time offset of the end of a clip within a larger |
|
131 | * file. |
|
132 | * |
|
133 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
134 | * when describing dates with times. This situation may be clarified in |
|
135 | * future revisions. |
|
136 | * |
|
137 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
138 | * |
|
139 | * @return static |
|
140 | * |
|
141 | * @see http://schema.org/endTime |
|
142 | */ |
|
143 | public function endTime($endTime) |
|
144 | { |
|
145 | return $this->setProperty('endTime', $endTime); |
|
146 | } |
|
147 | ||
148 | /** |
|
149 | * A sub property of location. The entertainment business where the action |
|
150 | * occurred. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract|\Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract[] $entertainmentBusiness |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/entertainmentBusiness |
|
157 | */ |
|
158 | public function entertainmentBusiness($entertainmentBusiness) |
|
159 | { |
|
160 | return $this->setProperty('entertainmentBusiness', $entertainmentBusiness); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * For failed actions, more information on the cause of the failure. |
|
165 | * |
|
166 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
167 | * |
|
168 | * @return static |
|
169 | * |
|
170 | * @see http://schema.org/error |
|
171 | */ |
|
172 | public function error($error) |
|
173 | { |
|
174 | return $this->setProperty('error', $error); |
|
175 | } |
|
176 | ||
177 | /** |
|
178 | * Upcoming or past event associated with this place, organization, or |
|
179 | * action. |
|
180 | * |
|
181 | * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event |
|
182 | * |
|
183 | * @return static |
|
184 | * |
|
185 | * @see http://schema.org/event |
|
186 | */ |
|
187 | public function event($event) |
|
188 | { |
|
189 | return $this->setProperty('event', $event); |
|
190 | } |
|
191 | ||
192 | /** |
|
193 | * The identifier property represents any kind of identifier for any kind of |
|
194 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
195 | * dedicated properties for representing many of these, either as textual |
|
196 | * strings or as URL (URI) links. See [background |
|
197 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
198 | * |
|
199 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
200 | * |
|
201 | * @return static |
|
202 | * |
|
203 | * @see http://schema.org/identifier |
|
204 | */ |
|
205 | public function identifier($identifier) |
|
206 | { |
|
207 | return $this->setProperty('identifier', $identifier); |
|
208 | } |
|
209 | ||
210 | /** |
|
211 | * An image of the item. This can be a [[URL]] or a fully described |
|
212 | * [[ImageObject]]. |
|
213 | * |
|
214 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
215 | * |
|
216 | * @return static |
|
217 | * |
|
218 | * @see http://schema.org/image |
|
219 | */ |
|
220 | public function image($image) |
|
221 | { |
|
222 | return $this->setProperty('image', $image); |
|
223 | } |
|
224 | ||
225 | /** |
|
226 | * The object that helped the agent perform the action. e.g. John wrote a |
|
227 | * book with *a pen*. |
|
228 | * |
|
229 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
230 | * |
|
231 | * @return static |
|
232 | * |
|
233 | * @see http://schema.org/instrument |
|
234 | */ |
|
235 | public function instrument($instrument) |
|
236 | { |
|
237 | return $this->setProperty('instrument', $instrument); |
|
238 | } |
|
239 | ||
240 | /** |
|
241 | * The location of for example where the event is happening, an organization |
|
242 | * is located, or where an action takes place. |
|
243 | * |
|
244 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
245 | * |
|
246 | * @return static |
|
247 | * |
|
248 | * @see http://schema.org/location |
|
249 | */ |
|
250 | public function location($location) |
|
251 | { |
|
252 | return $this->setProperty('location', $location); |
|
253 | } |
|
254 | ||
255 | /** |
|
256 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
257 | * entity being described. See [background |
|
258 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
259 | * |
|
260 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
261 | * |
|
262 | * @return static |
|
263 | * |
|
264 | * @see http://schema.org/mainEntityOfPage |
|
265 | */ |
|
266 | public function mainEntityOfPage($mainEntityOfPage) |
|
267 | { |
|
268 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
269 | } |
|
270 | ||
271 | /** |
|
272 | * The name of the item. |
|
273 | * |
|
274 | * @param string|string[] $name |
|
275 | * |
|
276 | * @return static |
|
277 | * |
|
278 | * @see http://schema.org/name |
|
279 | */ |
|
280 | public function name($name) |
|
281 | { |
|
282 | return $this->setProperty('name', $name); |
|
283 | } |
|
284 | ||
285 | /** |
|
286 | * The object upon which the action is carried out, whose state is kept |
|
287 | * intact or changed. Also known as the semantic roles patient, affected or |
|
288 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
289 | * read *a book*. |
|
290 | * |
|
291 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
292 | * |
|
293 | * @return static |
|
294 | * |
|
295 | * @see http://schema.org/object |
|
296 | */ |
|
297 | public function object($object) |
|
298 | { |
|
299 | return $this->setProperty('object', $object); |
|
300 | } |
|
301 | ||
302 | /** |
|
303 | * Other co-agents that participated in the action indirectly. e.g. John |
|
304 | * wrote a book with *Steve*. |
|
305 | * |
|
306 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
307 | * |
|
308 | * @return static |
|
309 | * |
|
310 | * @see http://schema.org/participant |
|
311 | */ |
|
312 | public function participant($participant) |
|
313 | { |
|
314 | return $this->setProperty('participant', $participant); |
|
315 | } |
|
316 | ||
317 | /** |
|
318 | * Indicates a potential Action, which describes an idealized action in |
|
319 | * which this thing would play an 'object' role. |
|
320 | * |
|
321 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
322 | * |
|
323 | * @return static |
|
324 | * |
|
325 | * @see http://schema.org/potentialAction |
|
326 | */ |
|
327 | public function potentialAction($potentialAction) |
|
328 | { |
|
329 | return $this->setProperty('potentialAction', $potentialAction); |
|
330 | } |
|
331 | ||
332 | /** |
|
333 | * The result produced in the action. e.g. John wrote *a book*. |
|
334 | * |
|
335 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
336 | * |
|
337 | * @return static |
|
338 | * |
|
339 | * @see http://schema.org/result |
|
340 | */ |
|
341 | public function result($result) |
|
342 | { |
|
343 | return $this->setProperty('result', $result); |
|
344 | } |
|
345 | ||
346 | /** |
|
347 | * URL of a reference Web page that unambiguously indicates the item's |
|
348 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
349 | * official website. |
|
350 | * |
|
351 | * @param string|string[] $sameAs |
|
352 | * |
|
353 | * @return static |
|
354 | * |
|
355 | * @see http://schema.org/sameAs |
|
356 | */ |
|
357 | public function sameAs($sameAs) |
|
358 | { |
|
359 | return $this->setProperty('sameAs', $sameAs); |
|
360 | } |
|
361 | ||
362 | /** |
|
363 | * The startTime of something. For a reserved event or service (e.g. |
|
364 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
365 | * actions that span a period of time, when the action was performed. e.g. |
|
366 | * John wrote a book from *January* to December. For media, including audio |
|
367 | * and video, it's the time offset of the start of a clip within a larger |
|
368 | * file. |
|
369 | * |
|
370 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
371 | * when describing dates with times. This situation may be clarified in |
|
372 | * future revisions. |
|
373 | * |
|
374 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
375 | * |
|
376 | * @return static |
|
377 | * |
|
378 | * @see http://schema.org/startTime |
|
379 | */ |
|
380 | public function startTime($startTime) |
|
381 | { |
|
382 | return $this->setProperty('startTime', $startTime); |
|
383 | } |
|
384 | ||
385 | /** |
|
386 | * A CreativeWork or Event about this Thing. |
|
387 | * |
|
388 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
389 | * |
|
390 | * @return static |
|
391 | * |
|
392 | * @see http://schema.org/subjectOf |
|
393 | */ |
|
394 | public function subjectOf($subjectOf) |
|
395 | { |
|
396 | return $this->setProperty('subjectOf', $subjectOf); |
|
397 | } |
|
398 | ||
399 | /** |
|
400 | * Indicates a target EntryPoint for an Action. |
|
401 | * |
|
402 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
403 | * |
|
404 | * @return static |
|
405 | * |
|
406 | * @see http://schema.org/target |
|
407 | */ |
|
408 | public function target($target) |
|
409 | { |
|
410 | return $this->setProperty('target', $target); |
|
411 | } |
|
412 | ||
413 | /** |
|
414 | * URL of the item. |
|
415 | * |
|
416 | * @param string|string[] $url |
|
417 | * |
|
418 | * @return static |
|
419 | * |
|
420 | * @see http://schema.org/url |
|
421 | */ |
|
422 | public function url($url) |
|
423 | { |
|
424 | return $this->setProperty('url', $url); |
|
425 | } |
|
426 | ||
427 | } |
|
428 |
@@ 17-398 (lines=382) @@ | ||
14 | * @see http://schema.org/PlanAction |
|
15 | * |
|
16 | */ |
|
17 | class PlanAction extends BaseType implements PlanActionContract, ActionContract, OrganizeActionContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * For failed actions, more information on the cause of the failure. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/error |
|
143 | */ |
|
144 | public function error($error) |
|
145 | { |
|
146 | return $this->setProperty('error', $error); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * The identifier property represents any kind of identifier for any kind of |
|
151 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
152 | * dedicated properties for representing many of these, either as textual |
|
153 | * strings or as URL (URI) links. See [background |
|
154 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
155 | * |
|
156 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
157 | * |
|
158 | * @return static |
|
159 | * |
|
160 | * @see http://schema.org/identifier |
|
161 | */ |
|
162 | public function identifier($identifier) |
|
163 | { |
|
164 | return $this->setProperty('identifier', $identifier); |
|
165 | } |
|
166 | ||
167 | /** |
|
168 | * An image of the item. This can be a [[URL]] or a fully described |
|
169 | * [[ImageObject]]. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/image |
|
176 | */ |
|
177 | public function image($image) |
|
178 | { |
|
179 | return $this->setProperty('image', $image); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * The object that helped the agent perform the action. e.g. John wrote a |
|
184 | * book with *a pen*. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/instrument |
|
191 | */ |
|
192 | public function instrument($instrument) |
|
193 | { |
|
194 | return $this->setProperty('instrument', $instrument); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The location of for example where the event is happening, an organization |
|
199 | * is located, or where an action takes place. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/location |
|
206 | */ |
|
207 | public function location($location) |
|
208 | { |
|
209 | return $this->setProperty('location', $location); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
214 | * entity being described. See [background |
|
215 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/mainEntityOfPage |
|
222 | */ |
|
223 | public function mainEntityOfPage($mainEntityOfPage) |
|
224 | { |
|
225 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The name of the item. |
|
230 | * |
|
231 | * @param string|string[] $name |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/name |
|
236 | */ |
|
237 | public function name($name) |
|
238 | { |
|
239 | return $this->setProperty('name', $name); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The object upon which the action is carried out, whose state is kept |
|
244 | * intact or changed. Also known as the semantic roles patient, affected or |
|
245 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
246 | * read *a book*. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/object |
|
253 | */ |
|
254 | public function object($object) |
|
255 | { |
|
256 | return $this->setProperty('object', $object); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * Other co-agents that participated in the action indirectly. e.g. John |
|
261 | * wrote a book with *Steve*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/participant |
|
268 | */ |
|
269 | public function participant($participant) |
|
270 | { |
|
271 | return $this->setProperty('participant', $participant); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Indicates a potential Action, which describes an idealized action in |
|
276 | * which this thing would play an 'object' role. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/potentialAction |
|
283 | */ |
|
284 | public function potentialAction($potentialAction) |
|
285 | { |
|
286 | return $this->setProperty('potentialAction', $potentialAction); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * The result produced in the action. e.g. John wrote *a book*. |
|
291 | * |
|
292 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
293 | * |
|
294 | * @return static |
|
295 | * |
|
296 | * @see http://schema.org/result |
|
297 | */ |
|
298 | public function result($result) |
|
299 | { |
|
300 | return $this->setProperty('result', $result); |
|
301 | } |
|
302 | ||
303 | /** |
|
304 | * URL of a reference Web page that unambiguously indicates the item's |
|
305 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
306 | * official website. |
|
307 | * |
|
308 | * @param string|string[] $sameAs |
|
309 | * |
|
310 | * @return static |
|
311 | * |
|
312 | * @see http://schema.org/sameAs |
|
313 | */ |
|
314 | public function sameAs($sameAs) |
|
315 | { |
|
316 | return $this->setProperty('sameAs', $sameAs); |
|
317 | } |
|
318 | ||
319 | /** |
|
320 | * The time the object is scheduled to. |
|
321 | * |
|
322 | * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime |
|
323 | * |
|
324 | * @return static |
|
325 | * |
|
326 | * @see http://schema.org/scheduledTime |
|
327 | */ |
|
328 | public function scheduledTime($scheduledTime) |
|
329 | { |
|
330 | return $this->setProperty('scheduledTime', $scheduledTime); |
|
331 | } |
|
332 | ||
333 | /** |
|
334 | * The startTime of something. For a reserved event or service (e.g. |
|
335 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
336 | * actions that span a period of time, when the action was performed. e.g. |
|
337 | * John wrote a book from *January* to December. For media, including audio |
|
338 | * and video, it's the time offset of the start of a clip within a larger |
|
339 | * file. |
|
340 | * |
|
341 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
342 | * when describing dates with times. This situation may be clarified in |
|
343 | * future revisions. |
|
344 | * |
|
345 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
346 | * |
|
347 | * @return static |
|
348 | * |
|
349 | * @see http://schema.org/startTime |
|
350 | */ |
|
351 | public function startTime($startTime) |
|
352 | { |
|
353 | return $this->setProperty('startTime', $startTime); |
|
354 | } |
|
355 | ||
356 | /** |
|
357 | * A CreativeWork or Event about this Thing. |
|
358 | * |
|
359 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
360 | * |
|
361 | * @return static |
|
362 | * |
|
363 | * @see http://schema.org/subjectOf |
|
364 | */ |
|
365 | public function subjectOf($subjectOf) |
|
366 | { |
|
367 | return $this->setProperty('subjectOf', $subjectOf); |
|
368 | } |
|
369 | ||
370 | /** |
|
371 | * Indicates a target EntryPoint for an Action. |
|
372 | * |
|
373 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
374 | * |
|
375 | * @return static |
|
376 | * |
|
377 | * @see http://schema.org/target |
|
378 | */ |
|
379 | public function target($target) |
|
380 | { |
|
381 | return $this->setProperty('target', $target); |
|
382 | } |
|
383 | ||
384 | /** |
|
385 | * URL of the item. |
|
386 | * |
|
387 | * @param string|string[] $url |
|
388 | * |
|
389 | * @return static |
|
390 | * |
|
391 | * @see http://schema.org/url |
|
392 | */ |
|
393 | public function url($url) |
|
394 | { |
|
395 | return $this->setProperty('url', $url); |
|
396 | } |
|
397 | ||
398 | } |
|
399 |
@@ 25-421 (lines=397) @@ | ||
22 | * @see http://schema.org/PlayAction |
|
23 | * |
|
24 | */ |
|
25 | class PlayAction extends BaseType implements PlayActionContract, ActionContract, ThingContract |
|
26 | { |
|
27 | /** |
|
28 | * Indicates the current disposition of the Action. |
|
29 | * |
|
30 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
31 | * |
|
32 | * @return static |
|
33 | * |
|
34 | * @see http://schema.org/actionStatus |
|
35 | */ |
|
36 | public function actionStatus($actionStatus) |
|
37 | { |
|
38 | return $this->setProperty('actionStatus', $actionStatus); |
|
39 | } |
|
40 | ||
41 | /** |
|
42 | * An additional type for the item, typically used for adding more specific |
|
43 | * types from external vocabularies in microdata syntax. This is a |
|
44 | * relationship between something and a class that the thing is in. In RDFa |
|
45 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
46 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
47 | * understanding of extra types, in particular those defined externally. |
|
48 | * |
|
49 | * @param string|string[] $additionalType |
|
50 | * |
|
51 | * @return static |
|
52 | * |
|
53 | * @see http://schema.org/additionalType |
|
54 | */ |
|
55 | public function additionalType($additionalType) |
|
56 | { |
|
57 | return $this->setProperty('additionalType', $additionalType); |
|
58 | } |
|
59 | ||
60 | /** |
|
61 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
62 | * *John* wrote a book. |
|
63 | * |
|
64 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
65 | * |
|
66 | * @return static |
|
67 | * |
|
68 | * @see http://schema.org/agent |
|
69 | */ |
|
70 | public function agent($agent) |
|
71 | { |
|
72 | return $this->setProperty('agent', $agent); |
|
73 | } |
|
74 | ||
75 | /** |
|
76 | * An alias for the item. |
|
77 | * |
|
78 | * @param string|string[] $alternateName |
|
79 | * |
|
80 | * @return static |
|
81 | * |
|
82 | * @see http://schema.org/alternateName |
|
83 | */ |
|
84 | public function alternateName($alternateName) |
|
85 | { |
|
86 | return $this->setProperty('alternateName', $alternateName); |
|
87 | } |
|
88 | ||
89 | /** |
|
90 | * An intended audience, i.e. a group for whom something was created. |
|
91 | * |
|
92 | * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience |
|
93 | * |
|
94 | * @return static |
|
95 | * |
|
96 | * @see http://schema.org/audience |
|
97 | */ |
|
98 | public function audience($audience) |
|
99 | { |
|
100 | return $this->setProperty('audience', $audience); |
|
101 | } |
|
102 | ||
103 | /** |
|
104 | * A description of the item. |
|
105 | * |
|
106 | * @param string|string[] $description |
|
107 | * |
|
108 | * @return static |
|
109 | * |
|
110 | * @see http://schema.org/description |
|
111 | */ |
|
112 | public function description($description) |
|
113 | { |
|
114 | return $this->setProperty('description', $description); |
|
115 | } |
|
116 | ||
117 | /** |
|
118 | * A sub property of description. A short description of the item used to |
|
119 | * disambiguate from other, similar items. Information from other properties |
|
120 | * (in particular, name) may be necessary for the description to be useful |
|
121 | * for disambiguation. |
|
122 | * |
|
123 | * @param string|string[] $disambiguatingDescription |
|
124 | * |
|
125 | * @return static |
|
126 | * |
|
127 | * @see http://schema.org/disambiguatingDescription |
|
128 | */ |
|
129 | public function disambiguatingDescription($disambiguatingDescription) |
|
130 | { |
|
131 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
132 | } |
|
133 | ||
134 | /** |
|
135 | * The endTime of something. For a reserved event or service (e.g. |
|
136 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
137 | * actions that span a period of time, when the action was performed. e.g. |
|
138 | * John wrote a book from January to *December*. For media, including audio |
|
139 | * and video, it's the time offset of the end of a clip within a larger |
|
140 | * file. |
|
141 | * |
|
142 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
143 | * when describing dates with times. This situation may be clarified in |
|
144 | * future revisions. |
|
145 | * |
|
146 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
147 | * |
|
148 | * @return static |
|
149 | * |
|
150 | * @see http://schema.org/endTime |
|
151 | */ |
|
152 | public function endTime($endTime) |
|
153 | { |
|
154 | return $this->setProperty('endTime', $endTime); |
|
155 | } |
|
156 | ||
157 | /** |
|
158 | * For failed actions, more information on the cause of the failure. |
|
159 | * |
|
160 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
161 | * |
|
162 | * @return static |
|
163 | * |
|
164 | * @see http://schema.org/error |
|
165 | */ |
|
166 | public function error($error) |
|
167 | { |
|
168 | return $this->setProperty('error', $error); |
|
169 | } |
|
170 | ||
171 | /** |
|
172 | * Upcoming or past event associated with this place, organization, or |
|
173 | * action. |
|
174 | * |
|
175 | * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event |
|
176 | * |
|
177 | * @return static |
|
178 | * |
|
179 | * @see http://schema.org/event |
|
180 | */ |
|
181 | public function event($event) |
|
182 | { |
|
183 | return $this->setProperty('event', $event); |
|
184 | } |
|
185 | ||
186 | /** |
|
187 | * The identifier property represents any kind of identifier for any kind of |
|
188 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
189 | * dedicated properties for representing many of these, either as textual |
|
190 | * strings or as URL (URI) links. See [background |
|
191 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
192 | * |
|
193 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
194 | * |
|
195 | * @return static |
|
196 | * |
|
197 | * @see http://schema.org/identifier |
|
198 | */ |
|
199 | public function identifier($identifier) |
|
200 | { |
|
201 | return $this->setProperty('identifier', $identifier); |
|
202 | } |
|
203 | ||
204 | /** |
|
205 | * An image of the item. This can be a [[URL]] or a fully described |
|
206 | * [[ImageObject]]. |
|
207 | * |
|
208 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
209 | * |
|
210 | * @return static |
|
211 | * |
|
212 | * @see http://schema.org/image |
|
213 | */ |
|
214 | public function image($image) |
|
215 | { |
|
216 | return $this->setProperty('image', $image); |
|
217 | } |
|
218 | ||
219 | /** |
|
220 | * The object that helped the agent perform the action. e.g. John wrote a |
|
221 | * book with *a pen*. |
|
222 | * |
|
223 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
224 | * |
|
225 | * @return static |
|
226 | * |
|
227 | * @see http://schema.org/instrument |
|
228 | */ |
|
229 | public function instrument($instrument) |
|
230 | { |
|
231 | return $this->setProperty('instrument', $instrument); |
|
232 | } |
|
233 | ||
234 | /** |
|
235 | * The location of for example where the event is happening, an organization |
|
236 | * is located, or where an action takes place. |
|
237 | * |
|
238 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
239 | * |
|
240 | * @return static |
|
241 | * |
|
242 | * @see http://schema.org/location |
|
243 | */ |
|
244 | public function location($location) |
|
245 | { |
|
246 | return $this->setProperty('location', $location); |
|
247 | } |
|
248 | ||
249 | /** |
|
250 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
251 | * entity being described. See [background |
|
252 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
253 | * |
|
254 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
255 | * |
|
256 | * @return static |
|
257 | * |
|
258 | * @see http://schema.org/mainEntityOfPage |
|
259 | */ |
|
260 | public function mainEntityOfPage($mainEntityOfPage) |
|
261 | { |
|
262 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
263 | } |
|
264 | ||
265 | /** |
|
266 | * The name of the item. |
|
267 | * |
|
268 | * @param string|string[] $name |
|
269 | * |
|
270 | * @return static |
|
271 | * |
|
272 | * @see http://schema.org/name |
|
273 | */ |
|
274 | public function name($name) |
|
275 | { |
|
276 | return $this->setProperty('name', $name); |
|
277 | } |
|
278 | ||
279 | /** |
|
280 | * The object upon which the action is carried out, whose state is kept |
|
281 | * intact or changed. Also known as the semantic roles patient, affected or |
|
282 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
283 | * read *a book*. |
|
284 | * |
|
285 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
286 | * |
|
287 | * @return static |
|
288 | * |
|
289 | * @see http://schema.org/object |
|
290 | */ |
|
291 | public function object($object) |
|
292 | { |
|
293 | return $this->setProperty('object', $object); |
|
294 | } |
|
295 | ||
296 | /** |
|
297 | * Other co-agents that participated in the action indirectly. e.g. John |
|
298 | * wrote a book with *Steve*. |
|
299 | * |
|
300 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
301 | * |
|
302 | * @return static |
|
303 | * |
|
304 | * @see http://schema.org/participant |
|
305 | */ |
|
306 | public function participant($participant) |
|
307 | { |
|
308 | return $this->setProperty('participant', $participant); |
|
309 | } |
|
310 | ||
311 | /** |
|
312 | * Indicates a potential Action, which describes an idealized action in |
|
313 | * which this thing would play an 'object' role. |
|
314 | * |
|
315 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
316 | * |
|
317 | * @return static |
|
318 | * |
|
319 | * @see http://schema.org/potentialAction |
|
320 | */ |
|
321 | public function potentialAction($potentialAction) |
|
322 | { |
|
323 | return $this->setProperty('potentialAction', $potentialAction); |
|
324 | } |
|
325 | ||
326 | /** |
|
327 | * The result produced in the action. e.g. John wrote *a book*. |
|
328 | * |
|
329 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
330 | * |
|
331 | * @return static |
|
332 | * |
|
333 | * @see http://schema.org/result |
|
334 | */ |
|
335 | public function result($result) |
|
336 | { |
|
337 | return $this->setProperty('result', $result); |
|
338 | } |
|
339 | ||
340 | /** |
|
341 | * URL of a reference Web page that unambiguously indicates the item's |
|
342 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
343 | * official website. |
|
344 | * |
|
345 | * @param string|string[] $sameAs |
|
346 | * |
|
347 | * @return static |
|
348 | * |
|
349 | * @see http://schema.org/sameAs |
|
350 | */ |
|
351 | public function sameAs($sameAs) |
|
352 | { |
|
353 | return $this->setProperty('sameAs', $sameAs); |
|
354 | } |
|
355 | ||
356 | /** |
|
357 | * The startTime of something. For a reserved event or service (e.g. |
|
358 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
359 | * actions that span a period of time, when the action was performed. e.g. |
|
360 | * John wrote a book from *January* to December. For media, including audio |
|
361 | * and video, it's the time offset of the start of a clip within a larger |
|
362 | * file. |
|
363 | * |
|
364 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
365 | * when describing dates with times. This situation may be clarified in |
|
366 | * future revisions. |
|
367 | * |
|
368 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
369 | * |
|
370 | * @return static |
|
371 | * |
|
372 | * @see http://schema.org/startTime |
|
373 | */ |
|
374 | public function startTime($startTime) |
|
375 | { |
|
376 | return $this->setProperty('startTime', $startTime); |
|
377 | } |
|
378 | ||
379 | /** |
|
380 | * A CreativeWork or Event about this Thing. |
|
381 | * |
|
382 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
383 | * |
|
384 | * @return static |
|
385 | * |
|
386 | * @see http://schema.org/subjectOf |
|
387 | */ |
|
388 | public function subjectOf($subjectOf) |
|
389 | { |
|
390 | return $this->setProperty('subjectOf', $subjectOf); |
|
391 | } |
|
392 | ||
393 | /** |
|
394 | * Indicates a target EntryPoint for an Action. |
|
395 | * |
|
396 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
397 | * |
|
398 | * @return static |
|
399 | * |
|
400 | * @see http://schema.org/target |
|
401 | */ |
|
402 | public function target($target) |
|
403 | { |
|
404 | return $this->setProperty('target', $target); |
|
405 | } |
|
406 | ||
407 | /** |
|
408 | * URL of the item. |
|
409 | * |
|
410 | * @param string|string[] $url |
|
411 | * |
|
412 | * @return static |
|
413 | * |
|
414 | * @see http://schema.org/url |
|
415 | */ |
|
416 | public function url($url) |
|
417 | { |
|
418 | return $this->setProperty('url', $url); |
|
419 | } |
|
420 | ||
421 | } |
|
422 |
@@ 17-459 (lines=443) @@ | ||
14 | * @see http://schema.org/PreOrderAction |
|
15 | * |
|
16 | */ |
|
17 | class PreOrderAction extends BaseType implements PreOrderActionContract, ActionContract, ThingContract, TradeActionContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * For failed actions, more information on the cause of the failure. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/error |
|
143 | */ |
|
144 | public function error($error) |
|
145 | { |
|
146 | return $this->setProperty('error', $error); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * The identifier property represents any kind of identifier for any kind of |
|
151 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
152 | * dedicated properties for representing many of these, either as textual |
|
153 | * strings or as URL (URI) links. See [background |
|
154 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
155 | * |
|
156 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
157 | * |
|
158 | * @return static |
|
159 | * |
|
160 | * @see http://schema.org/identifier |
|
161 | */ |
|
162 | public function identifier($identifier) |
|
163 | { |
|
164 | return $this->setProperty('identifier', $identifier); |
|
165 | } |
|
166 | ||
167 | /** |
|
168 | * An image of the item. This can be a [[URL]] or a fully described |
|
169 | * [[ImageObject]]. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/image |
|
176 | */ |
|
177 | public function image($image) |
|
178 | { |
|
179 | return $this->setProperty('image', $image); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * The object that helped the agent perform the action. e.g. John wrote a |
|
184 | * book with *a pen*. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/instrument |
|
191 | */ |
|
192 | public function instrument($instrument) |
|
193 | { |
|
194 | return $this->setProperty('instrument', $instrument); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The location of for example where the event is happening, an organization |
|
199 | * is located, or where an action takes place. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/location |
|
206 | */ |
|
207 | public function location($location) |
|
208 | { |
|
209 | return $this->setProperty('location', $location); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
214 | * entity being described. See [background |
|
215 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/mainEntityOfPage |
|
222 | */ |
|
223 | public function mainEntityOfPage($mainEntityOfPage) |
|
224 | { |
|
225 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The name of the item. |
|
230 | * |
|
231 | * @param string|string[] $name |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/name |
|
236 | */ |
|
237 | public function name($name) |
|
238 | { |
|
239 | return $this->setProperty('name', $name); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The object upon which the action is carried out, whose state is kept |
|
244 | * intact or changed. Also known as the semantic roles patient, affected or |
|
245 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
246 | * read *a book*. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/object |
|
253 | */ |
|
254 | public function object($object) |
|
255 | { |
|
256 | return $this->setProperty('object', $object); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * Other co-agents that participated in the action indirectly. e.g. John |
|
261 | * wrote a book with *Steve*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/participant |
|
268 | */ |
|
269 | public function participant($participant) |
|
270 | { |
|
271 | return $this->setProperty('participant', $participant); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Indicates a potential Action, which describes an idealized action in |
|
276 | * which this thing would play an 'object' role. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/potentialAction |
|
283 | */ |
|
284 | public function potentialAction($potentialAction) |
|
285 | { |
|
286 | return $this->setProperty('potentialAction', $potentialAction); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * The offer price of a product, or of a price component when attached to |
|
291 | * PriceSpecification and its subtypes. |
|
292 | * |
|
293 | * Usage guidelines: |
|
294 | * |
|
295 | * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 |
|
296 | * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; |
|
297 | * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) |
|
298 | * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
299 | * Tradings |
|
300 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
301 | * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including |
|
302 | * [ambiguous |
|
303 | * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) |
|
304 | * such as '$' in the value. |
|
305 | * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a |
|
306 | * decimal point. Avoid using these symbols as a readability separator. |
|
307 | * * Note that both |
|
308 | * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) |
|
309 | * and Microdata syntax allow the use of a "content=" attribute for |
|
310 | * publishing simple machine-readable values alongside more human-friendly |
|
311 | * formatting. |
|
312 | * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT |
|
313 | * NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
|
314 | * |
|
315 | * @param float|float[]|int|int[]|string|string[] $price |
|
316 | * |
|
317 | * @return static |
|
318 | * |
|
319 | * @see http://schema.org/price |
|
320 | */ |
|
321 | public function price($price) |
|
322 | { |
|
323 | return $this->setProperty('price', $price); |
|
324 | } |
|
325 | ||
326 | /** |
|
327 | * The currency of the price, or a price component when attached to |
|
328 | * [[PriceSpecification]] and its subtypes. |
|
329 | * |
|
330 | * Use standard formats: [ISO 4217 currency |
|
331 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
332 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
333 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
334 | * Tradings |
|
335 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
336 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
337 | * |
|
338 | * @param string|string[] $priceCurrency |
|
339 | * |
|
340 | * @return static |
|
341 | * |
|
342 | * @see http://schema.org/priceCurrency |
|
343 | */ |
|
344 | public function priceCurrency($priceCurrency) |
|
345 | { |
|
346 | return $this->setProperty('priceCurrency', $priceCurrency); |
|
347 | } |
|
348 | ||
349 | /** |
|
350 | * One or more detailed price specifications, indicating the unit price and |
|
351 | * delivery or payment charges. |
|
352 | * |
|
353 | * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[] $priceSpecification |
|
354 | * |
|
355 | * @return static |
|
356 | * |
|
357 | * @see http://schema.org/priceSpecification |
|
358 | */ |
|
359 | public function priceSpecification($priceSpecification) |
|
360 | { |
|
361 | return $this->setProperty('priceSpecification', $priceSpecification); |
|
362 | } |
|
363 | ||
364 | /** |
|
365 | * The result produced in the action. e.g. John wrote *a book*. |
|
366 | * |
|
367 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
368 | * |
|
369 | * @return static |
|
370 | * |
|
371 | * @see http://schema.org/result |
|
372 | */ |
|
373 | public function result($result) |
|
374 | { |
|
375 | return $this->setProperty('result', $result); |
|
376 | } |
|
377 | ||
378 | /** |
|
379 | * URL of a reference Web page that unambiguously indicates the item's |
|
380 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
381 | * official website. |
|
382 | * |
|
383 | * @param string|string[] $sameAs |
|
384 | * |
|
385 | * @return static |
|
386 | * |
|
387 | * @see http://schema.org/sameAs |
|
388 | */ |
|
389 | public function sameAs($sameAs) |
|
390 | { |
|
391 | return $this->setProperty('sameAs', $sameAs); |
|
392 | } |
|
393 | ||
394 | /** |
|
395 | * The startTime of something. For a reserved event or service (e.g. |
|
396 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
397 | * actions that span a period of time, when the action was performed. e.g. |
|
398 | * John wrote a book from *January* to December. For media, including audio |
|
399 | * and video, it's the time offset of the start of a clip within a larger |
|
400 | * file. |
|
401 | * |
|
402 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
403 | * when describing dates with times. This situation may be clarified in |
|
404 | * future revisions. |
|
405 | * |
|
406 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
407 | * |
|
408 | * @return static |
|
409 | * |
|
410 | * @see http://schema.org/startTime |
|
411 | */ |
|
412 | public function startTime($startTime) |
|
413 | { |
|
414 | return $this->setProperty('startTime', $startTime); |
|
415 | } |
|
416 | ||
417 | /** |
|
418 | * A CreativeWork or Event about this Thing. |
|
419 | * |
|
420 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
421 | * |
|
422 | * @return static |
|
423 | * |
|
424 | * @see http://schema.org/subjectOf |
|
425 | */ |
|
426 | public function subjectOf($subjectOf) |
|
427 | { |
|
428 | return $this->setProperty('subjectOf', $subjectOf); |
|
429 | } |
|
430 | ||
431 | /** |
|
432 | * Indicates a target EntryPoint for an Action. |
|
433 | * |
|
434 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
435 | * |
|
436 | * @return static |
|
437 | * |
|
438 | * @see http://schema.org/target |
|
439 | */ |
|
440 | public function target($target) |
|
441 | { |
|
442 | return $this->setProperty('target', $target); |
|
443 | } |
|
444 | ||
445 | /** |
|
446 | * URL of the item. |
|
447 | * |
|
448 | * @param string|string[] $url |
|
449 | * |
|
450 | * @return static |
|
451 | * |
|
452 | * @see http://schema.org/url |
|
453 | */ |
|
454 | public function url($url) |
|
455 | { |
|
456 | return $this->setProperty('url', $url); |
|
457 | } |
|
458 | ||
459 | } |
|
460 |
@@ 18-428 (lines=411) @@ | ||
15 | * @see http://schema.org/PrependAction |
|
16 | * |
|
17 | */ |
|
18 | class PrependAction extends BaseType implements PrependActionContract, ActionContract, AddActionContract, InsertActionContract, ThingContract, UpdateActionContract |
|
19 | { |
|
20 | /** |
|
21 | * Indicates the current disposition of the Action. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionStatus |
|
28 | */ |
|
29 | public function actionStatus($actionStatus) |
|
30 | { |
|
31 | return $this->setProperty('actionStatus', $actionStatus); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * An additional type for the item, typically used for adding more specific |
|
36 | * types from external vocabularies in microdata syntax. This is a |
|
37 | * relationship between something and a class that the thing is in. In RDFa |
|
38 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
39 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
40 | * understanding of extra types, in particular those defined externally. |
|
41 | * |
|
42 | * @param string|string[] $additionalType |
|
43 | * |
|
44 | * @return static |
|
45 | * |
|
46 | * @see http://schema.org/additionalType |
|
47 | */ |
|
48 | public function additionalType($additionalType) |
|
49 | { |
|
50 | return $this->setProperty('additionalType', $additionalType); |
|
51 | } |
|
52 | ||
53 | /** |
|
54 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
55 | * *John* wrote a book. |
|
56 | * |
|
57 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
58 | * |
|
59 | * @return static |
|
60 | * |
|
61 | * @see http://schema.org/agent |
|
62 | */ |
|
63 | public function agent($agent) |
|
64 | { |
|
65 | return $this->setProperty('agent', $agent); |
|
66 | } |
|
67 | ||
68 | /** |
|
69 | * An alias for the item. |
|
70 | * |
|
71 | * @param string|string[] $alternateName |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/alternateName |
|
76 | */ |
|
77 | public function alternateName($alternateName) |
|
78 | { |
|
79 | return $this->setProperty('alternateName', $alternateName); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * A sub property of object. The collection target of the action. |
|
84 | * |
|
85 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $collection |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/collection |
|
90 | */ |
|
91 | public function collection($collection) |
|
92 | { |
|
93 | return $this->setProperty('collection', $collection); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * The identifier property represents any kind of identifier for any kind of |
|
166 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
167 | * dedicated properties for representing many of these, either as textual |
|
168 | * strings or as URL (URI) links. See [background |
|
169 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/identifier |
|
176 | */ |
|
177 | public function identifier($identifier) |
|
178 | { |
|
179 | return $this->setProperty('identifier', $identifier); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * An image of the item. This can be a [[URL]] or a fully described |
|
184 | * [[ImageObject]]. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/image |
|
191 | */ |
|
192 | public function image($image) |
|
193 | { |
|
194 | return $this->setProperty('image', $image); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The object that helped the agent perform the action. e.g. John wrote a |
|
199 | * book with *a pen*. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/instrument |
|
206 | */ |
|
207 | public function instrument($instrument) |
|
208 | { |
|
209 | return $this->setProperty('instrument', $instrument); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * The location of for example where the event is happening, an organization |
|
214 | * is located, or where an action takes place. |
|
215 | * |
|
216 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
217 | * |
|
218 | * @return static |
|
219 | * |
|
220 | * @see http://schema.org/location |
|
221 | */ |
|
222 | public function location($location) |
|
223 | { |
|
224 | return $this->setProperty('location', $location); |
|
225 | } |
|
226 | ||
227 | /** |
|
228 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
229 | * entity being described. See [background |
|
230 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/mainEntityOfPage |
|
237 | */ |
|
238 | public function mainEntityOfPage($mainEntityOfPage) |
|
239 | { |
|
240 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * The name of the item. |
|
245 | * |
|
246 | * @param string|string[] $name |
|
247 | * |
|
248 | * @return static |
|
249 | * |
|
250 | * @see http://schema.org/name |
|
251 | */ |
|
252 | public function name($name) |
|
253 | { |
|
254 | return $this->setProperty('name', $name); |
|
255 | } |
|
256 | ||
257 | /** |
|
258 | * The object upon which the action is carried out, whose state is kept |
|
259 | * intact or changed. Also known as the semantic roles patient, affected or |
|
260 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
261 | * read *a book*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/object |
|
268 | */ |
|
269 | public function object($object) |
|
270 | { |
|
271 | return $this->setProperty('object', $object); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Other co-agents that participated in the action indirectly. e.g. John |
|
276 | * wrote a book with *Steve*. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/participant |
|
283 | */ |
|
284 | public function participant($participant) |
|
285 | { |
|
286 | return $this->setProperty('participant', $participant); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * Indicates a potential Action, which describes an idealized action in |
|
291 | * which this thing would play an 'object' role. |
|
292 | * |
|
293 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
294 | * |
|
295 | * @return static |
|
296 | * |
|
297 | * @see http://schema.org/potentialAction |
|
298 | */ |
|
299 | public function potentialAction($potentialAction) |
|
300 | { |
|
301 | return $this->setProperty('potentialAction', $potentialAction); |
|
302 | } |
|
303 | ||
304 | /** |
|
305 | * The result produced in the action. e.g. John wrote *a book*. |
|
306 | * |
|
307 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
308 | * |
|
309 | * @return static |
|
310 | * |
|
311 | * @see http://schema.org/result |
|
312 | */ |
|
313 | public function result($result) |
|
314 | { |
|
315 | return $this->setProperty('result', $result); |
|
316 | } |
|
317 | ||
318 | /** |
|
319 | * URL of a reference Web page that unambiguously indicates the item's |
|
320 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
321 | * official website. |
|
322 | * |
|
323 | * @param string|string[] $sameAs |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/sameAs |
|
328 | */ |
|
329 | public function sameAs($sameAs) |
|
330 | { |
|
331 | return $this->setProperty('sameAs', $sameAs); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * The startTime of something. For a reserved event or service (e.g. |
|
336 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
337 | * actions that span a period of time, when the action was performed. e.g. |
|
338 | * John wrote a book from *January* to December. For media, including audio |
|
339 | * and video, it's the time offset of the start of a clip within a larger |
|
340 | * file. |
|
341 | * |
|
342 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
343 | * when describing dates with times. This situation may be clarified in |
|
344 | * future revisions. |
|
345 | * |
|
346 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
347 | * |
|
348 | * @return static |
|
349 | * |
|
350 | * @see http://schema.org/startTime |
|
351 | */ |
|
352 | public function startTime($startTime) |
|
353 | { |
|
354 | return $this->setProperty('startTime', $startTime); |
|
355 | } |
|
356 | ||
357 | /** |
|
358 | * A CreativeWork or Event about this Thing. |
|
359 | * |
|
360 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
361 | * |
|
362 | * @return static |
|
363 | * |
|
364 | * @see http://schema.org/subjectOf |
|
365 | */ |
|
366 | public function subjectOf($subjectOf) |
|
367 | { |
|
368 | return $this->setProperty('subjectOf', $subjectOf); |
|
369 | } |
|
370 | ||
371 | /** |
|
372 | * Indicates a target EntryPoint for an Action. |
|
373 | * |
|
374 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
375 | * |
|
376 | * @return static |
|
377 | * |
|
378 | * @see http://schema.org/target |
|
379 | */ |
|
380 | public function target($target) |
|
381 | { |
|
382 | return $this->setProperty('target', $target); |
|
383 | } |
|
384 | ||
385 | /** |
|
386 | * A sub property of object. The collection target of the action. |
|
387 | * |
|
388 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $targetCollection |
|
389 | * |
|
390 | * @return static |
|
391 | * |
|
392 | * @see http://schema.org/targetCollection |
|
393 | */ |
|
394 | public function targetCollection($targetCollection) |
|
395 | { |
|
396 | return $this->setProperty('targetCollection', $targetCollection); |
|
397 | } |
|
398 | ||
399 | /** |
|
400 | * A sub property of location. The final location of the object or the agent |
|
401 | * after the action. |
|
402 | * |
|
403 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/toLocation |
|
408 | */ |
|
409 | public function toLocation($toLocation) |
|
410 | { |
|
411 | return $this->setProperty('toLocation', $toLocation); |
|
412 | } |
|
413 | ||
414 | /** |
|
415 | * URL of the item. |
|
416 | * |
|
417 | * @param string|string[] $url |
|
418 | * |
|
419 | * @return static |
|
420 | * |
|
421 | * @see http://schema.org/url |
|
422 | */ |
|
423 | public function url($url) |
|
424 | { |
|
425 | return $this->setProperty('url', $url); |
|
426 | } |
|
427 | ||
428 | } |
|
429 |
@@ 17-459 (lines=443) @@ | ||
14 | * @see http://schema.org/QuoteAction |
|
15 | * |
|
16 | */ |
|
17 | class QuoteAction extends BaseType implements QuoteActionContract, ActionContract, ThingContract, TradeActionContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * For failed actions, more information on the cause of the failure. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/error |
|
143 | */ |
|
144 | public function error($error) |
|
145 | { |
|
146 | return $this->setProperty('error', $error); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * The identifier property represents any kind of identifier for any kind of |
|
151 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
152 | * dedicated properties for representing many of these, either as textual |
|
153 | * strings or as URL (URI) links. See [background |
|
154 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
155 | * |
|
156 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
157 | * |
|
158 | * @return static |
|
159 | * |
|
160 | * @see http://schema.org/identifier |
|
161 | */ |
|
162 | public function identifier($identifier) |
|
163 | { |
|
164 | return $this->setProperty('identifier', $identifier); |
|
165 | } |
|
166 | ||
167 | /** |
|
168 | * An image of the item. This can be a [[URL]] or a fully described |
|
169 | * [[ImageObject]]. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/image |
|
176 | */ |
|
177 | public function image($image) |
|
178 | { |
|
179 | return $this->setProperty('image', $image); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * The object that helped the agent perform the action. e.g. John wrote a |
|
184 | * book with *a pen*. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/instrument |
|
191 | */ |
|
192 | public function instrument($instrument) |
|
193 | { |
|
194 | return $this->setProperty('instrument', $instrument); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The location of for example where the event is happening, an organization |
|
199 | * is located, or where an action takes place. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/location |
|
206 | */ |
|
207 | public function location($location) |
|
208 | { |
|
209 | return $this->setProperty('location', $location); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
214 | * entity being described. See [background |
|
215 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/mainEntityOfPage |
|
222 | */ |
|
223 | public function mainEntityOfPage($mainEntityOfPage) |
|
224 | { |
|
225 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The name of the item. |
|
230 | * |
|
231 | * @param string|string[] $name |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/name |
|
236 | */ |
|
237 | public function name($name) |
|
238 | { |
|
239 | return $this->setProperty('name', $name); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The object upon which the action is carried out, whose state is kept |
|
244 | * intact or changed. Also known as the semantic roles patient, affected or |
|
245 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
246 | * read *a book*. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/object |
|
253 | */ |
|
254 | public function object($object) |
|
255 | { |
|
256 | return $this->setProperty('object', $object); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * Other co-agents that participated in the action indirectly. e.g. John |
|
261 | * wrote a book with *Steve*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/participant |
|
268 | */ |
|
269 | public function participant($participant) |
|
270 | { |
|
271 | return $this->setProperty('participant', $participant); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Indicates a potential Action, which describes an idealized action in |
|
276 | * which this thing would play an 'object' role. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/potentialAction |
|
283 | */ |
|
284 | public function potentialAction($potentialAction) |
|
285 | { |
|
286 | return $this->setProperty('potentialAction', $potentialAction); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * The offer price of a product, or of a price component when attached to |
|
291 | * PriceSpecification and its subtypes. |
|
292 | * |
|
293 | * Usage guidelines: |
|
294 | * |
|
295 | * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 |
|
296 | * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; |
|
297 | * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) |
|
298 | * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
299 | * Tradings |
|
300 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
301 | * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including |
|
302 | * [ambiguous |
|
303 | * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) |
|
304 | * such as '$' in the value. |
|
305 | * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a |
|
306 | * decimal point. Avoid using these symbols as a readability separator. |
|
307 | * * Note that both |
|
308 | * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) |
|
309 | * and Microdata syntax allow the use of a "content=" attribute for |
|
310 | * publishing simple machine-readable values alongside more human-friendly |
|
311 | * formatting. |
|
312 | * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT |
|
313 | * NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
|
314 | * |
|
315 | * @param float|float[]|int|int[]|string|string[] $price |
|
316 | * |
|
317 | * @return static |
|
318 | * |
|
319 | * @see http://schema.org/price |
|
320 | */ |
|
321 | public function price($price) |
|
322 | { |
|
323 | return $this->setProperty('price', $price); |
|
324 | } |
|
325 | ||
326 | /** |
|
327 | * The currency of the price, or a price component when attached to |
|
328 | * [[PriceSpecification]] and its subtypes. |
|
329 | * |
|
330 | * Use standard formats: [ISO 4217 currency |
|
331 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
332 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
333 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
334 | * Tradings |
|
335 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
336 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
337 | * |
|
338 | * @param string|string[] $priceCurrency |
|
339 | * |
|
340 | * @return static |
|
341 | * |
|
342 | * @see http://schema.org/priceCurrency |
|
343 | */ |
|
344 | public function priceCurrency($priceCurrency) |
|
345 | { |
|
346 | return $this->setProperty('priceCurrency', $priceCurrency); |
|
347 | } |
|
348 | ||
349 | /** |
|
350 | * One or more detailed price specifications, indicating the unit price and |
|
351 | * delivery or payment charges. |
|
352 | * |
|
353 | * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[] $priceSpecification |
|
354 | * |
|
355 | * @return static |
|
356 | * |
|
357 | * @see http://schema.org/priceSpecification |
|
358 | */ |
|
359 | public function priceSpecification($priceSpecification) |
|
360 | { |
|
361 | return $this->setProperty('priceSpecification', $priceSpecification); |
|
362 | } |
|
363 | ||
364 | /** |
|
365 | * The result produced in the action. e.g. John wrote *a book*. |
|
366 | * |
|
367 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
368 | * |
|
369 | * @return static |
|
370 | * |
|
371 | * @see http://schema.org/result |
|
372 | */ |
|
373 | public function result($result) |
|
374 | { |
|
375 | return $this->setProperty('result', $result); |
|
376 | } |
|
377 | ||
378 | /** |
|
379 | * URL of a reference Web page that unambiguously indicates the item's |
|
380 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
381 | * official website. |
|
382 | * |
|
383 | * @param string|string[] $sameAs |
|
384 | * |
|
385 | * @return static |
|
386 | * |
|
387 | * @see http://schema.org/sameAs |
|
388 | */ |
|
389 | public function sameAs($sameAs) |
|
390 | { |
|
391 | return $this->setProperty('sameAs', $sameAs); |
|
392 | } |
|
393 | ||
394 | /** |
|
395 | * The startTime of something. For a reserved event or service (e.g. |
|
396 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
397 | * actions that span a period of time, when the action was performed. e.g. |
|
398 | * John wrote a book from *January* to December. For media, including audio |
|
399 | * and video, it's the time offset of the start of a clip within a larger |
|
400 | * file. |
|
401 | * |
|
402 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
403 | * when describing dates with times. This situation may be clarified in |
|
404 | * future revisions. |
|
405 | * |
|
406 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
407 | * |
|
408 | * @return static |
|
409 | * |
|
410 | * @see http://schema.org/startTime |
|
411 | */ |
|
412 | public function startTime($startTime) |
|
413 | { |
|
414 | return $this->setProperty('startTime', $startTime); |
|
415 | } |
|
416 | ||
417 | /** |
|
418 | * A CreativeWork or Event about this Thing. |
|
419 | * |
|
420 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
421 | * |
|
422 | * @return static |
|
423 | * |
|
424 | * @see http://schema.org/subjectOf |
|
425 | */ |
|
426 | public function subjectOf($subjectOf) |
|
427 | { |
|
428 | return $this->setProperty('subjectOf', $subjectOf); |
|
429 | } |
|
430 | ||
431 | /** |
|
432 | * Indicates a target EntryPoint for an Action. |
|
433 | * |
|
434 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
435 | * |
|
436 | * @return static |
|
437 | * |
|
438 | * @see http://schema.org/target |
|
439 | */ |
|
440 | public function target($target) |
|
441 | { |
|
442 | return $this->setProperty('target', $target); |
|
443 | } |
|
444 | ||
445 | /** |
|
446 | * URL of the item. |
|
447 | * |
|
448 | * @param string|string[] $url |
|
449 | * |
|
450 | * @return static |
|
451 | * |
|
452 | * @see http://schema.org/url |
|
453 | */ |
|
454 | public function url($url) |
|
455 | { |
|
456 | return $this->setProperty('url', $url); |
|
457 | } |
|
458 | ||
459 | } |
|
460 |
@@ 16-415 (lines=400) @@ | ||
13 | * @see http://schema.org/ReadAction |
|
14 | * |
|
15 | */ |
|
16 | class ReadAction extends BaseType implements ReadActionContract, ActionContract, ConsumeActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * A set of requirements that a must be fulfilled in order to perform an |
|
20 | * Action. If more than one value is specied, fulfilling one set of |
|
21 | * requirements will allow the Action to be performed. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionAccessibilityRequirement |
|
28 | */ |
|
29 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
30 | { |
|
31 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * Indicates the current disposition of the Action. |
|
36 | * |
|
37 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
38 | * |
|
39 | * @return static |
|
40 | * |
|
41 | * @see http://schema.org/actionStatus |
|
42 | */ |
|
43 | public function actionStatus($actionStatus) |
|
44 | { |
|
45 | return $this->setProperty('actionStatus', $actionStatus); |
|
46 | } |
|
47 | ||
48 | /** |
|
49 | * An additional type for the item, typically used for adding more specific |
|
50 | * types from external vocabularies in microdata syntax. This is a |
|
51 | * relationship between something and a class that the thing is in. In RDFa |
|
52 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
53 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
54 | * understanding of extra types, in particular those defined externally. |
|
55 | * |
|
56 | * @param string|string[] $additionalType |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/additionalType |
|
61 | */ |
|
62 | public function additionalType($additionalType) |
|
63 | { |
|
64 | return $this->setProperty('additionalType', $additionalType); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
69 | * *John* wrote a book. |
|
70 | * |
|
71 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/agent |
|
76 | */ |
|
77 | public function agent($agent) |
|
78 | { |
|
79 | return $this->setProperty('agent', $agent); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * An alias for the item. |
|
84 | * |
|
85 | * @param string|string[] $alternateName |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/alternateName |
|
90 | */ |
|
91 | public function alternateName($alternateName) |
|
92 | { |
|
93 | return $this->setProperty('alternateName', $alternateName); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * An Offer which must be accepted before the user can perform the Action. |
|
166 | * For example, the user may need to buy a movie before being able to watch |
|
167 | * it. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/expectsAcceptanceOf |
|
174 | */ |
|
175 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
176 | { |
|
177 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * The identifier property represents any kind of identifier for any kind of |
|
182 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
183 | * dedicated properties for representing many of these, either as textual |
|
184 | * strings or as URL (URI) links. See [background |
|
185 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
186 | * |
|
187 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
188 | * |
|
189 | * @return static |
|
190 | * |
|
191 | * @see http://schema.org/identifier |
|
192 | */ |
|
193 | public function identifier($identifier) |
|
194 | { |
|
195 | return $this->setProperty('identifier', $identifier); |
|
196 | } |
|
197 | ||
198 | /** |
|
199 | * An image of the item. This can be a [[URL]] or a fully described |
|
200 | * [[ImageObject]]. |
|
201 | * |
|
202 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
203 | * |
|
204 | * @return static |
|
205 | * |
|
206 | * @see http://schema.org/image |
|
207 | */ |
|
208 | public function image($image) |
|
209 | { |
|
210 | return $this->setProperty('image', $image); |
|
211 | } |
|
212 | ||
213 | /** |
|
214 | * The object that helped the agent perform the action. e.g. John wrote a |
|
215 | * book with *a pen*. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/instrument |
|
222 | */ |
|
223 | public function instrument($instrument) |
|
224 | { |
|
225 | return $this->setProperty('instrument', $instrument); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The location of for example where the event is happening, an organization |
|
230 | * is located, or where an action takes place. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/location |
|
237 | */ |
|
238 | public function location($location) |
|
239 | { |
|
240 | return $this->setProperty('location', $location); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
245 | * entity being described. See [background |
|
246 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/mainEntityOfPage |
|
253 | */ |
|
254 | public function mainEntityOfPage($mainEntityOfPage) |
|
255 | { |
|
256 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The name of the item. |
|
261 | * |
|
262 | * @param string|string[] $name |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/name |
|
267 | */ |
|
268 | public function name($name) |
|
269 | { |
|
270 | return $this->setProperty('name', $name); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * The object upon which the action is carried out, whose state is kept |
|
275 | * intact or changed. Also known as the semantic roles patient, affected or |
|
276 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
277 | * read *a book*. |
|
278 | * |
|
279 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
280 | * |
|
281 | * @return static |
|
282 | * |
|
283 | * @see http://schema.org/object |
|
284 | */ |
|
285 | public function object($object) |
|
286 | { |
|
287 | return $this->setProperty('object', $object); |
|
288 | } |
|
289 | ||
290 | /** |
|
291 | * Other co-agents that participated in the action indirectly. e.g. John |
|
292 | * wrote a book with *Steve*. |
|
293 | * |
|
294 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
295 | * |
|
296 | * @return static |
|
297 | * |
|
298 | * @see http://schema.org/participant |
|
299 | */ |
|
300 | public function participant($participant) |
|
301 | { |
|
302 | return $this->setProperty('participant', $participant); |
|
303 | } |
|
304 | ||
305 | /** |
|
306 | * Indicates a potential Action, which describes an idealized action in |
|
307 | * which this thing would play an 'object' role. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/potentialAction |
|
314 | */ |
|
315 | public function potentialAction($potentialAction) |
|
316 | { |
|
317 | return $this->setProperty('potentialAction', $potentialAction); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * The result produced in the action. e.g. John wrote *a book*. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/result |
|
328 | */ |
|
329 | public function result($result) |
|
330 | { |
|
331 | return $this->setProperty('result', $result); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * The startTime of something. For a reserved event or service (e.g. |
|
352 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
353 | * actions that span a period of time, when the action was performed. e.g. |
|
354 | * John wrote a book from *January* to December. For media, including audio |
|
355 | * and video, it's the time offset of the start of a clip within a larger |
|
356 | * file. |
|
357 | * |
|
358 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
359 | * when describing dates with times. This situation may be clarified in |
|
360 | * future revisions. |
|
361 | * |
|
362 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
363 | * |
|
364 | * @return static |
|
365 | * |
|
366 | * @see http://schema.org/startTime |
|
367 | */ |
|
368 | public function startTime($startTime) |
|
369 | { |
|
370 | return $this->setProperty('startTime', $startTime); |
|
371 | } |
|
372 | ||
373 | /** |
|
374 | * A CreativeWork or Event about this Thing. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/subjectOf |
|
381 | */ |
|
382 | public function subjectOf($subjectOf) |
|
383 | { |
|
384 | return $this->setProperty('subjectOf', $subjectOf); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * Indicates a target EntryPoint for an Action. |
|
389 | * |
|
390 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/target |
|
395 | */ |
|
396 | public function target($target) |
|
397 | { |
|
398 | return $this->setProperty('target', $target); |
|
399 | } |
|
400 | ||
401 | /** |
|
402 | * URL of the item. |
|
403 | * |
|
404 | * @param string|string[] $url |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/url |
|
409 | */ |
|
410 | public function url($url) |
|
411 | { |
|
412 | return $this->setProperty('url', $url); |
|
413 | } |
|
414 | ||
415 | } |
|
416 |
@@ 21-415 (lines=395) @@ | ||
18 | * @see http://schema.org/Reservation |
|
19 | * |
|
20 | */ |
|
21 | class Reservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract |
|
22 | { |
|
23 | /** |
|
24 | * An additional type for the item, typically used for adding more specific |
|
25 | * types from external vocabularies in microdata syntax. This is a |
|
26 | * relationship between something and a class that the thing is in. In RDFa |
|
27 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
28 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
29 | * understanding of extra types, in particular those defined externally. |
|
30 | * |
|
31 | * @param string|string[] $additionalType |
|
32 | * |
|
33 | * @return static |
|
34 | * |
|
35 | * @see http://schema.org/additionalType |
|
36 | */ |
|
37 | public function additionalType($additionalType) |
|
38 | { |
|
39 | return $this->setProperty('additionalType', $additionalType); |
|
40 | } |
|
41 | ||
42 | /** |
|
43 | * An alias for the item. |
|
44 | * |
|
45 | * @param string|string[] $alternateName |
|
46 | * |
|
47 | * @return static |
|
48 | * |
|
49 | * @see http://schema.org/alternateName |
|
50 | */ |
|
51 | public function alternateName($alternateName) |
|
52 | { |
|
53 | return $this->setProperty('alternateName', $alternateName); |
|
54 | } |
|
55 | ||
56 | /** |
|
57 | * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as |
|
58 | * a booking agent. |
|
59 | * |
|
60 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $bookingAgent |
|
61 | * |
|
62 | * @return static |
|
63 | * |
|
64 | * @see http://schema.org/bookingAgent |
|
65 | */ |
|
66 | public function bookingAgent($bookingAgent) |
|
67 | { |
|
68 | return $this->setProperty('bookingAgent', $bookingAgent); |
|
69 | } |
|
70 | ||
71 | /** |
|
72 | * The date and time the reservation was booked. |
|
73 | * |
|
74 | * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime |
|
75 | * |
|
76 | * @return static |
|
77 | * |
|
78 | * @see http://schema.org/bookingTime |
|
79 | */ |
|
80 | public function bookingTime($bookingTime) |
|
81 | { |
|
82 | return $this->setProperty('bookingTime', $bookingTime); |
|
83 | } |
|
84 | ||
85 | /** |
|
86 | * An entity that arranges for an exchange between a buyer and a seller. In |
|
87 | * most cases a broker never acquires or releases ownership of a product or |
|
88 | * service involved in an exchange. If it is not clear whether an entity is |
|
89 | * a broker, seller, or buyer, the latter two terms are preferred. |
|
90 | * |
|
91 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $broker |
|
92 | * |
|
93 | * @return static |
|
94 | * |
|
95 | * @see http://schema.org/broker |
|
96 | */ |
|
97 | public function broker($broker) |
|
98 | { |
|
99 | return $this->setProperty('broker', $broker); |
|
100 | } |
|
101 | ||
102 | /** |
|
103 | * A description of the item. |
|
104 | * |
|
105 | * @param string|string[] $description |
|
106 | * |
|
107 | * @return static |
|
108 | * |
|
109 | * @see http://schema.org/description |
|
110 | */ |
|
111 | public function description($description) |
|
112 | { |
|
113 | return $this->setProperty('description', $description); |
|
114 | } |
|
115 | ||
116 | /** |
|
117 | * A sub property of description. A short description of the item used to |
|
118 | * disambiguate from other, similar items. Information from other properties |
|
119 | * (in particular, name) may be necessary for the description to be useful |
|
120 | * for disambiguation. |
|
121 | * |
|
122 | * @param string|string[] $disambiguatingDescription |
|
123 | * |
|
124 | * @return static |
|
125 | * |
|
126 | * @see http://schema.org/disambiguatingDescription |
|
127 | */ |
|
128 | public function disambiguatingDescription($disambiguatingDescription) |
|
129 | { |
|
130 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
131 | } |
|
132 | ||
133 | /** |
|
134 | * The identifier property represents any kind of identifier for any kind of |
|
135 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
136 | * dedicated properties for representing many of these, either as textual |
|
137 | * strings or as URL (URI) links. See [background |
|
138 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
139 | * |
|
140 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
141 | * |
|
142 | * @return static |
|
143 | * |
|
144 | * @see http://schema.org/identifier |
|
145 | */ |
|
146 | public function identifier($identifier) |
|
147 | { |
|
148 | return $this->setProperty('identifier', $identifier); |
|
149 | } |
|
150 | ||
151 | /** |
|
152 | * An image of the item. This can be a [[URL]] or a fully described |
|
153 | * [[ImageObject]]. |
|
154 | * |
|
155 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
156 | * |
|
157 | * @return static |
|
158 | * |
|
159 | * @see http://schema.org/image |
|
160 | */ |
|
161 | public function image($image) |
|
162 | { |
|
163 | return $this->setProperty('image', $image); |
|
164 | } |
|
165 | ||
166 | /** |
|
167 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
168 | * entity being described. See [background |
|
169 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/mainEntityOfPage |
|
176 | */ |
|
177 | public function mainEntityOfPage($mainEntityOfPage) |
|
178 | { |
|
179 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * The date and time the reservation was modified. |
|
184 | * |
|
185 | * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/modifiedTime |
|
190 | */ |
|
191 | public function modifiedTime($modifiedTime) |
|
192 | { |
|
193 | return $this->setProperty('modifiedTime', $modifiedTime); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * The name of the item. |
|
198 | * |
|
199 | * @param string|string[] $name |
|
200 | * |
|
201 | * @return static |
|
202 | * |
|
203 | * @see http://schema.org/name |
|
204 | */ |
|
205 | public function name($name) |
|
206 | { |
|
207 | return $this->setProperty('name', $name); |
|
208 | } |
|
209 | ||
210 | /** |
|
211 | * Indicates a potential Action, which describes an idealized action in |
|
212 | * which this thing would play an 'object' role. |
|
213 | * |
|
214 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
215 | * |
|
216 | * @return static |
|
217 | * |
|
218 | * @see http://schema.org/potentialAction |
|
219 | */ |
|
220 | public function potentialAction($potentialAction) |
|
221 | { |
|
222 | return $this->setProperty('potentialAction', $potentialAction); |
|
223 | } |
|
224 | ||
225 | /** |
|
226 | * The currency of the price, or a price component when attached to |
|
227 | * [[PriceSpecification]] and its subtypes. |
|
228 | * |
|
229 | * Use standard formats: [ISO 4217 currency |
|
230 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
231 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
232 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
233 | * Tradings |
|
234 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
235 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
236 | * |
|
237 | * @param string|string[] $priceCurrency |
|
238 | * |
|
239 | * @return static |
|
240 | * |
|
241 | * @see http://schema.org/priceCurrency |
|
242 | */ |
|
243 | public function priceCurrency($priceCurrency) |
|
244 | { |
|
245 | return $this->setProperty('priceCurrency', $priceCurrency); |
|
246 | } |
|
247 | ||
248 | /** |
|
249 | * Any membership in a frequent flyer, hotel loyalty program, etc. being |
|
250 | * applied to the reservation. |
|
251 | * |
|
252 | * @param \Spatie\SchemaOrg\Contracts\ProgramMembershipContract|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract[] $programMembershipUsed |
|
253 | * |
|
254 | * @return static |
|
255 | * |
|
256 | * @see http://schema.org/programMembershipUsed |
|
257 | */ |
|
258 | public function programMembershipUsed($programMembershipUsed) |
|
259 | { |
|
260 | return $this->setProperty('programMembershipUsed', $programMembershipUsed); |
|
261 | } |
|
262 | ||
263 | /** |
|
264 | * The service provider, service operator, or service performer; the goods |
|
265 | * producer. Another party (a seller) may offer those services or goods on |
|
266 | * behalf of the provider. A provider may also serve as the seller. |
|
267 | * |
|
268 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider |
|
269 | * |
|
270 | * @return static |
|
271 | * |
|
272 | * @see http://schema.org/provider |
|
273 | */ |
|
274 | public function provider($provider) |
|
275 | { |
|
276 | return $this->setProperty('provider', $provider); |
|
277 | } |
|
278 | ||
279 | /** |
|
280 | * The thing -- flight, event, restaurant,etc. being reserved. |
|
281 | * |
|
282 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $reservationFor |
|
283 | * |
|
284 | * @return static |
|
285 | * |
|
286 | * @see http://schema.org/reservationFor |
|
287 | */ |
|
288 | public function reservationFor($reservationFor) |
|
289 | { |
|
290 | return $this->setProperty('reservationFor', $reservationFor); |
|
291 | } |
|
292 | ||
293 | /** |
|
294 | * A unique identifier for the reservation. |
|
295 | * |
|
296 | * @param string|string[] $reservationId |
|
297 | * |
|
298 | * @return static |
|
299 | * |
|
300 | * @see http://schema.org/reservationId |
|
301 | */ |
|
302 | public function reservationId($reservationId) |
|
303 | { |
|
304 | return $this->setProperty('reservationId', $reservationId); |
|
305 | } |
|
306 | ||
307 | /** |
|
308 | * The current status of the reservation. |
|
309 | * |
|
310 | * @param \Spatie\SchemaOrg\Contracts\ReservationStatusTypeContract|\Spatie\SchemaOrg\Contracts\ReservationStatusTypeContract[] $reservationStatus |
|
311 | * |
|
312 | * @return static |
|
313 | * |
|
314 | * @see http://schema.org/reservationStatus |
|
315 | */ |
|
316 | public function reservationStatus($reservationStatus) |
|
317 | { |
|
318 | return $this->setProperty('reservationStatus', $reservationStatus); |
|
319 | } |
|
320 | ||
321 | /** |
|
322 | * A ticket associated with the reservation. |
|
323 | * |
|
324 | * @param \Spatie\SchemaOrg\Contracts\TicketContract|\Spatie\SchemaOrg\Contracts\TicketContract[] $reservedTicket |
|
325 | * |
|
326 | * @return static |
|
327 | * |
|
328 | * @see http://schema.org/reservedTicket |
|
329 | */ |
|
330 | public function reservedTicket($reservedTicket) |
|
331 | { |
|
332 | return $this->setProperty('reservedTicket', $reservedTicket); |
|
333 | } |
|
334 | ||
335 | /** |
|
336 | * URL of a reference Web page that unambiguously indicates the item's |
|
337 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
338 | * official website. |
|
339 | * |
|
340 | * @param string|string[] $sameAs |
|
341 | * |
|
342 | * @return static |
|
343 | * |
|
344 | * @see http://schema.org/sameAs |
|
345 | */ |
|
346 | public function sameAs($sameAs) |
|
347 | { |
|
348 | return $this->setProperty('sameAs', $sameAs); |
|
349 | } |
|
350 | ||
351 | /** |
|
352 | * A CreativeWork or Event about this Thing. |
|
353 | * |
|
354 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
355 | * |
|
356 | * @return static |
|
357 | * |
|
358 | * @see http://schema.org/subjectOf |
|
359 | */ |
|
360 | public function subjectOf($subjectOf) |
|
361 | { |
|
362 | return $this->setProperty('subjectOf', $subjectOf); |
|
363 | } |
|
364 | ||
365 | /** |
|
366 | * The total price for the reservation or ticket, including applicable |
|
367 | * taxes, shipping, etc. |
|
368 | * |
|
369 | * Usage guidelines: |
|
370 | * |
|
371 | * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT |
|
372 | * NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
|
373 | * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a |
|
374 | * decimal point. Avoid using these symbols as a readability separator. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[]|float|float[]|int|int[]|string|string[] $totalPrice |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/totalPrice |
|
381 | */ |
|
382 | public function totalPrice($totalPrice) |
|
383 | { |
|
384 | return $this->setProperty('totalPrice', $totalPrice); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * The person or organization the reservation or ticket is for. |
|
389 | * |
|
390 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $underName |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/underName |
|
395 | */ |
|
396 | public function underName($underName) |
|
397 | { |
|
398 | return $this->setProperty('underName', $underName); |
|
399 | } |
|
400 | ||
401 | /** |
|
402 | * URL of the item. |
|
403 | * |
|
404 | * @param string|string[] $url |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/url |
|
409 | */ |
|
410 | public function url($url) |
|
411 | { |
|
412 | return $this->setProperty('url', $url); |
|
413 | } |
|
414 | ||
415 | } |
|
416 |
@@ 23-404 (lines=382) @@ | ||
20 | * @see http://schema.org/ReserveAction |
|
21 | * |
|
22 | */ |
|
23 | class ReserveAction extends BaseType implements ReserveActionContract, ActionContract, OrganizeActionContract, PlanActionContract, ThingContract |
|
24 | { |
|
25 | /** |
|
26 | * Indicates the current disposition of the Action. |
|
27 | * |
|
28 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
29 | * |
|
30 | * @return static |
|
31 | * |
|
32 | * @see http://schema.org/actionStatus |
|
33 | */ |
|
34 | public function actionStatus($actionStatus) |
|
35 | { |
|
36 | return $this->setProperty('actionStatus', $actionStatus); |
|
37 | } |
|
38 | ||
39 | /** |
|
40 | * An additional type for the item, typically used for adding more specific |
|
41 | * types from external vocabularies in microdata syntax. This is a |
|
42 | * relationship between something and a class that the thing is in. In RDFa |
|
43 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
44 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
45 | * understanding of extra types, in particular those defined externally. |
|
46 | * |
|
47 | * @param string|string[] $additionalType |
|
48 | * |
|
49 | * @return static |
|
50 | * |
|
51 | * @see http://schema.org/additionalType |
|
52 | */ |
|
53 | public function additionalType($additionalType) |
|
54 | { |
|
55 | return $this->setProperty('additionalType', $additionalType); |
|
56 | } |
|
57 | ||
58 | /** |
|
59 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
60 | * *John* wrote a book. |
|
61 | * |
|
62 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
63 | * |
|
64 | * @return static |
|
65 | * |
|
66 | * @see http://schema.org/agent |
|
67 | */ |
|
68 | public function agent($agent) |
|
69 | { |
|
70 | return $this->setProperty('agent', $agent); |
|
71 | } |
|
72 | ||
73 | /** |
|
74 | * An alias for the item. |
|
75 | * |
|
76 | * @param string|string[] $alternateName |
|
77 | * |
|
78 | * @return static |
|
79 | * |
|
80 | * @see http://schema.org/alternateName |
|
81 | */ |
|
82 | public function alternateName($alternateName) |
|
83 | { |
|
84 | return $this->setProperty('alternateName', $alternateName); |
|
85 | } |
|
86 | ||
87 | /** |
|
88 | * A description of the item. |
|
89 | * |
|
90 | * @param string|string[] $description |
|
91 | * |
|
92 | * @return static |
|
93 | * |
|
94 | * @see http://schema.org/description |
|
95 | */ |
|
96 | public function description($description) |
|
97 | { |
|
98 | return $this->setProperty('description', $description); |
|
99 | } |
|
100 | ||
101 | /** |
|
102 | * A sub property of description. A short description of the item used to |
|
103 | * disambiguate from other, similar items. Information from other properties |
|
104 | * (in particular, name) may be necessary for the description to be useful |
|
105 | * for disambiguation. |
|
106 | * |
|
107 | * @param string|string[] $disambiguatingDescription |
|
108 | * |
|
109 | * @return static |
|
110 | * |
|
111 | * @see http://schema.org/disambiguatingDescription |
|
112 | */ |
|
113 | public function disambiguatingDescription($disambiguatingDescription) |
|
114 | { |
|
115 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
116 | } |
|
117 | ||
118 | /** |
|
119 | * The endTime of something. For a reserved event or service (e.g. |
|
120 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
121 | * actions that span a period of time, when the action was performed. e.g. |
|
122 | * John wrote a book from January to *December*. For media, including audio |
|
123 | * and video, it's the time offset of the end of a clip within a larger |
|
124 | * file. |
|
125 | * |
|
126 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
127 | * when describing dates with times. This situation may be clarified in |
|
128 | * future revisions. |
|
129 | * |
|
130 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
131 | * |
|
132 | * @return static |
|
133 | * |
|
134 | * @see http://schema.org/endTime |
|
135 | */ |
|
136 | public function endTime($endTime) |
|
137 | { |
|
138 | return $this->setProperty('endTime', $endTime); |
|
139 | } |
|
140 | ||
141 | /** |
|
142 | * For failed actions, more information on the cause of the failure. |
|
143 | * |
|
144 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
145 | * |
|
146 | * @return static |
|
147 | * |
|
148 | * @see http://schema.org/error |
|
149 | */ |
|
150 | public function error($error) |
|
151 | { |
|
152 | return $this->setProperty('error', $error); |
|
153 | } |
|
154 | ||
155 | /** |
|
156 | * The identifier property represents any kind of identifier for any kind of |
|
157 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
158 | * dedicated properties for representing many of these, either as textual |
|
159 | * strings or as URL (URI) links. See [background |
|
160 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
161 | * |
|
162 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
163 | * |
|
164 | * @return static |
|
165 | * |
|
166 | * @see http://schema.org/identifier |
|
167 | */ |
|
168 | public function identifier($identifier) |
|
169 | { |
|
170 | return $this->setProperty('identifier', $identifier); |
|
171 | } |
|
172 | ||
173 | /** |
|
174 | * An image of the item. This can be a [[URL]] or a fully described |
|
175 | * [[ImageObject]]. |
|
176 | * |
|
177 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
178 | * |
|
179 | * @return static |
|
180 | * |
|
181 | * @see http://schema.org/image |
|
182 | */ |
|
183 | public function image($image) |
|
184 | { |
|
185 | return $this->setProperty('image', $image); |
|
186 | } |
|
187 | ||
188 | /** |
|
189 | * The object that helped the agent perform the action. e.g. John wrote a |
|
190 | * book with *a pen*. |
|
191 | * |
|
192 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
193 | * |
|
194 | * @return static |
|
195 | * |
|
196 | * @see http://schema.org/instrument |
|
197 | */ |
|
198 | public function instrument($instrument) |
|
199 | { |
|
200 | return $this->setProperty('instrument', $instrument); |
|
201 | } |
|
202 | ||
203 | /** |
|
204 | * The location of for example where the event is happening, an organization |
|
205 | * is located, or where an action takes place. |
|
206 | * |
|
207 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
208 | * |
|
209 | * @return static |
|
210 | * |
|
211 | * @see http://schema.org/location |
|
212 | */ |
|
213 | public function location($location) |
|
214 | { |
|
215 | return $this->setProperty('location', $location); |
|
216 | } |
|
217 | ||
218 | /** |
|
219 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
220 | * entity being described. See [background |
|
221 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
222 | * |
|
223 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
224 | * |
|
225 | * @return static |
|
226 | * |
|
227 | * @see http://schema.org/mainEntityOfPage |
|
228 | */ |
|
229 | public function mainEntityOfPage($mainEntityOfPage) |
|
230 | { |
|
231 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
232 | } |
|
233 | ||
234 | /** |
|
235 | * The name of the item. |
|
236 | * |
|
237 | * @param string|string[] $name |
|
238 | * |
|
239 | * @return static |
|
240 | * |
|
241 | * @see http://schema.org/name |
|
242 | */ |
|
243 | public function name($name) |
|
244 | { |
|
245 | return $this->setProperty('name', $name); |
|
246 | } |
|
247 | ||
248 | /** |
|
249 | * The object upon which the action is carried out, whose state is kept |
|
250 | * intact or changed. Also known as the semantic roles patient, affected or |
|
251 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
252 | * read *a book*. |
|
253 | * |
|
254 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
255 | * |
|
256 | * @return static |
|
257 | * |
|
258 | * @see http://schema.org/object |
|
259 | */ |
|
260 | public function object($object) |
|
261 | { |
|
262 | return $this->setProperty('object', $object); |
|
263 | } |
|
264 | ||
265 | /** |
|
266 | * Other co-agents that participated in the action indirectly. e.g. John |
|
267 | * wrote a book with *Steve*. |
|
268 | * |
|
269 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
270 | * |
|
271 | * @return static |
|
272 | * |
|
273 | * @see http://schema.org/participant |
|
274 | */ |
|
275 | public function participant($participant) |
|
276 | { |
|
277 | return $this->setProperty('participant', $participant); |
|
278 | } |
|
279 | ||
280 | /** |
|
281 | * Indicates a potential Action, which describes an idealized action in |
|
282 | * which this thing would play an 'object' role. |
|
283 | * |
|
284 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
285 | * |
|
286 | * @return static |
|
287 | * |
|
288 | * @see http://schema.org/potentialAction |
|
289 | */ |
|
290 | public function potentialAction($potentialAction) |
|
291 | { |
|
292 | return $this->setProperty('potentialAction', $potentialAction); |
|
293 | } |
|
294 | ||
295 | /** |
|
296 | * The result produced in the action. e.g. John wrote *a book*. |
|
297 | * |
|
298 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
299 | * |
|
300 | * @return static |
|
301 | * |
|
302 | * @see http://schema.org/result |
|
303 | */ |
|
304 | public function result($result) |
|
305 | { |
|
306 | return $this->setProperty('result', $result); |
|
307 | } |
|
308 | ||
309 | /** |
|
310 | * URL of a reference Web page that unambiguously indicates the item's |
|
311 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
312 | * official website. |
|
313 | * |
|
314 | * @param string|string[] $sameAs |
|
315 | * |
|
316 | * @return static |
|
317 | * |
|
318 | * @see http://schema.org/sameAs |
|
319 | */ |
|
320 | public function sameAs($sameAs) |
|
321 | { |
|
322 | return $this->setProperty('sameAs', $sameAs); |
|
323 | } |
|
324 | ||
325 | /** |
|
326 | * The time the object is scheduled to. |
|
327 | * |
|
328 | * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime |
|
329 | * |
|
330 | * @return static |
|
331 | * |
|
332 | * @see http://schema.org/scheduledTime |
|
333 | */ |
|
334 | public function scheduledTime($scheduledTime) |
|
335 | { |
|
336 | return $this->setProperty('scheduledTime', $scheduledTime); |
|
337 | } |
|
338 | ||
339 | /** |
|
340 | * The startTime of something. For a reserved event or service (e.g. |
|
341 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
342 | * actions that span a period of time, when the action was performed. e.g. |
|
343 | * John wrote a book from *January* to December. For media, including audio |
|
344 | * and video, it's the time offset of the start of a clip within a larger |
|
345 | * file. |
|
346 | * |
|
347 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
348 | * when describing dates with times. This situation may be clarified in |
|
349 | * future revisions. |
|
350 | * |
|
351 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
352 | * |
|
353 | * @return static |
|
354 | * |
|
355 | * @see http://schema.org/startTime |
|
356 | */ |
|
357 | public function startTime($startTime) |
|
358 | { |
|
359 | return $this->setProperty('startTime', $startTime); |
|
360 | } |
|
361 | ||
362 | /** |
|
363 | * A CreativeWork or Event about this Thing. |
|
364 | * |
|
365 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
366 | * |
|
367 | * @return static |
|
368 | * |
|
369 | * @see http://schema.org/subjectOf |
|
370 | */ |
|
371 | public function subjectOf($subjectOf) |
|
372 | { |
|
373 | return $this->setProperty('subjectOf', $subjectOf); |
|
374 | } |
|
375 | ||
376 | /** |
|
377 | * Indicates a target EntryPoint for an Action. |
|
378 | * |
|
379 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
380 | * |
|
381 | * @return static |
|
382 | * |
|
383 | * @see http://schema.org/target |
|
384 | */ |
|
385 | public function target($target) |
|
386 | { |
|
387 | return $this->setProperty('target', $target); |
|
388 | } |
|
389 | ||
390 | /** |
|
391 | * URL of the item. |
|
392 | * |
|
393 | * @param string|string[] $url |
|
394 | * |
|
395 | * @return static |
|
396 | * |
|
397 | * @see http://schema.org/url |
|
398 | */ |
|
399 | public function url($url) |
|
400 | { |
|
401 | return $this->setProperty('url', $url); |
|
402 | } |
|
403 | ||
404 | } |
|
405 |
@@ 17-429 (lines=413) @@ | ||
14 | * @see http://schema.org/ReturnAction |
|
15 | * |
|
16 | */ |
|
17 | class ReturnAction extends BaseType implements ReturnActionContract, ActionContract, ThingContract, TransferActionContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * For failed actions, more information on the cause of the failure. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/error |
|
143 | */ |
|
144 | public function error($error) |
|
145 | { |
|
146 | return $this->setProperty('error', $error); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * A sub property of location. The original location of the object or the |
|
151 | * agent before the action. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/fromLocation |
|
158 | */ |
|
159 | public function fromLocation($fromLocation) |
|
160 | { |
|
161 | return $this->setProperty('fromLocation', $fromLocation); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * The identifier property represents any kind of identifier for any kind of |
|
166 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
167 | * dedicated properties for representing many of these, either as textual |
|
168 | * strings or as URL (URI) links. See [background |
|
169 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/identifier |
|
176 | */ |
|
177 | public function identifier($identifier) |
|
178 | { |
|
179 | return $this->setProperty('identifier', $identifier); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * An image of the item. This can be a [[URL]] or a fully described |
|
184 | * [[ImageObject]]. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/image |
|
191 | */ |
|
192 | public function image($image) |
|
193 | { |
|
194 | return $this->setProperty('image', $image); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The object that helped the agent perform the action. e.g. John wrote a |
|
199 | * book with *a pen*. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/instrument |
|
206 | */ |
|
207 | public function instrument($instrument) |
|
208 | { |
|
209 | return $this->setProperty('instrument', $instrument); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * The location of for example where the event is happening, an organization |
|
214 | * is located, or where an action takes place. |
|
215 | * |
|
216 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
217 | * |
|
218 | * @return static |
|
219 | * |
|
220 | * @see http://schema.org/location |
|
221 | */ |
|
222 | public function location($location) |
|
223 | { |
|
224 | return $this->setProperty('location', $location); |
|
225 | } |
|
226 | ||
227 | /** |
|
228 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
229 | * entity being described. See [background |
|
230 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/mainEntityOfPage |
|
237 | */ |
|
238 | public function mainEntityOfPage($mainEntityOfPage) |
|
239 | { |
|
240 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * The name of the item. |
|
245 | * |
|
246 | * @param string|string[] $name |
|
247 | * |
|
248 | * @return static |
|
249 | * |
|
250 | * @see http://schema.org/name |
|
251 | */ |
|
252 | public function name($name) |
|
253 | { |
|
254 | return $this->setProperty('name', $name); |
|
255 | } |
|
256 | ||
257 | /** |
|
258 | * The object upon which the action is carried out, whose state is kept |
|
259 | * intact or changed. Also known as the semantic roles patient, affected or |
|
260 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
261 | * read *a book*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/object |
|
268 | */ |
|
269 | public function object($object) |
|
270 | { |
|
271 | return $this->setProperty('object', $object); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Other co-agents that participated in the action indirectly. e.g. John |
|
276 | * wrote a book with *Steve*. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/participant |
|
283 | */ |
|
284 | public function participant($participant) |
|
285 | { |
|
286 | return $this->setProperty('participant', $participant); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * Indicates a potential Action, which describes an idealized action in |
|
291 | * which this thing would play an 'object' role. |
|
292 | * |
|
293 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
294 | * |
|
295 | * @return static |
|
296 | * |
|
297 | * @see http://schema.org/potentialAction |
|
298 | */ |
|
299 | public function potentialAction($potentialAction) |
|
300 | { |
|
301 | return $this->setProperty('potentialAction', $potentialAction); |
|
302 | } |
|
303 | ||
304 | /** |
|
305 | * A sub property of participant. The participant who is at the receiving |
|
306 | * end of the action. |
|
307 | * |
|
308 | * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[]|\Spatie\SchemaOrg\Contracts\ContactPointContract|\Spatie\SchemaOrg\Contracts\ContactPointContract[]|\Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $recipient |
|
309 | * |
|
310 | * @return static |
|
311 | * |
|
312 | * @see http://schema.org/recipient |
|
313 | */ |
|
314 | public function recipient($recipient) |
|
315 | { |
|
316 | return $this->setProperty('recipient', $recipient); |
|
317 | } |
|
318 | ||
319 | /** |
|
320 | * The result produced in the action. e.g. John wrote *a book*. |
|
321 | * |
|
322 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
323 | * |
|
324 | * @return static |
|
325 | * |
|
326 | * @see http://schema.org/result |
|
327 | */ |
|
328 | public function result($result) |
|
329 | { |
|
330 | return $this->setProperty('result', $result); |
|
331 | } |
|
332 | ||
333 | /** |
|
334 | * URL of a reference Web page that unambiguously indicates the item's |
|
335 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
336 | * official website. |
|
337 | * |
|
338 | * @param string|string[] $sameAs |
|
339 | * |
|
340 | * @return static |
|
341 | * |
|
342 | * @see http://schema.org/sameAs |
|
343 | */ |
|
344 | public function sameAs($sameAs) |
|
345 | { |
|
346 | return $this->setProperty('sameAs', $sameAs); |
|
347 | } |
|
348 | ||
349 | /** |
|
350 | * The startTime of something. For a reserved event or service (e.g. |
|
351 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
352 | * actions that span a period of time, when the action was performed. e.g. |
|
353 | * John wrote a book from *January* to December. For media, including audio |
|
354 | * and video, it's the time offset of the start of a clip within a larger |
|
355 | * file. |
|
356 | * |
|
357 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
358 | * when describing dates with times. This situation may be clarified in |
|
359 | * future revisions. |
|
360 | * |
|
361 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
362 | * |
|
363 | * @return static |
|
364 | * |
|
365 | * @see http://schema.org/startTime |
|
366 | */ |
|
367 | public function startTime($startTime) |
|
368 | { |
|
369 | return $this->setProperty('startTime', $startTime); |
|
370 | } |
|
371 | ||
372 | /** |
|
373 | * A CreativeWork or Event about this Thing. |
|
374 | * |
|
375 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
376 | * |
|
377 | * @return static |
|
378 | * |
|
379 | * @see http://schema.org/subjectOf |
|
380 | */ |
|
381 | public function subjectOf($subjectOf) |
|
382 | { |
|
383 | return $this->setProperty('subjectOf', $subjectOf); |
|
384 | } |
|
385 | ||
386 | /** |
|
387 | * Indicates a target EntryPoint for an Action. |
|
388 | * |
|
389 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/target |
|
394 | */ |
|
395 | public function target($target) |
|
396 | { |
|
397 | return $this->setProperty('target', $target); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * A sub property of location. The final location of the object or the agent |
|
402 | * after the action. |
|
403 | * |
|
404 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/toLocation |
|
409 | */ |
|
410 | public function toLocation($toLocation) |
|
411 | { |
|
412 | return $this->setProperty('toLocation', $toLocation); |
|
413 | } |
|
414 | ||
415 | /** |
|
416 | * URL of the item. |
|
417 | * |
|
418 | * @param string|string[] $url |
|
419 | * |
|
420 | * @return static |
|
421 | * |
|
422 | * @see http://schema.org/url |
|
423 | */ |
|
424 | public function url($url) |
|
425 | { |
|
426 | return $this->setProperty('url', $url); |
|
427 | } |
|
428 | ||
429 | } |
|
430 |
@@ 17-399 (lines=383) @@ | ||
14 | * @see http://schema.org/ReviewAction |
|
15 | * |
|
16 | */ |
|
17 | class ReviewAction extends BaseType implements ReviewActionContract, ActionContract, AssessActionContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * For failed actions, more information on the cause of the failure. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/error |
|
143 | */ |
|
144 | public function error($error) |
|
145 | { |
|
146 | return $this->setProperty('error', $error); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * The identifier property represents any kind of identifier for any kind of |
|
151 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
152 | * dedicated properties for representing many of these, either as textual |
|
153 | * strings or as URL (URI) links. See [background |
|
154 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
155 | * |
|
156 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
157 | * |
|
158 | * @return static |
|
159 | * |
|
160 | * @see http://schema.org/identifier |
|
161 | */ |
|
162 | public function identifier($identifier) |
|
163 | { |
|
164 | return $this->setProperty('identifier', $identifier); |
|
165 | } |
|
166 | ||
167 | /** |
|
168 | * An image of the item. This can be a [[URL]] or a fully described |
|
169 | * [[ImageObject]]. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/image |
|
176 | */ |
|
177 | public function image($image) |
|
178 | { |
|
179 | return $this->setProperty('image', $image); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * The object that helped the agent perform the action. e.g. John wrote a |
|
184 | * book with *a pen*. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/instrument |
|
191 | */ |
|
192 | public function instrument($instrument) |
|
193 | { |
|
194 | return $this->setProperty('instrument', $instrument); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The location of for example where the event is happening, an organization |
|
199 | * is located, or where an action takes place. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/location |
|
206 | */ |
|
207 | public function location($location) |
|
208 | { |
|
209 | return $this->setProperty('location', $location); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
214 | * entity being described. See [background |
|
215 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/mainEntityOfPage |
|
222 | */ |
|
223 | public function mainEntityOfPage($mainEntityOfPage) |
|
224 | { |
|
225 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The name of the item. |
|
230 | * |
|
231 | * @param string|string[] $name |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/name |
|
236 | */ |
|
237 | public function name($name) |
|
238 | { |
|
239 | return $this->setProperty('name', $name); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The object upon which the action is carried out, whose state is kept |
|
244 | * intact or changed. Also known as the semantic roles patient, affected or |
|
245 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
246 | * read *a book*. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/object |
|
253 | */ |
|
254 | public function object($object) |
|
255 | { |
|
256 | return $this->setProperty('object', $object); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * Other co-agents that participated in the action indirectly. e.g. John |
|
261 | * wrote a book with *Steve*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/participant |
|
268 | */ |
|
269 | public function participant($participant) |
|
270 | { |
|
271 | return $this->setProperty('participant', $participant); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Indicates a potential Action, which describes an idealized action in |
|
276 | * which this thing would play an 'object' role. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/potentialAction |
|
283 | */ |
|
284 | public function potentialAction($potentialAction) |
|
285 | { |
|
286 | return $this->setProperty('potentialAction', $potentialAction); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * The result produced in the action. e.g. John wrote *a book*. |
|
291 | * |
|
292 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
293 | * |
|
294 | * @return static |
|
295 | * |
|
296 | * @see http://schema.org/result |
|
297 | */ |
|
298 | public function result($result) |
|
299 | { |
|
300 | return $this->setProperty('result', $result); |
|
301 | } |
|
302 | ||
303 | /** |
|
304 | * A sub property of result. The review that resulted in the performing of |
|
305 | * the action. |
|
306 | * |
|
307 | * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $resultReview |
|
308 | * |
|
309 | * @return static |
|
310 | * |
|
311 | * @see http://schema.org/resultReview |
|
312 | */ |
|
313 | public function resultReview($resultReview) |
|
314 | { |
|
315 | return $this->setProperty('resultReview', $resultReview); |
|
316 | } |
|
317 | ||
318 | /** |
|
319 | * URL of a reference Web page that unambiguously indicates the item's |
|
320 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
321 | * official website. |
|
322 | * |
|
323 | * @param string|string[] $sameAs |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/sameAs |
|
328 | */ |
|
329 | public function sameAs($sameAs) |
|
330 | { |
|
331 | return $this->setProperty('sameAs', $sameAs); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * The startTime of something. For a reserved event or service (e.g. |
|
336 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
337 | * actions that span a period of time, when the action was performed. e.g. |
|
338 | * John wrote a book from *January* to December. For media, including audio |
|
339 | * and video, it's the time offset of the start of a clip within a larger |
|
340 | * file. |
|
341 | * |
|
342 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
343 | * when describing dates with times. This situation may be clarified in |
|
344 | * future revisions. |
|
345 | * |
|
346 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
347 | * |
|
348 | * @return static |
|
349 | * |
|
350 | * @see http://schema.org/startTime |
|
351 | */ |
|
352 | public function startTime($startTime) |
|
353 | { |
|
354 | return $this->setProperty('startTime', $startTime); |
|
355 | } |
|
356 | ||
357 | /** |
|
358 | * A CreativeWork or Event about this Thing. |
|
359 | * |
|
360 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
361 | * |
|
362 | * @return static |
|
363 | * |
|
364 | * @see http://schema.org/subjectOf |
|
365 | */ |
|
366 | public function subjectOf($subjectOf) |
|
367 | { |
|
368 | return $this->setProperty('subjectOf', $subjectOf); |
|
369 | } |
|
370 | ||
371 | /** |
|
372 | * Indicates a target EntryPoint for an Action. |
|
373 | * |
|
374 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
375 | * |
|
376 | * @return static |
|
377 | * |
|
378 | * @see http://schema.org/target |
|
379 | */ |
|
380 | public function target($target) |
|
381 | { |
|
382 | return $this->setProperty('target', $target); |
|
383 | } |
|
384 | ||
385 | /** |
|
386 | * URL of the item. |
|
387 | * |
|
388 | * @param string|string[] $url |
|
389 | * |
|
390 | * @return static |
|
391 | * |
|
392 | * @see http://schema.org/url |
|
393 | */ |
|
394 | public function url($url) |
|
395 | { |
|
396 | return $this->setProperty('url', $url); |
|
397 | } |
|
398 | ||
399 | } |
|
400 |
@@ 23-404 (lines=382) @@ | ||
20 | * @see http://schema.org/ScheduleAction |
|
21 | * |
|
22 | */ |
|
23 | class ScheduleAction extends BaseType implements ScheduleActionContract, ActionContract, OrganizeActionContract, PlanActionContract, ThingContract |
|
24 | { |
|
25 | /** |
|
26 | * Indicates the current disposition of the Action. |
|
27 | * |
|
28 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
29 | * |
|
30 | * @return static |
|
31 | * |
|
32 | * @see http://schema.org/actionStatus |
|
33 | */ |
|
34 | public function actionStatus($actionStatus) |
|
35 | { |
|
36 | return $this->setProperty('actionStatus', $actionStatus); |
|
37 | } |
|
38 | ||
39 | /** |
|
40 | * An additional type for the item, typically used for adding more specific |
|
41 | * types from external vocabularies in microdata syntax. This is a |
|
42 | * relationship between something and a class that the thing is in. In RDFa |
|
43 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
44 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
45 | * understanding of extra types, in particular those defined externally. |
|
46 | * |
|
47 | * @param string|string[] $additionalType |
|
48 | * |
|
49 | * @return static |
|
50 | * |
|
51 | * @see http://schema.org/additionalType |
|
52 | */ |
|
53 | public function additionalType($additionalType) |
|
54 | { |
|
55 | return $this->setProperty('additionalType', $additionalType); |
|
56 | } |
|
57 | ||
58 | /** |
|
59 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
60 | * *John* wrote a book. |
|
61 | * |
|
62 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
63 | * |
|
64 | * @return static |
|
65 | * |
|
66 | * @see http://schema.org/agent |
|
67 | */ |
|
68 | public function agent($agent) |
|
69 | { |
|
70 | return $this->setProperty('agent', $agent); |
|
71 | } |
|
72 | ||
73 | /** |
|
74 | * An alias for the item. |
|
75 | * |
|
76 | * @param string|string[] $alternateName |
|
77 | * |
|
78 | * @return static |
|
79 | * |
|
80 | * @see http://schema.org/alternateName |
|
81 | */ |
|
82 | public function alternateName($alternateName) |
|
83 | { |
|
84 | return $this->setProperty('alternateName', $alternateName); |
|
85 | } |
|
86 | ||
87 | /** |
|
88 | * A description of the item. |
|
89 | * |
|
90 | * @param string|string[] $description |
|
91 | * |
|
92 | * @return static |
|
93 | * |
|
94 | * @see http://schema.org/description |
|
95 | */ |
|
96 | public function description($description) |
|
97 | { |
|
98 | return $this->setProperty('description', $description); |
|
99 | } |
|
100 | ||
101 | /** |
|
102 | * A sub property of description. A short description of the item used to |
|
103 | * disambiguate from other, similar items. Information from other properties |
|
104 | * (in particular, name) may be necessary for the description to be useful |
|
105 | * for disambiguation. |
|
106 | * |
|
107 | * @param string|string[] $disambiguatingDescription |
|
108 | * |
|
109 | * @return static |
|
110 | * |
|
111 | * @see http://schema.org/disambiguatingDescription |
|
112 | */ |
|
113 | public function disambiguatingDescription($disambiguatingDescription) |
|
114 | { |
|
115 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
116 | } |
|
117 | ||
118 | /** |
|
119 | * The endTime of something. For a reserved event or service (e.g. |
|
120 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
121 | * actions that span a period of time, when the action was performed. e.g. |
|
122 | * John wrote a book from January to *December*. For media, including audio |
|
123 | * and video, it's the time offset of the end of a clip within a larger |
|
124 | * file. |
|
125 | * |
|
126 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
127 | * when describing dates with times. This situation may be clarified in |
|
128 | * future revisions. |
|
129 | * |
|
130 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
131 | * |
|
132 | * @return static |
|
133 | * |
|
134 | * @see http://schema.org/endTime |
|
135 | */ |
|
136 | public function endTime($endTime) |
|
137 | { |
|
138 | return $this->setProperty('endTime', $endTime); |
|
139 | } |
|
140 | ||
141 | /** |
|
142 | * For failed actions, more information on the cause of the failure. |
|
143 | * |
|
144 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
145 | * |
|
146 | * @return static |
|
147 | * |
|
148 | * @see http://schema.org/error |
|
149 | */ |
|
150 | public function error($error) |
|
151 | { |
|
152 | return $this->setProperty('error', $error); |
|
153 | } |
|
154 | ||
155 | /** |
|
156 | * The identifier property represents any kind of identifier for any kind of |
|
157 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
158 | * dedicated properties for representing many of these, either as textual |
|
159 | * strings or as URL (URI) links. See [background |
|
160 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
161 | * |
|
162 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
163 | * |
|
164 | * @return static |
|
165 | * |
|
166 | * @see http://schema.org/identifier |
|
167 | */ |
|
168 | public function identifier($identifier) |
|
169 | { |
|
170 | return $this->setProperty('identifier', $identifier); |
|
171 | } |
|
172 | ||
173 | /** |
|
174 | * An image of the item. This can be a [[URL]] or a fully described |
|
175 | * [[ImageObject]]. |
|
176 | * |
|
177 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
178 | * |
|
179 | * @return static |
|
180 | * |
|
181 | * @see http://schema.org/image |
|
182 | */ |
|
183 | public function image($image) |
|
184 | { |
|
185 | return $this->setProperty('image', $image); |
|
186 | } |
|
187 | ||
188 | /** |
|
189 | * The object that helped the agent perform the action. e.g. John wrote a |
|
190 | * book with *a pen*. |
|
191 | * |
|
192 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
193 | * |
|
194 | * @return static |
|
195 | * |
|
196 | * @see http://schema.org/instrument |
|
197 | */ |
|
198 | public function instrument($instrument) |
|
199 | { |
|
200 | return $this->setProperty('instrument', $instrument); |
|
201 | } |
|
202 | ||
203 | /** |
|
204 | * The location of for example where the event is happening, an organization |
|
205 | * is located, or where an action takes place. |
|
206 | * |
|
207 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
208 | * |
|
209 | * @return static |
|
210 | * |
|
211 | * @see http://schema.org/location |
|
212 | */ |
|
213 | public function location($location) |
|
214 | { |
|
215 | return $this->setProperty('location', $location); |
|
216 | } |
|
217 | ||
218 | /** |
|
219 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
220 | * entity being described. See [background |
|
221 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
222 | * |
|
223 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
224 | * |
|
225 | * @return static |
|
226 | * |
|
227 | * @see http://schema.org/mainEntityOfPage |
|
228 | */ |
|
229 | public function mainEntityOfPage($mainEntityOfPage) |
|
230 | { |
|
231 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
232 | } |
|
233 | ||
234 | /** |
|
235 | * The name of the item. |
|
236 | * |
|
237 | * @param string|string[] $name |
|
238 | * |
|
239 | * @return static |
|
240 | * |
|
241 | * @see http://schema.org/name |
|
242 | */ |
|
243 | public function name($name) |
|
244 | { |
|
245 | return $this->setProperty('name', $name); |
|
246 | } |
|
247 | ||
248 | /** |
|
249 | * The object upon which the action is carried out, whose state is kept |
|
250 | * intact or changed. Also known as the semantic roles patient, affected or |
|
251 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
252 | * read *a book*. |
|
253 | * |
|
254 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
255 | * |
|
256 | * @return static |
|
257 | * |
|
258 | * @see http://schema.org/object |
|
259 | */ |
|
260 | public function object($object) |
|
261 | { |
|
262 | return $this->setProperty('object', $object); |
|
263 | } |
|
264 | ||
265 | /** |
|
266 | * Other co-agents that participated in the action indirectly. e.g. John |
|
267 | * wrote a book with *Steve*. |
|
268 | * |
|
269 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
270 | * |
|
271 | * @return static |
|
272 | * |
|
273 | * @see http://schema.org/participant |
|
274 | */ |
|
275 | public function participant($participant) |
|
276 | { |
|
277 | return $this->setProperty('participant', $participant); |
|
278 | } |
|
279 | ||
280 | /** |
|
281 | * Indicates a potential Action, which describes an idealized action in |
|
282 | * which this thing would play an 'object' role. |
|
283 | * |
|
284 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
285 | * |
|
286 | * @return static |
|
287 | * |
|
288 | * @see http://schema.org/potentialAction |
|
289 | */ |
|
290 | public function potentialAction($potentialAction) |
|
291 | { |
|
292 | return $this->setProperty('potentialAction', $potentialAction); |
|
293 | } |
|
294 | ||
295 | /** |
|
296 | * The result produced in the action. e.g. John wrote *a book*. |
|
297 | * |
|
298 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
299 | * |
|
300 | * @return static |
|
301 | * |
|
302 | * @see http://schema.org/result |
|
303 | */ |
|
304 | public function result($result) |
|
305 | { |
|
306 | return $this->setProperty('result', $result); |
|
307 | } |
|
308 | ||
309 | /** |
|
310 | * URL of a reference Web page that unambiguously indicates the item's |
|
311 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
312 | * official website. |
|
313 | * |
|
314 | * @param string|string[] $sameAs |
|
315 | * |
|
316 | * @return static |
|
317 | * |
|
318 | * @see http://schema.org/sameAs |
|
319 | */ |
|
320 | public function sameAs($sameAs) |
|
321 | { |
|
322 | return $this->setProperty('sameAs', $sameAs); |
|
323 | } |
|
324 | ||
325 | /** |
|
326 | * The time the object is scheduled to. |
|
327 | * |
|
328 | * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime |
|
329 | * |
|
330 | * @return static |
|
331 | * |
|
332 | * @see http://schema.org/scheduledTime |
|
333 | */ |
|
334 | public function scheduledTime($scheduledTime) |
|
335 | { |
|
336 | return $this->setProperty('scheduledTime', $scheduledTime); |
|
337 | } |
|
338 | ||
339 | /** |
|
340 | * The startTime of something. For a reserved event or service (e.g. |
|
341 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
342 | * actions that span a period of time, when the action was performed. e.g. |
|
343 | * John wrote a book from *January* to December. For media, including audio |
|
344 | * and video, it's the time offset of the start of a clip within a larger |
|
345 | * file. |
|
346 | * |
|
347 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
348 | * when describing dates with times. This situation may be clarified in |
|
349 | * future revisions. |
|
350 | * |
|
351 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
352 | * |
|
353 | * @return static |
|
354 | * |
|
355 | * @see http://schema.org/startTime |
|
356 | */ |
|
357 | public function startTime($startTime) |
|
358 | { |
|
359 | return $this->setProperty('startTime', $startTime); |
|
360 | } |
|
361 | ||
362 | /** |
|
363 | * A CreativeWork or Event about this Thing. |
|
364 | * |
|
365 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
366 | * |
|
367 | * @return static |
|
368 | * |
|
369 | * @see http://schema.org/subjectOf |
|
370 | */ |
|
371 | public function subjectOf($subjectOf) |
|
372 | { |
|
373 | return $this->setProperty('subjectOf', $subjectOf); |
|
374 | } |
|
375 | ||
376 | /** |
|
377 | * Indicates a target EntryPoint for an Action. |
|
378 | * |
|
379 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
380 | * |
|
381 | * @return static |
|
382 | * |
|
383 | * @see http://schema.org/target |
|
384 | */ |
|
385 | public function target($target) |
|
386 | { |
|
387 | return $this->setProperty('target', $target); |
|
388 | } |
|
389 | ||
390 | /** |
|
391 | * URL of the item. |
|
392 | * |
|
393 | * @param string|string[] $url |
|
394 | * |
|
395 | * @return static |
|
396 | * |
|
397 | * @see http://schema.org/url |
|
398 | */ |
|
399 | public function url($url) |
|
400 | { |
|
401 | return $this->setProperty('url', $url); |
|
402 | } |
|
403 | ||
404 | } |
|
405 |
@@ 20-401 (lines=382) @@ | ||
17 | * @see http://schema.org/SearchAction |
|
18 | * |
|
19 | */ |
|
20 | class SearchAction extends BaseType implements SearchActionContract, ActionContract, ThingContract |
|
21 | { |
|
22 | /** |
|
23 | * Indicates the current disposition of the Action. |
|
24 | * |
|
25 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
26 | * |
|
27 | * @return static |
|
28 | * |
|
29 | * @see http://schema.org/actionStatus |
|
30 | */ |
|
31 | public function actionStatus($actionStatus) |
|
32 | { |
|
33 | return $this->setProperty('actionStatus', $actionStatus); |
|
34 | } |
|
35 | ||
36 | /** |
|
37 | * An additional type for the item, typically used for adding more specific |
|
38 | * types from external vocabularies in microdata syntax. This is a |
|
39 | * relationship between something and a class that the thing is in. In RDFa |
|
40 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
41 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
42 | * understanding of extra types, in particular those defined externally. |
|
43 | * |
|
44 | * @param string|string[] $additionalType |
|
45 | * |
|
46 | * @return static |
|
47 | * |
|
48 | * @see http://schema.org/additionalType |
|
49 | */ |
|
50 | public function additionalType($additionalType) |
|
51 | { |
|
52 | return $this->setProperty('additionalType', $additionalType); |
|
53 | } |
|
54 | ||
55 | /** |
|
56 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
57 | * *John* wrote a book. |
|
58 | * |
|
59 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
60 | * |
|
61 | * @return static |
|
62 | * |
|
63 | * @see http://schema.org/agent |
|
64 | */ |
|
65 | public function agent($agent) |
|
66 | { |
|
67 | return $this->setProperty('agent', $agent); |
|
68 | } |
|
69 | ||
70 | /** |
|
71 | * An alias for the item. |
|
72 | * |
|
73 | * @param string|string[] $alternateName |
|
74 | * |
|
75 | * @return static |
|
76 | * |
|
77 | * @see http://schema.org/alternateName |
|
78 | */ |
|
79 | public function alternateName($alternateName) |
|
80 | { |
|
81 | return $this->setProperty('alternateName', $alternateName); |
|
82 | } |
|
83 | ||
84 | /** |
|
85 | * A description of the item. |
|
86 | * |
|
87 | * @param string|string[] $description |
|
88 | * |
|
89 | * @return static |
|
90 | * |
|
91 | * @see http://schema.org/description |
|
92 | */ |
|
93 | public function description($description) |
|
94 | { |
|
95 | return $this->setProperty('description', $description); |
|
96 | } |
|
97 | ||
98 | /** |
|
99 | * A sub property of description. A short description of the item used to |
|
100 | * disambiguate from other, similar items. Information from other properties |
|
101 | * (in particular, name) may be necessary for the description to be useful |
|
102 | * for disambiguation. |
|
103 | * |
|
104 | * @param string|string[] $disambiguatingDescription |
|
105 | * |
|
106 | * @return static |
|
107 | * |
|
108 | * @see http://schema.org/disambiguatingDescription |
|
109 | */ |
|
110 | public function disambiguatingDescription($disambiguatingDescription) |
|
111 | { |
|
112 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
113 | } |
|
114 | ||
115 | /** |
|
116 | * The endTime of something. For a reserved event or service (e.g. |
|
117 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
118 | * actions that span a period of time, when the action was performed. e.g. |
|
119 | * John wrote a book from January to *December*. For media, including audio |
|
120 | * and video, it's the time offset of the end of a clip within a larger |
|
121 | * file. |
|
122 | * |
|
123 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
124 | * when describing dates with times. This situation may be clarified in |
|
125 | * future revisions. |
|
126 | * |
|
127 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
128 | * |
|
129 | * @return static |
|
130 | * |
|
131 | * @see http://schema.org/endTime |
|
132 | */ |
|
133 | public function endTime($endTime) |
|
134 | { |
|
135 | return $this->setProperty('endTime', $endTime); |
|
136 | } |
|
137 | ||
138 | /** |
|
139 | * For failed actions, more information on the cause of the failure. |
|
140 | * |
|
141 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
142 | * |
|
143 | * @return static |
|
144 | * |
|
145 | * @see http://schema.org/error |
|
146 | */ |
|
147 | public function error($error) |
|
148 | { |
|
149 | return $this->setProperty('error', $error); |
|
150 | } |
|
151 | ||
152 | /** |
|
153 | * The identifier property represents any kind of identifier for any kind of |
|
154 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
155 | * dedicated properties for representing many of these, either as textual |
|
156 | * strings or as URL (URI) links. See [background |
|
157 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
158 | * |
|
159 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
160 | * |
|
161 | * @return static |
|
162 | * |
|
163 | * @see http://schema.org/identifier |
|
164 | */ |
|
165 | public function identifier($identifier) |
|
166 | { |
|
167 | return $this->setProperty('identifier', $identifier); |
|
168 | } |
|
169 | ||
170 | /** |
|
171 | * An image of the item. This can be a [[URL]] or a fully described |
|
172 | * [[ImageObject]]. |
|
173 | * |
|
174 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
175 | * |
|
176 | * @return static |
|
177 | * |
|
178 | * @see http://schema.org/image |
|
179 | */ |
|
180 | public function image($image) |
|
181 | { |
|
182 | return $this->setProperty('image', $image); |
|
183 | } |
|
184 | ||
185 | /** |
|
186 | * The object that helped the agent perform the action. e.g. John wrote a |
|
187 | * book with *a pen*. |
|
188 | * |
|
189 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
190 | * |
|
191 | * @return static |
|
192 | * |
|
193 | * @see http://schema.org/instrument |
|
194 | */ |
|
195 | public function instrument($instrument) |
|
196 | { |
|
197 | return $this->setProperty('instrument', $instrument); |
|
198 | } |
|
199 | ||
200 | /** |
|
201 | * The location of for example where the event is happening, an organization |
|
202 | * is located, or where an action takes place. |
|
203 | * |
|
204 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
205 | * |
|
206 | * @return static |
|
207 | * |
|
208 | * @see http://schema.org/location |
|
209 | */ |
|
210 | public function location($location) |
|
211 | { |
|
212 | return $this->setProperty('location', $location); |
|
213 | } |
|
214 | ||
215 | /** |
|
216 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
217 | * entity being described. See [background |
|
218 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
219 | * |
|
220 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
221 | * |
|
222 | * @return static |
|
223 | * |
|
224 | * @see http://schema.org/mainEntityOfPage |
|
225 | */ |
|
226 | public function mainEntityOfPage($mainEntityOfPage) |
|
227 | { |
|
228 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
229 | } |
|
230 | ||
231 | /** |
|
232 | * The name of the item. |
|
233 | * |
|
234 | * @param string|string[] $name |
|
235 | * |
|
236 | * @return static |
|
237 | * |
|
238 | * @see http://schema.org/name |
|
239 | */ |
|
240 | public function name($name) |
|
241 | { |
|
242 | return $this->setProperty('name', $name); |
|
243 | } |
|
244 | ||
245 | /** |
|
246 | * The object upon which the action is carried out, whose state is kept |
|
247 | * intact or changed. Also known as the semantic roles patient, affected or |
|
248 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
249 | * read *a book*. |
|
250 | * |
|
251 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
252 | * |
|
253 | * @return static |
|
254 | * |
|
255 | * @see http://schema.org/object |
|
256 | */ |
|
257 | public function object($object) |
|
258 | { |
|
259 | return $this->setProperty('object', $object); |
|
260 | } |
|
261 | ||
262 | /** |
|
263 | * Other co-agents that participated in the action indirectly. e.g. John |
|
264 | * wrote a book with *Steve*. |
|
265 | * |
|
266 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
267 | * |
|
268 | * @return static |
|
269 | * |
|
270 | * @see http://schema.org/participant |
|
271 | */ |
|
272 | public function participant($participant) |
|
273 | { |
|
274 | return $this->setProperty('participant', $participant); |
|
275 | } |
|
276 | ||
277 | /** |
|
278 | * Indicates a potential Action, which describes an idealized action in |
|
279 | * which this thing would play an 'object' role. |
|
280 | * |
|
281 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
282 | * |
|
283 | * @return static |
|
284 | * |
|
285 | * @see http://schema.org/potentialAction |
|
286 | */ |
|
287 | public function potentialAction($potentialAction) |
|
288 | { |
|
289 | return $this->setProperty('potentialAction', $potentialAction); |
|
290 | } |
|
291 | ||
292 | /** |
|
293 | * A sub property of instrument. The query used on this action. |
|
294 | * |
|
295 | * @param string|string[] $query |
|
296 | * |
|
297 | * @return static |
|
298 | * |
|
299 | * @see http://schema.org/query |
|
300 | */ |
|
301 | public function query($query) |
|
302 | { |
|
303 | return $this->setProperty('query', $query); |
|
304 | } |
|
305 | ||
306 | /** |
|
307 | * The result produced in the action. e.g. John wrote *a book*. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/result |
|
314 | */ |
|
315 | public function result($result) |
|
316 | { |
|
317 | return $this->setProperty('result', $result); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * URL of a reference Web page that unambiguously indicates the item's |
|
322 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
323 | * official website. |
|
324 | * |
|
325 | * @param string|string[] $sameAs |
|
326 | * |
|
327 | * @return static |
|
328 | * |
|
329 | * @see http://schema.org/sameAs |
|
330 | */ |
|
331 | public function sameAs($sameAs) |
|
332 | { |
|
333 | return $this->setProperty('sameAs', $sameAs); |
|
334 | } |
|
335 | ||
336 | /** |
|
337 | * The startTime of something. For a reserved event or service (e.g. |
|
338 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
339 | * actions that span a period of time, when the action was performed. e.g. |
|
340 | * John wrote a book from *January* to December. For media, including audio |
|
341 | * and video, it's the time offset of the start of a clip within a larger |
|
342 | * file. |
|
343 | * |
|
344 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
345 | * when describing dates with times. This situation may be clarified in |
|
346 | * future revisions. |
|
347 | * |
|
348 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
349 | * |
|
350 | * @return static |
|
351 | * |
|
352 | * @see http://schema.org/startTime |
|
353 | */ |
|
354 | public function startTime($startTime) |
|
355 | { |
|
356 | return $this->setProperty('startTime', $startTime); |
|
357 | } |
|
358 | ||
359 | /** |
|
360 | * A CreativeWork or Event about this Thing. |
|
361 | * |
|
362 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
363 | * |
|
364 | * @return static |
|
365 | * |
|
366 | * @see http://schema.org/subjectOf |
|
367 | */ |
|
368 | public function subjectOf($subjectOf) |
|
369 | { |
|
370 | return $this->setProperty('subjectOf', $subjectOf); |
|
371 | } |
|
372 | ||
373 | /** |
|
374 | * Indicates a target EntryPoint for an Action. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/target |
|
381 | */ |
|
382 | public function target($target) |
|
383 | { |
|
384 | return $this->setProperty('target', $target); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * URL of the item. |
|
389 | * |
|
390 | * @param string|string[] $url |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/url |
|
395 | */ |
|
396 | public function url($url) |
|
397 | { |
|
398 | return $this->setProperty('url', $url); |
|
399 | } |
|
400 | ||
401 | } |
|
402 |
@@ 23-420 (lines=398) @@ | ||
20 | * @see http://schema.org/TakeAction |
|
21 | * |
|
22 | */ |
|
23 | class TakeAction extends BaseType implements TakeActionContract, ActionContract, ThingContract, TransferActionContract |
|
24 | { |
|
25 | /** |
|
26 | * Indicates the current disposition of the Action. |
|
27 | * |
|
28 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
29 | * |
|
30 | * @return static |
|
31 | * |
|
32 | * @see http://schema.org/actionStatus |
|
33 | */ |
|
34 | public function actionStatus($actionStatus) |
|
35 | { |
|
36 | return $this->setProperty('actionStatus', $actionStatus); |
|
37 | } |
|
38 | ||
39 | /** |
|
40 | * An additional type for the item, typically used for adding more specific |
|
41 | * types from external vocabularies in microdata syntax. This is a |
|
42 | * relationship between something and a class that the thing is in. In RDFa |
|
43 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
44 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
45 | * understanding of extra types, in particular those defined externally. |
|
46 | * |
|
47 | * @param string|string[] $additionalType |
|
48 | * |
|
49 | * @return static |
|
50 | * |
|
51 | * @see http://schema.org/additionalType |
|
52 | */ |
|
53 | public function additionalType($additionalType) |
|
54 | { |
|
55 | return $this->setProperty('additionalType', $additionalType); |
|
56 | } |
|
57 | ||
58 | /** |
|
59 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
60 | * *John* wrote a book. |
|
61 | * |
|
62 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
63 | * |
|
64 | * @return static |
|
65 | * |
|
66 | * @see http://schema.org/agent |
|
67 | */ |
|
68 | public function agent($agent) |
|
69 | { |
|
70 | return $this->setProperty('agent', $agent); |
|
71 | } |
|
72 | ||
73 | /** |
|
74 | * An alias for the item. |
|
75 | * |
|
76 | * @param string|string[] $alternateName |
|
77 | * |
|
78 | * @return static |
|
79 | * |
|
80 | * @see http://schema.org/alternateName |
|
81 | */ |
|
82 | public function alternateName($alternateName) |
|
83 | { |
|
84 | return $this->setProperty('alternateName', $alternateName); |
|
85 | } |
|
86 | ||
87 | /** |
|
88 | * A description of the item. |
|
89 | * |
|
90 | * @param string|string[] $description |
|
91 | * |
|
92 | * @return static |
|
93 | * |
|
94 | * @see http://schema.org/description |
|
95 | */ |
|
96 | public function description($description) |
|
97 | { |
|
98 | return $this->setProperty('description', $description); |
|
99 | } |
|
100 | ||
101 | /** |
|
102 | * A sub property of description. A short description of the item used to |
|
103 | * disambiguate from other, similar items. Information from other properties |
|
104 | * (in particular, name) may be necessary for the description to be useful |
|
105 | * for disambiguation. |
|
106 | * |
|
107 | * @param string|string[] $disambiguatingDescription |
|
108 | * |
|
109 | * @return static |
|
110 | * |
|
111 | * @see http://schema.org/disambiguatingDescription |
|
112 | */ |
|
113 | public function disambiguatingDescription($disambiguatingDescription) |
|
114 | { |
|
115 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
116 | } |
|
117 | ||
118 | /** |
|
119 | * The endTime of something. For a reserved event or service (e.g. |
|
120 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
121 | * actions that span a period of time, when the action was performed. e.g. |
|
122 | * John wrote a book from January to *December*. For media, including audio |
|
123 | * and video, it's the time offset of the end of a clip within a larger |
|
124 | * file. |
|
125 | * |
|
126 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
127 | * when describing dates with times. This situation may be clarified in |
|
128 | * future revisions. |
|
129 | * |
|
130 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
131 | * |
|
132 | * @return static |
|
133 | * |
|
134 | * @see http://schema.org/endTime |
|
135 | */ |
|
136 | public function endTime($endTime) |
|
137 | { |
|
138 | return $this->setProperty('endTime', $endTime); |
|
139 | } |
|
140 | ||
141 | /** |
|
142 | * For failed actions, more information on the cause of the failure. |
|
143 | * |
|
144 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
145 | * |
|
146 | * @return static |
|
147 | * |
|
148 | * @see http://schema.org/error |
|
149 | */ |
|
150 | public function error($error) |
|
151 | { |
|
152 | return $this->setProperty('error', $error); |
|
153 | } |
|
154 | ||
155 | /** |
|
156 | * A sub property of location. The original location of the object or the |
|
157 | * agent before the action. |
|
158 | * |
|
159 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
160 | * |
|
161 | * @return static |
|
162 | * |
|
163 | * @see http://schema.org/fromLocation |
|
164 | */ |
|
165 | public function fromLocation($fromLocation) |
|
166 | { |
|
167 | return $this->setProperty('fromLocation', $fromLocation); |
|
168 | } |
|
169 | ||
170 | /** |
|
171 | * The identifier property represents any kind of identifier for any kind of |
|
172 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
173 | * dedicated properties for representing many of these, either as textual |
|
174 | * strings or as URL (URI) links. See [background |
|
175 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
176 | * |
|
177 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
178 | * |
|
179 | * @return static |
|
180 | * |
|
181 | * @see http://schema.org/identifier |
|
182 | */ |
|
183 | public function identifier($identifier) |
|
184 | { |
|
185 | return $this->setProperty('identifier', $identifier); |
|
186 | } |
|
187 | ||
188 | /** |
|
189 | * An image of the item. This can be a [[URL]] or a fully described |
|
190 | * [[ImageObject]]. |
|
191 | * |
|
192 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
193 | * |
|
194 | * @return static |
|
195 | * |
|
196 | * @see http://schema.org/image |
|
197 | */ |
|
198 | public function image($image) |
|
199 | { |
|
200 | return $this->setProperty('image', $image); |
|
201 | } |
|
202 | ||
203 | /** |
|
204 | * The object that helped the agent perform the action. e.g. John wrote a |
|
205 | * book with *a pen*. |
|
206 | * |
|
207 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
208 | * |
|
209 | * @return static |
|
210 | * |
|
211 | * @see http://schema.org/instrument |
|
212 | */ |
|
213 | public function instrument($instrument) |
|
214 | { |
|
215 | return $this->setProperty('instrument', $instrument); |
|
216 | } |
|
217 | ||
218 | /** |
|
219 | * The location of for example where the event is happening, an organization |
|
220 | * is located, or where an action takes place. |
|
221 | * |
|
222 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
223 | * |
|
224 | * @return static |
|
225 | * |
|
226 | * @see http://schema.org/location |
|
227 | */ |
|
228 | public function location($location) |
|
229 | { |
|
230 | return $this->setProperty('location', $location); |
|
231 | } |
|
232 | ||
233 | /** |
|
234 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
235 | * entity being described. See [background |
|
236 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
237 | * |
|
238 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
239 | * |
|
240 | * @return static |
|
241 | * |
|
242 | * @see http://schema.org/mainEntityOfPage |
|
243 | */ |
|
244 | public function mainEntityOfPage($mainEntityOfPage) |
|
245 | { |
|
246 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
247 | } |
|
248 | ||
249 | /** |
|
250 | * The name of the item. |
|
251 | * |
|
252 | * @param string|string[] $name |
|
253 | * |
|
254 | * @return static |
|
255 | * |
|
256 | * @see http://schema.org/name |
|
257 | */ |
|
258 | public function name($name) |
|
259 | { |
|
260 | return $this->setProperty('name', $name); |
|
261 | } |
|
262 | ||
263 | /** |
|
264 | * The object upon which the action is carried out, whose state is kept |
|
265 | * intact or changed. Also known as the semantic roles patient, affected or |
|
266 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
267 | * read *a book*. |
|
268 | * |
|
269 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
270 | * |
|
271 | * @return static |
|
272 | * |
|
273 | * @see http://schema.org/object |
|
274 | */ |
|
275 | public function object($object) |
|
276 | { |
|
277 | return $this->setProperty('object', $object); |
|
278 | } |
|
279 | ||
280 | /** |
|
281 | * Other co-agents that participated in the action indirectly. e.g. John |
|
282 | * wrote a book with *Steve*. |
|
283 | * |
|
284 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
285 | * |
|
286 | * @return static |
|
287 | * |
|
288 | * @see http://schema.org/participant |
|
289 | */ |
|
290 | public function participant($participant) |
|
291 | { |
|
292 | return $this->setProperty('participant', $participant); |
|
293 | } |
|
294 | ||
295 | /** |
|
296 | * Indicates a potential Action, which describes an idealized action in |
|
297 | * which this thing would play an 'object' role. |
|
298 | * |
|
299 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
300 | * |
|
301 | * @return static |
|
302 | * |
|
303 | * @see http://schema.org/potentialAction |
|
304 | */ |
|
305 | public function potentialAction($potentialAction) |
|
306 | { |
|
307 | return $this->setProperty('potentialAction', $potentialAction); |
|
308 | } |
|
309 | ||
310 | /** |
|
311 | * The result produced in the action. e.g. John wrote *a book*. |
|
312 | * |
|
313 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
314 | * |
|
315 | * @return static |
|
316 | * |
|
317 | * @see http://schema.org/result |
|
318 | */ |
|
319 | public function result($result) |
|
320 | { |
|
321 | return $this->setProperty('result', $result); |
|
322 | } |
|
323 | ||
324 | /** |
|
325 | * URL of a reference Web page that unambiguously indicates the item's |
|
326 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
327 | * official website. |
|
328 | * |
|
329 | * @param string|string[] $sameAs |
|
330 | * |
|
331 | * @return static |
|
332 | * |
|
333 | * @see http://schema.org/sameAs |
|
334 | */ |
|
335 | public function sameAs($sameAs) |
|
336 | { |
|
337 | return $this->setProperty('sameAs', $sameAs); |
|
338 | } |
|
339 | ||
340 | /** |
|
341 | * The startTime of something. For a reserved event or service (e.g. |
|
342 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
343 | * actions that span a period of time, when the action was performed. e.g. |
|
344 | * John wrote a book from *January* to December. For media, including audio |
|
345 | * and video, it's the time offset of the start of a clip within a larger |
|
346 | * file. |
|
347 | * |
|
348 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
349 | * when describing dates with times. This situation may be clarified in |
|
350 | * future revisions. |
|
351 | * |
|
352 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
353 | * |
|
354 | * @return static |
|
355 | * |
|
356 | * @see http://schema.org/startTime |
|
357 | */ |
|
358 | public function startTime($startTime) |
|
359 | { |
|
360 | return $this->setProperty('startTime', $startTime); |
|
361 | } |
|
362 | ||
363 | /** |
|
364 | * A CreativeWork or Event about this Thing. |
|
365 | * |
|
366 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
367 | * |
|
368 | * @return static |
|
369 | * |
|
370 | * @see http://schema.org/subjectOf |
|
371 | */ |
|
372 | public function subjectOf($subjectOf) |
|
373 | { |
|
374 | return $this->setProperty('subjectOf', $subjectOf); |
|
375 | } |
|
376 | ||
377 | /** |
|
378 | * Indicates a target EntryPoint for an Action. |
|
379 | * |
|
380 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
381 | * |
|
382 | * @return static |
|
383 | * |
|
384 | * @see http://schema.org/target |
|
385 | */ |
|
386 | public function target($target) |
|
387 | { |
|
388 | return $this->setProperty('target', $target); |
|
389 | } |
|
390 | ||
391 | /** |
|
392 | * A sub property of location. The final location of the object or the agent |
|
393 | * after the action. |
|
394 | * |
|
395 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
396 | * |
|
397 | * @return static |
|
398 | * |
|
399 | * @see http://schema.org/toLocation |
|
400 | */ |
|
401 | public function toLocation($toLocation) |
|
402 | { |
|
403 | return $this->setProperty('toLocation', $toLocation); |
|
404 | } |
|
405 | ||
406 | /** |
|
407 | * URL of the item. |
|
408 | * |
|
409 | * @param string|string[] $url |
|
410 | * |
|
411 | * @return static |
|
412 | * |
|
413 | * @see http://schema.org/url |
|
414 | */ |
|
415 | public function url($url) |
|
416 | { |
|
417 | return $this->setProperty('url', $url); |
|
418 | } |
|
419 | ||
420 | } |
|
421 |
@@ 23-404 (lines=382) @@ | ||
20 | * @see http://schema.org/TrackAction |
|
21 | * |
|
22 | */ |
|
23 | class TrackAction extends BaseType implements TrackActionContract, ActionContract, FindActionContract, ThingContract |
|
24 | { |
|
25 | /** |
|
26 | * Indicates the current disposition of the Action. |
|
27 | * |
|
28 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
29 | * |
|
30 | * @return static |
|
31 | * |
|
32 | * @see http://schema.org/actionStatus |
|
33 | */ |
|
34 | public function actionStatus($actionStatus) |
|
35 | { |
|
36 | return $this->setProperty('actionStatus', $actionStatus); |
|
37 | } |
|
38 | ||
39 | /** |
|
40 | * An additional type for the item, typically used for adding more specific |
|
41 | * types from external vocabularies in microdata syntax. This is a |
|
42 | * relationship between something and a class that the thing is in. In RDFa |
|
43 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
44 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
45 | * understanding of extra types, in particular those defined externally. |
|
46 | * |
|
47 | * @param string|string[] $additionalType |
|
48 | * |
|
49 | * @return static |
|
50 | * |
|
51 | * @see http://schema.org/additionalType |
|
52 | */ |
|
53 | public function additionalType($additionalType) |
|
54 | { |
|
55 | return $this->setProperty('additionalType', $additionalType); |
|
56 | } |
|
57 | ||
58 | /** |
|
59 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
60 | * *John* wrote a book. |
|
61 | * |
|
62 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
63 | * |
|
64 | * @return static |
|
65 | * |
|
66 | * @see http://schema.org/agent |
|
67 | */ |
|
68 | public function agent($agent) |
|
69 | { |
|
70 | return $this->setProperty('agent', $agent); |
|
71 | } |
|
72 | ||
73 | /** |
|
74 | * An alias for the item. |
|
75 | * |
|
76 | * @param string|string[] $alternateName |
|
77 | * |
|
78 | * @return static |
|
79 | * |
|
80 | * @see http://schema.org/alternateName |
|
81 | */ |
|
82 | public function alternateName($alternateName) |
|
83 | { |
|
84 | return $this->setProperty('alternateName', $alternateName); |
|
85 | } |
|
86 | ||
87 | /** |
|
88 | * A sub property of instrument. The method of delivery. |
|
89 | * |
|
90 | * @param \Spatie\SchemaOrg\Contracts\DeliveryMethodContract|\Spatie\SchemaOrg\Contracts\DeliveryMethodContract[] $deliveryMethod |
|
91 | * |
|
92 | * @return static |
|
93 | * |
|
94 | * @see http://schema.org/deliveryMethod |
|
95 | */ |
|
96 | public function deliveryMethod($deliveryMethod) |
|
97 | { |
|
98 | return $this->setProperty('deliveryMethod', $deliveryMethod); |
|
99 | } |
|
100 | ||
101 | /** |
|
102 | * A description of the item. |
|
103 | * |
|
104 | * @param string|string[] $description |
|
105 | * |
|
106 | * @return static |
|
107 | * |
|
108 | * @see http://schema.org/description |
|
109 | */ |
|
110 | public function description($description) |
|
111 | { |
|
112 | return $this->setProperty('description', $description); |
|
113 | } |
|
114 | ||
115 | /** |
|
116 | * A sub property of description. A short description of the item used to |
|
117 | * disambiguate from other, similar items. Information from other properties |
|
118 | * (in particular, name) may be necessary for the description to be useful |
|
119 | * for disambiguation. |
|
120 | * |
|
121 | * @param string|string[] $disambiguatingDescription |
|
122 | * |
|
123 | * @return static |
|
124 | * |
|
125 | * @see http://schema.org/disambiguatingDescription |
|
126 | */ |
|
127 | public function disambiguatingDescription($disambiguatingDescription) |
|
128 | { |
|
129 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
130 | } |
|
131 | ||
132 | /** |
|
133 | * The endTime of something. For a reserved event or service (e.g. |
|
134 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
135 | * actions that span a period of time, when the action was performed. e.g. |
|
136 | * John wrote a book from January to *December*. For media, including audio |
|
137 | * and video, it's the time offset of the end of a clip within a larger |
|
138 | * file. |
|
139 | * |
|
140 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
141 | * when describing dates with times. This situation may be clarified in |
|
142 | * future revisions. |
|
143 | * |
|
144 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
145 | * |
|
146 | * @return static |
|
147 | * |
|
148 | * @see http://schema.org/endTime |
|
149 | */ |
|
150 | public function endTime($endTime) |
|
151 | { |
|
152 | return $this->setProperty('endTime', $endTime); |
|
153 | } |
|
154 | ||
155 | /** |
|
156 | * For failed actions, more information on the cause of the failure. |
|
157 | * |
|
158 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
159 | * |
|
160 | * @return static |
|
161 | * |
|
162 | * @see http://schema.org/error |
|
163 | */ |
|
164 | public function error($error) |
|
165 | { |
|
166 | return $this->setProperty('error', $error); |
|
167 | } |
|
168 | ||
169 | /** |
|
170 | * The identifier property represents any kind of identifier for any kind of |
|
171 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
172 | * dedicated properties for representing many of these, either as textual |
|
173 | * strings or as URL (URI) links. See [background |
|
174 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
175 | * |
|
176 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
177 | * |
|
178 | * @return static |
|
179 | * |
|
180 | * @see http://schema.org/identifier |
|
181 | */ |
|
182 | public function identifier($identifier) |
|
183 | { |
|
184 | return $this->setProperty('identifier', $identifier); |
|
185 | } |
|
186 | ||
187 | /** |
|
188 | * An image of the item. This can be a [[URL]] or a fully described |
|
189 | * [[ImageObject]]. |
|
190 | * |
|
191 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
192 | * |
|
193 | * @return static |
|
194 | * |
|
195 | * @see http://schema.org/image |
|
196 | */ |
|
197 | public function image($image) |
|
198 | { |
|
199 | return $this->setProperty('image', $image); |
|
200 | } |
|
201 | ||
202 | /** |
|
203 | * The object that helped the agent perform the action. e.g. John wrote a |
|
204 | * book with *a pen*. |
|
205 | * |
|
206 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
207 | * |
|
208 | * @return static |
|
209 | * |
|
210 | * @see http://schema.org/instrument |
|
211 | */ |
|
212 | public function instrument($instrument) |
|
213 | { |
|
214 | return $this->setProperty('instrument', $instrument); |
|
215 | } |
|
216 | ||
217 | /** |
|
218 | * The location of for example where the event is happening, an organization |
|
219 | * is located, or where an action takes place. |
|
220 | * |
|
221 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
222 | * |
|
223 | * @return static |
|
224 | * |
|
225 | * @see http://schema.org/location |
|
226 | */ |
|
227 | public function location($location) |
|
228 | { |
|
229 | return $this->setProperty('location', $location); |
|
230 | } |
|
231 | ||
232 | /** |
|
233 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
234 | * entity being described. See [background |
|
235 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
236 | * |
|
237 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
238 | * |
|
239 | * @return static |
|
240 | * |
|
241 | * @see http://schema.org/mainEntityOfPage |
|
242 | */ |
|
243 | public function mainEntityOfPage($mainEntityOfPage) |
|
244 | { |
|
245 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
246 | } |
|
247 | ||
248 | /** |
|
249 | * The name of the item. |
|
250 | * |
|
251 | * @param string|string[] $name |
|
252 | * |
|
253 | * @return static |
|
254 | * |
|
255 | * @see http://schema.org/name |
|
256 | */ |
|
257 | public function name($name) |
|
258 | { |
|
259 | return $this->setProperty('name', $name); |
|
260 | } |
|
261 | ||
262 | /** |
|
263 | * The object upon which the action is carried out, whose state is kept |
|
264 | * intact or changed. Also known as the semantic roles patient, affected or |
|
265 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
266 | * read *a book*. |
|
267 | * |
|
268 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
269 | * |
|
270 | * @return static |
|
271 | * |
|
272 | * @see http://schema.org/object |
|
273 | */ |
|
274 | public function object($object) |
|
275 | { |
|
276 | return $this->setProperty('object', $object); |
|
277 | } |
|
278 | ||
279 | /** |
|
280 | * Other co-agents that participated in the action indirectly. e.g. John |
|
281 | * wrote a book with *Steve*. |
|
282 | * |
|
283 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
284 | * |
|
285 | * @return static |
|
286 | * |
|
287 | * @see http://schema.org/participant |
|
288 | */ |
|
289 | public function participant($participant) |
|
290 | { |
|
291 | return $this->setProperty('participant', $participant); |
|
292 | } |
|
293 | ||
294 | /** |
|
295 | * Indicates a potential Action, which describes an idealized action in |
|
296 | * which this thing would play an 'object' role. |
|
297 | * |
|
298 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
299 | * |
|
300 | * @return static |
|
301 | * |
|
302 | * @see http://schema.org/potentialAction |
|
303 | */ |
|
304 | public function potentialAction($potentialAction) |
|
305 | { |
|
306 | return $this->setProperty('potentialAction', $potentialAction); |
|
307 | } |
|
308 | ||
309 | /** |
|
310 | * The result produced in the action. e.g. John wrote *a book*. |
|
311 | * |
|
312 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
313 | * |
|
314 | * @return static |
|
315 | * |
|
316 | * @see http://schema.org/result |
|
317 | */ |
|
318 | public function result($result) |
|
319 | { |
|
320 | return $this->setProperty('result', $result); |
|
321 | } |
|
322 | ||
323 | /** |
|
324 | * URL of a reference Web page that unambiguously indicates the item's |
|
325 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
326 | * official website. |
|
327 | * |
|
328 | * @param string|string[] $sameAs |
|
329 | * |
|
330 | * @return static |
|
331 | * |
|
332 | * @see http://schema.org/sameAs |
|
333 | */ |
|
334 | public function sameAs($sameAs) |
|
335 | { |
|
336 | return $this->setProperty('sameAs', $sameAs); |
|
337 | } |
|
338 | ||
339 | /** |
|
340 | * The startTime of something. For a reserved event or service (e.g. |
|
341 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
342 | * actions that span a period of time, when the action was performed. e.g. |
|
343 | * John wrote a book from *January* to December. For media, including audio |
|
344 | * and video, it's the time offset of the start of a clip within a larger |
|
345 | * file. |
|
346 | * |
|
347 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
348 | * when describing dates with times. This situation may be clarified in |
|
349 | * future revisions. |
|
350 | * |
|
351 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
352 | * |
|
353 | * @return static |
|
354 | * |
|
355 | * @see http://schema.org/startTime |
|
356 | */ |
|
357 | public function startTime($startTime) |
|
358 | { |
|
359 | return $this->setProperty('startTime', $startTime); |
|
360 | } |
|
361 | ||
362 | /** |
|
363 | * A CreativeWork or Event about this Thing. |
|
364 | * |
|
365 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
366 | * |
|
367 | * @return static |
|
368 | * |
|
369 | * @see http://schema.org/subjectOf |
|
370 | */ |
|
371 | public function subjectOf($subjectOf) |
|
372 | { |
|
373 | return $this->setProperty('subjectOf', $subjectOf); |
|
374 | } |
|
375 | ||
376 | /** |
|
377 | * Indicates a target EntryPoint for an Action. |
|
378 | * |
|
379 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
380 | * |
|
381 | * @return static |
|
382 | * |
|
383 | * @see http://schema.org/target |
|
384 | */ |
|
385 | public function target($target) |
|
386 | { |
|
387 | return $this->setProperty('target', $target); |
|
388 | } |
|
389 | ||
390 | /** |
|
391 | * URL of the item. |
|
392 | * |
|
393 | * @param string|string[] $url |
|
394 | * |
|
395 | * @return static |
|
396 | * |
|
397 | * @see http://schema.org/url |
|
398 | */ |
|
399 | public function url($url) |
|
400 | { |
|
401 | return $this->setProperty('url', $url); |
|
402 | } |
|
403 | ||
404 | } |
|
405 |
@@ 17-459 (lines=443) @@ | ||
14 | * @see http://schema.org/TradeAction |
|
15 | * |
|
16 | */ |
|
17 | class TradeAction extends BaseType implements TradeActionContract, ActionContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The endTime of something. For a reserved event or service (e.g. |
|
114 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
115 | * actions that span a period of time, when the action was performed. e.g. |
|
116 | * John wrote a book from January to *December*. For media, including audio |
|
117 | * and video, it's the time offset of the end of a clip within a larger |
|
118 | * file. |
|
119 | * |
|
120 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
121 | * when describing dates with times. This situation may be clarified in |
|
122 | * future revisions. |
|
123 | * |
|
124 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
125 | * |
|
126 | * @return static |
|
127 | * |
|
128 | * @see http://schema.org/endTime |
|
129 | */ |
|
130 | public function endTime($endTime) |
|
131 | { |
|
132 | return $this->setProperty('endTime', $endTime); |
|
133 | } |
|
134 | ||
135 | /** |
|
136 | * For failed actions, more information on the cause of the failure. |
|
137 | * |
|
138 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/error |
|
143 | */ |
|
144 | public function error($error) |
|
145 | { |
|
146 | return $this->setProperty('error', $error); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * The identifier property represents any kind of identifier for any kind of |
|
151 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
152 | * dedicated properties for representing many of these, either as textual |
|
153 | * strings or as URL (URI) links. See [background |
|
154 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
155 | * |
|
156 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
157 | * |
|
158 | * @return static |
|
159 | * |
|
160 | * @see http://schema.org/identifier |
|
161 | */ |
|
162 | public function identifier($identifier) |
|
163 | { |
|
164 | return $this->setProperty('identifier', $identifier); |
|
165 | } |
|
166 | ||
167 | /** |
|
168 | * An image of the item. This can be a [[URL]] or a fully described |
|
169 | * [[ImageObject]]. |
|
170 | * |
|
171 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
172 | * |
|
173 | * @return static |
|
174 | * |
|
175 | * @see http://schema.org/image |
|
176 | */ |
|
177 | public function image($image) |
|
178 | { |
|
179 | return $this->setProperty('image', $image); |
|
180 | } |
|
181 | ||
182 | /** |
|
183 | * The object that helped the agent perform the action. e.g. John wrote a |
|
184 | * book with *a pen*. |
|
185 | * |
|
186 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
187 | * |
|
188 | * @return static |
|
189 | * |
|
190 | * @see http://schema.org/instrument |
|
191 | */ |
|
192 | public function instrument($instrument) |
|
193 | { |
|
194 | return $this->setProperty('instrument', $instrument); |
|
195 | } |
|
196 | ||
197 | /** |
|
198 | * The location of for example where the event is happening, an organization |
|
199 | * is located, or where an action takes place. |
|
200 | * |
|
201 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
202 | * |
|
203 | * @return static |
|
204 | * |
|
205 | * @see http://schema.org/location |
|
206 | */ |
|
207 | public function location($location) |
|
208 | { |
|
209 | return $this->setProperty('location', $location); |
|
210 | } |
|
211 | ||
212 | /** |
|
213 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
214 | * entity being described. See [background |
|
215 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/mainEntityOfPage |
|
222 | */ |
|
223 | public function mainEntityOfPage($mainEntityOfPage) |
|
224 | { |
|
225 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The name of the item. |
|
230 | * |
|
231 | * @param string|string[] $name |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/name |
|
236 | */ |
|
237 | public function name($name) |
|
238 | { |
|
239 | return $this->setProperty('name', $name); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The object upon which the action is carried out, whose state is kept |
|
244 | * intact or changed. Also known as the semantic roles patient, affected or |
|
245 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
246 | * read *a book*. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/object |
|
253 | */ |
|
254 | public function object($object) |
|
255 | { |
|
256 | return $this->setProperty('object', $object); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * Other co-agents that participated in the action indirectly. e.g. John |
|
261 | * wrote a book with *Steve*. |
|
262 | * |
|
263 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/participant |
|
268 | */ |
|
269 | public function participant($participant) |
|
270 | { |
|
271 | return $this->setProperty('participant', $participant); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * Indicates a potential Action, which describes an idealized action in |
|
276 | * which this thing would play an 'object' role. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/potentialAction |
|
283 | */ |
|
284 | public function potentialAction($potentialAction) |
|
285 | { |
|
286 | return $this->setProperty('potentialAction', $potentialAction); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * The offer price of a product, or of a price component when attached to |
|
291 | * PriceSpecification and its subtypes. |
|
292 | * |
|
293 | * Usage guidelines: |
|
294 | * |
|
295 | * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 |
|
296 | * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; |
|
297 | * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) |
|
298 | * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
299 | * Tradings |
|
300 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
301 | * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including |
|
302 | * [ambiguous |
|
303 | * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) |
|
304 | * such as '$' in the value. |
|
305 | * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a |
|
306 | * decimal point. Avoid using these symbols as a readability separator. |
|
307 | * * Note that both |
|
308 | * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) |
|
309 | * and Microdata syntax allow the use of a "content=" attribute for |
|
310 | * publishing simple machine-readable values alongside more human-friendly |
|
311 | * formatting. |
|
312 | * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT |
|
313 | * NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
|
314 | * |
|
315 | * @param float|float[]|int|int[]|string|string[] $price |
|
316 | * |
|
317 | * @return static |
|
318 | * |
|
319 | * @see http://schema.org/price |
|
320 | */ |
|
321 | public function price($price) |
|
322 | { |
|
323 | return $this->setProperty('price', $price); |
|
324 | } |
|
325 | ||
326 | /** |
|
327 | * The currency of the price, or a price component when attached to |
|
328 | * [[PriceSpecification]] and its subtypes. |
|
329 | * |
|
330 | * Use standard formats: [ISO 4217 currency |
|
331 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
332 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
333 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
334 | * Tradings |
|
335 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
336 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
337 | * |
|
338 | * @param string|string[] $priceCurrency |
|
339 | * |
|
340 | * @return static |
|
341 | * |
|
342 | * @see http://schema.org/priceCurrency |
|
343 | */ |
|
344 | public function priceCurrency($priceCurrency) |
|
345 | { |
|
346 | return $this->setProperty('priceCurrency', $priceCurrency); |
|
347 | } |
|
348 | ||
349 | /** |
|
350 | * One or more detailed price specifications, indicating the unit price and |
|
351 | * delivery or payment charges. |
|
352 | * |
|
353 | * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[] $priceSpecification |
|
354 | * |
|
355 | * @return static |
|
356 | * |
|
357 | * @see http://schema.org/priceSpecification |
|
358 | */ |
|
359 | public function priceSpecification($priceSpecification) |
|
360 | { |
|
361 | return $this->setProperty('priceSpecification', $priceSpecification); |
|
362 | } |
|
363 | ||
364 | /** |
|
365 | * The result produced in the action. e.g. John wrote *a book*. |
|
366 | * |
|
367 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
368 | * |
|
369 | * @return static |
|
370 | * |
|
371 | * @see http://schema.org/result |
|
372 | */ |
|
373 | public function result($result) |
|
374 | { |
|
375 | return $this->setProperty('result', $result); |
|
376 | } |
|
377 | ||
378 | /** |
|
379 | * URL of a reference Web page that unambiguously indicates the item's |
|
380 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
381 | * official website. |
|
382 | * |
|
383 | * @param string|string[] $sameAs |
|
384 | * |
|
385 | * @return static |
|
386 | * |
|
387 | * @see http://schema.org/sameAs |
|
388 | */ |
|
389 | public function sameAs($sameAs) |
|
390 | { |
|
391 | return $this->setProperty('sameAs', $sameAs); |
|
392 | } |
|
393 | ||
394 | /** |
|
395 | * The startTime of something. For a reserved event or service (e.g. |
|
396 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
397 | * actions that span a period of time, when the action was performed. e.g. |
|
398 | * John wrote a book from *January* to December. For media, including audio |
|
399 | * and video, it's the time offset of the start of a clip within a larger |
|
400 | * file. |
|
401 | * |
|
402 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
403 | * when describing dates with times. This situation may be clarified in |
|
404 | * future revisions. |
|
405 | * |
|
406 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
407 | * |
|
408 | * @return static |
|
409 | * |
|
410 | * @see http://schema.org/startTime |
|
411 | */ |
|
412 | public function startTime($startTime) |
|
413 | { |
|
414 | return $this->setProperty('startTime', $startTime); |
|
415 | } |
|
416 | ||
417 | /** |
|
418 | * A CreativeWork or Event about this Thing. |
|
419 | * |
|
420 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
421 | * |
|
422 | * @return static |
|
423 | * |
|
424 | * @see http://schema.org/subjectOf |
|
425 | */ |
|
426 | public function subjectOf($subjectOf) |
|
427 | { |
|
428 | return $this->setProperty('subjectOf', $subjectOf); |
|
429 | } |
|
430 | ||
431 | /** |
|
432 | * Indicates a target EntryPoint for an Action. |
|
433 | * |
|
434 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
435 | * |
|
436 | * @return static |
|
437 | * |
|
438 | * @see http://schema.org/target |
|
439 | */ |
|
440 | public function target($target) |
|
441 | { |
|
442 | return $this->setProperty('target', $target); |
|
443 | } |
|
444 | ||
445 | /** |
|
446 | * URL of the item. |
|
447 | * |
|
448 | * @param string|string[] $url |
|
449 | * |
|
450 | * @return static |
|
451 | * |
|
452 | * @see http://schema.org/url |
|
453 | */ |
|
454 | public function url($url) |
|
455 | { |
|
456 | return $this->setProperty('url', $url); |
|
457 | } |
|
458 | ||
459 | } |
|
460 |
@@ 20-414 (lines=395) @@ | ||
17 | * @see http://schema.org/TrainReservation |
|
18 | * |
|
19 | */ |
|
20 | class TrainReservation extends BaseType implements TrainReservationContract, IntangibleContract, ReservationContract, ThingContract |
|
21 | { |
|
22 | /** |
|
23 | * An additional type for the item, typically used for adding more specific |
|
24 | * types from external vocabularies in microdata syntax. This is a |
|
25 | * relationship between something and a class that the thing is in. In RDFa |
|
26 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
27 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
28 | * understanding of extra types, in particular those defined externally. |
|
29 | * |
|
30 | * @param string|string[] $additionalType |
|
31 | * |
|
32 | * @return static |
|
33 | * |
|
34 | * @see http://schema.org/additionalType |
|
35 | */ |
|
36 | public function additionalType($additionalType) |
|
37 | { |
|
38 | return $this->setProperty('additionalType', $additionalType); |
|
39 | } |
|
40 | ||
41 | /** |
|
42 | * An alias for the item. |
|
43 | * |
|
44 | * @param string|string[] $alternateName |
|
45 | * |
|
46 | * @return static |
|
47 | * |
|
48 | * @see http://schema.org/alternateName |
|
49 | */ |
|
50 | public function alternateName($alternateName) |
|
51 | { |
|
52 | return $this->setProperty('alternateName', $alternateName); |
|
53 | } |
|
54 | ||
55 | /** |
|
56 | * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as |
|
57 | * a booking agent. |
|
58 | * |
|
59 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $bookingAgent |
|
60 | * |
|
61 | * @return static |
|
62 | * |
|
63 | * @see http://schema.org/bookingAgent |
|
64 | */ |
|
65 | public function bookingAgent($bookingAgent) |
|
66 | { |
|
67 | return $this->setProperty('bookingAgent', $bookingAgent); |
|
68 | } |
|
69 | ||
70 | /** |
|
71 | * The date and time the reservation was booked. |
|
72 | * |
|
73 | * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime |
|
74 | * |
|
75 | * @return static |
|
76 | * |
|
77 | * @see http://schema.org/bookingTime |
|
78 | */ |
|
79 | public function bookingTime($bookingTime) |
|
80 | { |
|
81 | return $this->setProperty('bookingTime', $bookingTime); |
|
82 | } |
|
83 | ||
84 | /** |
|
85 | * An entity that arranges for an exchange between a buyer and a seller. In |
|
86 | * most cases a broker never acquires or releases ownership of a product or |
|
87 | * service involved in an exchange. If it is not clear whether an entity is |
|
88 | * a broker, seller, or buyer, the latter two terms are preferred. |
|
89 | * |
|
90 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $broker |
|
91 | * |
|
92 | * @return static |
|
93 | * |
|
94 | * @see http://schema.org/broker |
|
95 | */ |
|
96 | public function broker($broker) |
|
97 | { |
|
98 | return $this->setProperty('broker', $broker); |
|
99 | } |
|
100 | ||
101 | /** |
|
102 | * A description of the item. |
|
103 | * |
|
104 | * @param string|string[] $description |
|
105 | * |
|
106 | * @return static |
|
107 | * |
|
108 | * @see http://schema.org/description |
|
109 | */ |
|
110 | public function description($description) |
|
111 | { |
|
112 | return $this->setProperty('description', $description); |
|
113 | } |
|
114 | ||
115 | /** |
|
116 | * A sub property of description. A short description of the item used to |
|
117 | * disambiguate from other, similar items. Information from other properties |
|
118 | * (in particular, name) may be necessary for the description to be useful |
|
119 | * for disambiguation. |
|
120 | * |
|
121 | * @param string|string[] $disambiguatingDescription |
|
122 | * |
|
123 | * @return static |
|
124 | * |
|
125 | * @see http://schema.org/disambiguatingDescription |
|
126 | */ |
|
127 | public function disambiguatingDescription($disambiguatingDescription) |
|
128 | { |
|
129 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
130 | } |
|
131 | ||
132 | /** |
|
133 | * The identifier property represents any kind of identifier for any kind of |
|
134 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
135 | * dedicated properties for representing many of these, either as textual |
|
136 | * strings or as URL (URI) links. See [background |
|
137 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
138 | * |
|
139 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/identifier |
|
144 | */ |
|
145 | public function identifier($identifier) |
|
146 | { |
|
147 | return $this->setProperty('identifier', $identifier); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * An image of the item. This can be a [[URL]] or a fully described |
|
152 | * [[ImageObject]]. |
|
153 | * |
|
154 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
155 | * |
|
156 | * @return static |
|
157 | * |
|
158 | * @see http://schema.org/image |
|
159 | */ |
|
160 | public function image($image) |
|
161 | { |
|
162 | return $this->setProperty('image', $image); |
|
163 | } |
|
164 | ||
165 | /** |
|
166 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
167 | * entity being described. See [background |
|
168 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/mainEntityOfPage |
|
175 | */ |
|
176 | public function mainEntityOfPage($mainEntityOfPage) |
|
177 | { |
|
178 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * The date and time the reservation was modified. |
|
183 | * |
|
184 | * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime |
|
185 | * |
|
186 | * @return static |
|
187 | * |
|
188 | * @see http://schema.org/modifiedTime |
|
189 | */ |
|
190 | public function modifiedTime($modifiedTime) |
|
191 | { |
|
192 | return $this->setProperty('modifiedTime', $modifiedTime); |
|
193 | } |
|
194 | ||
195 | /** |
|
196 | * The name of the item. |
|
197 | * |
|
198 | * @param string|string[] $name |
|
199 | * |
|
200 | * @return static |
|
201 | * |
|
202 | * @see http://schema.org/name |
|
203 | */ |
|
204 | public function name($name) |
|
205 | { |
|
206 | return $this->setProperty('name', $name); |
|
207 | } |
|
208 | ||
209 | /** |
|
210 | * Indicates a potential Action, which describes an idealized action in |
|
211 | * which this thing would play an 'object' role. |
|
212 | * |
|
213 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
214 | * |
|
215 | * @return static |
|
216 | * |
|
217 | * @see http://schema.org/potentialAction |
|
218 | */ |
|
219 | public function potentialAction($potentialAction) |
|
220 | { |
|
221 | return $this->setProperty('potentialAction', $potentialAction); |
|
222 | } |
|
223 | ||
224 | /** |
|
225 | * The currency of the price, or a price component when attached to |
|
226 | * [[PriceSpecification]] and its subtypes. |
|
227 | * |
|
228 | * Use standard formats: [ISO 4217 currency |
|
229 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
230 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
231 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
232 | * Tradings |
|
233 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
234 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
235 | * |
|
236 | * @param string|string[] $priceCurrency |
|
237 | * |
|
238 | * @return static |
|
239 | * |
|
240 | * @see http://schema.org/priceCurrency |
|
241 | */ |
|
242 | public function priceCurrency($priceCurrency) |
|
243 | { |
|
244 | return $this->setProperty('priceCurrency', $priceCurrency); |
|
245 | } |
|
246 | ||
247 | /** |
|
248 | * Any membership in a frequent flyer, hotel loyalty program, etc. being |
|
249 | * applied to the reservation. |
|
250 | * |
|
251 | * @param \Spatie\SchemaOrg\Contracts\ProgramMembershipContract|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract[] $programMembershipUsed |
|
252 | * |
|
253 | * @return static |
|
254 | * |
|
255 | * @see http://schema.org/programMembershipUsed |
|
256 | */ |
|
257 | public function programMembershipUsed($programMembershipUsed) |
|
258 | { |
|
259 | return $this->setProperty('programMembershipUsed', $programMembershipUsed); |
|
260 | } |
|
261 | ||
262 | /** |
|
263 | * The service provider, service operator, or service performer; the goods |
|
264 | * producer. Another party (a seller) may offer those services or goods on |
|
265 | * behalf of the provider. A provider may also serve as the seller. |
|
266 | * |
|
267 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider |
|
268 | * |
|
269 | * @return static |
|
270 | * |
|
271 | * @see http://schema.org/provider |
|
272 | */ |
|
273 | public function provider($provider) |
|
274 | { |
|
275 | return $this->setProperty('provider', $provider); |
|
276 | } |
|
277 | ||
278 | /** |
|
279 | * The thing -- flight, event, restaurant,etc. being reserved. |
|
280 | * |
|
281 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $reservationFor |
|
282 | * |
|
283 | * @return static |
|
284 | * |
|
285 | * @see http://schema.org/reservationFor |
|
286 | */ |
|
287 | public function reservationFor($reservationFor) |
|
288 | { |
|
289 | return $this->setProperty('reservationFor', $reservationFor); |
|
290 | } |
|
291 | ||
292 | /** |
|
293 | * A unique identifier for the reservation. |
|
294 | * |
|
295 | * @param string|string[] $reservationId |
|
296 | * |
|
297 | * @return static |
|
298 | * |
|
299 | * @see http://schema.org/reservationId |
|
300 | */ |
|
301 | public function reservationId($reservationId) |
|
302 | { |
|
303 | return $this->setProperty('reservationId', $reservationId); |
|
304 | } |
|
305 | ||
306 | /** |
|
307 | * The current status of the reservation. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ReservationStatusTypeContract|\Spatie\SchemaOrg\Contracts\ReservationStatusTypeContract[] $reservationStatus |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/reservationStatus |
|
314 | */ |
|
315 | public function reservationStatus($reservationStatus) |
|
316 | { |
|
317 | return $this->setProperty('reservationStatus', $reservationStatus); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * A ticket associated with the reservation. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\TicketContract|\Spatie\SchemaOrg\Contracts\TicketContract[] $reservedTicket |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/reservedTicket |
|
328 | */ |
|
329 | public function reservedTicket($reservedTicket) |
|
330 | { |
|
331 | return $this->setProperty('reservedTicket', $reservedTicket); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * A CreativeWork or Event about this Thing. |
|
352 | * |
|
353 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
354 | * |
|
355 | * @return static |
|
356 | * |
|
357 | * @see http://schema.org/subjectOf |
|
358 | */ |
|
359 | public function subjectOf($subjectOf) |
|
360 | { |
|
361 | return $this->setProperty('subjectOf', $subjectOf); |
|
362 | } |
|
363 | ||
364 | /** |
|
365 | * The total price for the reservation or ticket, including applicable |
|
366 | * taxes, shipping, etc. |
|
367 | * |
|
368 | * Usage guidelines: |
|
369 | * |
|
370 | * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT |
|
371 | * NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
|
372 | * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a |
|
373 | * decimal point. Avoid using these symbols as a readability separator. |
|
374 | * |
|
375 | * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[]|float|float[]|int|int[]|string|string[] $totalPrice |
|
376 | * |
|
377 | * @return static |
|
378 | * |
|
379 | * @see http://schema.org/totalPrice |
|
380 | */ |
|
381 | public function totalPrice($totalPrice) |
|
382 | { |
|
383 | return $this->setProperty('totalPrice', $totalPrice); |
|
384 | } |
|
385 | ||
386 | /** |
|
387 | * The person or organization the reservation or ticket is for. |
|
388 | * |
|
389 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $underName |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/underName |
|
394 | */ |
|
395 | public function underName($underName) |
|
396 | { |
|
397 | return $this->setProperty('underName', $underName); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * URL of the item. |
|
402 | * |
|
403 | * @param string|string[] $url |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/url |
|
408 | */ |
|
409 | public function url($url) |
|
410 | { |
|
411 | return $this->setProperty('url', $url); |
|
412 | } |
|
413 | ||
414 | } |
|
415 |
@@ 16-413 (lines=398) @@ | ||
13 | * @see http://schema.org/TransferAction |
|
14 | * |
|
15 | */ |
|
16 | class TransferAction extends BaseType implements TransferActionContract, ActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * Indicates the current disposition of the Action. |
|
20 | * |
|
21 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
22 | * |
|
23 | * @return static |
|
24 | * |
|
25 | * @see http://schema.org/actionStatus |
|
26 | */ |
|
27 | public function actionStatus($actionStatus) |
|
28 | { |
|
29 | return $this->setProperty('actionStatus', $actionStatus); |
|
30 | } |
|
31 | ||
32 | /** |
|
33 | * An additional type for the item, typically used for adding more specific |
|
34 | * types from external vocabularies in microdata syntax. This is a |
|
35 | * relationship between something and a class that the thing is in. In RDFa |
|
36 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
37 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
38 | * understanding of extra types, in particular those defined externally. |
|
39 | * |
|
40 | * @param string|string[] $additionalType |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/additionalType |
|
45 | */ |
|
46 | public function additionalType($additionalType) |
|
47 | { |
|
48 | return $this->setProperty('additionalType', $additionalType); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
53 | * *John* wrote a book. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/agent |
|
60 | */ |
|
61 | public function agent($agent) |
|
62 | { |
|
63 | return $this->setProperty('agent', $agent); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * An alias for the item. |
|
68 | * |
|
69 | * @param string|string[] $alternateName |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/alternateName |
|
74 | */ |
|
75 | public function alternateName($alternateName) |
|
76 | { |
|
77 | return $this->setProperty('alternateName', $alternateName); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * A description of the item. |
|
82 | * |
|
83 | * @param string|string[] $description |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/description |
|
88 | */ |
|
89 | public function description($description) |
|
90 | { |
|
91 | return $this->setProperty('description', $description); |
|
92 | } |
|
93 | ||
94 | /** |
|
95 | * A sub property of description. A short description of the item used to |
|
96 | * disambiguate from other, similar items. Information from other properties |
|
97 | * (in particular, name) may be necessary for the description to be useful |
|
98 | * for disambiguation. |
|
99 | * |
|
100 | * @param string|string[] $disambiguatingDescription |
|
101 | * |
|
102 | * @return static |
|
103 | * |
|
104 | * @see http://schema.org/disambiguatingDescription |
|
105 | */ |
|
106 | public function disambiguatingDescription($disambiguatingDescription) |
|
107 | { |
|
108 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
109 | } |
|
110 | ||
111 | /** |
|
112 | * The endTime of something. For a reserved event or service (e.g. |
|
113 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
114 | * actions that span a period of time, when the action was performed. e.g. |
|
115 | * John wrote a book from January to *December*. For media, including audio |
|
116 | * and video, it's the time offset of the end of a clip within a larger |
|
117 | * file. |
|
118 | * |
|
119 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
120 | * when describing dates with times. This situation may be clarified in |
|
121 | * future revisions. |
|
122 | * |
|
123 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
124 | * |
|
125 | * @return static |
|
126 | * |
|
127 | * @see http://schema.org/endTime |
|
128 | */ |
|
129 | public function endTime($endTime) |
|
130 | { |
|
131 | return $this->setProperty('endTime', $endTime); |
|
132 | } |
|
133 | ||
134 | /** |
|
135 | * For failed actions, more information on the cause of the failure. |
|
136 | * |
|
137 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
138 | * |
|
139 | * @return static |
|
140 | * |
|
141 | * @see http://schema.org/error |
|
142 | */ |
|
143 | public function error($error) |
|
144 | { |
|
145 | return $this->setProperty('error', $error); |
|
146 | } |
|
147 | ||
148 | /** |
|
149 | * A sub property of location. The original location of the object or the |
|
150 | * agent before the action. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/fromLocation |
|
157 | */ |
|
158 | public function fromLocation($fromLocation) |
|
159 | { |
|
160 | return $this->setProperty('fromLocation', $fromLocation); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * The identifier property represents any kind of identifier for any kind of |
|
165 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
166 | * dedicated properties for representing many of these, either as textual |
|
167 | * strings or as URL (URI) links. See [background |
|
168 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/identifier |
|
175 | */ |
|
176 | public function identifier($identifier) |
|
177 | { |
|
178 | return $this->setProperty('identifier', $identifier); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * An image of the item. This can be a [[URL]] or a fully described |
|
183 | * [[ImageObject]]. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/image |
|
190 | */ |
|
191 | public function image($image) |
|
192 | { |
|
193 | return $this->setProperty('image', $image); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * The object that helped the agent perform the action. e.g. John wrote a |
|
198 | * book with *a pen*. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/instrument |
|
205 | */ |
|
206 | public function instrument($instrument) |
|
207 | { |
|
208 | return $this->setProperty('instrument', $instrument); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * The location of for example where the event is happening, an organization |
|
213 | * is located, or where an action takes place. |
|
214 | * |
|
215 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
216 | * |
|
217 | * @return static |
|
218 | * |
|
219 | * @see http://schema.org/location |
|
220 | */ |
|
221 | public function location($location) |
|
222 | { |
|
223 | return $this->setProperty('location', $location); |
|
224 | } |
|
225 | ||
226 | /** |
|
227 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
228 | * entity being described. See [background |
|
229 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
230 | * |
|
231 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/mainEntityOfPage |
|
236 | */ |
|
237 | public function mainEntityOfPage($mainEntityOfPage) |
|
238 | { |
|
239 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * The name of the item. |
|
244 | * |
|
245 | * @param string|string[] $name |
|
246 | * |
|
247 | * @return static |
|
248 | * |
|
249 | * @see http://schema.org/name |
|
250 | */ |
|
251 | public function name($name) |
|
252 | { |
|
253 | return $this->setProperty('name', $name); |
|
254 | } |
|
255 | ||
256 | /** |
|
257 | * The object upon which the action is carried out, whose state is kept |
|
258 | * intact or changed. Also known as the semantic roles patient, affected or |
|
259 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
260 | * read *a book*. |
|
261 | * |
|
262 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/object |
|
267 | */ |
|
268 | public function object($object) |
|
269 | { |
|
270 | return $this->setProperty('object', $object); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * Other co-agents that participated in the action indirectly. e.g. John |
|
275 | * wrote a book with *Steve*. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/participant |
|
282 | */ |
|
283 | public function participant($participant) |
|
284 | { |
|
285 | return $this->setProperty('participant', $participant); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * Indicates a potential Action, which describes an idealized action in |
|
290 | * which this thing would play an 'object' role. |
|
291 | * |
|
292 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
293 | * |
|
294 | * @return static |
|
295 | * |
|
296 | * @see http://schema.org/potentialAction |
|
297 | */ |
|
298 | public function potentialAction($potentialAction) |
|
299 | { |
|
300 | return $this->setProperty('potentialAction', $potentialAction); |
|
301 | } |
|
302 | ||
303 | /** |
|
304 | * The result produced in the action. e.g. John wrote *a book*. |
|
305 | * |
|
306 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
307 | * |
|
308 | * @return static |
|
309 | * |
|
310 | * @see http://schema.org/result |
|
311 | */ |
|
312 | public function result($result) |
|
313 | { |
|
314 | return $this->setProperty('result', $result); |
|
315 | } |
|
316 | ||
317 | /** |
|
318 | * URL of a reference Web page that unambiguously indicates the item's |
|
319 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
320 | * official website. |
|
321 | * |
|
322 | * @param string|string[] $sameAs |
|
323 | * |
|
324 | * @return static |
|
325 | * |
|
326 | * @see http://schema.org/sameAs |
|
327 | */ |
|
328 | public function sameAs($sameAs) |
|
329 | { |
|
330 | return $this->setProperty('sameAs', $sameAs); |
|
331 | } |
|
332 | ||
333 | /** |
|
334 | * The startTime of something. For a reserved event or service (e.g. |
|
335 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
336 | * actions that span a period of time, when the action was performed. e.g. |
|
337 | * John wrote a book from *January* to December. For media, including audio |
|
338 | * and video, it's the time offset of the start of a clip within a larger |
|
339 | * file. |
|
340 | * |
|
341 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
342 | * when describing dates with times. This situation may be clarified in |
|
343 | * future revisions. |
|
344 | * |
|
345 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
346 | * |
|
347 | * @return static |
|
348 | * |
|
349 | * @see http://schema.org/startTime |
|
350 | */ |
|
351 | public function startTime($startTime) |
|
352 | { |
|
353 | return $this->setProperty('startTime', $startTime); |
|
354 | } |
|
355 | ||
356 | /** |
|
357 | * A CreativeWork or Event about this Thing. |
|
358 | * |
|
359 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
360 | * |
|
361 | * @return static |
|
362 | * |
|
363 | * @see http://schema.org/subjectOf |
|
364 | */ |
|
365 | public function subjectOf($subjectOf) |
|
366 | { |
|
367 | return $this->setProperty('subjectOf', $subjectOf); |
|
368 | } |
|
369 | ||
370 | /** |
|
371 | * Indicates a target EntryPoint for an Action. |
|
372 | * |
|
373 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
374 | * |
|
375 | * @return static |
|
376 | * |
|
377 | * @see http://schema.org/target |
|
378 | */ |
|
379 | public function target($target) |
|
380 | { |
|
381 | return $this->setProperty('target', $target); |
|
382 | } |
|
383 | ||
384 | /** |
|
385 | * A sub property of location. The final location of the object or the agent |
|
386 | * after the action. |
|
387 | * |
|
388 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
389 | * |
|
390 | * @return static |
|
391 | * |
|
392 | * @see http://schema.org/toLocation |
|
393 | */ |
|
394 | public function toLocation($toLocation) |
|
395 | { |
|
396 | return $this->setProperty('toLocation', $toLocation); |
|
397 | } |
|
398 | ||
399 | /** |
|
400 | * URL of the item. |
|
401 | * |
|
402 | * @param string|string[] $url |
|
403 | * |
|
404 | * @return static |
|
405 | * |
|
406 | * @see http://schema.org/url |
|
407 | */ |
|
408 | public function url($url) |
|
409 | { |
|
410 | return $this->setProperty('url', $url); |
|
411 | } |
|
412 | ||
413 | } |
|
414 |
@@ 17-428 (lines=412) @@ | ||
14 | * @see http://schema.org/TravelAction |
|
15 | * |
|
16 | */ |
|
17 | class TravelAction extends BaseType implements TravelActionContract, ActionContract, MoveActionContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * Indicates the current disposition of the Action. |
|
21 | * |
|
22 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
23 | * |
|
24 | * @return static |
|
25 | * |
|
26 | * @see http://schema.org/actionStatus |
|
27 | */ |
|
28 | public function actionStatus($actionStatus) |
|
29 | { |
|
30 | return $this->setProperty('actionStatus', $actionStatus); |
|
31 | } |
|
32 | ||
33 | /** |
|
34 | * An additional type for the item, typically used for adding more specific |
|
35 | * types from external vocabularies in microdata syntax. This is a |
|
36 | * relationship between something and a class that the thing is in. In RDFa |
|
37 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
38 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
39 | * understanding of extra types, in particular those defined externally. |
|
40 | * |
|
41 | * @param string|string[] $additionalType |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/additionalType |
|
46 | */ |
|
47 | public function additionalType($additionalType) |
|
48 | { |
|
49 | return $this->setProperty('additionalType', $additionalType); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
54 | * *John* wrote a book. |
|
55 | * |
|
56 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/agent |
|
61 | */ |
|
62 | public function agent($agent) |
|
63 | { |
|
64 | return $this->setProperty('agent', $agent); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * An alias for the item. |
|
69 | * |
|
70 | * @param string|string[] $alternateName |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/alternateName |
|
75 | */ |
|
76 | public function alternateName($alternateName) |
|
77 | { |
|
78 | return $this->setProperty('alternateName', $alternateName); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * A description of the item. |
|
83 | * |
|
84 | * @param string|string[] $description |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/description |
|
89 | */ |
|
90 | public function description($description) |
|
91 | { |
|
92 | return $this->setProperty('description', $description); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of description. A short description of the item used to |
|
97 | * disambiguate from other, similar items. Information from other properties |
|
98 | * (in particular, name) may be necessary for the description to be useful |
|
99 | * for disambiguation. |
|
100 | * |
|
101 | * @param string|string[] $disambiguatingDescription |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/disambiguatingDescription |
|
106 | */ |
|
107 | public function disambiguatingDescription($disambiguatingDescription) |
|
108 | { |
|
109 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * The distance travelled, e.g. exercising or travelling. |
|
114 | * |
|
115 | * @param \Spatie\SchemaOrg\Contracts\DistanceContract|\Spatie\SchemaOrg\Contracts\DistanceContract[] $distance |
|
116 | * |
|
117 | * @return static |
|
118 | * |
|
119 | * @see http://schema.org/distance |
|
120 | */ |
|
121 | public function distance($distance) |
|
122 | { |
|
123 | return $this->setProperty('distance', $distance); |
|
124 | } |
|
125 | ||
126 | /** |
|
127 | * The endTime of something. For a reserved event or service (e.g. |
|
128 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
129 | * actions that span a period of time, when the action was performed. e.g. |
|
130 | * John wrote a book from January to *December*. For media, including audio |
|
131 | * and video, it's the time offset of the end of a clip within a larger |
|
132 | * file. |
|
133 | * |
|
134 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
135 | * when describing dates with times. This situation may be clarified in |
|
136 | * future revisions. |
|
137 | * |
|
138 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
139 | * |
|
140 | * @return static |
|
141 | * |
|
142 | * @see http://schema.org/endTime |
|
143 | */ |
|
144 | public function endTime($endTime) |
|
145 | { |
|
146 | return $this->setProperty('endTime', $endTime); |
|
147 | } |
|
148 | ||
149 | /** |
|
150 | * For failed actions, more information on the cause of the failure. |
|
151 | * |
|
152 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
153 | * |
|
154 | * @return static |
|
155 | * |
|
156 | * @see http://schema.org/error |
|
157 | */ |
|
158 | public function error($error) |
|
159 | { |
|
160 | return $this->setProperty('error', $error); |
|
161 | } |
|
162 | ||
163 | /** |
|
164 | * A sub property of location. The original location of the object or the |
|
165 | * agent before the action. |
|
166 | * |
|
167 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
168 | * |
|
169 | * @return static |
|
170 | * |
|
171 | * @see http://schema.org/fromLocation |
|
172 | */ |
|
173 | public function fromLocation($fromLocation) |
|
174 | { |
|
175 | return $this->setProperty('fromLocation', $fromLocation); |
|
176 | } |
|
177 | ||
178 | /** |
|
179 | * The identifier property represents any kind of identifier for any kind of |
|
180 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
181 | * dedicated properties for representing many of these, either as textual |
|
182 | * strings or as URL (URI) links. See [background |
|
183 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/identifier |
|
190 | */ |
|
191 | public function identifier($identifier) |
|
192 | { |
|
193 | return $this->setProperty('identifier', $identifier); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * An image of the item. This can be a [[URL]] or a fully described |
|
198 | * [[ImageObject]]. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/image |
|
205 | */ |
|
206 | public function image($image) |
|
207 | { |
|
208 | return $this->setProperty('image', $image); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * The object that helped the agent perform the action. e.g. John wrote a |
|
213 | * book with *a pen*. |
|
214 | * |
|
215 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
216 | * |
|
217 | * @return static |
|
218 | * |
|
219 | * @see http://schema.org/instrument |
|
220 | */ |
|
221 | public function instrument($instrument) |
|
222 | { |
|
223 | return $this->setProperty('instrument', $instrument); |
|
224 | } |
|
225 | ||
226 | /** |
|
227 | * The location of for example where the event is happening, an organization |
|
228 | * is located, or where an action takes place. |
|
229 | * |
|
230 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
231 | * |
|
232 | * @return static |
|
233 | * |
|
234 | * @see http://schema.org/location |
|
235 | */ |
|
236 | public function location($location) |
|
237 | { |
|
238 | return $this->setProperty('location', $location); |
|
239 | } |
|
240 | ||
241 | /** |
|
242 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
243 | * entity being described. See [background |
|
244 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
245 | * |
|
246 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
247 | * |
|
248 | * @return static |
|
249 | * |
|
250 | * @see http://schema.org/mainEntityOfPage |
|
251 | */ |
|
252 | public function mainEntityOfPage($mainEntityOfPage) |
|
253 | { |
|
254 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
255 | } |
|
256 | ||
257 | /** |
|
258 | * The name of the item. |
|
259 | * |
|
260 | * @param string|string[] $name |
|
261 | * |
|
262 | * @return static |
|
263 | * |
|
264 | * @see http://schema.org/name |
|
265 | */ |
|
266 | public function name($name) |
|
267 | { |
|
268 | return $this->setProperty('name', $name); |
|
269 | } |
|
270 | ||
271 | /** |
|
272 | * The object upon which the action is carried out, whose state is kept |
|
273 | * intact or changed. Also known as the semantic roles patient, affected or |
|
274 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
275 | * read *a book*. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/object |
|
282 | */ |
|
283 | public function object($object) |
|
284 | { |
|
285 | return $this->setProperty('object', $object); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * Other co-agents that participated in the action indirectly. e.g. John |
|
290 | * wrote a book with *Steve*. |
|
291 | * |
|
292 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
293 | * |
|
294 | * @return static |
|
295 | * |
|
296 | * @see http://schema.org/participant |
|
297 | */ |
|
298 | public function participant($participant) |
|
299 | { |
|
300 | return $this->setProperty('participant', $participant); |
|
301 | } |
|
302 | ||
303 | /** |
|
304 | * Indicates a potential Action, which describes an idealized action in |
|
305 | * which this thing would play an 'object' role. |
|
306 | * |
|
307 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
308 | * |
|
309 | * @return static |
|
310 | * |
|
311 | * @see http://schema.org/potentialAction |
|
312 | */ |
|
313 | public function potentialAction($potentialAction) |
|
314 | { |
|
315 | return $this->setProperty('potentialAction', $potentialAction); |
|
316 | } |
|
317 | ||
318 | /** |
|
319 | * The result produced in the action. e.g. John wrote *a book*. |
|
320 | * |
|
321 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
322 | * |
|
323 | * @return static |
|
324 | * |
|
325 | * @see http://schema.org/result |
|
326 | */ |
|
327 | public function result($result) |
|
328 | { |
|
329 | return $this->setProperty('result', $result); |
|
330 | } |
|
331 | ||
332 | /** |
|
333 | * URL of a reference Web page that unambiguously indicates the item's |
|
334 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
335 | * official website. |
|
336 | * |
|
337 | * @param string|string[] $sameAs |
|
338 | * |
|
339 | * @return static |
|
340 | * |
|
341 | * @see http://schema.org/sameAs |
|
342 | */ |
|
343 | public function sameAs($sameAs) |
|
344 | { |
|
345 | return $this->setProperty('sameAs', $sameAs); |
|
346 | } |
|
347 | ||
348 | /** |
|
349 | * The startTime of something. For a reserved event or service (e.g. |
|
350 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
351 | * actions that span a period of time, when the action was performed. e.g. |
|
352 | * John wrote a book from *January* to December. For media, including audio |
|
353 | * and video, it's the time offset of the start of a clip within a larger |
|
354 | * file. |
|
355 | * |
|
356 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
357 | * when describing dates with times. This situation may be clarified in |
|
358 | * future revisions. |
|
359 | * |
|
360 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
361 | * |
|
362 | * @return static |
|
363 | * |
|
364 | * @see http://schema.org/startTime |
|
365 | */ |
|
366 | public function startTime($startTime) |
|
367 | { |
|
368 | return $this->setProperty('startTime', $startTime); |
|
369 | } |
|
370 | ||
371 | /** |
|
372 | * A CreativeWork or Event about this Thing. |
|
373 | * |
|
374 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
375 | * |
|
376 | * @return static |
|
377 | * |
|
378 | * @see http://schema.org/subjectOf |
|
379 | */ |
|
380 | public function subjectOf($subjectOf) |
|
381 | { |
|
382 | return $this->setProperty('subjectOf', $subjectOf); |
|
383 | } |
|
384 | ||
385 | /** |
|
386 | * Indicates a target EntryPoint for an Action. |
|
387 | * |
|
388 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
389 | * |
|
390 | * @return static |
|
391 | * |
|
392 | * @see http://schema.org/target |
|
393 | */ |
|
394 | public function target($target) |
|
395 | { |
|
396 | return $this->setProperty('target', $target); |
|
397 | } |
|
398 | ||
399 | /** |
|
400 | * A sub property of location. The final location of the object or the agent |
|
401 | * after the action. |
|
402 | * |
|
403 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/toLocation |
|
408 | */ |
|
409 | public function toLocation($toLocation) |
|
410 | { |
|
411 | return $this->setProperty('toLocation', $toLocation); |
|
412 | } |
|
413 | ||
414 | /** |
|
415 | * URL of the item. |
|
416 | * |
|
417 | * @param string|string[] $url |
|
418 | * |
|
419 | * @return static |
|
420 | * |
|
421 | * @see http://schema.org/url |
|
422 | */ |
|
423 | public function url($url) |
|
424 | { |
|
425 | return $this->setProperty('url', $url); |
|
426 | } |
|
427 | ||
428 | } |
|
429 |
@@ 17-451 (lines=435) @@ | ||
14 | * @see http://schema.org/UnitPriceSpecification |
|
15 | * |
|
16 | */ |
|
17 | class UnitPriceSpecification extends BaseType implements UnitPriceSpecificationContract, IntangibleContract, PriceSpecificationContract, StructuredValueContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * An additional type for the item, typically used for adding more specific |
|
21 | * types from external vocabularies in microdata syntax. This is a |
|
22 | * relationship between something and a class that the thing is in. In RDFa |
|
23 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
24 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
25 | * understanding of extra types, in particular those defined externally. |
|
26 | * |
|
27 | * @param string|string[] $additionalType |
|
28 | * |
|
29 | * @return static |
|
30 | * |
|
31 | * @see http://schema.org/additionalType |
|
32 | */ |
|
33 | public function additionalType($additionalType) |
|
34 | { |
|
35 | return $this->setProperty('additionalType', $additionalType); |
|
36 | } |
|
37 | ||
38 | /** |
|
39 | * An alias for the item. |
|
40 | * |
|
41 | * @param string|string[] $alternateName |
|
42 | * |
|
43 | * @return static |
|
44 | * |
|
45 | * @see http://schema.org/alternateName |
|
46 | */ |
|
47 | public function alternateName($alternateName) |
|
48 | { |
|
49 | return $this->setProperty('alternateName', $alternateName); |
|
50 | } |
|
51 | ||
52 | /** |
|
53 | * This property specifies the minimal quantity and rounding increment that |
|
54 | * will be the basis for the billing. The unit of measurement is specified |
|
55 | * by the unitCode property. |
|
56 | * |
|
57 | * @param float|float[]|int|int[] $billingIncrement |
|
58 | * |
|
59 | * @return static |
|
60 | * |
|
61 | * @see http://schema.org/billingIncrement |
|
62 | */ |
|
63 | public function billingIncrement($billingIncrement) |
|
64 | { |
|
65 | return $this->setProperty('billingIncrement', $billingIncrement); |
|
66 | } |
|
67 | ||
68 | /** |
|
69 | * A description of the item. |
|
70 | * |
|
71 | * @param string|string[] $description |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/description |
|
76 | */ |
|
77 | public function description($description) |
|
78 | { |
|
79 | return $this->setProperty('description', $description); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * A sub property of description. A short description of the item used to |
|
84 | * disambiguate from other, similar items. Information from other properties |
|
85 | * (in particular, name) may be necessary for the description to be useful |
|
86 | * for disambiguation. |
|
87 | * |
|
88 | * @param string|string[] $disambiguatingDescription |
|
89 | * |
|
90 | * @return static |
|
91 | * |
|
92 | * @see http://schema.org/disambiguatingDescription |
|
93 | */ |
|
94 | public function disambiguatingDescription($disambiguatingDescription) |
|
95 | { |
|
96 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
97 | } |
|
98 | ||
99 | /** |
|
100 | * The interval and unit of measurement of ordering quantities for which the |
|
101 | * offer or price specification is valid. This allows e.g. specifying that a |
|
102 | * certain freight charge is valid only for a certain quantity. |
|
103 | * |
|
104 | * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $eligibleQuantity |
|
105 | * |
|
106 | * @return static |
|
107 | * |
|
108 | * @see http://schema.org/eligibleQuantity |
|
109 | */ |
|
110 | public function eligibleQuantity($eligibleQuantity) |
|
111 | { |
|
112 | return $this->setProperty('eligibleQuantity', $eligibleQuantity); |
|
113 | } |
|
114 | ||
115 | /** |
|
116 | * The transaction volume, in a monetary unit, for which the offer or price |
|
117 | * specification is valid, e.g. for indicating a minimal purchasing volume, |
|
118 | * to express free shipping above a certain order volume, or to limit the |
|
119 | * acceptance of credit cards to purchases to a certain minimal amount. |
|
120 | * |
|
121 | * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[] $eligibleTransactionVolume |
|
122 | * |
|
123 | * @return static |
|
124 | * |
|
125 | * @see http://schema.org/eligibleTransactionVolume |
|
126 | */ |
|
127 | public function eligibleTransactionVolume($eligibleTransactionVolume) |
|
128 | { |
|
129 | return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); |
|
130 | } |
|
131 | ||
132 | /** |
|
133 | * The identifier property represents any kind of identifier for any kind of |
|
134 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
135 | * dedicated properties for representing many of these, either as textual |
|
136 | * strings or as URL (URI) links. See [background |
|
137 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
138 | * |
|
139 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/identifier |
|
144 | */ |
|
145 | public function identifier($identifier) |
|
146 | { |
|
147 | return $this->setProperty('identifier', $identifier); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * An image of the item. This can be a [[URL]] or a fully described |
|
152 | * [[ImageObject]]. |
|
153 | * |
|
154 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
155 | * |
|
156 | * @return static |
|
157 | * |
|
158 | * @see http://schema.org/image |
|
159 | */ |
|
160 | public function image($image) |
|
161 | { |
|
162 | return $this->setProperty('image', $image); |
|
163 | } |
|
164 | ||
165 | /** |
|
166 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
167 | * entity being described. See [background |
|
168 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/mainEntityOfPage |
|
175 | */ |
|
176 | public function mainEntityOfPage($mainEntityOfPage) |
|
177 | { |
|
178 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * The highest price if the price is a range. |
|
183 | * |
|
184 | * @param float|float[]|int|int[] $maxPrice |
|
185 | * |
|
186 | * @return static |
|
187 | * |
|
188 | * @see http://schema.org/maxPrice |
|
189 | */ |
|
190 | public function maxPrice($maxPrice) |
|
191 | { |
|
192 | return $this->setProperty('maxPrice', $maxPrice); |
|
193 | } |
|
194 | ||
195 | /** |
|
196 | * The lowest price if the price is a range. |
|
197 | * |
|
198 | * @param float|float[]|int|int[] $minPrice |
|
199 | * |
|
200 | * @return static |
|
201 | * |
|
202 | * @see http://schema.org/minPrice |
|
203 | */ |
|
204 | public function minPrice($minPrice) |
|
205 | { |
|
206 | return $this->setProperty('minPrice', $minPrice); |
|
207 | } |
|
208 | ||
209 | /** |
|
210 | * The name of the item. |
|
211 | * |
|
212 | * @param string|string[] $name |
|
213 | * |
|
214 | * @return static |
|
215 | * |
|
216 | * @see http://schema.org/name |
|
217 | */ |
|
218 | public function name($name) |
|
219 | { |
|
220 | return $this->setProperty('name', $name); |
|
221 | } |
|
222 | ||
223 | /** |
|
224 | * Indicates a potential Action, which describes an idealized action in |
|
225 | * which this thing would play an 'object' role. |
|
226 | * |
|
227 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
228 | * |
|
229 | * @return static |
|
230 | * |
|
231 | * @see http://schema.org/potentialAction |
|
232 | */ |
|
233 | public function potentialAction($potentialAction) |
|
234 | { |
|
235 | return $this->setProperty('potentialAction', $potentialAction); |
|
236 | } |
|
237 | ||
238 | /** |
|
239 | * The offer price of a product, or of a price component when attached to |
|
240 | * PriceSpecification and its subtypes. |
|
241 | * |
|
242 | * Usage guidelines: |
|
243 | * |
|
244 | * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 |
|
245 | * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; |
|
246 | * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) |
|
247 | * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
248 | * Tradings |
|
249 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
250 | * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including |
|
251 | * [ambiguous |
|
252 | * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) |
|
253 | * such as '$' in the value. |
|
254 | * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a |
|
255 | * decimal point. Avoid using these symbols as a readability separator. |
|
256 | * * Note that both |
|
257 | * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) |
|
258 | * and Microdata syntax allow the use of a "content=" attribute for |
|
259 | * publishing simple machine-readable values alongside more human-friendly |
|
260 | * formatting. |
|
261 | * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT |
|
262 | * NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
|
263 | * |
|
264 | * @param float|float[]|int|int[]|string|string[] $price |
|
265 | * |
|
266 | * @return static |
|
267 | * |
|
268 | * @see http://schema.org/price |
|
269 | */ |
|
270 | public function price($price) |
|
271 | { |
|
272 | return $this->setProperty('price', $price); |
|
273 | } |
|
274 | ||
275 | /** |
|
276 | * The currency of the price, or a price component when attached to |
|
277 | * [[PriceSpecification]] and its subtypes. |
|
278 | * |
|
279 | * Use standard formats: [ISO 4217 currency |
|
280 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
281 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
282 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
283 | * Tradings |
|
284 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
285 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
286 | * |
|
287 | * @param string|string[] $priceCurrency |
|
288 | * |
|
289 | * @return static |
|
290 | * |
|
291 | * @see http://schema.org/priceCurrency |
|
292 | */ |
|
293 | public function priceCurrency($priceCurrency) |
|
294 | { |
|
295 | return $this->setProperty('priceCurrency', $priceCurrency); |
|
296 | } |
|
297 | ||
298 | /** |
|
299 | * A short text or acronym indicating multiple price specifications for the |
|
300 | * same offer, e.g. SRP for the suggested retail price or INVOICE for the |
|
301 | * invoice price, mostly used in the car industry. |
|
302 | * |
|
303 | * @param string|string[] $priceType |
|
304 | * |
|
305 | * @return static |
|
306 | * |
|
307 | * @see http://schema.org/priceType |
|
308 | */ |
|
309 | public function priceType($priceType) |
|
310 | { |
|
311 | return $this->setProperty('priceType', $priceType); |
|
312 | } |
|
313 | ||
314 | /** |
|
315 | * The reference quantity for which a certain price applies, e.g. 1 EUR per |
|
316 | * 4 kWh of electricity. This property is a replacement for |
|
317 | * unitOfMeasurement for the advanced cases where the price does not relate |
|
318 | * to a standard unit. |
|
319 | * |
|
320 | * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $referenceQuantity |
|
321 | * |
|
322 | * @return static |
|
323 | * |
|
324 | * @see http://schema.org/referenceQuantity |
|
325 | */ |
|
326 | public function referenceQuantity($referenceQuantity) |
|
327 | { |
|
328 | return $this->setProperty('referenceQuantity', $referenceQuantity); |
|
329 | } |
|
330 | ||
331 | /** |
|
332 | * URL of a reference Web page that unambiguously indicates the item's |
|
333 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
334 | * official website. |
|
335 | * |
|
336 | * @param string|string[] $sameAs |
|
337 | * |
|
338 | * @return static |
|
339 | * |
|
340 | * @see http://schema.org/sameAs |
|
341 | */ |
|
342 | public function sameAs($sameAs) |
|
343 | { |
|
344 | return $this->setProperty('sameAs', $sameAs); |
|
345 | } |
|
346 | ||
347 | /** |
|
348 | * A CreativeWork or Event about this Thing. |
|
349 | * |
|
350 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
351 | * |
|
352 | * @return static |
|
353 | * |
|
354 | * @see http://schema.org/subjectOf |
|
355 | */ |
|
356 | public function subjectOf($subjectOf) |
|
357 | { |
|
358 | return $this->setProperty('subjectOf', $subjectOf); |
|
359 | } |
|
360 | ||
361 | /** |
|
362 | * The unit of measurement given using the UN/CEFACT Common Code (3 |
|
363 | * characters) or a URL. Other codes than the UN/CEFACT Common Code may be |
|
364 | * used with a prefix followed by a colon. |
|
365 | * |
|
366 | * @param string|string[] $unitCode |
|
367 | * |
|
368 | * @return static |
|
369 | * |
|
370 | * @see http://schema.org/unitCode |
|
371 | */ |
|
372 | public function unitCode($unitCode) |
|
373 | { |
|
374 | return $this->setProperty('unitCode', $unitCode); |
|
375 | } |
|
376 | ||
377 | /** |
|
378 | * A string or text indicating the unit of measurement. Useful if you cannot |
|
379 | * provide a standard unit code for |
|
380 | * <a href='unitCode'>unitCode</a>. |
|
381 | * |
|
382 | * @param string|string[] $unitText |
|
383 | * |
|
384 | * @return static |
|
385 | * |
|
386 | * @see http://schema.org/unitText |
|
387 | */ |
|
388 | public function unitText($unitText) |
|
389 | { |
|
390 | return $this->setProperty('unitText', $unitText); |
|
391 | } |
|
392 | ||
393 | /** |
|
394 | * URL of the item. |
|
395 | * |
|
396 | * @param string|string[] $url |
|
397 | * |
|
398 | * @return static |
|
399 | * |
|
400 | * @see http://schema.org/url |
|
401 | */ |
|
402 | public function url($url) |
|
403 | { |
|
404 | return $this->setProperty('url', $url); |
|
405 | } |
|
406 | ||
407 | /** |
|
408 | * The date when the item becomes valid. |
|
409 | * |
|
410 | * @param \DateTimeInterface|\DateTimeInterface[] $validFrom |
|
411 | * |
|
412 | * @return static |
|
413 | * |
|
414 | * @see http://schema.org/validFrom |
|
415 | */ |
|
416 | public function validFrom($validFrom) |
|
417 | { |
|
418 | return $this->setProperty('validFrom', $validFrom); |
|
419 | } |
|
420 | ||
421 | /** |
|
422 | * The date after when the item is not valid. For example the end of an |
|
423 | * offer, salary period, or a period of opening hours. |
|
424 | * |
|
425 | * @param \DateTimeInterface|\DateTimeInterface[] $validThrough |
|
426 | * |
|
427 | * @return static |
|
428 | * |
|
429 | * @see http://schema.org/validThrough |
|
430 | */ |
|
431 | public function validThrough($validThrough) |
|
432 | { |
|
433 | return $this->setProperty('validThrough', $validThrough); |
|
434 | } |
|
435 | ||
436 | /** |
|
437 | * Specifies whether the applicable value-added tax (VAT) is included in the |
|
438 | * price specification or not. |
|
439 | * |
|
440 | * @param bool|bool[] $valueAddedTaxIncluded |
|
441 | * |
|
442 | * @return static |
|
443 | * |
|
444 | * @see http://schema.org/valueAddedTaxIncluded |
|
445 | */ |
|
446 | public function valueAddedTaxIncluded($valueAddedTaxIncluded) |
|
447 | { |
|
448 | return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); |
|
449 | } |
|
450 | ||
451 | } |
|
452 |
@@ 15-410 (lines=396) @@ | ||
12 | * @see http://schema.org/UpdateAction |
|
13 | * |
|
14 | */ |
|
15 | class UpdateAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract |
|
16 | { |
|
17 | /** |
|
18 | * Indicates the current disposition of the Action. |
|
19 | * |
|
20 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
21 | * |
|
22 | * @return static |
|
23 | * |
|
24 | * @see http://schema.org/actionStatus |
|
25 | */ |
|
26 | public function actionStatus($actionStatus) |
|
27 | { |
|
28 | return $this->setProperty('actionStatus', $actionStatus); |
|
29 | } |
|
30 | ||
31 | /** |
|
32 | * An additional type for the item, typically used for adding more specific |
|
33 | * types from external vocabularies in microdata syntax. This is a |
|
34 | * relationship between something and a class that the thing is in. In RDFa |
|
35 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
36 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
37 | * understanding of extra types, in particular those defined externally. |
|
38 | * |
|
39 | * @param string|string[] $additionalType |
|
40 | * |
|
41 | * @return static |
|
42 | * |
|
43 | * @see http://schema.org/additionalType |
|
44 | */ |
|
45 | public function additionalType($additionalType) |
|
46 | { |
|
47 | return $this->setProperty('additionalType', $additionalType); |
|
48 | } |
|
49 | ||
50 | /** |
|
51 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
52 | * *John* wrote a book. |
|
53 | * |
|
54 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
55 | * |
|
56 | * @return static |
|
57 | * |
|
58 | * @see http://schema.org/agent |
|
59 | */ |
|
60 | public function agent($agent) |
|
61 | { |
|
62 | return $this->setProperty('agent', $agent); |
|
63 | } |
|
64 | ||
65 | /** |
|
66 | * An alias for the item. |
|
67 | * |
|
68 | * @param string|string[] $alternateName |
|
69 | * |
|
70 | * @return static |
|
71 | * |
|
72 | * @see http://schema.org/alternateName |
|
73 | */ |
|
74 | public function alternateName($alternateName) |
|
75 | { |
|
76 | return $this->setProperty('alternateName', $alternateName); |
|
77 | } |
|
78 | ||
79 | /** |
|
80 | * A sub property of object. The collection target of the action. |
|
81 | * |
|
82 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $collection |
|
83 | * |
|
84 | * @return static |
|
85 | * |
|
86 | * @see http://schema.org/collection |
|
87 | */ |
|
88 | public function collection($collection) |
|
89 | { |
|
90 | return $this->setProperty('collection', $collection); |
|
91 | } |
|
92 | ||
93 | /** |
|
94 | * A description of the item. |
|
95 | * |
|
96 | * @param string|string[] $description |
|
97 | * |
|
98 | * @return static |
|
99 | * |
|
100 | * @see http://schema.org/description |
|
101 | */ |
|
102 | public function description($description) |
|
103 | { |
|
104 | return $this->setProperty('description', $description); |
|
105 | } |
|
106 | ||
107 | /** |
|
108 | * A sub property of description. A short description of the item used to |
|
109 | * disambiguate from other, similar items. Information from other properties |
|
110 | * (in particular, name) may be necessary for the description to be useful |
|
111 | * for disambiguation. |
|
112 | * |
|
113 | * @param string|string[] $disambiguatingDescription |
|
114 | * |
|
115 | * @return static |
|
116 | * |
|
117 | * @see http://schema.org/disambiguatingDescription |
|
118 | */ |
|
119 | public function disambiguatingDescription($disambiguatingDescription) |
|
120 | { |
|
121 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
122 | } |
|
123 | ||
124 | /** |
|
125 | * The endTime of something. For a reserved event or service (e.g. |
|
126 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
127 | * actions that span a period of time, when the action was performed. e.g. |
|
128 | * John wrote a book from January to *December*. For media, including audio |
|
129 | * and video, it's the time offset of the end of a clip within a larger |
|
130 | * file. |
|
131 | * |
|
132 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
133 | * when describing dates with times. This situation may be clarified in |
|
134 | * future revisions. |
|
135 | * |
|
136 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
137 | * |
|
138 | * @return static |
|
139 | * |
|
140 | * @see http://schema.org/endTime |
|
141 | */ |
|
142 | public function endTime($endTime) |
|
143 | { |
|
144 | return $this->setProperty('endTime', $endTime); |
|
145 | } |
|
146 | ||
147 | /** |
|
148 | * For failed actions, more information on the cause of the failure. |
|
149 | * |
|
150 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
151 | * |
|
152 | * @return static |
|
153 | * |
|
154 | * @see http://schema.org/error |
|
155 | */ |
|
156 | public function error($error) |
|
157 | { |
|
158 | return $this->setProperty('error', $error); |
|
159 | } |
|
160 | ||
161 | /** |
|
162 | * The identifier property represents any kind of identifier for any kind of |
|
163 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
164 | * dedicated properties for representing many of these, either as textual |
|
165 | * strings or as URL (URI) links. See [background |
|
166 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
167 | * |
|
168 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
169 | * |
|
170 | * @return static |
|
171 | * |
|
172 | * @see http://schema.org/identifier |
|
173 | */ |
|
174 | public function identifier($identifier) |
|
175 | { |
|
176 | return $this->setProperty('identifier', $identifier); |
|
177 | } |
|
178 | ||
179 | /** |
|
180 | * An image of the item. This can be a [[URL]] or a fully described |
|
181 | * [[ImageObject]]. |
|
182 | * |
|
183 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
184 | * |
|
185 | * @return static |
|
186 | * |
|
187 | * @see http://schema.org/image |
|
188 | */ |
|
189 | public function image($image) |
|
190 | { |
|
191 | return $this->setProperty('image', $image); |
|
192 | } |
|
193 | ||
194 | /** |
|
195 | * The object that helped the agent perform the action. e.g. John wrote a |
|
196 | * book with *a pen*. |
|
197 | * |
|
198 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
199 | * |
|
200 | * @return static |
|
201 | * |
|
202 | * @see http://schema.org/instrument |
|
203 | */ |
|
204 | public function instrument($instrument) |
|
205 | { |
|
206 | return $this->setProperty('instrument', $instrument); |
|
207 | } |
|
208 | ||
209 | /** |
|
210 | * The location of for example where the event is happening, an organization |
|
211 | * is located, or where an action takes place. |
|
212 | * |
|
213 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
214 | * |
|
215 | * @return static |
|
216 | * |
|
217 | * @see http://schema.org/location |
|
218 | */ |
|
219 | public function location($location) |
|
220 | { |
|
221 | return $this->setProperty('location', $location); |
|
222 | } |
|
223 | ||
224 | /** |
|
225 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
226 | * entity being described. See [background |
|
227 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
228 | * |
|
229 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
230 | * |
|
231 | * @return static |
|
232 | * |
|
233 | * @see http://schema.org/mainEntityOfPage |
|
234 | */ |
|
235 | public function mainEntityOfPage($mainEntityOfPage) |
|
236 | { |
|
237 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
238 | } |
|
239 | ||
240 | /** |
|
241 | * The name of the item. |
|
242 | * |
|
243 | * @param string|string[] $name |
|
244 | * |
|
245 | * @return static |
|
246 | * |
|
247 | * @see http://schema.org/name |
|
248 | */ |
|
249 | public function name($name) |
|
250 | { |
|
251 | return $this->setProperty('name', $name); |
|
252 | } |
|
253 | ||
254 | /** |
|
255 | * The object upon which the action is carried out, whose state is kept |
|
256 | * intact or changed. Also known as the semantic roles patient, affected or |
|
257 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
258 | * read *a book*. |
|
259 | * |
|
260 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
261 | * |
|
262 | * @return static |
|
263 | * |
|
264 | * @see http://schema.org/object |
|
265 | */ |
|
266 | public function object($object) |
|
267 | { |
|
268 | return $this->setProperty('object', $object); |
|
269 | } |
|
270 | ||
271 | /** |
|
272 | * Other co-agents that participated in the action indirectly. e.g. John |
|
273 | * wrote a book with *Steve*. |
|
274 | * |
|
275 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
276 | * |
|
277 | * @return static |
|
278 | * |
|
279 | * @see http://schema.org/participant |
|
280 | */ |
|
281 | public function participant($participant) |
|
282 | { |
|
283 | return $this->setProperty('participant', $participant); |
|
284 | } |
|
285 | ||
286 | /** |
|
287 | * Indicates a potential Action, which describes an idealized action in |
|
288 | * which this thing would play an 'object' role. |
|
289 | * |
|
290 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
291 | * |
|
292 | * @return static |
|
293 | * |
|
294 | * @see http://schema.org/potentialAction |
|
295 | */ |
|
296 | public function potentialAction($potentialAction) |
|
297 | { |
|
298 | return $this->setProperty('potentialAction', $potentialAction); |
|
299 | } |
|
300 | ||
301 | /** |
|
302 | * The result produced in the action. e.g. John wrote *a book*. |
|
303 | * |
|
304 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
305 | * |
|
306 | * @return static |
|
307 | * |
|
308 | * @see http://schema.org/result |
|
309 | */ |
|
310 | public function result($result) |
|
311 | { |
|
312 | return $this->setProperty('result', $result); |
|
313 | } |
|
314 | ||
315 | /** |
|
316 | * URL of a reference Web page that unambiguously indicates the item's |
|
317 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
318 | * official website. |
|
319 | * |
|
320 | * @param string|string[] $sameAs |
|
321 | * |
|
322 | * @return static |
|
323 | * |
|
324 | * @see http://schema.org/sameAs |
|
325 | */ |
|
326 | public function sameAs($sameAs) |
|
327 | { |
|
328 | return $this->setProperty('sameAs', $sameAs); |
|
329 | } |
|
330 | ||
331 | /** |
|
332 | * The startTime of something. For a reserved event or service (e.g. |
|
333 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
334 | * actions that span a period of time, when the action was performed. e.g. |
|
335 | * John wrote a book from *January* to December. For media, including audio |
|
336 | * and video, it's the time offset of the start of a clip within a larger |
|
337 | * file. |
|
338 | * |
|
339 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
340 | * when describing dates with times. This situation may be clarified in |
|
341 | * future revisions. |
|
342 | * |
|
343 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
344 | * |
|
345 | * @return static |
|
346 | * |
|
347 | * @see http://schema.org/startTime |
|
348 | */ |
|
349 | public function startTime($startTime) |
|
350 | { |
|
351 | return $this->setProperty('startTime', $startTime); |
|
352 | } |
|
353 | ||
354 | /** |
|
355 | * A CreativeWork or Event about this Thing. |
|
356 | * |
|
357 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
358 | * |
|
359 | * @return static |
|
360 | * |
|
361 | * @see http://schema.org/subjectOf |
|
362 | */ |
|
363 | public function subjectOf($subjectOf) |
|
364 | { |
|
365 | return $this->setProperty('subjectOf', $subjectOf); |
|
366 | } |
|
367 | ||
368 | /** |
|
369 | * Indicates a target EntryPoint for an Action. |
|
370 | * |
|
371 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
372 | * |
|
373 | * @return static |
|
374 | * |
|
375 | * @see http://schema.org/target |
|
376 | */ |
|
377 | public function target($target) |
|
378 | { |
|
379 | return $this->setProperty('target', $target); |
|
380 | } |
|
381 | ||
382 | /** |
|
383 | * A sub property of object. The collection target of the action. |
|
384 | * |
|
385 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $targetCollection |
|
386 | * |
|
387 | * @return static |
|
388 | * |
|
389 | * @see http://schema.org/targetCollection |
|
390 | */ |
|
391 | public function targetCollection($targetCollection) |
|
392 | { |
|
393 | return $this->setProperty('targetCollection', $targetCollection); |
|
394 | } |
|
395 | ||
396 | /** |
|
397 | * URL of the item. |
|
398 | * |
|
399 | * @param string|string[] $url |
|
400 | * |
|
401 | * @return static |
|
402 | * |
|
403 | * @see http://schema.org/url |
|
404 | */ |
|
405 | public function url($url) |
|
406 | { |
|
407 | return $this->setProperty('url', $url); |
|
408 | } |
|
409 | ||
410 | } |
|
411 |
@@ 16-415 (lines=400) @@ | ||
13 | * @see http://schema.org/UseAction |
|
14 | * |
|
15 | */ |
|
16 | class UseAction extends BaseType implements UseActionContract, ActionContract, ConsumeActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * A set of requirements that a must be fulfilled in order to perform an |
|
20 | * Action. If more than one value is specied, fulfilling one set of |
|
21 | * requirements will allow the Action to be performed. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionAccessibilityRequirement |
|
28 | */ |
|
29 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
30 | { |
|
31 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * Indicates the current disposition of the Action. |
|
36 | * |
|
37 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
38 | * |
|
39 | * @return static |
|
40 | * |
|
41 | * @see http://schema.org/actionStatus |
|
42 | */ |
|
43 | public function actionStatus($actionStatus) |
|
44 | { |
|
45 | return $this->setProperty('actionStatus', $actionStatus); |
|
46 | } |
|
47 | ||
48 | /** |
|
49 | * An additional type for the item, typically used for adding more specific |
|
50 | * types from external vocabularies in microdata syntax. This is a |
|
51 | * relationship between something and a class that the thing is in. In RDFa |
|
52 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
53 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
54 | * understanding of extra types, in particular those defined externally. |
|
55 | * |
|
56 | * @param string|string[] $additionalType |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/additionalType |
|
61 | */ |
|
62 | public function additionalType($additionalType) |
|
63 | { |
|
64 | return $this->setProperty('additionalType', $additionalType); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
69 | * *John* wrote a book. |
|
70 | * |
|
71 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/agent |
|
76 | */ |
|
77 | public function agent($agent) |
|
78 | { |
|
79 | return $this->setProperty('agent', $agent); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * An alias for the item. |
|
84 | * |
|
85 | * @param string|string[] $alternateName |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/alternateName |
|
90 | */ |
|
91 | public function alternateName($alternateName) |
|
92 | { |
|
93 | return $this->setProperty('alternateName', $alternateName); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * An Offer which must be accepted before the user can perform the Action. |
|
166 | * For example, the user may need to buy a movie before being able to watch |
|
167 | * it. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/expectsAcceptanceOf |
|
174 | */ |
|
175 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
176 | { |
|
177 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * The identifier property represents any kind of identifier for any kind of |
|
182 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
183 | * dedicated properties for representing many of these, either as textual |
|
184 | * strings or as URL (URI) links. See [background |
|
185 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
186 | * |
|
187 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
188 | * |
|
189 | * @return static |
|
190 | * |
|
191 | * @see http://schema.org/identifier |
|
192 | */ |
|
193 | public function identifier($identifier) |
|
194 | { |
|
195 | return $this->setProperty('identifier', $identifier); |
|
196 | } |
|
197 | ||
198 | /** |
|
199 | * An image of the item. This can be a [[URL]] or a fully described |
|
200 | * [[ImageObject]]. |
|
201 | * |
|
202 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
203 | * |
|
204 | * @return static |
|
205 | * |
|
206 | * @see http://schema.org/image |
|
207 | */ |
|
208 | public function image($image) |
|
209 | { |
|
210 | return $this->setProperty('image', $image); |
|
211 | } |
|
212 | ||
213 | /** |
|
214 | * The object that helped the agent perform the action. e.g. John wrote a |
|
215 | * book with *a pen*. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/instrument |
|
222 | */ |
|
223 | public function instrument($instrument) |
|
224 | { |
|
225 | return $this->setProperty('instrument', $instrument); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The location of for example where the event is happening, an organization |
|
230 | * is located, or where an action takes place. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/location |
|
237 | */ |
|
238 | public function location($location) |
|
239 | { |
|
240 | return $this->setProperty('location', $location); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
245 | * entity being described. See [background |
|
246 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/mainEntityOfPage |
|
253 | */ |
|
254 | public function mainEntityOfPage($mainEntityOfPage) |
|
255 | { |
|
256 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The name of the item. |
|
261 | * |
|
262 | * @param string|string[] $name |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/name |
|
267 | */ |
|
268 | public function name($name) |
|
269 | { |
|
270 | return $this->setProperty('name', $name); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * The object upon which the action is carried out, whose state is kept |
|
275 | * intact or changed. Also known as the semantic roles patient, affected or |
|
276 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
277 | * read *a book*. |
|
278 | * |
|
279 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
280 | * |
|
281 | * @return static |
|
282 | * |
|
283 | * @see http://schema.org/object |
|
284 | */ |
|
285 | public function object($object) |
|
286 | { |
|
287 | return $this->setProperty('object', $object); |
|
288 | } |
|
289 | ||
290 | /** |
|
291 | * Other co-agents that participated in the action indirectly. e.g. John |
|
292 | * wrote a book with *Steve*. |
|
293 | * |
|
294 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
295 | * |
|
296 | * @return static |
|
297 | * |
|
298 | * @see http://schema.org/participant |
|
299 | */ |
|
300 | public function participant($participant) |
|
301 | { |
|
302 | return $this->setProperty('participant', $participant); |
|
303 | } |
|
304 | ||
305 | /** |
|
306 | * Indicates a potential Action, which describes an idealized action in |
|
307 | * which this thing would play an 'object' role. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/potentialAction |
|
314 | */ |
|
315 | public function potentialAction($potentialAction) |
|
316 | { |
|
317 | return $this->setProperty('potentialAction', $potentialAction); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * The result produced in the action. e.g. John wrote *a book*. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/result |
|
328 | */ |
|
329 | public function result($result) |
|
330 | { |
|
331 | return $this->setProperty('result', $result); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * The startTime of something. For a reserved event or service (e.g. |
|
352 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
353 | * actions that span a period of time, when the action was performed. e.g. |
|
354 | * John wrote a book from *January* to December. For media, including audio |
|
355 | * and video, it's the time offset of the start of a clip within a larger |
|
356 | * file. |
|
357 | * |
|
358 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
359 | * when describing dates with times. This situation may be clarified in |
|
360 | * future revisions. |
|
361 | * |
|
362 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
363 | * |
|
364 | * @return static |
|
365 | * |
|
366 | * @see http://schema.org/startTime |
|
367 | */ |
|
368 | public function startTime($startTime) |
|
369 | { |
|
370 | return $this->setProperty('startTime', $startTime); |
|
371 | } |
|
372 | ||
373 | /** |
|
374 | * A CreativeWork or Event about this Thing. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/subjectOf |
|
381 | */ |
|
382 | public function subjectOf($subjectOf) |
|
383 | { |
|
384 | return $this->setProperty('subjectOf', $subjectOf); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * Indicates a target EntryPoint for an Action. |
|
389 | * |
|
390 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/target |
|
395 | */ |
|
396 | public function target($target) |
|
397 | { |
|
398 | return $this->setProperty('target', $target); |
|
399 | } |
|
400 | ||
401 | /** |
|
402 | * URL of the item. |
|
403 | * |
|
404 | * @param string|string[] $url |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/url |
|
409 | */ |
|
410 | public function url($url) |
|
411 | { |
|
412 | return $this->setProperty('url', $url); |
|
413 | } |
|
414 | ||
415 | } |
|
416 |
@@ 16-415 (lines=400) @@ | ||
13 | * @see http://schema.org/ViewAction |
|
14 | * |
|
15 | */ |
|
16 | class ViewAction extends BaseType implements ViewActionContract, ActionContract, ConsumeActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * A set of requirements that a must be fulfilled in order to perform an |
|
20 | * Action. If more than one value is specied, fulfilling one set of |
|
21 | * requirements will allow the Action to be performed. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionAccessibilityRequirement |
|
28 | */ |
|
29 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
30 | { |
|
31 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * Indicates the current disposition of the Action. |
|
36 | * |
|
37 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
38 | * |
|
39 | * @return static |
|
40 | * |
|
41 | * @see http://schema.org/actionStatus |
|
42 | */ |
|
43 | public function actionStatus($actionStatus) |
|
44 | { |
|
45 | return $this->setProperty('actionStatus', $actionStatus); |
|
46 | } |
|
47 | ||
48 | /** |
|
49 | * An additional type for the item, typically used for adding more specific |
|
50 | * types from external vocabularies in microdata syntax. This is a |
|
51 | * relationship between something and a class that the thing is in. In RDFa |
|
52 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
53 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
54 | * understanding of extra types, in particular those defined externally. |
|
55 | * |
|
56 | * @param string|string[] $additionalType |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/additionalType |
|
61 | */ |
|
62 | public function additionalType($additionalType) |
|
63 | { |
|
64 | return $this->setProperty('additionalType', $additionalType); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
69 | * *John* wrote a book. |
|
70 | * |
|
71 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/agent |
|
76 | */ |
|
77 | public function agent($agent) |
|
78 | { |
|
79 | return $this->setProperty('agent', $agent); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * An alias for the item. |
|
84 | * |
|
85 | * @param string|string[] $alternateName |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/alternateName |
|
90 | */ |
|
91 | public function alternateName($alternateName) |
|
92 | { |
|
93 | return $this->setProperty('alternateName', $alternateName); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * An Offer which must be accepted before the user can perform the Action. |
|
166 | * For example, the user may need to buy a movie before being able to watch |
|
167 | * it. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/expectsAcceptanceOf |
|
174 | */ |
|
175 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
176 | { |
|
177 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * The identifier property represents any kind of identifier for any kind of |
|
182 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
183 | * dedicated properties for representing many of these, either as textual |
|
184 | * strings or as URL (URI) links. See [background |
|
185 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
186 | * |
|
187 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
188 | * |
|
189 | * @return static |
|
190 | * |
|
191 | * @see http://schema.org/identifier |
|
192 | */ |
|
193 | public function identifier($identifier) |
|
194 | { |
|
195 | return $this->setProperty('identifier', $identifier); |
|
196 | } |
|
197 | ||
198 | /** |
|
199 | * An image of the item. This can be a [[URL]] or a fully described |
|
200 | * [[ImageObject]]. |
|
201 | * |
|
202 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
203 | * |
|
204 | * @return static |
|
205 | * |
|
206 | * @see http://schema.org/image |
|
207 | */ |
|
208 | public function image($image) |
|
209 | { |
|
210 | return $this->setProperty('image', $image); |
|
211 | } |
|
212 | ||
213 | /** |
|
214 | * The object that helped the agent perform the action. e.g. John wrote a |
|
215 | * book with *a pen*. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/instrument |
|
222 | */ |
|
223 | public function instrument($instrument) |
|
224 | { |
|
225 | return $this->setProperty('instrument', $instrument); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The location of for example where the event is happening, an organization |
|
230 | * is located, or where an action takes place. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/location |
|
237 | */ |
|
238 | public function location($location) |
|
239 | { |
|
240 | return $this->setProperty('location', $location); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
245 | * entity being described. See [background |
|
246 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/mainEntityOfPage |
|
253 | */ |
|
254 | public function mainEntityOfPage($mainEntityOfPage) |
|
255 | { |
|
256 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The name of the item. |
|
261 | * |
|
262 | * @param string|string[] $name |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/name |
|
267 | */ |
|
268 | public function name($name) |
|
269 | { |
|
270 | return $this->setProperty('name', $name); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * The object upon which the action is carried out, whose state is kept |
|
275 | * intact or changed. Also known as the semantic roles patient, affected or |
|
276 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
277 | * read *a book*. |
|
278 | * |
|
279 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
280 | * |
|
281 | * @return static |
|
282 | * |
|
283 | * @see http://schema.org/object |
|
284 | */ |
|
285 | public function object($object) |
|
286 | { |
|
287 | return $this->setProperty('object', $object); |
|
288 | } |
|
289 | ||
290 | /** |
|
291 | * Other co-agents that participated in the action indirectly. e.g. John |
|
292 | * wrote a book with *Steve*. |
|
293 | * |
|
294 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
295 | * |
|
296 | * @return static |
|
297 | * |
|
298 | * @see http://schema.org/participant |
|
299 | */ |
|
300 | public function participant($participant) |
|
301 | { |
|
302 | return $this->setProperty('participant', $participant); |
|
303 | } |
|
304 | ||
305 | /** |
|
306 | * Indicates a potential Action, which describes an idealized action in |
|
307 | * which this thing would play an 'object' role. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/potentialAction |
|
314 | */ |
|
315 | public function potentialAction($potentialAction) |
|
316 | { |
|
317 | return $this->setProperty('potentialAction', $potentialAction); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * The result produced in the action. e.g. John wrote *a book*. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/result |
|
328 | */ |
|
329 | public function result($result) |
|
330 | { |
|
331 | return $this->setProperty('result', $result); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * The startTime of something. For a reserved event or service (e.g. |
|
352 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
353 | * actions that span a period of time, when the action was performed. e.g. |
|
354 | * John wrote a book from *January* to December. For media, including audio |
|
355 | * and video, it's the time offset of the start of a clip within a larger |
|
356 | * file. |
|
357 | * |
|
358 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
359 | * when describing dates with times. This situation may be clarified in |
|
360 | * future revisions. |
|
361 | * |
|
362 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
363 | * |
|
364 | * @return static |
|
365 | * |
|
366 | * @see http://schema.org/startTime |
|
367 | */ |
|
368 | public function startTime($startTime) |
|
369 | { |
|
370 | return $this->setProperty('startTime', $startTime); |
|
371 | } |
|
372 | ||
373 | /** |
|
374 | * A CreativeWork or Event about this Thing. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/subjectOf |
|
381 | */ |
|
382 | public function subjectOf($subjectOf) |
|
383 | { |
|
384 | return $this->setProperty('subjectOf', $subjectOf); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * Indicates a target EntryPoint for an Action. |
|
389 | * |
|
390 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/target |
|
395 | */ |
|
396 | public function target($target) |
|
397 | { |
|
398 | return $this->setProperty('target', $target); |
|
399 | } |
|
400 | ||
401 | /** |
|
402 | * URL of the item. |
|
403 | * |
|
404 | * @param string|string[] $url |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/url |
|
409 | */ |
|
410 | public function url($url) |
|
411 | { |
|
412 | return $this->setProperty('url', $url); |
|
413 | } |
|
414 | ||
415 | } |
|
416 |
@@ 18-427 (lines=410) @@ | ||
15 | * @see http://schema.org/VoteAction |
|
16 | * |
|
17 | */ |
|
18 | class VoteAction extends BaseType implements VoteActionContract, ActionContract, AssessActionContract, ChooseActionContract, ThingContract |
|
19 | { |
|
20 | /** |
|
21 | * A sub property of object. The options subject to this action. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $actionOption |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionOption |
|
28 | */ |
|
29 | public function actionOption($actionOption) |
|
30 | { |
|
31 | return $this->setProperty('actionOption', $actionOption); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * Indicates the current disposition of the Action. |
|
36 | * |
|
37 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
38 | * |
|
39 | * @return static |
|
40 | * |
|
41 | * @see http://schema.org/actionStatus |
|
42 | */ |
|
43 | public function actionStatus($actionStatus) |
|
44 | { |
|
45 | return $this->setProperty('actionStatus', $actionStatus); |
|
46 | } |
|
47 | ||
48 | /** |
|
49 | * An additional type for the item, typically used for adding more specific |
|
50 | * types from external vocabularies in microdata syntax. This is a |
|
51 | * relationship between something and a class that the thing is in. In RDFa |
|
52 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
53 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
54 | * understanding of extra types, in particular those defined externally. |
|
55 | * |
|
56 | * @param string|string[] $additionalType |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/additionalType |
|
61 | */ |
|
62 | public function additionalType($additionalType) |
|
63 | { |
|
64 | return $this->setProperty('additionalType', $additionalType); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
69 | * *John* wrote a book. |
|
70 | * |
|
71 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/agent |
|
76 | */ |
|
77 | public function agent($agent) |
|
78 | { |
|
79 | return $this->setProperty('agent', $agent); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * An alias for the item. |
|
84 | * |
|
85 | * @param string|string[] $alternateName |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/alternateName |
|
90 | */ |
|
91 | public function alternateName($alternateName) |
|
92 | { |
|
93 | return $this->setProperty('alternateName', $alternateName); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A sub property of object. The candidate subject of this action. |
|
98 | * |
|
99 | * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $candidate |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/candidate |
|
104 | */ |
|
105 | public function candidate($candidate) |
|
106 | { |
|
107 | return $this->setProperty('candidate', $candidate); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A description of the item. |
|
112 | * |
|
113 | * @param string|string[] $description |
|
114 | * |
|
115 | * @return static |
|
116 | * |
|
117 | * @see http://schema.org/description |
|
118 | */ |
|
119 | public function description($description) |
|
120 | { |
|
121 | return $this->setProperty('description', $description); |
|
122 | } |
|
123 | ||
124 | /** |
|
125 | * A sub property of description. A short description of the item used to |
|
126 | * disambiguate from other, similar items. Information from other properties |
|
127 | * (in particular, name) may be necessary for the description to be useful |
|
128 | * for disambiguation. |
|
129 | * |
|
130 | * @param string|string[] $disambiguatingDescription |
|
131 | * |
|
132 | * @return static |
|
133 | * |
|
134 | * @see http://schema.org/disambiguatingDescription |
|
135 | */ |
|
136 | public function disambiguatingDescription($disambiguatingDescription) |
|
137 | { |
|
138 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
139 | } |
|
140 | ||
141 | /** |
|
142 | * The endTime of something. For a reserved event or service (e.g. |
|
143 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
144 | * actions that span a period of time, when the action was performed. e.g. |
|
145 | * John wrote a book from January to *December*. For media, including audio |
|
146 | * and video, it's the time offset of the end of a clip within a larger |
|
147 | * file. |
|
148 | * |
|
149 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
150 | * when describing dates with times. This situation may be clarified in |
|
151 | * future revisions. |
|
152 | * |
|
153 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/endTime |
|
158 | */ |
|
159 | public function endTime($endTime) |
|
160 | { |
|
161 | return $this->setProperty('endTime', $endTime); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * For failed actions, more information on the cause of the failure. |
|
166 | * |
|
167 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
168 | * |
|
169 | * @return static |
|
170 | * |
|
171 | * @see http://schema.org/error |
|
172 | */ |
|
173 | public function error($error) |
|
174 | { |
|
175 | return $this->setProperty('error', $error); |
|
176 | } |
|
177 | ||
178 | /** |
|
179 | * The identifier property represents any kind of identifier for any kind of |
|
180 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
181 | * dedicated properties for representing many of these, either as textual |
|
182 | * strings or as URL (URI) links. See [background |
|
183 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/identifier |
|
190 | */ |
|
191 | public function identifier($identifier) |
|
192 | { |
|
193 | return $this->setProperty('identifier', $identifier); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * An image of the item. This can be a [[URL]] or a fully described |
|
198 | * [[ImageObject]]. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/image |
|
205 | */ |
|
206 | public function image($image) |
|
207 | { |
|
208 | return $this->setProperty('image', $image); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * The object that helped the agent perform the action. e.g. John wrote a |
|
213 | * book with *a pen*. |
|
214 | * |
|
215 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
216 | * |
|
217 | * @return static |
|
218 | * |
|
219 | * @see http://schema.org/instrument |
|
220 | */ |
|
221 | public function instrument($instrument) |
|
222 | { |
|
223 | return $this->setProperty('instrument', $instrument); |
|
224 | } |
|
225 | ||
226 | /** |
|
227 | * The location of for example where the event is happening, an organization |
|
228 | * is located, or where an action takes place. |
|
229 | * |
|
230 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
231 | * |
|
232 | * @return static |
|
233 | * |
|
234 | * @see http://schema.org/location |
|
235 | */ |
|
236 | public function location($location) |
|
237 | { |
|
238 | return $this->setProperty('location', $location); |
|
239 | } |
|
240 | ||
241 | /** |
|
242 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
243 | * entity being described. See [background |
|
244 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
245 | * |
|
246 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
247 | * |
|
248 | * @return static |
|
249 | * |
|
250 | * @see http://schema.org/mainEntityOfPage |
|
251 | */ |
|
252 | public function mainEntityOfPage($mainEntityOfPage) |
|
253 | { |
|
254 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
255 | } |
|
256 | ||
257 | /** |
|
258 | * The name of the item. |
|
259 | * |
|
260 | * @param string|string[] $name |
|
261 | * |
|
262 | * @return static |
|
263 | * |
|
264 | * @see http://schema.org/name |
|
265 | */ |
|
266 | public function name($name) |
|
267 | { |
|
268 | return $this->setProperty('name', $name); |
|
269 | } |
|
270 | ||
271 | /** |
|
272 | * The object upon which the action is carried out, whose state is kept |
|
273 | * intact or changed. Also known as the semantic roles patient, affected or |
|
274 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
275 | * read *a book*. |
|
276 | * |
|
277 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
278 | * |
|
279 | * @return static |
|
280 | * |
|
281 | * @see http://schema.org/object |
|
282 | */ |
|
283 | public function object($object) |
|
284 | { |
|
285 | return $this->setProperty('object', $object); |
|
286 | } |
|
287 | ||
288 | /** |
|
289 | * A sub property of object. The options subject to this action. |
|
290 | * |
|
291 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $option |
|
292 | * |
|
293 | * @return static |
|
294 | * |
|
295 | * @see http://schema.org/option |
|
296 | */ |
|
297 | public function option($option) |
|
298 | { |
|
299 | return $this->setProperty('option', $option); |
|
300 | } |
|
301 | ||
302 | /** |
|
303 | * Other co-agents that participated in the action indirectly. e.g. John |
|
304 | * wrote a book with *Steve*. |
|
305 | * |
|
306 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
307 | * |
|
308 | * @return static |
|
309 | * |
|
310 | * @see http://schema.org/participant |
|
311 | */ |
|
312 | public function participant($participant) |
|
313 | { |
|
314 | return $this->setProperty('participant', $participant); |
|
315 | } |
|
316 | ||
317 | /** |
|
318 | * Indicates a potential Action, which describes an idealized action in |
|
319 | * which this thing would play an 'object' role. |
|
320 | * |
|
321 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
322 | * |
|
323 | * @return static |
|
324 | * |
|
325 | * @see http://schema.org/potentialAction |
|
326 | */ |
|
327 | public function potentialAction($potentialAction) |
|
328 | { |
|
329 | return $this->setProperty('potentialAction', $potentialAction); |
|
330 | } |
|
331 | ||
332 | /** |
|
333 | * The result produced in the action. e.g. John wrote *a book*. |
|
334 | * |
|
335 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
336 | * |
|
337 | * @return static |
|
338 | * |
|
339 | * @see http://schema.org/result |
|
340 | */ |
|
341 | public function result($result) |
|
342 | { |
|
343 | return $this->setProperty('result', $result); |
|
344 | } |
|
345 | ||
346 | /** |
|
347 | * URL of a reference Web page that unambiguously indicates the item's |
|
348 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
349 | * official website. |
|
350 | * |
|
351 | * @param string|string[] $sameAs |
|
352 | * |
|
353 | * @return static |
|
354 | * |
|
355 | * @see http://schema.org/sameAs |
|
356 | */ |
|
357 | public function sameAs($sameAs) |
|
358 | { |
|
359 | return $this->setProperty('sameAs', $sameAs); |
|
360 | } |
|
361 | ||
362 | /** |
|
363 | * The startTime of something. For a reserved event or service (e.g. |
|
364 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
365 | * actions that span a period of time, when the action was performed. e.g. |
|
366 | * John wrote a book from *January* to December. For media, including audio |
|
367 | * and video, it's the time offset of the start of a clip within a larger |
|
368 | * file. |
|
369 | * |
|
370 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
371 | * when describing dates with times. This situation may be clarified in |
|
372 | * future revisions. |
|
373 | * |
|
374 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
375 | * |
|
376 | * @return static |
|
377 | * |
|
378 | * @see http://schema.org/startTime |
|
379 | */ |
|
380 | public function startTime($startTime) |
|
381 | { |
|
382 | return $this->setProperty('startTime', $startTime); |
|
383 | } |
|
384 | ||
385 | /** |
|
386 | * A CreativeWork or Event about this Thing. |
|
387 | * |
|
388 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
389 | * |
|
390 | * @return static |
|
391 | * |
|
392 | * @see http://schema.org/subjectOf |
|
393 | */ |
|
394 | public function subjectOf($subjectOf) |
|
395 | { |
|
396 | return $this->setProperty('subjectOf', $subjectOf); |
|
397 | } |
|
398 | ||
399 | /** |
|
400 | * Indicates a target EntryPoint for an Action. |
|
401 | * |
|
402 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
403 | * |
|
404 | * @return static |
|
405 | * |
|
406 | * @see http://schema.org/target |
|
407 | */ |
|
408 | public function target($target) |
|
409 | { |
|
410 | return $this->setProperty('target', $target); |
|
411 | } |
|
412 | ||
413 | /** |
|
414 | * URL of the item. |
|
415 | * |
|
416 | * @param string|string[] $url |
|
417 | * |
|
418 | * @return static |
|
419 | * |
|
420 | * @see http://schema.org/url |
|
421 | */ |
|
422 | public function url($url) |
|
423 | { |
|
424 | return $this->setProperty('url', $url); |
|
425 | } |
|
426 | ||
427 | } |
|
428 |
@@ 16-415 (lines=400) @@ | ||
13 | * @see http://schema.org/WatchAction |
|
14 | * |
|
15 | */ |
|
16 | class WatchAction extends BaseType implements WatchActionContract, ActionContract, ConsumeActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * A set of requirements that a must be fulfilled in order to perform an |
|
20 | * Action. If more than one value is specied, fulfilling one set of |
|
21 | * requirements will allow the Action to be performed. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/actionAccessibilityRequirement |
|
28 | */ |
|
29 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
30 | { |
|
31 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
32 | } |
|
33 | ||
34 | /** |
|
35 | * Indicates the current disposition of the Action. |
|
36 | * |
|
37 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
38 | * |
|
39 | * @return static |
|
40 | * |
|
41 | * @see http://schema.org/actionStatus |
|
42 | */ |
|
43 | public function actionStatus($actionStatus) |
|
44 | { |
|
45 | return $this->setProperty('actionStatus', $actionStatus); |
|
46 | } |
|
47 | ||
48 | /** |
|
49 | * An additional type for the item, typically used for adding more specific |
|
50 | * types from external vocabularies in microdata syntax. This is a |
|
51 | * relationship between something and a class that the thing is in. In RDFa |
|
52 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
53 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
54 | * understanding of extra types, in particular those defined externally. |
|
55 | * |
|
56 | * @param string|string[] $additionalType |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/additionalType |
|
61 | */ |
|
62 | public function additionalType($additionalType) |
|
63 | { |
|
64 | return $this->setProperty('additionalType', $additionalType); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
69 | * *John* wrote a book. |
|
70 | * |
|
71 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
72 | * |
|
73 | * @return static |
|
74 | * |
|
75 | * @see http://schema.org/agent |
|
76 | */ |
|
77 | public function agent($agent) |
|
78 | { |
|
79 | return $this->setProperty('agent', $agent); |
|
80 | } |
|
81 | ||
82 | /** |
|
83 | * An alias for the item. |
|
84 | * |
|
85 | * @param string|string[] $alternateName |
|
86 | * |
|
87 | * @return static |
|
88 | * |
|
89 | * @see http://schema.org/alternateName |
|
90 | */ |
|
91 | public function alternateName($alternateName) |
|
92 | { |
|
93 | return $this->setProperty('alternateName', $alternateName); |
|
94 | } |
|
95 | ||
96 | /** |
|
97 | * A description of the item. |
|
98 | * |
|
99 | * @param string|string[] $description |
|
100 | * |
|
101 | * @return static |
|
102 | * |
|
103 | * @see http://schema.org/description |
|
104 | */ |
|
105 | public function description($description) |
|
106 | { |
|
107 | return $this->setProperty('description', $description); |
|
108 | } |
|
109 | ||
110 | /** |
|
111 | * A sub property of description. A short description of the item used to |
|
112 | * disambiguate from other, similar items. Information from other properties |
|
113 | * (in particular, name) may be necessary for the description to be useful |
|
114 | * for disambiguation. |
|
115 | * |
|
116 | * @param string|string[] $disambiguatingDescription |
|
117 | * |
|
118 | * @return static |
|
119 | * |
|
120 | * @see http://schema.org/disambiguatingDescription |
|
121 | */ |
|
122 | public function disambiguatingDescription($disambiguatingDescription) |
|
123 | { |
|
124 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
125 | } |
|
126 | ||
127 | /** |
|
128 | * The endTime of something. For a reserved event or service (e.g. |
|
129 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
130 | * actions that span a period of time, when the action was performed. e.g. |
|
131 | * John wrote a book from January to *December*. For media, including audio |
|
132 | * and video, it's the time offset of the end of a clip within a larger |
|
133 | * file. |
|
134 | * |
|
135 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
136 | * when describing dates with times. This situation may be clarified in |
|
137 | * future revisions. |
|
138 | * |
|
139 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
140 | * |
|
141 | * @return static |
|
142 | * |
|
143 | * @see http://schema.org/endTime |
|
144 | */ |
|
145 | public function endTime($endTime) |
|
146 | { |
|
147 | return $this->setProperty('endTime', $endTime); |
|
148 | } |
|
149 | ||
150 | /** |
|
151 | * For failed actions, more information on the cause of the failure. |
|
152 | * |
|
153 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
154 | * |
|
155 | * @return static |
|
156 | * |
|
157 | * @see http://schema.org/error |
|
158 | */ |
|
159 | public function error($error) |
|
160 | { |
|
161 | return $this->setProperty('error', $error); |
|
162 | } |
|
163 | ||
164 | /** |
|
165 | * An Offer which must be accepted before the user can perform the Action. |
|
166 | * For example, the user may need to buy a movie before being able to watch |
|
167 | * it. |
|
168 | * |
|
169 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
170 | * |
|
171 | * @return static |
|
172 | * |
|
173 | * @see http://schema.org/expectsAcceptanceOf |
|
174 | */ |
|
175 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
176 | { |
|
177 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
178 | } |
|
179 | ||
180 | /** |
|
181 | * The identifier property represents any kind of identifier for any kind of |
|
182 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
183 | * dedicated properties for representing many of these, either as textual |
|
184 | * strings or as URL (URI) links. See [background |
|
185 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
186 | * |
|
187 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
188 | * |
|
189 | * @return static |
|
190 | * |
|
191 | * @see http://schema.org/identifier |
|
192 | */ |
|
193 | public function identifier($identifier) |
|
194 | { |
|
195 | return $this->setProperty('identifier', $identifier); |
|
196 | } |
|
197 | ||
198 | /** |
|
199 | * An image of the item. This can be a [[URL]] or a fully described |
|
200 | * [[ImageObject]]. |
|
201 | * |
|
202 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
203 | * |
|
204 | * @return static |
|
205 | * |
|
206 | * @see http://schema.org/image |
|
207 | */ |
|
208 | public function image($image) |
|
209 | { |
|
210 | return $this->setProperty('image', $image); |
|
211 | } |
|
212 | ||
213 | /** |
|
214 | * The object that helped the agent perform the action. e.g. John wrote a |
|
215 | * book with *a pen*. |
|
216 | * |
|
217 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
218 | * |
|
219 | * @return static |
|
220 | * |
|
221 | * @see http://schema.org/instrument |
|
222 | */ |
|
223 | public function instrument($instrument) |
|
224 | { |
|
225 | return $this->setProperty('instrument', $instrument); |
|
226 | } |
|
227 | ||
228 | /** |
|
229 | * The location of for example where the event is happening, an organization |
|
230 | * is located, or where an action takes place. |
|
231 | * |
|
232 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
233 | * |
|
234 | * @return static |
|
235 | * |
|
236 | * @see http://schema.org/location |
|
237 | */ |
|
238 | public function location($location) |
|
239 | { |
|
240 | return $this->setProperty('location', $location); |
|
241 | } |
|
242 | ||
243 | /** |
|
244 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
245 | * entity being described. See [background |
|
246 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
247 | * |
|
248 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
249 | * |
|
250 | * @return static |
|
251 | * |
|
252 | * @see http://schema.org/mainEntityOfPage |
|
253 | */ |
|
254 | public function mainEntityOfPage($mainEntityOfPage) |
|
255 | { |
|
256 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
257 | } |
|
258 | ||
259 | /** |
|
260 | * The name of the item. |
|
261 | * |
|
262 | * @param string|string[] $name |
|
263 | * |
|
264 | * @return static |
|
265 | * |
|
266 | * @see http://schema.org/name |
|
267 | */ |
|
268 | public function name($name) |
|
269 | { |
|
270 | return $this->setProperty('name', $name); |
|
271 | } |
|
272 | ||
273 | /** |
|
274 | * The object upon which the action is carried out, whose state is kept |
|
275 | * intact or changed. Also known as the semantic roles patient, affected or |
|
276 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
277 | * read *a book*. |
|
278 | * |
|
279 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
280 | * |
|
281 | * @return static |
|
282 | * |
|
283 | * @see http://schema.org/object |
|
284 | */ |
|
285 | public function object($object) |
|
286 | { |
|
287 | return $this->setProperty('object', $object); |
|
288 | } |
|
289 | ||
290 | /** |
|
291 | * Other co-agents that participated in the action indirectly. e.g. John |
|
292 | * wrote a book with *Steve*. |
|
293 | * |
|
294 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
295 | * |
|
296 | * @return static |
|
297 | * |
|
298 | * @see http://schema.org/participant |
|
299 | */ |
|
300 | public function participant($participant) |
|
301 | { |
|
302 | return $this->setProperty('participant', $participant); |
|
303 | } |
|
304 | ||
305 | /** |
|
306 | * Indicates a potential Action, which describes an idealized action in |
|
307 | * which this thing would play an 'object' role. |
|
308 | * |
|
309 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
310 | * |
|
311 | * @return static |
|
312 | * |
|
313 | * @see http://schema.org/potentialAction |
|
314 | */ |
|
315 | public function potentialAction($potentialAction) |
|
316 | { |
|
317 | return $this->setProperty('potentialAction', $potentialAction); |
|
318 | } |
|
319 | ||
320 | /** |
|
321 | * The result produced in the action. e.g. John wrote *a book*. |
|
322 | * |
|
323 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
324 | * |
|
325 | * @return static |
|
326 | * |
|
327 | * @see http://schema.org/result |
|
328 | */ |
|
329 | public function result($result) |
|
330 | { |
|
331 | return $this->setProperty('result', $result); |
|
332 | } |
|
333 | ||
334 | /** |
|
335 | * URL of a reference Web page that unambiguously indicates the item's |
|
336 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
337 | * official website. |
|
338 | * |
|
339 | * @param string|string[] $sameAs |
|
340 | * |
|
341 | * @return static |
|
342 | * |
|
343 | * @see http://schema.org/sameAs |
|
344 | */ |
|
345 | public function sameAs($sameAs) |
|
346 | { |
|
347 | return $this->setProperty('sameAs', $sameAs); |
|
348 | } |
|
349 | ||
350 | /** |
|
351 | * The startTime of something. For a reserved event or service (e.g. |
|
352 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
353 | * actions that span a period of time, when the action was performed. e.g. |
|
354 | * John wrote a book from *January* to December. For media, including audio |
|
355 | * and video, it's the time offset of the start of a clip within a larger |
|
356 | * file. |
|
357 | * |
|
358 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
359 | * when describing dates with times. This situation may be clarified in |
|
360 | * future revisions. |
|
361 | * |
|
362 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
363 | * |
|
364 | * @return static |
|
365 | * |
|
366 | * @see http://schema.org/startTime |
|
367 | */ |
|
368 | public function startTime($startTime) |
|
369 | { |
|
370 | return $this->setProperty('startTime', $startTime); |
|
371 | } |
|
372 | ||
373 | /** |
|
374 | * A CreativeWork or Event about this Thing. |
|
375 | * |
|
376 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
377 | * |
|
378 | * @return static |
|
379 | * |
|
380 | * @see http://schema.org/subjectOf |
|
381 | */ |
|
382 | public function subjectOf($subjectOf) |
|
383 | { |
|
384 | return $this->setProperty('subjectOf', $subjectOf); |
|
385 | } |
|
386 | ||
387 | /** |
|
388 | * Indicates a target EntryPoint for an Action. |
|
389 | * |
|
390 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
391 | * |
|
392 | * @return static |
|
393 | * |
|
394 | * @see http://schema.org/target |
|
395 | */ |
|
396 | public function target($target) |
|
397 | { |
|
398 | return $this->setProperty('target', $target); |
|
399 | } |
|
400 | ||
401 | /** |
|
402 | * URL of the item. |
|
403 | * |
|
404 | * @param string|string[] $url |
|
405 | * |
|
406 | * @return static |
|
407 | * |
|
408 | * @see http://schema.org/url |
|
409 | */ |
|
410 | public function url($url) |
|
411 | { |
|
412 | return $this->setProperty('url', $url); |
|
413 | } |
|
414 | ||
415 | } |
|
416 |
@@ 17-416 (lines=400) @@ | ||
14 | * @see http://schema.org/WearAction |
|
15 | * |
|
16 | */ |
|
17 | class WearAction extends BaseType implements WearActionContract, ActionContract, ConsumeActionContract, ThingContract, UseActionContract |
|
18 | { |
|
19 | /** |
|
20 | * A set of requirements that a must be fulfilled in order to perform an |
|
21 | * Action. If more than one value is specied, fulfilling one set of |
|
22 | * requirements will allow the Action to be performed. |
|
23 | * |
|
24 | * @param \Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract|\Spatie\SchemaOrg\Contracts\ActionAccessSpecificationContract[] $actionAccessibilityRequirement |
|
25 | * |
|
26 | * @return static |
|
27 | * |
|
28 | * @see http://schema.org/actionAccessibilityRequirement |
|
29 | */ |
|
30 | public function actionAccessibilityRequirement($actionAccessibilityRequirement) |
|
31 | { |
|
32 | return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); |
|
33 | } |
|
34 | ||
35 | /** |
|
36 | * Indicates the current disposition of the Action. |
|
37 | * |
|
38 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
39 | * |
|
40 | * @return static |
|
41 | * |
|
42 | * @see http://schema.org/actionStatus |
|
43 | */ |
|
44 | public function actionStatus($actionStatus) |
|
45 | { |
|
46 | return $this->setProperty('actionStatus', $actionStatus); |
|
47 | } |
|
48 | ||
49 | /** |
|
50 | * An additional type for the item, typically used for adding more specific |
|
51 | * types from external vocabularies in microdata syntax. This is a |
|
52 | * relationship between something and a class that the thing is in. In RDFa |
|
53 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
54 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
55 | * understanding of extra types, in particular those defined externally. |
|
56 | * |
|
57 | * @param string|string[] $additionalType |
|
58 | * |
|
59 | * @return static |
|
60 | * |
|
61 | * @see http://schema.org/additionalType |
|
62 | */ |
|
63 | public function additionalType($additionalType) |
|
64 | { |
|
65 | return $this->setProperty('additionalType', $additionalType); |
|
66 | } |
|
67 | ||
68 | /** |
|
69 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
70 | * *John* wrote a book. |
|
71 | * |
|
72 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
73 | * |
|
74 | * @return static |
|
75 | * |
|
76 | * @see http://schema.org/agent |
|
77 | */ |
|
78 | public function agent($agent) |
|
79 | { |
|
80 | return $this->setProperty('agent', $agent); |
|
81 | } |
|
82 | ||
83 | /** |
|
84 | * An alias for the item. |
|
85 | * |
|
86 | * @param string|string[] $alternateName |
|
87 | * |
|
88 | * @return static |
|
89 | * |
|
90 | * @see http://schema.org/alternateName |
|
91 | */ |
|
92 | public function alternateName($alternateName) |
|
93 | { |
|
94 | return $this->setProperty('alternateName', $alternateName); |
|
95 | } |
|
96 | ||
97 | /** |
|
98 | * A description of the item. |
|
99 | * |
|
100 | * @param string|string[] $description |
|
101 | * |
|
102 | * @return static |
|
103 | * |
|
104 | * @see http://schema.org/description |
|
105 | */ |
|
106 | public function description($description) |
|
107 | { |
|
108 | return $this->setProperty('description', $description); |
|
109 | } |
|
110 | ||
111 | /** |
|
112 | * A sub property of description. A short description of the item used to |
|
113 | * disambiguate from other, similar items. Information from other properties |
|
114 | * (in particular, name) may be necessary for the description to be useful |
|
115 | * for disambiguation. |
|
116 | * |
|
117 | * @param string|string[] $disambiguatingDescription |
|
118 | * |
|
119 | * @return static |
|
120 | * |
|
121 | * @see http://schema.org/disambiguatingDescription |
|
122 | */ |
|
123 | public function disambiguatingDescription($disambiguatingDescription) |
|
124 | { |
|
125 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
126 | } |
|
127 | ||
128 | /** |
|
129 | * The endTime of something. For a reserved event or service (e.g. |
|
130 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
131 | * actions that span a period of time, when the action was performed. e.g. |
|
132 | * John wrote a book from January to *December*. For media, including audio |
|
133 | * and video, it's the time offset of the end of a clip within a larger |
|
134 | * file. |
|
135 | * |
|
136 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
137 | * when describing dates with times. This situation may be clarified in |
|
138 | * future revisions. |
|
139 | * |
|
140 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
141 | * |
|
142 | * @return static |
|
143 | * |
|
144 | * @see http://schema.org/endTime |
|
145 | */ |
|
146 | public function endTime($endTime) |
|
147 | { |
|
148 | return $this->setProperty('endTime', $endTime); |
|
149 | } |
|
150 | ||
151 | /** |
|
152 | * For failed actions, more information on the cause of the failure. |
|
153 | * |
|
154 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
155 | * |
|
156 | * @return static |
|
157 | * |
|
158 | * @see http://schema.org/error |
|
159 | */ |
|
160 | public function error($error) |
|
161 | { |
|
162 | return $this->setProperty('error', $error); |
|
163 | } |
|
164 | ||
165 | /** |
|
166 | * An Offer which must be accepted before the user can perform the Action. |
|
167 | * For example, the user may need to buy a movie before being able to watch |
|
168 | * it. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $expectsAcceptanceOf |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/expectsAcceptanceOf |
|
175 | */ |
|
176 | public function expectsAcceptanceOf($expectsAcceptanceOf) |
|
177 | { |
|
178 | return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * The identifier property represents any kind of identifier for any kind of |
|
183 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
184 | * dedicated properties for representing many of these, either as textual |
|
185 | * strings or as URL (URI) links. See [background |
|
186 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
187 | * |
|
188 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
189 | * |
|
190 | * @return static |
|
191 | * |
|
192 | * @see http://schema.org/identifier |
|
193 | */ |
|
194 | public function identifier($identifier) |
|
195 | { |
|
196 | return $this->setProperty('identifier', $identifier); |
|
197 | } |
|
198 | ||
199 | /** |
|
200 | * An image of the item. This can be a [[URL]] or a fully described |
|
201 | * [[ImageObject]]. |
|
202 | * |
|
203 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
204 | * |
|
205 | * @return static |
|
206 | * |
|
207 | * @see http://schema.org/image |
|
208 | */ |
|
209 | public function image($image) |
|
210 | { |
|
211 | return $this->setProperty('image', $image); |
|
212 | } |
|
213 | ||
214 | /** |
|
215 | * The object that helped the agent perform the action. e.g. John wrote a |
|
216 | * book with *a pen*. |
|
217 | * |
|
218 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
219 | * |
|
220 | * @return static |
|
221 | * |
|
222 | * @see http://schema.org/instrument |
|
223 | */ |
|
224 | public function instrument($instrument) |
|
225 | { |
|
226 | return $this->setProperty('instrument', $instrument); |
|
227 | } |
|
228 | ||
229 | /** |
|
230 | * The location of for example where the event is happening, an organization |
|
231 | * is located, or where an action takes place. |
|
232 | * |
|
233 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
234 | * |
|
235 | * @return static |
|
236 | * |
|
237 | * @see http://schema.org/location |
|
238 | */ |
|
239 | public function location($location) |
|
240 | { |
|
241 | return $this->setProperty('location', $location); |
|
242 | } |
|
243 | ||
244 | /** |
|
245 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
246 | * entity being described. See [background |
|
247 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
248 | * |
|
249 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
250 | * |
|
251 | * @return static |
|
252 | * |
|
253 | * @see http://schema.org/mainEntityOfPage |
|
254 | */ |
|
255 | public function mainEntityOfPage($mainEntityOfPage) |
|
256 | { |
|
257 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
258 | } |
|
259 | ||
260 | /** |
|
261 | * The name of the item. |
|
262 | * |
|
263 | * @param string|string[] $name |
|
264 | * |
|
265 | * @return static |
|
266 | * |
|
267 | * @see http://schema.org/name |
|
268 | */ |
|
269 | public function name($name) |
|
270 | { |
|
271 | return $this->setProperty('name', $name); |
|
272 | } |
|
273 | ||
274 | /** |
|
275 | * The object upon which the action is carried out, whose state is kept |
|
276 | * intact or changed. Also known as the semantic roles patient, affected or |
|
277 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
278 | * read *a book*. |
|
279 | * |
|
280 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
281 | * |
|
282 | * @return static |
|
283 | * |
|
284 | * @see http://schema.org/object |
|
285 | */ |
|
286 | public function object($object) |
|
287 | { |
|
288 | return $this->setProperty('object', $object); |
|
289 | } |
|
290 | ||
291 | /** |
|
292 | * Other co-agents that participated in the action indirectly. e.g. John |
|
293 | * wrote a book with *Steve*. |
|
294 | * |
|
295 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
296 | * |
|
297 | * @return static |
|
298 | * |
|
299 | * @see http://schema.org/participant |
|
300 | */ |
|
301 | public function participant($participant) |
|
302 | { |
|
303 | return $this->setProperty('participant', $participant); |
|
304 | } |
|
305 | ||
306 | /** |
|
307 | * Indicates a potential Action, which describes an idealized action in |
|
308 | * which this thing would play an 'object' role. |
|
309 | * |
|
310 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
311 | * |
|
312 | * @return static |
|
313 | * |
|
314 | * @see http://schema.org/potentialAction |
|
315 | */ |
|
316 | public function potentialAction($potentialAction) |
|
317 | { |
|
318 | return $this->setProperty('potentialAction', $potentialAction); |
|
319 | } |
|
320 | ||
321 | /** |
|
322 | * The result produced in the action. e.g. John wrote *a book*. |
|
323 | * |
|
324 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
325 | * |
|
326 | * @return static |
|
327 | * |
|
328 | * @see http://schema.org/result |
|
329 | */ |
|
330 | public function result($result) |
|
331 | { |
|
332 | return $this->setProperty('result', $result); |
|
333 | } |
|
334 | ||
335 | /** |
|
336 | * URL of a reference Web page that unambiguously indicates the item's |
|
337 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
338 | * official website. |
|
339 | * |
|
340 | * @param string|string[] $sameAs |
|
341 | * |
|
342 | * @return static |
|
343 | * |
|
344 | * @see http://schema.org/sameAs |
|
345 | */ |
|
346 | public function sameAs($sameAs) |
|
347 | { |
|
348 | return $this->setProperty('sameAs', $sameAs); |
|
349 | } |
|
350 | ||
351 | /** |
|
352 | * The startTime of something. For a reserved event or service (e.g. |
|
353 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
354 | * actions that span a period of time, when the action was performed. e.g. |
|
355 | * John wrote a book from *January* to December. For media, including audio |
|
356 | * and video, it's the time offset of the start of a clip within a larger |
|
357 | * file. |
|
358 | * |
|
359 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
360 | * when describing dates with times. This situation may be clarified in |
|
361 | * future revisions. |
|
362 | * |
|
363 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
364 | * |
|
365 | * @return static |
|
366 | * |
|
367 | * @see http://schema.org/startTime |
|
368 | */ |
|
369 | public function startTime($startTime) |
|
370 | { |
|
371 | return $this->setProperty('startTime', $startTime); |
|
372 | } |
|
373 | ||
374 | /** |
|
375 | * A CreativeWork or Event about this Thing. |
|
376 | * |
|
377 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
378 | * |
|
379 | * @return static |
|
380 | * |
|
381 | * @see http://schema.org/subjectOf |
|
382 | */ |
|
383 | public function subjectOf($subjectOf) |
|
384 | { |
|
385 | return $this->setProperty('subjectOf', $subjectOf); |
|
386 | } |
|
387 | ||
388 | /** |
|
389 | * Indicates a target EntryPoint for an Action. |
|
390 | * |
|
391 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
392 | * |
|
393 | * @return static |
|
394 | * |
|
395 | * @see http://schema.org/target |
|
396 | */ |
|
397 | public function target($target) |
|
398 | { |
|
399 | return $this->setProperty('target', $target); |
|
400 | } |
|
401 | ||
402 | /** |
|
403 | * URL of the item. |
|
404 | * |
|
405 | * @param string|string[] $url |
|
406 | * |
|
407 | * @return static |
|
408 | * |
|
409 | * @see http://schema.org/url |
|
410 | */ |
|
411 | public function url($url) |
|
412 | { |
|
413 | return $this->setProperty('url', $url); |
|
414 | } |
|
415 | ||
416 | } |
|
417 |
@@ 16-397 (lines=382) @@ | ||
13 | * @see http://schema.org/WinAction |
|
14 | * |
|
15 | */ |
|
16 | class WinAction extends BaseType implements WinActionContract, AchieveActionContract, ActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * Indicates the current disposition of the Action. |
|
20 | * |
|
21 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
22 | * |
|
23 | * @return static |
|
24 | * |
|
25 | * @see http://schema.org/actionStatus |
|
26 | */ |
|
27 | public function actionStatus($actionStatus) |
|
28 | { |
|
29 | return $this->setProperty('actionStatus', $actionStatus); |
|
30 | } |
|
31 | ||
32 | /** |
|
33 | * An additional type for the item, typically used for adding more specific |
|
34 | * types from external vocabularies in microdata syntax. This is a |
|
35 | * relationship between something and a class that the thing is in. In RDFa |
|
36 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
37 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
38 | * understanding of extra types, in particular those defined externally. |
|
39 | * |
|
40 | * @param string|string[] $additionalType |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/additionalType |
|
45 | */ |
|
46 | public function additionalType($additionalType) |
|
47 | { |
|
48 | return $this->setProperty('additionalType', $additionalType); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
53 | * *John* wrote a book. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/agent |
|
60 | */ |
|
61 | public function agent($agent) |
|
62 | { |
|
63 | return $this->setProperty('agent', $agent); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * An alias for the item. |
|
68 | * |
|
69 | * @param string|string[] $alternateName |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/alternateName |
|
74 | */ |
|
75 | public function alternateName($alternateName) |
|
76 | { |
|
77 | return $this->setProperty('alternateName', $alternateName); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * A description of the item. |
|
82 | * |
|
83 | * @param string|string[] $description |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/description |
|
88 | */ |
|
89 | public function description($description) |
|
90 | { |
|
91 | return $this->setProperty('description', $description); |
|
92 | } |
|
93 | ||
94 | /** |
|
95 | * A sub property of description. A short description of the item used to |
|
96 | * disambiguate from other, similar items. Information from other properties |
|
97 | * (in particular, name) may be necessary for the description to be useful |
|
98 | * for disambiguation. |
|
99 | * |
|
100 | * @param string|string[] $disambiguatingDescription |
|
101 | * |
|
102 | * @return static |
|
103 | * |
|
104 | * @see http://schema.org/disambiguatingDescription |
|
105 | */ |
|
106 | public function disambiguatingDescription($disambiguatingDescription) |
|
107 | { |
|
108 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
109 | } |
|
110 | ||
111 | /** |
|
112 | * The endTime of something. For a reserved event or service (e.g. |
|
113 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
114 | * actions that span a period of time, when the action was performed. e.g. |
|
115 | * John wrote a book from January to *December*. For media, including audio |
|
116 | * and video, it's the time offset of the end of a clip within a larger |
|
117 | * file. |
|
118 | * |
|
119 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
120 | * when describing dates with times. This situation may be clarified in |
|
121 | * future revisions. |
|
122 | * |
|
123 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
124 | * |
|
125 | * @return static |
|
126 | * |
|
127 | * @see http://schema.org/endTime |
|
128 | */ |
|
129 | public function endTime($endTime) |
|
130 | { |
|
131 | return $this->setProperty('endTime', $endTime); |
|
132 | } |
|
133 | ||
134 | /** |
|
135 | * For failed actions, more information on the cause of the failure. |
|
136 | * |
|
137 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
138 | * |
|
139 | * @return static |
|
140 | * |
|
141 | * @see http://schema.org/error |
|
142 | */ |
|
143 | public function error($error) |
|
144 | { |
|
145 | return $this->setProperty('error', $error); |
|
146 | } |
|
147 | ||
148 | /** |
|
149 | * The identifier property represents any kind of identifier for any kind of |
|
150 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
151 | * dedicated properties for representing many of these, either as textual |
|
152 | * strings or as URL (URI) links. See [background |
|
153 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
154 | * |
|
155 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
156 | * |
|
157 | * @return static |
|
158 | * |
|
159 | * @see http://schema.org/identifier |
|
160 | */ |
|
161 | public function identifier($identifier) |
|
162 | { |
|
163 | return $this->setProperty('identifier', $identifier); |
|
164 | } |
|
165 | ||
166 | /** |
|
167 | * An image of the item. This can be a [[URL]] or a fully described |
|
168 | * [[ImageObject]]. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/image |
|
175 | */ |
|
176 | public function image($image) |
|
177 | { |
|
178 | return $this->setProperty('image', $image); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * The object that helped the agent perform the action. e.g. John wrote a |
|
183 | * book with *a pen*. |
|
184 | * |
|
185 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
186 | * |
|
187 | * @return static |
|
188 | * |
|
189 | * @see http://schema.org/instrument |
|
190 | */ |
|
191 | public function instrument($instrument) |
|
192 | { |
|
193 | return $this->setProperty('instrument', $instrument); |
|
194 | } |
|
195 | ||
196 | /** |
|
197 | * The location of for example where the event is happening, an organization |
|
198 | * is located, or where an action takes place. |
|
199 | * |
|
200 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
201 | * |
|
202 | * @return static |
|
203 | * |
|
204 | * @see http://schema.org/location |
|
205 | */ |
|
206 | public function location($location) |
|
207 | { |
|
208 | return $this->setProperty('location', $location); |
|
209 | } |
|
210 | ||
211 | /** |
|
212 | * A sub property of participant. The loser of the action. |
|
213 | * |
|
214 | * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $loser |
|
215 | * |
|
216 | * @return static |
|
217 | * |
|
218 | * @see http://schema.org/loser |
|
219 | */ |
|
220 | public function loser($loser) |
|
221 | { |
|
222 | return $this->setProperty('loser', $loser); |
|
223 | } |
|
224 | ||
225 | /** |
|
226 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
227 | * entity being described. See [background |
|
228 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
229 | * |
|
230 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
231 | * |
|
232 | * @return static |
|
233 | * |
|
234 | * @see http://schema.org/mainEntityOfPage |
|
235 | */ |
|
236 | public function mainEntityOfPage($mainEntityOfPage) |
|
237 | { |
|
238 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
239 | } |
|
240 | ||
241 | /** |
|
242 | * The name of the item. |
|
243 | * |
|
244 | * @param string|string[] $name |
|
245 | * |
|
246 | * @return static |
|
247 | * |
|
248 | * @see http://schema.org/name |
|
249 | */ |
|
250 | public function name($name) |
|
251 | { |
|
252 | return $this->setProperty('name', $name); |
|
253 | } |
|
254 | ||
255 | /** |
|
256 | * The object upon which the action is carried out, whose state is kept |
|
257 | * intact or changed. Also known as the semantic roles patient, affected or |
|
258 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
259 | * read *a book*. |
|
260 | * |
|
261 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
262 | * |
|
263 | * @return static |
|
264 | * |
|
265 | * @see http://schema.org/object |
|
266 | */ |
|
267 | public function object($object) |
|
268 | { |
|
269 | return $this->setProperty('object', $object); |
|
270 | } |
|
271 | ||
272 | /** |
|
273 | * Other co-agents that participated in the action indirectly. e.g. John |
|
274 | * wrote a book with *Steve*. |
|
275 | * |
|
276 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
277 | * |
|
278 | * @return static |
|
279 | * |
|
280 | * @see http://schema.org/participant |
|
281 | */ |
|
282 | public function participant($participant) |
|
283 | { |
|
284 | return $this->setProperty('participant', $participant); |
|
285 | } |
|
286 | ||
287 | /** |
|
288 | * Indicates a potential Action, which describes an idealized action in |
|
289 | * which this thing would play an 'object' role. |
|
290 | * |
|
291 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
292 | * |
|
293 | * @return static |
|
294 | * |
|
295 | * @see http://schema.org/potentialAction |
|
296 | */ |
|
297 | public function potentialAction($potentialAction) |
|
298 | { |
|
299 | return $this->setProperty('potentialAction', $potentialAction); |
|
300 | } |
|
301 | ||
302 | /** |
|
303 | * The result produced in the action. e.g. John wrote *a book*. |
|
304 | * |
|
305 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
306 | * |
|
307 | * @return static |
|
308 | * |
|
309 | * @see http://schema.org/result |
|
310 | */ |
|
311 | public function result($result) |
|
312 | { |
|
313 | return $this->setProperty('result', $result); |
|
314 | } |
|
315 | ||
316 | /** |
|
317 | * URL of a reference Web page that unambiguously indicates the item's |
|
318 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
319 | * official website. |
|
320 | * |
|
321 | * @param string|string[] $sameAs |
|
322 | * |
|
323 | * @return static |
|
324 | * |
|
325 | * @see http://schema.org/sameAs |
|
326 | */ |
|
327 | public function sameAs($sameAs) |
|
328 | { |
|
329 | return $this->setProperty('sameAs', $sameAs); |
|
330 | } |
|
331 | ||
332 | /** |
|
333 | * The startTime of something. For a reserved event or service (e.g. |
|
334 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
335 | * actions that span a period of time, when the action was performed. e.g. |
|
336 | * John wrote a book from *January* to December. For media, including audio |
|
337 | * and video, it's the time offset of the start of a clip within a larger |
|
338 | * file. |
|
339 | * |
|
340 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
341 | * when describing dates with times. This situation may be clarified in |
|
342 | * future revisions. |
|
343 | * |
|
344 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
345 | * |
|
346 | * @return static |
|
347 | * |
|
348 | * @see http://schema.org/startTime |
|
349 | */ |
|
350 | public function startTime($startTime) |
|
351 | { |
|
352 | return $this->setProperty('startTime', $startTime); |
|
353 | } |
|
354 | ||
355 | /** |
|
356 | * A CreativeWork or Event about this Thing. |
|
357 | * |
|
358 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
359 | * |
|
360 | * @return static |
|
361 | * |
|
362 | * @see http://schema.org/subjectOf |
|
363 | */ |
|
364 | public function subjectOf($subjectOf) |
|
365 | { |
|
366 | return $this->setProperty('subjectOf', $subjectOf); |
|
367 | } |
|
368 | ||
369 | /** |
|
370 | * Indicates a target EntryPoint for an Action. |
|
371 | * |
|
372 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
373 | * |
|
374 | * @return static |
|
375 | * |
|
376 | * @see http://schema.org/target |
|
377 | */ |
|
378 | public function target($target) |
|
379 | { |
|
380 | return $this->setProperty('target', $target); |
|
381 | } |
|
382 | ||
383 | /** |
|
384 | * URL of the item. |
|
385 | * |
|
386 | * @param string|string[] $url |
|
387 | * |
|
388 | * @return static |
|
389 | * |
|
390 | * @see http://schema.org/url |
|
391 | */ |
|
392 | public function url($url) |
|
393 | { |
|
394 | return $this->setProperty('url', $url); |
|
395 | } |
|
396 | ||
397 | } |
|
398 |
@@ 16-414 (lines=399) @@ | ||
13 | * @see http://schema.org/WriteAction |
|
14 | * |
|
15 | */ |
|
16 | class WriteAction extends BaseType implements WriteActionContract, ActionContract, CreateActionContract, ThingContract |
|
17 | { |
|
18 | /** |
|
19 | * Indicates the current disposition of the Action. |
|
20 | * |
|
21 | * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus |
|
22 | * |
|
23 | * @return static |
|
24 | * |
|
25 | * @see http://schema.org/actionStatus |
|
26 | */ |
|
27 | public function actionStatus($actionStatus) |
|
28 | { |
|
29 | return $this->setProperty('actionStatus', $actionStatus); |
|
30 | } |
|
31 | ||
32 | /** |
|
33 | * An additional type for the item, typically used for adding more specific |
|
34 | * types from external vocabularies in microdata syntax. This is a |
|
35 | * relationship between something and a class that the thing is in. In RDFa |
|
36 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
|
37 | * attribute - for multiple types. Schema.org tools may have only weaker |
|
38 | * understanding of extra types, in particular those defined externally. |
|
39 | * |
|
40 | * @param string|string[] $additionalType |
|
41 | * |
|
42 | * @return static |
|
43 | * |
|
44 | * @see http://schema.org/additionalType |
|
45 | */ |
|
46 | public function additionalType($additionalType) |
|
47 | { |
|
48 | return $this->setProperty('additionalType', $additionalType); |
|
49 | } |
|
50 | ||
51 | /** |
|
52 | * The direct performer or driver of the action (animate or inanimate). e.g. |
|
53 | * *John* wrote a book. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/agent |
|
60 | */ |
|
61 | public function agent($agent) |
|
62 | { |
|
63 | return $this->setProperty('agent', $agent); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * An alias for the item. |
|
68 | * |
|
69 | * @param string|string[] $alternateName |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/alternateName |
|
74 | */ |
|
75 | public function alternateName($alternateName) |
|
76 | { |
|
77 | return $this->setProperty('alternateName', $alternateName); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * A description of the item. |
|
82 | * |
|
83 | * @param string|string[] $description |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/description |
|
88 | */ |
|
89 | public function description($description) |
|
90 | { |
|
91 | return $this->setProperty('description', $description); |
|
92 | } |
|
93 | ||
94 | /** |
|
95 | * A sub property of description. A short description of the item used to |
|
96 | * disambiguate from other, similar items. Information from other properties |
|
97 | * (in particular, name) may be necessary for the description to be useful |
|
98 | * for disambiguation. |
|
99 | * |
|
100 | * @param string|string[] $disambiguatingDescription |
|
101 | * |
|
102 | * @return static |
|
103 | * |
|
104 | * @see http://schema.org/disambiguatingDescription |
|
105 | */ |
|
106 | public function disambiguatingDescription($disambiguatingDescription) |
|
107 | { |
|
108 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
109 | } |
|
110 | ||
111 | /** |
|
112 | * The endTime of something. For a reserved event or service (e.g. |
|
113 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
114 | * actions that span a period of time, when the action was performed. e.g. |
|
115 | * John wrote a book from January to *December*. For media, including audio |
|
116 | * and video, it's the time offset of the end of a clip within a larger |
|
117 | * file. |
|
118 | * |
|
119 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
120 | * when describing dates with times. This situation may be clarified in |
|
121 | * future revisions. |
|
122 | * |
|
123 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
124 | * |
|
125 | * @return static |
|
126 | * |
|
127 | * @see http://schema.org/endTime |
|
128 | */ |
|
129 | public function endTime($endTime) |
|
130 | { |
|
131 | return $this->setProperty('endTime', $endTime); |
|
132 | } |
|
133 | ||
134 | /** |
|
135 | * For failed actions, more information on the cause of the failure. |
|
136 | * |
|
137 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
138 | * |
|
139 | * @return static |
|
140 | * |
|
141 | * @see http://schema.org/error |
|
142 | */ |
|
143 | public function error($error) |
|
144 | { |
|
145 | return $this->setProperty('error', $error); |
|
146 | } |
|
147 | ||
148 | /** |
|
149 | * The identifier property represents any kind of identifier for any kind of |
|
150 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
151 | * dedicated properties for representing many of these, either as textual |
|
152 | * strings or as URL (URI) links. See [background |
|
153 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
154 | * |
|
155 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
156 | * |
|
157 | * @return static |
|
158 | * |
|
159 | * @see http://schema.org/identifier |
|
160 | */ |
|
161 | public function identifier($identifier) |
|
162 | { |
|
163 | return $this->setProperty('identifier', $identifier); |
|
164 | } |
|
165 | ||
166 | /** |
|
167 | * An image of the item. This can be a [[URL]] or a fully described |
|
168 | * [[ImageObject]]. |
|
169 | * |
|
170 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
171 | * |
|
172 | * @return static |
|
173 | * |
|
174 | * @see http://schema.org/image |
|
175 | */ |
|
176 | public function image($image) |
|
177 | { |
|
178 | return $this->setProperty('image', $image); |
|
179 | } |
|
180 | ||
181 | /** |
|
182 | * The language of the content or performance or used in an action. Please |
|
183 | * use one of the language codes from the [IETF BCP 47 |
|
184 | * standard](http://tools.ietf.org/html/bcp47). See also |
|
185 | * [[availableLanguage]]. |
|
186 | * |
|
187 | * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $inLanguage |
|
188 | * |
|
189 | * @return static |
|
190 | * |
|
191 | * @see http://schema.org/inLanguage |
|
192 | */ |
|
193 | public function inLanguage($inLanguage) |
|
194 | { |
|
195 | return $this->setProperty('inLanguage', $inLanguage); |
|
196 | } |
|
197 | ||
198 | /** |
|
199 | * The object that helped the agent perform the action. e.g. John wrote a |
|
200 | * book with *a pen*. |
|
201 | * |
|
202 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
203 | * |
|
204 | * @return static |
|
205 | * |
|
206 | * @see http://schema.org/instrument |
|
207 | */ |
|
208 | public function instrument($instrument) |
|
209 | { |
|
210 | return $this->setProperty('instrument', $instrument); |
|
211 | } |
|
212 | ||
213 | /** |
|
214 | * A sub property of instrument. The language used on this action. |
|
215 | * |
|
216 | * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[] $language |
|
217 | * |
|
218 | * @return static |
|
219 | * |
|
220 | * @see http://schema.org/language |
|
221 | */ |
|
222 | public function language($language) |
|
223 | { |
|
224 | return $this->setProperty('language', $language); |
|
225 | } |
|
226 | ||
227 | /** |
|
228 | * The location of for example where the event is happening, an organization |
|
229 | * is located, or where an action takes place. |
|
230 | * |
|
231 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
232 | * |
|
233 | * @return static |
|
234 | * |
|
235 | * @see http://schema.org/location |
|
236 | */ |
|
237 | public function location($location) |
|
238 | { |
|
239 | return $this->setProperty('location', $location); |
|
240 | } |
|
241 | ||
242 | /** |
|
243 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
244 | * entity being described. See [background |
|
245 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
246 | * |
|
247 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
248 | * |
|
249 | * @return static |
|
250 | * |
|
251 | * @see http://schema.org/mainEntityOfPage |
|
252 | */ |
|
253 | public function mainEntityOfPage($mainEntityOfPage) |
|
254 | { |
|
255 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
256 | } |
|
257 | ||
258 | /** |
|
259 | * The name of the item. |
|
260 | * |
|
261 | * @param string|string[] $name |
|
262 | * |
|
263 | * @return static |
|
264 | * |
|
265 | * @see http://schema.org/name |
|
266 | */ |
|
267 | public function name($name) |
|
268 | { |
|
269 | return $this->setProperty('name', $name); |
|
270 | } |
|
271 | ||
272 | /** |
|
273 | * The object upon which the action is carried out, whose state is kept |
|
274 | * intact or changed. Also known as the semantic roles patient, affected or |
|
275 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
276 | * read *a book*. |
|
277 | * |
|
278 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
279 | * |
|
280 | * @return static |
|
281 | * |
|
282 | * @see http://schema.org/object |
|
283 | */ |
|
284 | public function object($object) |
|
285 | { |
|
286 | return $this->setProperty('object', $object); |
|
287 | } |
|
288 | ||
289 | /** |
|
290 | * Other co-agents that participated in the action indirectly. e.g. John |
|
291 | * wrote a book with *Steve*. |
|
292 | * |
|
293 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
294 | * |
|
295 | * @return static |
|
296 | * |
|
297 | * @see http://schema.org/participant |
|
298 | */ |
|
299 | public function participant($participant) |
|
300 | { |
|
301 | return $this->setProperty('participant', $participant); |
|
302 | } |
|
303 | ||
304 | /** |
|
305 | * Indicates a potential Action, which describes an idealized action in |
|
306 | * which this thing would play an 'object' role. |
|
307 | * |
|
308 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
309 | * |
|
310 | * @return static |
|
311 | * |
|
312 | * @see http://schema.org/potentialAction |
|
313 | */ |
|
314 | public function potentialAction($potentialAction) |
|
315 | { |
|
316 | return $this->setProperty('potentialAction', $potentialAction); |
|
317 | } |
|
318 | ||
319 | /** |
|
320 | * The result produced in the action. e.g. John wrote *a book*. |
|
321 | * |
|
322 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
323 | * |
|
324 | * @return static |
|
325 | * |
|
326 | * @see http://schema.org/result |
|
327 | */ |
|
328 | public function result($result) |
|
329 | { |
|
330 | return $this->setProperty('result', $result); |
|
331 | } |
|
332 | ||
333 | /** |
|
334 | * URL of a reference Web page that unambiguously indicates the item's |
|
335 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
336 | * official website. |
|
337 | * |
|
338 | * @param string|string[] $sameAs |
|
339 | * |
|
340 | * @return static |
|
341 | * |
|
342 | * @see http://schema.org/sameAs |
|
343 | */ |
|
344 | public function sameAs($sameAs) |
|
345 | { |
|
346 | return $this->setProperty('sameAs', $sameAs); |
|
347 | } |
|
348 | ||
349 | /** |
|
350 | * The startTime of something. For a reserved event or service (e.g. |
|
351 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
352 | * actions that span a period of time, when the action was performed. e.g. |
|
353 | * John wrote a book from *January* to December. For media, including audio |
|
354 | * and video, it's the time offset of the start of a clip within a larger |
|
355 | * file. |
|
356 | * |
|
357 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
358 | * when describing dates with times. This situation may be clarified in |
|
359 | * future revisions. |
|
360 | * |
|
361 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
362 | * |
|
363 | * @return static |
|
364 | * |
|
365 | * @see http://schema.org/startTime |
|
366 | */ |
|
367 | public function startTime($startTime) |
|
368 | { |
|
369 | return $this->setProperty('startTime', $startTime); |
|
370 | } |
|
371 | ||
372 | /** |
|
373 | * A CreativeWork or Event about this Thing. |
|
374 | * |
|
375 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
376 | * |
|
377 | * @return static |
|
378 | * |
|
379 | * @see http://schema.org/subjectOf |
|
380 | */ |
|
381 | public function subjectOf($subjectOf) |
|
382 | { |
|
383 | return $this->setProperty('subjectOf', $subjectOf); |
|
384 | } |
|
385 | ||
386 | /** |
|
387 | * Indicates a target EntryPoint for an Action. |
|
388 | * |
|
389 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/target |
|
394 | */ |
|
395 | public function target($target) |
|
396 | { |
|
397 | return $this->setProperty('target', $target); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * URL of the item. |
|
402 | * |
|
403 | * @param string|string[] $url |
|
404 | * |
|
405 | * @return static |
|
406 | * |
|
407 | * @see http://schema.org/url |
|
408 | */ |
|
409 | public function url($url) |
|
410 | { |
|
411 | return $this->setProperty('url', $url); |
|
412 | } |
|
413 | ||
414 | } |
|
415 |