@@ 17-543 (lines=527) @@ | ||
14 | * @see http://schema.org/ExerciseAction |
|
15 | * |
|
16 | */ |
|
17 | class ExerciseAction extends BaseType implements ExerciseActionContract, ActionContract, PlayActionContract, 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 | * An intended audience, i.e. a group for whom something was created. |
|
83 | * |
|
84 | * @param \Spatie\SchemaOrg\Contracts\AudienceContract|\Spatie\SchemaOrg\Contracts\AudienceContract[] $audience |
|
85 | * |
|
86 | * @return static |
|
87 | * |
|
88 | * @see http://schema.org/audience |
|
89 | */ |
|
90 | public function audience($audience) |
|
91 | { |
|
92 | return $this->setProperty('audience', $audience); |
|
93 | } |
|
94 | ||
95 | /** |
|
96 | * A sub property of location. The course where this action was taken. |
|
97 | * |
|
98 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $course |
|
99 | * |
|
100 | * @return static |
|
101 | * |
|
102 | * @see http://schema.org/course |
|
103 | */ |
|
104 | public function course($course) |
|
105 | { |
|
106 | return $this->setProperty('course', $course); |
|
107 | } |
|
108 | ||
109 | /** |
|
110 | * A description of the item. |
|
111 | * |
|
112 | * @param string|string[] $description |
|
113 | * |
|
114 | * @return static |
|
115 | * |
|
116 | * @see http://schema.org/description |
|
117 | */ |
|
118 | public function description($description) |
|
119 | { |
|
120 | return $this->setProperty('description', $description); |
|
121 | } |
|
122 | ||
123 | /** |
|
124 | * A sub property of description. A short description of the item used to |
|
125 | * disambiguate from other, similar items. Information from other properties |
|
126 | * (in particular, name) may be necessary for the description to be useful |
|
127 | * for disambiguation. |
|
128 | * |
|
129 | * @param string|string[] $disambiguatingDescription |
|
130 | * |
|
131 | * @return static |
|
132 | * |
|
133 | * @see http://schema.org/disambiguatingDescription |
|
134 | */ |
|
135 | public function disambiguatingDescription($disambiguatingDescription) |
|
136 | { |
|
137 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
138 | } |
|
139 | ||
140 | /** |
|
141 | * The distance travelled, e.g. exercising or travelling. |
|
142 | * |
|
143 | * @param \Spatie\SchemaOrg\Contracts\DistanceContract|\Spatie\SchemaOrg\Contracts\DistanceContract[] $distance |
|
144 | * |
|
145 | * @return static |
|
146 | * |
|
147 | * @see http://schema.org/distance |
|
148 | */ |
|
149 | public function distance($distance) |
|
150 | { |
|
151 | return $this->setProperty('distance', $distance); |
|
152 | } |
|
153 | ||
154 | /** |
|
155 | * The endTime of something. For a reserved event or service (e.g. |
|
156 | * FoodEstablishmentReservation), the time that it is expected to end. For |
|
157 | * actions that span a period of time, when the action was performed. e.g. |
|
158 | * John wrote a book from January to *December*. For media, including audio |
|
159 | * and video, it's the time offset of the end of a clip within a larger |
|
160 | * file. |
|
161 | * |
|
162 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
163 | * when describing dates with times. This situation may be clarified in |
|
164 | * future revisions. |
|
165 | * |
|
166 | * @param \DateTimeInterface|\DateTimeInterface[] $endTime |
|
167 | * |
|
168 | * @return static |
|
169 | * |
|
170 | * @see http://schema.org/endTime |
|
171 | */ |
|
172 | public function endTime($endTime) |
|
173 | { |
|
174 | return $this->setProperty('endTime', $endTime); |
|
175 | } |
|
176 | ||
177 | /** |
|
178 | * For failed actions, more information on the cause of the failure. |
|
179 | * |
|
180 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error |
|
181 | * |
|
182 | * @return static |
|
183 | * |
|
184 | * @see http://schema.org/error |
|
185 | */ |
|
186 | public function error($error) |
|
187 | { |
|
188 | return $this->setProperty('error', $error); |
|
189 | } |
|
190 | ||
191 | /** |
|
192 | * Upcoming or past event associated with this place, organization, or |
|
193 | * action. |
|
194 | * |
|
195 | * @param \Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $event |
|
196 | * |
|
197 | * @return static |
|
198 | * |
|
199 | * @see http://schema.org/event |
|
200 | */ |
|
201 | public function event($event) |
|
202 | { |
|
203 | return $this->setProperty('event', $event); |
|
204 | } |
|
205 | ||
206 | /** |
|
207 | * A sub property of location. The course where this action was taken. |
|
208 | * |
|
209 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $exerciseCourse |
|
210 | * |
|
211 | * @return static |
|
212 | * |
|
213 | * @see http://schema.org/exerciseCourse |
|
214 | */ |
|
215 | public function exerciseCourse($exerciseCourse) |
|
216 | { |
|
217 | return $this->setProperty('exerciseCourse', $exerciseCourse); |
|
218 | } |
|
219 | ||
220 | /** |
|
221 | * A sub property of location. The original location of the object or the |
|
222 | * agent before the action. |
|
223 | * |
|
224 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $fromLocation |
|
225 | * |
|
226 | * @return static |
|
227 | * |
|
228 | * @see http://schema.org/fromLocation |
|
229 | */ |
|
230 | public function fromLocation($fromLocation) |
|
231 | { |
|
232 | return $this->setProperty('fromLocation', $fromLocation); |
|
233 | } |
|
234 | ||
235 | /** |
|
236 | * The identifier property represents any kind of identifier for any kind of |
|
237 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
238 | * dedicated properties for representing many of these, either as textual |
|
239 | * strings or as URL (URI) links. See [background |
|
240 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
241 | * |
|
242 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
243 | * |
|
244 | * @return static |
|
245 | * |
|
246 | * @see http://schema.org/identifier |
|
247 | */ |
|
248 | public function identifier($identifier) |
|
249 | { |
|
250 | return $this->setProperty('identifier', $identifier); |
|
251 | } |
|
252 | ||
253 | /** |
|
254 | * An image of the item. This can be a [[URL]] or a fully described |
|
255 | * [[ImageObject]]. |
|
256 | * |
|
257 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
258 | * |
|
259 | * @return static |
|
260 | * |
|
261 | * @see http://schema.org/image |
|
262 | */ |
|
263 | public function image($image) |
|
264 | { |
|
265 | return $this->setProperty('image', $image); |
|
266 | } |
|
267 | ||
268 | /** |
|
269 | * The object that helped the agent perform the action. e.g. John wrote a |
|
270 | * book with *a pen*. |
|
271 | * |
|
272 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument |
|
273 | * |
|
274 | * @return static |
|
275 | * |
|
276 | * @see http://schema.org/instrument |
|
277 | */ |
|
278 | public function instrument($instrument) |
|
279 | { |
|
280 | return $this->setProperty('instrument', $instrument); |
|
281 | } |
|
282 | ||
283 | /** |
|
284 | * The location of for example where the event is happening, an organization |
|
285 | * is located, or where an action takes place. |
|
286 | * |
|
287 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location |
|
288 | * |
|
289 | * @return static |
|
290 | * |
|
291 | * @see http://schema.org/location |
|
292 | */ |
|
293 | public function location($location) |
|
294 | { |
|
295 | return $this->setProperty('location', $location); |
|
296 | } |
|
297 | ||
298 | /** |
|
299 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
300 | * entity being described. See [background |
|
301 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
302 | * |
|
303 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
304 | * |
|
305 | * @return static |
|
306 | * |
|
307 | * @see http://schema.org/mainEntityOfPage |
|
308 | */ |
|
309 | public function mainEntityOfPage($mainEntityOfPage) |
|
310 | { |
|
311 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
312 | } |
|
313 | ||
314 | /** |
|
315 | * The name of the item. |
|
316 | * |
|
317 | * @param string|string[] $name |
|
318 | * |
|
319 | * @return static |
|
320 | * |
|
321 | * @see http://schema.org/name |
|
322 | */ |
|
323 | public function name($name) |
|
324 | { |
|
325 | return $this->setProperty('name', $name); |
|
326 | } |
|
327 | ||
328 | /** |
|
329 | * The object upon which the action is carried out, whose state is kept |
|
330 | * intact or changed. Also known as the semantic roles patient, affected or |
|
331 | * undergoer (which change their state) or theme (which doesn't). e.g. John |
|
332 | * read *a book*. |
|
333 | * |
|
334 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object |
|
335 | * |
|
336 | * @return static |
|
337 | * |
|
338 | * @see http://schema.org/object |
|
339 | */ |
|
340 | public function object($object) |
|
341 | { |
|
342 | return $this->setProperty('object', $object); |
|
343 | } |
|
344 | ||
345 | /** |
|
346 | * A sub property of participant. The opponent on this action. |
|
347 | * |
|
348 | * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $opponent |
|
349 | * |
|
350 | * @return static |
|
351 | * |
|
352 | * @see http://schema.org/opponent |
|
353 | */ |
|
354 | public function opponent($opponent) |
|
355 | { |
|
356 | return $this->setProperty('opponent', $opponent); |
|
357 | } |
|
358 | ||
359 | /** |
|
360 | * Other co-agents that participated in the action indirectly. e.g. John |
|
361 | * wrote a book with *Steve*. |
|
362 | * |
|
363 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant |
|
364 | * |
|
365 | * @return static |
|
366 | * |
|
367 | * @see http://schema.org/participant |
|
368 | */ |
|
369 | public function participant($participant) |
|
370 | { |
|
371 | return $this->setProperty('participant', $participant); |
|
372 | } |
|
373 | ||
374 | /** |
|
375 | * Indicates a potential Action, which describes an idealized action in |
|
376 | * which this thing would play an 'object' role. |
|
377 | * |
|
378 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
379 | * |
|
380 | * @return static |
|
381 | * |
|
382 | * @see http://schema.org/potentialAction |
|
383 | */ |
|
384 | public function potentialAction($potentialAction) |
|
385 | { |
|
386 | return $this->setProperty('potentialAction', $potentialAction); |
|
387 | } |
|
388 | ||
389 | /** |
|
390 | * The result produced in the action. e.g. John wrote *a book*. |
|
391 | * |
|
392 | * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result |
|
393 | * |
|
394 | * @return static |
|
395 | * |
|
396 | * @see http://schema.org/result |
|
397 | */ |
|
398 | public function result($result) |
|
399 | { |
|
400 | return $this->setProperty('result', $result); |
|
401 | } |
|
402 | ||
403 | /** |
|
404 | * URL of a reference Web page that unambiguously indicates the item's |
|
405 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
406 | * official website. |
|
407 | * |
|
408 | * @param string|string[] $sameAs |
|
409 | * |
|
410 | * @return static |
|
411 | * |
|
412 | * @see http://schema.org/sameAs |
|
413 | */ |
|
414 | public function sameAs($sameAs) |
|
415 | { |
|
416 | return $this->setProperty('sameAs', $sameAs); |
|
417 | } |
|
418 | ||
419 | /** |
|
420 | * A sub property of location. The sports activity location where this |
|
421 | * action occurred. |
|
422 | * |
|
423 | * @param \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract|\Spatie\SchemaOrg\Contracts\SportsActivityLocationContract[] $sportsActivityLocation |
|
424 | * |
|
425 | * @return static |
|
426 | * |
|
427 | * @see http://schema.org/sportsActivityLocation |
|
428 | */ |
|
429 | public function sportsActivityLocation($sportsActivityLocation) |
|
430 | { |
|
431 | return $this->setProperty('sportsActivityLocation', $sportsActivityLocation); |
|
432 | } |
|
433 | ||
434 | /** |
|
435 | * A sub property of location. The sports event where this action occurred. |
|
436 | * |
|
437 | * @param \Spatie\SchemaOrg\Contracts\SportsEventContract|\Spatie\SchemaOrg\Contracts\SportsEventContract[] $sportsEvent |
|
438 | * |
|
439 | * @return static |
|
440 | * |
|
441 | * @see http://schema.org/sportsEvent |
|
442 | */ |
|
443 | public function sportsEvent($sportsEvent) |
|
444 | { |
|
445 | return $this->setProperty('sportsEvent', $sportsEvent); |
|
446 | } |
|
447 | ||
448 | /** |
|
449 | * A sub property of participant. The sports team that participated on this |
|
450 | * action. |
|
451 | * |
|
452 | * @param \Spatie\SchemaOrg\Contracts\SportsTeamContract|\Spatie\SchemaOrg\Contracts\SportsTeamContract[] $sportsTeam |
|
453 | * |
|
454 | * @return static |
|
455 | * |
|
456 | * @see http://schema.org/sportsTeam |
|
457 | */ |
|
458 | public function sportsTeam($sportsTeam) |
|
459 | { |
|
460 | return $this->setProperty('sportsTeam', $sportsTeam); |
|
461 | } |
|
462 | ||
463 | /** |
|
464 | * The startTime of something. For a reserved event or service (e.g. |
|
465 | * FoodEstablishmentReservation), the time that it is expected to start. For |
|
466 | * actions that span a period of time, when the action was performed. e.g. |
|
467 | * John wrote a book from *January* to December. For media, including audio |
|
468 | * and video, it's the time offset of the start of a clip within a larger |
|
469 | * file. |
|
470 | * |
|
471 | * Note that Event uses startDate/endDate instead of startTime/endTime, even |
|
472 | * when describing dates with times. This situation may be clarified in |
|
473 | * future revisions. |
|
474 | * |
|
475 | * @param \DateTimeInterface|\DateTimeInterface[] $startTime |
|
476 | * |
|
477 | * @return static |
|
478 | * |
|
479 | * @see http://schema.org/startTime |
|
480 | */ |
|
481 | public function startTime($startTime) |
|
482 | { |
|
483 | return $this->setProperty('startTime', $startTime); |
|
484 | } |
|
485 | ||
486 | /** |
|
487 | * A CreativeWork or Event about this Thing. |
|
488 | * |
|
489 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
490 | * |
|
491 | * @return static |
|
492 | * |
|
493 | * @see http://schema.org/subjectOf |
|
494 | */ |
|
495 | public function subjectOf($subjectOf) |
|
496 | { |
|
497 | return $this->setProperty('subjectOf', $subjectOf); |
|
498 | } |
|
499 | ||
500 | /** |
|
501 | * Indicates a target EntryPoint for an Action. |
|
502 | * |
|
503 | * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target |
|
504 | * |
|
505 | * @return static |
|
506 | * |
|
507 | * @see http://schema.org/target |
|
508 | */ |
|
509 | public function target($target) |
|
510 | { |
|
511 | return $this->setProperty('target', $target); |
|
512 | } |
|
513 | ||
514 | /** |
|
515 | * A sub property of location. The final location of the object or the agent |
|
516 | * after the action. |
|
517 | * |
|
518 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $toLocation |
|
519 | * |
|
520 | * @return static |
|
521 | * |
|
522 | * @see http://schema.org/toLocation |
|
523 | */ |
|
524 | public function toLocation($toLocation) |
|
525 | { |
|
526 | return $this->setProperty('toLocation', $toLocation); |
|
527 | } |
|
528 | ||
529 | /** |
|
530 | * URL of the item. |
|
531 | * |
|
532 | * @param string|string[] $url |
|
533 | * |
|
534 | * @return static |
|
535 | * |
|
536 | * @see http://schema.org/url |
|
537 | */ |
|
538 | public function url($url) |
|
539 | { |
|
540 | return $this->setProperty('url', $url); |
|
541 | } |
|
542 | ||
543 | } |
|
544 |
@@ 17-519 (lines=503) @@ | ||
14 | * @method static industry($industry) The value should be instance of pending types DefinedTerm|DefinedTerm[]|string|string[] |
|
15 | * @method static skills($skills) The value should be instance of pending types DefinedTerm|DefinedTerm[]|string|string[] |
|
16 | */ |
|
17 | class JobPosting extends BaseType implements JobPostingContract, IntangibleContract, 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 base salary of the job or of an employee in an EmployeeRole. |
|
54 | * |
|
55 | * @param \Spatie\SchemaOrg\Contracts\MonetaryAmountContract|\Spatie\SchemaOrg\Contracts\MonetaryAmountContract[]|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[]|float|float[]|int|int[] $baseSalary |
|
56 | * |
|
57 | * @return static |
|
58 | * |
|
59 | * @see http://schema.org/baseSalary |
|
60 | */ |
|
61 | public function baseSalary($baseSalary) |
|
62 | { |
|
63 | return $this->setProperty('baseSalary', $baseSalary); |
|
64 | } |
|
65 | ||
66 | /** |
|
67 | * Description of benefits associated with the job. |
|
68 | * |
|
69 | * @param string|string[] $benefits |
|
70 | * |
|
71 | * @return static |
|
72 | * |
|
73 | * @see http://schema.org/benefits |
|
74 | */ |
|
75 | public function benefits($benefits) |
|
76 | { |
|
77 | return $this->setProperty('benefits', $benefits); |
|
78 | } |
|
79 | ||
80 | /** |
|
81 | * Publication date of an online listing. |
|
82 | * |
|
83 | * @param \DateTimeInterface|\DateTimeInterface[] $datePosted |
|
84 | * |
|
85 | * @return static |
|
86 | * |
|
87 | * @see http://schema.org/datePosted |
|
88 | */ |
|
89 | public function datePosted($datePosted) |
|
90 | { |
|
91 | return $this->setProperty('datePosted', $datePosted); |
|
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 | * Educational background needed for the position or Occupation. |
|
127 | * |
|
128 | * @param string|string[] $educationRequirements |
|
129 | * |
|
130 | * @return static |
|
131 | * |
|
132 | * @see http://schema.org/educationRequirements |
|
133 | */ |
|
134 | public function educationRequirements($educationRequirements) |
|
135 | { |
|
136 | return $this->setProperty('educationRequirements', $educationRequirements); |
|
137 | } |
|
138 | ||
139 | /** |
|
140 | * Type of employment (e.g. full-time, part-time, contract, temporary, |
|
141 | * seasonal, internship). |
|
142 | * |
|
143 | * @param string|string[] $employmentType |
|
144 | * |
|
145 | * @return static |
|
146 | * |
|
147 | * @see http://schema.org/employmentType |
|
148 | */ |
|
149 | public function employmentType($employmentType) |
|
150 | { |
|
151 | return $this->setProperty('employmentType', $employmentType); |
|
152 | } |
|
153 | ||
154 | /** |
|
155 | * An estimated salary for a job posting or occupation, based on a variety |
|
156 | * of variables including, but not limited to industry, job title, and |
|
157 | * location. Estimated salaries are often computed by outside organizations |
|
158 | * rather than the hiring organization, who may not have committed to the |
|
159 | * estimated value. |
|
160 | * |
|
161 | * @param \Spatie\SchemaOrg\Contracts\MonetaryAmountContract|\Spatie\SchemaOrg\Contracts\MonetaryAmountDistributionContract|\Spatie\SchemaOrg\Contracts\MonetaryAmountDistributionContract[]|\Spatie\SchemaOrg\Contracts\MonetaryAmountContract[]|float|float[]|int|int[] $estimatedSalary |
|
162 | * |
|
163 | * @return static |
|
164 | * |
|
165 | * @see http://schema.org/estimatedSalary |
|
166 | */ |
|
167 | public function estimatedSalary($estimatedSalary) |
|
168 | { |
|
169 | return $this->setProperty('estimatedSalary', $estimatedSalary); |
|
170 | } |
|
171 | ||
172 | /** |
|
173 | * Description of skills and experience needed for the position or |
|
174 | * Occupation. |
|
175 | * |
|
176 | * @param string|string[] $experienceRequirements |
|
177 | * |
|
178 | * @return static |
|
179 | * |
|
180 | * @see http://schema.org/experienceRequirements |
|
181 | */ |
|
182 | public function experienceRequirements($experienceRequirements) |
|
183 | { |
|
184 | return $this->setProperty('experienceRequirements', $experienceRequirements); |
|
185 | } |
|
186 | ||
187 | /** |
|
188 | * Organization offering the job position. |
|
189 | * |
|
190 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $hiringOrganization |
|
191 | * |
|
192 | * @return static |
|
193 | * |
|
194 | * @see http://schema.org/hiringOrganization |
|
195 | */ |
|
196 | public function hiringOrganization($hiringOrganization) |
|
197 | { |
|
198 | return $this->setProperty('hiringOrganization', $hiringOrganization); |
|
199 | } |
|
200 | ||
201 | /** |
|
202 | * The identifier property represents any kind of identifier for any kind of |
|
203 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
204 | * dedicated properties for representing many of these, either as textual |
|
205 | * strings or as URL (URI) links. See [background |
|
206 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
207 | * |
|
208 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
209 | * |
|
210 | * @return static |
|
211 | * |
|
212 | * @see http://schema.org/identifier |
|
213 | */ |
|
214 | public function identifier($identifier) |
|
215 | { |
|
216 | return $this->setProperty('identifier', $identifier); |
|
217 | } |
|
218 | ||
219 | /** |
|
220 | * An image of the item. This can be a [[URL]] or a fully described |
|
221 | * [[ImageObject]]. |
|
222 | * |
|
223 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
224 | * |
|
225 | * @return static |
|
226 | * |
|
227 | * @see http://schema.org/image |
|
228 | */ |
|
229 | public function image($image) |
|
230 | { |
|
231 | return $this->setProperty('image', $image); |
|
232 | } |
|
233 | ||
234 | /** |
|
235 | * Description of bonus and commission compensation aspects of the job. |
|
236 | * |
|
237 | * @param string|string[] $incentiveCompensation |
|
238 | * |
|
239 | * @return static |
|
240 | * |
|
241 | * @see http://schema.org/incentiveCompensation |
|
242 | */ |
|
243 | public function incentiveCompensation($incentiveCompensation) |
|
244 | { |
|
245 | return $this->setProperty('incentiveCompensation', $incentiveCompensation); |
|
246 | } |
|
247 | ||
248 | /** |
|
249 | * Description of bonus and commission compensation aspects of the job. |
|
250 | * |
|
251 | * @param string|string[] $incentives |
|
252 | * |
|
253 | * @return static |
|
254 | * |
|
255 | * @see http://schema.org/incentives |
|
256 | */ |
|
257 | public function incentives($incentives) |
|
258 | { |
|
259 | return $this->setProperty('incentives', $incentives); |
|
260 | } |
|
261 | ||
262 | /** |
|
263 | * Description of benefits associated with the job. |
|
264 | * |
|
265 | * @param string|string[] $jobBenefits |
|
266 | * |
|
267 | * @return static |
|
268 | * |
|
269 | * @see http://schema.org/jobBenefits |
|
270 | */ |
|
271 | public function jobBenefits($jobBenefits) |
|
272 | { |
|
273 | return $this->setProperty('jobBenefits', $jobBenefits); |
|
274 | } |
|
275 | ||
276 | /** |
|
277 | * A (typically single) geographic location associated with the job |
|
278 | * position. |
|
279 | * |
|
280 | * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $jobLocation |
|
281 | * |
|
282 | * @return static |
|
283 | * |
|
284 | * @see http://schema.org/jobLocation |
|
285 | */ |
|
286 | public function jobLocation($jobLocation) |
|
287 | { |
|
288 | return $this->setProperty('jobLocation', $jobLocation); |
|
289 | } |
|
290 | ||
291 | /** |
|
292 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
293 | * entity being described. See [background |
|
294 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
295 | * |
|
296 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
297 | * |
|
298 | * @return static |
|
299 | * |
|
300 | * @see http://schema.org/mainEntityOfPage |
|
301 | */ |
|
302 | public function mainEntityOfPage($mainEntityOfPage) |
|
303 | { |
|
304 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
305 | } |
|
306 | ||
307 | /** |
|
308 | * The name of the item. |
|
309 | * |
|
310 | * @param string|string[] $name |
|
311 | * |
|
312 | * @return static |
|
313 | * |
|
314 | * @see http://schema.org/name |
|
315 | */ |
|
316 | public function name($name) |
|
317 | { |
|
318 | return $this->setProperty('name', $name); |
|
319 | } |
|
320 | ||
321 | /** |
|
322 | * A category describing the job, preferably using a term from a taxonomy |
|
323 | * such as [BLS O*NET-SOC](http://www.onetcenter.org/taxonomy.html), |
|
324 | * [ISCO-08](https://www.ilo.org/public/english/bureau/stat/isco/isco08/) or |
|
325 | * similar, with the property repeated for each applicable value. Ideally |
|
326 | * the taxonomy should be identified, and both the textual label and formal |
|
327 | * code for the category should be provided. |
|
328 | * |
|
329 | * Note: for historical reasons, any textual label and formal code provided |
|
330 | * as a literal may be assumed to be from O*NET-SOC. |
|
331 | * |
|
332 | * @param string|string[] $occupationalCategory |
|
333 | * |
|
334 | * @return static |
|
335 | * |
|
336 | * @see http://schema.org/occupationalCategory |
|
337 | */ |
|
338 | public function occupationalCategory($occupationalCategory) |
|
339 | { |
|
340 | return $this->setProperty('occupationalCategory', $occupationalCategory); |
|
341 | } |
|
342 | ||
343 | /** |
|
344 | * Indicates a potential Action, which describes an idealized action in |
|
345 | * which this thing would play an 'object' role. |
|
346 | * |
|
347 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
348 | * |
|
349 | * @return static |
|
350 | * |
|
351 | * @see http://schema.org/potentialAction |
|
352 | */ |
|
353 | public function potentialAction($potentialAction) |
|
354 | { |
|
355 | return $this->setProperty('potentialAction', $potentialAction); |
|
356 | } |
|
357 | ||
358 | /** |
|
359 | * Specific qualifications required for this role or Occupation. |
|
360 | * |
|
361 | * @param string|string[] $qualifications |
|
362 | * |
|
363 | * @return static |
|
364 | * |
|
365 | * @see http://schema.org/qualifications |
|
366 | */ |
|
367 | public function qualifications($qualifications) |
|
368 | { |
|
369 | return $this->setProperty('qualifications', $qualifications); |
|
370 | } |
|
371 | ||
372 | /** |
|
373 | * The Occupation for the JobPosting. |
|
374 | * |
|
375 | * @param \Spatie\SchemaOrg\Contracts\OccupationContract|\Spatie\SchemaOrg\Contracts\OccupationContract[] $relevantOccupation |
|
376 | * |
|
377 | * @return static |
|
378 | * |
|
379 | * @see http://schema.org/relevantOccupation |
|
380 | */ |
|
381 | public function relevantOccupation($relevantOccupation) |
|
382 | { |
|
383 | return $this->setProperty('relevantOccupation', $relevantOccupation); |
|
384 | } |
|
385 | ||
386 | /** |
|
387 | * Responsibilities associated with this role or Occupation. |
|
388 | * |
|
389 | * @param string|string[] $responsibilities |
|
390 | * |
|
391 | * @return static |
|
392 | * |
|
393 | * @see http://schema.org/responsibilities |
|
394 | */ |
|
395 | public function responsibilities($responsibilities) |
|
396 | { |
|
397 | return $this->setProperty('responsibilities', $responsibilities); |
|
398 | } |
|
399 | ||
400 | /** |
|
401 | * The currency (coded using [ISO |
|
402 | * 4217](http://en.wikipedia.org/wiki/ISO_4217) ) used for the main salary |
|
403 | * information in this job posting or for this employee. |
|
404 | * |
|
405 | * @param string|string[] $salaryCurrency |
|
406 | * |
|
407 | * @return static |
|
408 | * |
|
409 | * @see http://schema.org/salaryCurrency |
|
410 | */ |
|
411 | public function salaryCurrency($salaryCurrency) |
|
412 | { |
|
413 | return $this->setProperty('salaryCurrency', $salaryCurrency); |
|
414 | } |
|
415 | ||
416 | /** |
|
417 | * URL of a reference Web page that unambiguously indicates the item's |
|
418 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
419 | * official website. |
|
420 | * |
|
421 | * @param string|string[] $sameAs |
|
422 | * |
|
423 | * @return static |
|
424 | * |
|
425 | * @see http://schema.org/sameAs |
|
426 | */ |
|
427 | public function sameAs($sameAs) |
|
428 | { |
|
429 | return $this->setProperty('sameAs', $sameAs); |
|
430 | } |
|
431 | ||
432 | /** |
|
433 | * Any special commitments associated with this job posting. Valid entries |
|
434 | * include VeteranCommit, MilitarySpouseCommit, etc. |
|
435 | * |
|
436 | * @param string|string[] $specialCommitments |
|
437 | * |
|
438 | * @return static |
|
439 | * |
|
440 | * @see http://schema.org/specialCommitments |
|
441 | */ |
|
442 | public function specialCommitments($specialCommitments) |
|
443 | { |
|
444 | return $this->setProperty('specialCommitments', $specialCommitments); |
|
445 | } |
|
446 | ||
447 | /** |
|
448 | * A CreativeWork or Event about this Thing. |
|
449 | * |
|
450 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
451 | * |
|
452 | * @return static |
|
453 | * |
|
454 | * @see http://schema.org/subjectOf |
|
455 | */ |
|
456 | public function subjectOf($subjectOf) |
|
457 | { |
|
458 | return $this->setProperty('subjectOf', $subjectOf); |
|
459 | } |
|
460 | ||
461 | /** |
|
462 | * The title of the job. |
|
463 | * |
|
464 | * @param string|string[] $title |
|
465 | * |
|
466 | * @return static |
|
467 | * |
|
468 | * @see http://schema.org/title |
|
469 | */ |
|
470 | public function title($title) |
|
471 | { |
|
472 | return $this->setProperty('title', $title); |
|
473 | } |
|
474 | ||
475 | /** |
|
476 | * URL of the item. |
|
477 | * |
|
478 | * @param string|string[] $url |
|
479 | * |
|
480 | * @return static |
|
481 | * |
|
482 | * @see http://schema.org/url |
|
483 | */ |
|
484 | public function url($url) |
|
485 | { |
|
486 | return $this->setProperty('url', $url); |
|
487 | } |
|
488 | ||
489 | /** |
|
490 | * The date after when the item is not valid. For example the end of an |
|
491 | * offer, salary period, or a period of opening hours. |
|
492 | * |
|
493 | * @param \DateTimeInterface|\DateTimeInterface[] $validThrough |
|
494 | * |
|
495 | * @return static |
|
496 | * |
|
497 | * @see http://schema.org/validThrough |
|
498 | */ |
|
499 | public function validThrough($validThrough) |
|
500 | { |
|
501 | return $this->setProperty('validThrough', $validThrough); |
|
502 | } |
|
503 | ||
504 | /** |
|
505 | * The typical working hours for this job (e.g. 1st shift, night shift, |
|
506 | * 8am-5pm). |
|
507 | * |
|
508 | * @param string|string[] $workHours |
|
509 | * |
|
510 | * @return static |
|
511 | * |
|
512 | * @see http://schema.org/workHours |
|
513 | */ |
|
514 | public function workHours($workHours) |
|
515 | { |
|
516 | return $this->setProperty('workHours', $workHours); |
|
517 | } |
|
518 | ||
519 | } |
|
520 |
@@ 17-527 (lines=511) @@ | ||
14 | * @see http://schema.org/Order |
|
15 | * |
|
16 | */ |
|
17 | class Order extends BaseType implements OrderContract, IntangibleContract, ThingContract |
|
18 | { |
|
19 | /** |
|
20 | * The offer(s) -- e.g., product, quantity and price combinations -- |
|
21 | * included in the order. |
|
22 | * |
|
23 | * @param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $acceptedOffer |
|
24 | * |
|
25 | * @return static |
|
26 | * |
|
27 | * @see http://schema.org/acceptedOffer |
|
28 | */ |
|
29 | public function acceptedOffer($acceptedOffer) |
|
30 | { |
|
31 | return $this->setProperty('acceptedOffer', $acceptedOffer); |
|
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 | * An alias for the item. |
|
55 | * |
|
56 | * @param string|string[] $alternateName |
|
57 | * |
|
58 | * @return static |
|
59 | * |
|
60 | * @see http://schema.org/alternateName |
|
61 | */ |
|
62 | public function alternateName($alternateName) |
|
63 | { |
|
64 | return $this->setProperty('alternateName', $alternateName); |
|
65 | } |
|
66 | ||
67 | /** |
|
68 | * The billing address for the order. |
|
69 | * |
|
70 | * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[] $billingAddress |
|
71 | * |
|
72 | * @return static |
|
73 | * |
|
74 | * @see http://schema.org/billingAddress |
|
75 | */ |
|
76 | public function billingAddress($billingAddress) |
|
77 | { |
|
78 | return $this->setProperty('billingAddress', $billingAddress); |
|
79 | } |
|
80 | ||
81 | /** |
|
82 | * An entity that arranges for an exchange between a buyer and a seller. In |
|
83 | * most cases a broker never acquires or releases ownership of a product or |
|
84 | * service involved in an exchange. If it is not clear whether an entity is |
|
85 | * a broker, seller, or buyer, the latter two terms are preferred. |
|
86 | * |
|
87 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $broker |
|
88 | * |
|
89 | * @return static |
|
90 | * |
|
91 | * @see http://schema.org/broker |
|
92 | */ |
|
93 | public function broker($broker) |
|
94 | { |
|
95 | return $this->setProperty('broker', $broker); |
|
96 | } |
|
97 | ||
98 | /** |
|
99 | * A number that confirms the given order or payment has been received. |
|
100 | * |
|
101 | * @param string|string[] $confirmationNumber |
|
102 | * |
|
103 | * @return static |
|
104 | * |
|
105 | * @see http://schema.org/confirmationNumber |
|
106 | */ |
|
107 | public function confirmationNumber($confirmationNumber) |
|
108 | { |
|
109 | return $this->setProperty('confirmationNumber', $confirmationNumber); |
|
110 | } |
|
111 | ||
112 | /** |
|
113 | * Party placing the order or paying the invoice. |
|
114 | * |
|
115 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $customer |
|
116 | * |
|
117 | * @return static |
|
118 | * |
|
119 | * @see http://schema.org/customer |
|
120 | */ |
|
121 | public function customer($customer) |
|
122 | { |
|
123 | return $this->setProperty('customer', $customer); |
|
124 | } |
|
125 | ||
126 | /** |
|
127 | * A description of the item. |
|
128 | * |
|
129 | * @param string|string[] $description |
|
130 | * |
|
131 | * @return static |
|
132 | * |
|
133 | * @see http://schema.org/description |
|
134 | */ |
|
135 | public function description($description) |
|
136 | { |
|
137 | return $this->setProperty('description', $description); |
|
138 | } |
|
139 | ||
140 | /** |
|
141 | * A sub property of description. A short description of the item used to |
|
142 | * disambiguate from other, similar items. Information from other properties |
|
143 | * (in particular, name) may be necessary for the description to be useful |
|
144 | * for disambiguation. |
|
145 | * |
|
146 | * @param string|string[] $disambiguatingDescription |
|
147 | * |
|
148 | * @return static |
|
149 | * |
|
150 | * @see http://schema.org/disambiguatingDescription |
|
151 | */ |
|
152 | public function disambiguatingDescription($disambiguatingDescription) |
|
153 | { |
|
154 | return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); |
|
155 | } |
|
156 | ||
157 | /** |
|
158 | * Any discount applied (to an Order). |
|
159 | * |
|
160 | * @param float|float[]|int|int[]|string|string[] $discount |
|
161 | * |
|
162 | * @return static |
|
163 | * |
|
164 | * @see http://schema.org/discount |
|
165 | */ |
|
166 | public function discount($discount) |
|
167 | { |
|
168 | return $this->setProperty('discount', $discount); |
|
169 | } |
|
170 | ||
171 | /** |
|
172 | * Code used to redeem a discount. |
|
173 | * |
|
174 | * @param string|string[] $discountCode |
|
175 | * |
|
176 | * @return static |
|
177 | * |
|
178 | * @see http://schema.org/discountCode |
|
179 | */ |
|
180 | public function discountCode($discountCode) |
|
181 | { |
|
182 | return $this->setProperty('discountCode', $discountCode); |
|
183 | } |
|
184 | ||
185 | /** |
|
186 | * The currency of the discount. |
|
187 | * |
|
188 | * Use standard formats: [ISO 4217 currency |
|
189 | * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker |
|
190 | * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for |
|
191 | * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange |
|
192 | * Tradings |
|
193 | * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) |
|
194 | * (LETS) and other currency types e.g. "Ithaca HOUR". |
|
195 | * |
|
196 | * @param string|string[] $discountCurrency |
|
197 | * |
|
198 | * @return static |
|
199 | * |
|
200 | * @see http://schema.org/discountCurrency |
|
201 | */ |
|
202 | public function discountCurrency($discountCurrency) |
|
203 | { |
|
204 | return $this->setProperty('discountCurrency', $discountCurrency); |
|
205 | } |
|
206 | ||
207 | /** |
|
208 | * The identifier property represents any kind of identifier for any kind of |
|
209 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
|
210 | * dedicated properties for representing many of these, either as textual |
|
211 | * strings or as URL (URI) links. See [background |
|
212 | * notes](/docs/datamodel.html#identifierBg) for more details. |
|
213 | * |
|
214 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
|
215 | * |
|
216 | * @return static |
|
217 | * |
|
218 | * @see http://schema.org/identifier |
|
219 | */ |
|
220 | public function identifier($identifier) |
|
221 | { |
|
222 | return $this->setProperty('identifier', $identifier); |
|
223 | } |
|
224 | ||
225 | /** |
|
226 | * An image of the item. This can be a [[URL]] or a fully described |
|
227 | * [[ImageObject]]. |
|
228 | * |
|
229 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
|
230 | * |
|
231 | * @return static |
|
232 | * |
|
233 | * @see http://schema.org/image |
|
234 | */ |
|
235 | public function image($image) |
|
236 | { |
|
237 | return $this->setProperty('image', $image); |
|
238 | } |
|
239 | ||
240 | /** |
|
241 | * Was the offer accepted as a gift for someone other than the buyer. |
|
242 | * |
|
243 | * @param bool|bool[] $isGift |
|
244 | * |
|
245 | * @return static |
|
246 | * |
|
247 | * @see http://schema.org/isGift |
|
248 | */ |
|
249 | public function isGift($isGift) |
|
250 | { |
|
251 | return $this->setProperty('isGift', $isGift); |
|
252 | } |
|
253 | ||
254 | /** |
|
255 | * Indicates a page (or other CreativeWork) for which this thing is the main |
|
256 | * entity being described. See [background |
|
257 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
|
258 | * |
|
259 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
|
260 | * |
|
261 | * @return static |
|
262 | * |
|
263 | * @see http://schema.org/mainEntityOfPage |
|
264 | */ |
|
265 | public function mainEntityOfPage($mainEntityOfPage) |
|
266 | { |
|
267 | return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); |
|
268 | } |
|
269 | ||
270 | /** |
|
271 | * 'merchant' is an out-dated term for 'seller'. |
|
272 | * |
|
273 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $merchant |
|
274 | * |
|
275 | * @return static |
|
276 | * |
|
277 | * @see http://schema.org/merchant |
|
278 | */ |
|
279 | public function merchant($merchant) |
|
280 | { |
|
281 | return $this->setProperty('merchant', $merchant); |
|
282 | } |
|
283 | ||
284 | /** |
|
285 | * The name of the item. |
|
286 | * |
|
287 | * @param string|string[] $name |
|
288 | * |
|
289 | * @return static |
|
290 | * |
|
291 | * @see http://schema.org/name |
|
292 | */ |
|
293 | public function name($name) |
|
294 | { |
|
295 | return $this->setProperty('name', $name); |
|
296 | } |
|
297 | ||
298 | /** |
|
299 | * Date order was placed. |
|
300 | * |
|
301 | * @param \DateTimeInterface|\DateTimeInterface[] $orderDate |
|
302 | * |
|
303 | * @return static |
|
304 | * |
|
305 | * @see http://schema.org/orderDate |
|
306 | */ |
|
307 | public function orderDate($orderDate) |
|
308 | { |
|
309 | return $this->setProperty('orderDate', $orderDate); |
|
310 | } |
|
311 | ||
312 | /** |
|
313 | * The delivery of the parcel related to this order or order item. |
|
314 | * |
|
315 | * @param \Spatie\SchemaOrg\Contracts\ParcelDeliveryContract|\Spatie\SchemaOrg\Contracts\ParcelDeliveryContract[] $orderDelivery |
|
316 | * |
|
317 | * @return static |
|
318 | * |
|
319 | * @see http://schema.org/orderDelivery |
|
320 | */ |
|
321 | public function orderDelivery($orderDelivery) |
|
322 | { |
|
323 | return $this->setProperty('orderDelivery', $orderDelivery); |
|
324 | } |
|
325 | ||
326 | /** |
|
327 | * The identifier of the transaction. |
|
328 | * |
|
329 | * @param string|string[] $orderNumber |
|
330 | * |
|
331 | * @return static |
|
332 | * |
|
333 | * @see http://schema.org/orderNumber |
|
334 | */ |
|
335 | public function orderNumber($orderNumber) |
|
336 | { |
|
337 | return $this->setProperty('orderNumber', $orderNumber); |
|
338 | } |
|
339 | ||
340 | /** |
|
341 | * The current status of the order. |
|
342 | * |
|
343 | * @param \Spatie\SchemaOrg\Contracts\OrderStatusContract|\Spatie\SchemaOrg\Contracts\OrderStatusContract[] $orderStatus |
|
344 | * |
|
345 | * @return static |
|
346 | * |
|
347 | * @see http://schema.org/orderStatus |
|
348 | */ |
|
349 | public function orderStatus($orderStatus) |
|
350 | { |
|
351 | return $this->setProperty('orderStatus', $orderStatus); |
|
352 | } |
|
353 | ||
354 | /** |
|
355 | * The item ordered. |
|
356 | * |
|
357 | * @param \Spatie\SchemaOrg\Contracts\OrderItemContract|\Spatie\SchemaOrg\Contracts\OrderItemContract[]|\Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|\Spatie\SchemaOrg\Contracts\ServiceContract|\Spatie\SchemaOrg\Contracts\ServiceContract[] $orderedItem |
|
358 | * |
|
359 | * @return static |
|
360 | * |
|
361 | * @see http://schema.org/orderedItem |
|
362 | */ |
|
363 | public function orderedItem($orderedItem) |
|
364 | { |
|
365 | return $this->setProperty('orderedItem', $orderedItem); |
|
366 | } |
|
367 | ||
368 | /** |
|
369 | * The order is being paid as part of the referenced Invoice. |
|
370 | * |
|
371 | * @param \Spatie\SchemaOrg\Contracts\InvoiceContract|\Spatie\SchemaOrg\Contracts\InvoiceContract[] $partOfInvoice |
|
372 | * |
|
373 | * @return static |
|
374 | * |
|
375 | * @see http://schema.org/partOfInvoice |
|
376 | */ |
|
377 | public function partOfInvoice($partOfInvoice) |
|
378 | { |
|
379 | return $this->setProperty('partOfInvoice', $partOfInvoice); |
|
380 | } |
|
381 | ||
382 | /** |
|
383 | * The date that payment is due. |
|
384 | * |
|
385 | * @param \DateTimeInterface|\DateTimeInterface[] $paymentDue |
|
386 | * |
|
387 | * @return static |
|
388 | * |
|
389 | * @see http://schema.org/paymentDue |
|
390 | */ |
|
391 | public function paymentDue($paymentDue) |
|
392 | { |
|
393 | return $this->setProperty('paymentDue', $paymentDue); |
|
394 | } |
|
395 | ||
396 | /** |
|
397 | * The date that payment is due. |
|
398 | * |
|
399 | * @param \DateTimeInterface|\DateTimeInterface[] $paymentDueDate |
|
400 | * |
|
401 | * @return static |
|
402 | * |
|
403 | * @see http://schema.org/paymentDueDate |
|
404 | */ |
|
405 | public function paymentDueDate($paymentDueDate) |
|
406 | { |
|
407 | return $this->setProperty('paymentDueDate', $paymentDueDate); |
|
408 | } |
|
409 | ||
410 | /** |
|
411 | * The name of the credit card or other method of payment for the order. |
|
412 | * |
|
413 | * @param \Spatie\SchemaOrg\Contracts\PaymentMethodContract|\Spatie\SchemaOrg\Contracts\PaymentMethodContract[] $paymentMethod |
|
414 | * |
|
415 | * @return static |
|
416 | * |
|
417 | * @see http://schema.org/paymentMethod |
|
418 | */ |
|
419 | public function paymentMethod($paymentMethod) |
|
420 | { |
|
421 | return $this->setProperty('paymentMethod', $paymentMethod); |
|
422 | } |
|
423 | ||
424 | /** |
|
425 | * An identifier for the method of payment used (e.g. the last 4 digits of |
|
426 | * the credit card). |
|
427 | * |
|
428 | * @param string|string[] $paymentMethodId |
|
429 | * |
|
430 | * @return static |
|
431 | * |
|
432 | * @see http://schema.org/paymentMethodId |
|
433 | */ |
|
434 | public function paymentMethodId($paymentMethodId) |
|
435 | { |
|
436 | return $this->setProperty('paymentMethodId', $paymentMethodId); |
|
437 | } |
|
438 | ||
439 | /** |
|
440 | * The URL for sending a payment. |
|
441 | * |
|
442 | * @param string|string[] $paymentUrl |
|
443 | * |
|
444 | * @return static |
|
445 | * |
|
446 | * @see http://schema.org/paymentUrl |
|
447 | */ |
|
448 | public function paymentUrl($paymentUrl) |
|
449 | { |
|
450 | return $this->setProperty('paymentUrl', $paymentUrl); |
|
451 | } |
|
452 | ||
453 | /** |
|
454 | * Indicates a potential Action, which describes an idealized action in |
|
455 | * which this thing would play an 'object' role. |
|
456 | * |
|
457 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
|
458 | * |
|
459 | * @return static |
|
460 | * |
|
461 | * @see http://schema.org/potentialAction |
|
462 | */ |
|
463 | public function potentialAction($potentialAction) |
|
464 | { |
|
465 | return $this->setProperty('potentialAction', $potentialAction); |
|
466 | } |
|
467 | ||
468 | /** |
|
469 | * URL of a reference Web page that unambiguously indicates the item's |
|
470 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
|
471 | * official website. |
|
472 | * |
|
473 | * @param string|string[] $sameAs |
|
474 | * |
|
475 | * @return static |
|
476 | * |
|
477 | * @see http://schema.org/sameAs |
|
478 | */ |
|
479 | public function sameAs($sameAs) |
|
480 | { |
|
481 | return $this->setProperty('sameAs', $sameAs); |
|
482 | } |
|
483 | ||
484 | /** |
|
485 | * An entity which offers (sells / leases / lends / loans) the services / |
|
486 | * goods. A seller may also be a provider. |
|
487 | * |
|
488 | * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $seller |
|
489 | * |
|
490 | * @return static |
|
491 | * |
|
492 | * @see http://schema.org/seller |
|
493 | */ |
|
494 | public function seller($seller) |
|
495 | { |
|
496 | return $this->setProperty('seller', $seller); |
|
497 | } |
|
498 | ||
499 | /** |
|
500 | * A CreativeWork or Event about this Thing. |
|
501 | * |
|
502 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
|
503 | * |
|
504 | * @return static |
|
505 | * |
|
506 | * @see http://schema.org/subjectOf |
|
507 | */ |
|
508 | public function subjectOf($subjectOf) |
|
509 | { |
|
510 | return $this->setProperty('subjectOf', $subjectOf); |
|
511 | } |
|
512 | ||
513 | /** |
|
514 | * URL of the item. |
|
515 | * |
|
516 | * @param string|string[] $url |
|
517 | * |
|
518 | * @return static |
|
519 | * |
|
520 | * @see http://schema.org/url |
|
521 | */ |
|
522 | public function url($url) |
|
523 | { |
|
524 | return $this->setProperty('url', $url); |
|
525 | } |
|
526 | ||
527 | } |
|
528 |