Code Duplication    Length = 327-383 lines in 38 locations

src/AchieveAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/AchieveAction
14
 *
15
 */
16
class AchieveAction extends BaseType implements 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

src/ActivateAction.php 1 location

@@ 17-384 (lines=368) @@
14
 * @see http://schema.org/ActivateAction
15
 *
16
 */
17
class ActivateAction extends BaseType implements ActivateActionContract, ActionContract, ControlActionContract, 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 startTime of something. For a reserved event or service (e.g.
321
     * FoodEstablishmentReservation), the time that it is expected to start. For
322
     * actions that span a period of time, when the action was performed. e.g.
323
     * John wrote a book from *January* to December. For media, including audio
324
     * and video, it's the time offset of the start of a clip within a larger
325
     * file.
326
     * 
327
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
328
     * when describing dates with times. This situation may be clarified in
329
     * future revisions.
330
     *
331
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/startTime
336
     */
337
    public function startTime($startTime)
338
    {
339
        return $this->setProperty('startTime', $startTime);
340
    }
341
342
    /**
343
     * A CreativeWork or Event about this Thing.
344
     *
345
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
346
     *
347
     * @return static
348
     *
349
     * @see http://schema.org/subjectOf
350
     */
351
    public function subjectOf($subjectOf)
352
    {
353
        return $this->setProperty('subjectOf', $subjectOf);
354
    }
355
356
    /**
357
     * Indicates a target EntryPoint for an Action.
358
     *
359
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
360
     *
361
     * @return static
362
     *
363
     * @see http://schema.org/target
364
     */
365
    public function target($target)
366
    {
367
        return $this->setProperty('target', $target);
368
    }
369
370
    /**
371
     * URL of the item.
372
     *
373
     * @param string|string[] $url
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/url
378
     */
379
    public function url($url)
380
    {
381
        return $this->setProperty('url', $url);
382
    }
383
384
}
385

src/AllocateAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/AllocateAction
14
 *
15
 */
16
class AllocateAction extends BaseType implements AllocateActionContract, ActionContract, OrganizeActionContract, 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

src/ApplyAction.php 1 location

@@ 22-389 (lines=368) @@
19
 * @see http://schema.org/ApplyAction
20
 *
21
 */
22
class ApplyAction extends BaseType implements ApplyActionContract, ActionContract, OrganizeActionContract, 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
     * The identifier property represents any kind of identifier for any kind of
156
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
157
     * dedicated properties for representing many of these, either as textual
158
     * strings or as URL (URI) links. See [background
159
     * notes](/docs/datamodel.html#identifierBg) for more details.
160
     *
161
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
162
     *
163
     * @return static
164
     *
165
     * @see http://schema.org/identifier
166
     */
167
    public function identifier($identifier)
168
    {
169
        return $this->setProperty('identifier', $identifier);
170
    }
171
172
    /**
173
     * An image of the item. This can be a [[URL]] or a fully described
174
     * [[ImageObject]].
175
     *
176
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
177
     *
178
     * @return static
179
     *
180
     * @see http://schema.org/image
181
     */
182
    public function image($image)
183
    {
184
        return $this->setProperty('image', $image);
185
    }
186
187
    /**
188
     * The object that helped the agent perform the action. e.g. John wrote a
189
     * book with *a pen*.
190
     *
191
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
192
     *
193
     * @return static
194
     *
195
     * @see http://schema.org/instrument
196
     */
197
    public function instrument($instrument)
198
    {
199
        return $this->setProperty('instrument', $instrument);
200
    }
201
202
    /**
203
     * The location of for example where the event is happening, an organization
204
     * is located, or where an action takes place.
205
     *
206
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
207
     *
208
     * @return static
209
     *
210
     * @see http://schema.org/location
211
     */
212
    public function location($location)
213
    {
214
        return $this->setProperty('location', $location);
215
    }
216
217
    /**
218
     * Indicates a page (or other CreativeWork) for which this thing is the main
219
     * entity being described. See [background
220
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
221
     *
222
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
223
     *
224
     * @return static
225
     *
226
     * @see http://schema.org/mainEntityOfPage
227
     */
228
    public function mainEntityOfPage($mainEntityOfPage)
229
    {
230
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
231
    }
232
233
    /**
234
     * The name of the item.
235
     *
236
     * @param string|string[] $name
237
     *
238
     * @return static
239
     *
240
     * @see http://schema.org/name
241
     */
242
    public function name($name)
243
    {
244
        return $this->setProperty('name', $name);
245
    }
246
247
    /**
248
     * The object upon which the action is carried out, whose state is kept
249
     * intact or changed. Also known as the semantic roles patient, affected or
250
     * undergoer (which change their state) or theme (which doesn't). e.g. John
251
     * read *a book*.
252
     *
253
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
254
     *
255
     * @return static
256
     *
257
     * @see http://schema.org/object
258
     */
259
    public function object($object)
260
    {
261
        return $this->setProperty('object', $object);
262
    }
263
264
    /**
265
     * Other co-agents that participated in the action indirectly. e.g. John
266
     * wrote a book with *Steve*.
267
     *
268
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
269
     *
270
     * @return static
271
     *
272
     * @see http://schema.org/participant
273
     */
274
    public function participant($participant)
275
    {
276
        return $this->setProperty('participant', $participant);
277
    }
278
279
    /**
280
     * Indicates a potential Action, which describes an idealized action in
281
     * which this thing would play an 'object' role.
282
     *
283
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
284
     *
285
     * @return static
286
     *
287
     * @see http://schema.org/potentialAction
288
     */
289
    public function potentialAction($potentialAction)
290
    {
291
        return $this->setProperty('potentialAction', $potentialAction);
292
    }
293
294
    /**
295
     * The result produced in the action. e.g. John wrote *a book*.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/result
302
     */
303
    public function result($result)
304
    {
305
        return $this->setProperty('result', $result);
306
    }
307
308
    /**
309
     * URL of a reference Web page that unambiguously indicates the item's
310
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
311
     * official website.
312
     *
313
     * @param string|string[] $sameAs
314
     *
315
     * @return static
316
     *
317
     * @see http://schema.org/sameAs
318
     */
319
    public function sameAs($sameAs)
320
    {
321
        return $this->setProperty('sameAs', $sameAs);
322
    }
323
324
    /**
325
     * The startTime of something. For a reserved event or service (e.g.
326
     * FoodEstablishmentReservation), the time that it is expected to start. For
327
     * actions that span a period of time, when the action was performed. e.g.
328
     * John wrote a book from *January* to December. For media, including audio
329
     * and video, it's the time offset of the start of a clip within a larger
330
     * file.
331
     * 
332
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
333
     * when describing dates with times. This situation may be clarified in
334
     * future revisions.
335
     *
336
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
337
     *
338
     * @return static
339
     *
340
     * @see http://schema.org/startTime
341
     */
342
    public function startTime($startTime)
343
    {
344
        return $this->setProperty('startTime', $startTime);
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
     * Indicates a target EntryPoint for an Action.
363
     *
364
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
365
     *
366
     * @return static
367
     *
368
     * @see http://schema.org/target
369
     */
370
    public function target($target)
371
    {
372
        return $this->setProperty('target', $target);
373
    }
374
375
    /**
376
     * URL of the item.
377
     *
378
     * @param string|string[] $url
379
     *
380
     * @return static
381
     *
382
     * @see http://schema.org/url
383
     */
384
    public function url($url)
385
    {
386
        return $this->setProperty('url', $url);
387
    }
388
389
}
390

src/AssessAction.php 1 location

@@ 15-382 (lines=368) @@
12
 * @see http://schema.org/AssessAction
13
 *
14
 */
15
class AssessAction extends BaseType implements AssessActionContract, 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 description of the item.
81
     *
82
     * @param string|string[] $description
83
     *
84
     * @return static
85
     *
86
     * @see http://schema.org/description
87
     */
88
    public function description($description)
89
    {
90
        return $this->setProperty('description', $description);
91
    }
92
93
    /**
94
     * A sub property of description. A short description of the item used to
95
     * disambiguate from other, similar items. Information from other properties
96
     * (in particular, name) may be necessary for the description to be useful
97
     * for disambiguation.
98
     *
99
     * @param string|string[] $disambiguatingDescription
100
     *
101
     * @return static
102
     *
103
     * @see http://schema.org/disambiguatingDescription
104
     */
105
    public function disambiguatingDescription($disambiguatingDescription)
106
    {
107
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
108
    }
109
110
    /**
111
     * The endTime of something. For a reserved event or service (e.g.
112
     * FoodEstablishmentReservation), the time that it is expected to end. For
113
     * actions that span a period of time, when the action was performed. e.g.
114
     * John wrote a book from January to *December*. For media, including audio
115
     * and video, it's the time offset of the end of a clip within a larger
116
     * file.
117
     * 
118
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
119
     * when describing dates with times. This situation may be clarified in
120
     * future revisions.
121
     *
122
     * @param \DateTimeInterface|\DateTimeInterface[] $endTime
123
     *
124
     * @return static
125
     *
126
     * @see http://schema.org/endTime
127
     */
128
    public function endTime($endTime)
129
    {
130
        return $this->setProperty('endTime', $endTime);
131
    }
132
133
    /**
134
     * For failed actions, more information on the cause of the failure.
135
     *
136
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error
137
     *
138
     * @return static
139
     *
140
     * @see http://schema.org/error
141
     */
142
    public function error($error)
143
    {
144
        return $this->setProperty('error', $error);
145
    }
146
147
    /**
148
     * The identifier property represents any kind of identifier for any kind of
149
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
150
     * dedicated properties for representing many of these, either as textual
151
     * strings or as URL (URI) links. See [background
152
     * notes](/docs/datamodel.html#identifierBg) for more details.
153
     *
154
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
155
     *
156
     * @return static
157
     *
158
     * @see http://schema.org/identifier
159
     */
160
    public function identifier($identifier)
161
    {
162
        return $this->setProperty('identifier', $identifier);
163
    }
164
165
    /**
166
     * An image of the item. This can be a [[URL]] or a fully described
167
     * [[ImageObject]].
168
     *
169
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/image
174
     */
175
    public function image($image)
176
    {
177
        return $this->setProperty('image', $image);
178
    }
179
180
    /**
181
     * The object that helped the agent perform the action. e.g. John wrote a
182
     * book with *a pen*.
183
     *
184
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
185
     *
186
     * @return static
187
     *
188
     * @see http://schema.org/instrument
189
     */
190
    public function instrument($instrument)
191
    {
192
        return $this->setProperty('instrument', $instrument);
193
    }
194
195
    /**
196
     * The location of for example where the event is happening, an organization
197
     * is located, or where an action takes place.
198
     *
199
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
200
     *
201
     * @return static
202
     *
203
     * @see http://schema.org/location
204
     */
205
    public function location($location)
206
    {
207
        return $this->setProperty('location', $location);
208
    }
209
210
    /**
211
     * Indicates a page (or other CreativeWork) for which this thing is the main
212
     * entity being described. See [background
213
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
214
     *
215
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
216
     *
217
     * @return static
218
     *
219
     * @see http://schema.org/mainEntityOfPage
220
     */
221
    public function mainEntityOfPage($mainEntityOfPage)
222
    {
223
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
224
    }
225
226
    /**
227
     * The name of the item.
228
     *
229
     * @param string|string[] $name
230
     *
231
     * @return static
232
     *
233
     * @see http://schema.org/name
234
     */
235
    public function name($name)
236
    {
237
        return $this->setProperty('name', $name);
238
    }
239
240
    /**
241
     * The object upon which the action is carried out, whose state is kept
242
     * intact or changed. Also known as the semantic roles patient, affected or
243
     * undergoer (which change their state) or theme (which doesn't). e.g. John
244
     * read *a book*.
245
     *
246
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/object
251
     */
252
    public function object($object)
253
    {
254
        return $this->setProperty('object', $object);
255
    }
256
257
    /**
258
     * Other co-agents that participated in the action indirectly. e.g. John
259
     * wrote a book with *Steve*.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/participant
266
     */
267
    public function participant($participant)
268
    {
269
        return $this->setProperty('participant', $participant);
270
    }
271
272
    /**
273
     * Indicates a potential Action, which describes an idealized action in
274
     * which this thing would play an 'object' role.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/potentialAction
281
     */
282
    public function potentialAction($potentialAction)
283
    {
284
        return $this->setProperty('potentialAction', $potentialAction);
285
    }
286
287
    /**
288
     * The result produced in the action. e.g. John wrote *a book*.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/result
295
     */
296
    public function result($result)
297
    {
298
        return $this->setProperty('result', $result);
299
    }
300
301
    /**
302
     * URL of a reference Web page that unambiguously indicates the item's
303
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
304
     * official website.
305
     *
306
     * @param string|string[] $sameAs
307
     *
308
     * @return static
309
     *
310
     * @see http://schema.org/sameAs
311
     */
312
    public function sameAs($sameAs)
313
    {
314
        return $this->setProperty('sameAs', $sameAs);
315
    }
316
317
    /**
318
     * The startTime of something. For a reserved event or service (e.g.
319
     * FoodEstablishmentReservation), the time that it is expected to start. For
320
     * actions that span a period of time, when the action was performed. e.g.
321
     * John wrote a book from *January* to December. For media, including audio
322
     * and video, it's the time offset of the start of a clip within a larger
323
     * file.
324
     * 
325
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
326
     * when describing dates with times. This situation may be clarified in
327
     * future revisions.
328
     *
329
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/startTime
334
     */
335
    public function startTime($startTime)
336
    {
337
        return $this->setProperty('startTime', $startTime);
338
    }
339
340
    /**
341
     * A CreativeWork or Event about this Thing.
342
     *
343
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/subjectOf
348
     */
349
    public function subjectOf($subjectOf)
350
    {
351
        return $this->setProperty('subjectOf', $subjectOf);
352
    }
353
354
    /**
355
     * Indicates a target EntryPoint for an Action.
356
     *
357
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
358
     *
359
     * @return static
360
     *
361
     * @see http://schema.org/target
362
     */
363
    public function target($target)
364
    {
365
        return $this->setProperty('target', $target);
366
    }
367
368
    /**
369
     * URL of the item.
370
     *
371
     * @param string|string[] $url
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/url
376
     */
377
    public function url($url)
378
    {
379
        return $this->setProperty('url', $url);
380
    }
381
382
}
383

src/BefriendAction.php 1 location

@@ 22-389 (lines=368) @@
19
 * @see http://schema.org/BefriendAction
20
 *
21
 */
22
class BefriendAction extends BaseType implements BefriendActionContract, 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
     * The identifier property represents any kind of identifier for any kind of
156
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
157
     * dedicated properties for representing many of these, either as textual
158
     * strings or as URL (URI) links. See [background
159
     * notes](/docs/datamodel.html#identifierBg) for more details.
160
     *
161
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
162
     *
163
     * @return static
164
     *
165
     * @see http://schema.org/identifier
166
     */
167
    public function identifier($identifier)
168
    {
169
        return $this->setProperty('identifier', $identifier);
170
    }
171
172
    /**
173
     * An image of the item. This can be a [[URL]] or a fully described
174
     * [[ImageObject]].
175
     *
176
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
177
     *
178
     * @return static
179
     *
180
     * @see http://schema.org/image
181
     */
182
    public function image($image)
183
    {
184
        return $this->setProperty('image', $image);
185
    }
186
187
    /**
188
     * The object that helped the agent perform the action. e.g. John wrote a
189
     * book with *a pen*.
190
     *
191
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
192
     *
193
     * @return static
194
     *
195
     * @see http://schema.org/instrument
196
     */
197
    public function instrument($instrument)
198
    {
199
        return $this->setProperty('instrument', $instrument);
200
    }
201
202
    /**
203
     * The location of for example where the event is happening, an organization
204
     * is located, or where an action takes place.
205
     *
206
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
207
     *
208
     * @return static
209
     *
210
     * @see http://schema.org/location
211
     */
212
    public function location($location)
213
    {
214
        return $this->setProperty('location', $location);
215
    }
216
217
    /**
218
     * Indicates a page (or other CreativeWork) for which this thing is the main
219
     * entity being described. See [background
220
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
221
     *
222
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
223
     *
224
     * @return static
225
     *
226
     * @see http://schema.org/mainEntityOfPage
227
     */
228
    public function mainEntityOfPage($mainEntityOfPage)
229
    {
230
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
231
    }
232
233
    /**
234
     * The name of the item.
235
     *
236
     * @param string|string[] $name
237
     *
238
     * @return static
239
     *
240
     * @see http://schema.org/name
241
     */
242
    public function name($name)
243
    {
244
        return $this->setProperty('name', $name);
245
    }
246
247
    /**
248
     * The object upon which the action is carried out, whose state is kept
249
     * intact or changed. Also known as the semantic roles patient, affected or
250
     * undergoer (which change their state) or theme (which doesn't). e.g. John
251
     * read *a book*.
252
     *
253
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
254
     *
255
     * @return static
256
     *
257
     * @see http://schema.org/object
258
     */
259
    public function object($object)
260
    {
261
        return $this->setProperty('object', $object);
262
    }
263
264
    /**
265
     * Other co-agents that participated in the action indirectly. e.g. John
266
     * wrote a book with *Steve*.
267
     *
268
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
269
     *
270
     * @return static
271
     *
272
     * @see http://schema.org/participant
273
     */
274
    public function participant($participant)
275
    {
276
        return $this->setProperty('participant', $participant);
277
    }
278
279
    /**
280
     * Indicates a potential Action, which describes an idealized action in
281
     * which this thing would play an 'object' role.
282
     *
283
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
284
     *
285
     * @return static
286
     *
287
     * @see http://schema.org/potentialAction
288
     */
289
    public function potentialAction($potentialAction)
290
    {
291
        return $this->setProperty('potentialAction', $potentialAction);
292
    }
293
294
    /**
295
     * The result produced in the action. e.g. John wrote *a book*.
296
     *
297
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
298
     *
299
     * @return static
300
     *
301
     * @see http://schema.org/result
302
     */
303
    public function result($result)
304
    {
305
        return $this->setProperty('result', $result);
306
    }
307
308
    /**
309
     * URL of a reference Web page that unambiguously indicates the item's
310
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
311
     * official website.
312
     *
313
     * @param string|string[] $sameAs
314
     *
315
     * @return static
316
     *
317
     * @see http://schema.org/sameAs
318
     */
319
    public function sameAs($sameAs)
320
    {
321
        return $this->setProperty('sameAs', $sameAs);
322
    }
323
324
    /**
325
     * The startTime of something. For a reserved event or service (e.g.
326
     * FoodEstablishmentReservation), the time that it is expected to start. For
327
     * actions that span a period of time, when the action was performed. e.g.
328
     * John wrote a book from *January* to December. For media, including audio
329
     * and video, it's the time offset of the start of a clip within a larger
330
     * file.
331
     * 
332
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
333
     * when describing dates with times. This situation may be clarified in
334
     * future revisions.
335
     *
336
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
337
     *
338
     * @return static
339
     *
340
     * @see http://schema.org/startTime
341
     */
342
    public function startTime($startTime)
343
    {
344
        return $this->setProperty('startTime', $startTime);
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
     * Indicates a target EntryPoint for an Action.
363
     *
364
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
365
     *
366
     * @return static
367
     *
368
     * @see http://schema.org/target
369
     */
370
    public function target($target)
371
    {
372
        return $this->setProperty('target', $target);
373
    }
374
375
    /**
376
     * URL of the item.
377
     *
378
     * @param string|string[] $url
379
     *
380
     * @return static
381
     *
382
     * @see http://schema.org/url
383
     */
384
    public function url($url)
385
    {
386
        return $this->setProperty('url', $url);
387
    }
388
389
}
390

src/BookmarkAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/BookmarkAction
14
 *
15
 */
16
class BookmarkAction extends BaseType implements BookmarkActionContract, ActionContract, OrganizeActionContract, 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

src/CheckAction.php 1 location

@@ 17-384 (lines=368) @@
14
 * @see http://schema.org/CheckAction
15
 *
16
 */
17
class CheckAction extends BaseType implements CheckActionContract, ActionContract, FindActionContract, 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 startTime of something. For a reserved event or service (e.g.
321
     * FoodEstablishmentReservation), the time that it is expected to start. For
322
     * actions that span a period of time, when the action was performed. e.g.
323
     * John wrote a book from *January* to December. For media, including audio
324
     * and video, it's the time offset of the start of a clip within a larger
325
     * file.
326
     * 
327
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
328
     * when describing dates with times. This situation may be clarified in
329
     * future revisions.
330
     *
331
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/startTime
336
     */
337
    public function startTime($startTime)
338
    {
339
        return $this->setProperty('startTime', $startTime);
340
    }
341
342
    /**
343
     * A CreativeWork or Event about this Thing.
344
     *
345
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
346
     *
347
     * @return static
348
     *
349
     * @see http://schema.org/subjectOf
350
     */
351
    public function subjectOf($subjectOf)
352
    {
353
        return $this->setProperty('subjectOf', $subjectOf);
354
    }
355
356
    /**
357
     * Indicates a target EntryPoint for an Action.
358
     *
359
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
360
     *
361
     * @return static
362
     *
363
     * @see http://schema.org/target
364
     */
365
    public function target($target)
366
    {
367
        return $this->setProperty('target', $target);
368
    }
369
370
    /**
371
     * URL of the item.
372
     *
373
     * @param string|string[] $url
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/url
378
     */
379
    public function url($url)
380
    {
381
        return $this->setProperty('url', $url);
382
    }
383
384
}
385

src/CompoundPriceSpecification.php 1 location

@@ 20-388 (lines=369) @@
17
 * @see http://schema.org/CompoundPriceSpecification
18
 *
19
 */
20
class CompoundPriceSpecification extends BaseType implements CompoundPriceSpecificationContract, IntangibleContract, PriceSpecificationContract, StructuredValueContract, 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
     * A description of the item.
57
     *
58
     * @param string|string[] $description
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/description
63
     */
64
    public function description($description)
65
    {
66
        return $this->setProperty('description', $description);
67
    }
68
69
    /**
70
     * A sub property of description. A short description of the item used to
71
     * disambiguate from other, similar items. Information from other properties
72
     * (in particular, name) may be necessary for the description to be useful
73
     * for disambiguation.
74
     *
75
     * @param string|string[] $disambiguatingDescription
76
     *
77
     * @return static
78
     *
79
     * @see http://schema.org/disambiguatingDescription
80
     */
81
    public function disambiguatingDescription($disambiguatingDescription)
82
    {
83
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
84
    }
85
86
    /**
87
     * The interval and unit of measurement of ordering quantities for which the
88
     * offer or price specification is valid. This allows e.g. specifying that a
89
     * certain freight charge is valid only for a certain quantity.
90
     *
91
     * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $eligibleQuantity
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/eligibleQuantity
96
     */
97
    public function eligibleQuantity($eligibleQuantity)
98
    {
99
        return $this->setProperty('eligibleQuantity', $eligibleQuantity);
100
    }
101
102
    /**
103
     * The transaction volume, in a monetary unit, for which the offer or price
104
     * specification is valid, e.g. for indicating a minimal purchasing volume,
105
     * to express free shipping above a certain order volume, or to limit the
106
     * acceptance of credit cards to purchases to a certain minimal amount.
107
     *
108
     * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[] $eligibleTransactionVolume
109
     *
110
     * @return static
111
     *
112
     * @see http://schema.org/eligibleTransactionVolume
113
     */
114
    public function eligibleTransactionVolume($eligibleTransactionVolume)
115
    {
116
        return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume);
117
    }
118
119
    /**
120
     * The identifier property represents any kind of identifier for any kind of
121
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
122
     * dedicated properties for representing many of these, either as textual
123
     * strings or as URL (URI) links. See [background
124
     * notes](/docs/datamodel.html#identifierBg) for more details.
125
     *
126
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
127
     *
128
     * @return static
129
     *
130
     * @see http://schema.org/identifier
131
     */
132
    public function identifier($identifier)
133
    {
134
        return $this->setProperty('identifier', $identifier);
135
    }
136
137
    /**
138
     * An image of the item. This can be a [[URL]] or a fully described
139
     * [[ImageObject]].
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/image
146
     */
147
    public function image($image)
148
    {
149
        return $this->setProperty('image', $image);
150
    }
151
152
    /**
153
     * Indicates a page (or other CreativeWork) for which this thing is the main
154
     * entity being described. See [background
155
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
156
     *
157
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
158
     *
159
     * @return static
160
     *
161
     * @see http://schema.org/mainEntityOfPage
162
     */
163
    public function mainEntityOfPage($mainEntityOfPage)
164
    {
165
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
166
    }
167
168
    /**
169
     * The highest price if the price is a range.
170
     *
171
     * @param float|float[]|int|int[] $maxPrice
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/maxPrice
176
     */
177
    public function maxPrice($maxPrice)
178
    {
179
        return $this->setProperty('maxPrice', $maxPrice);
180
    }
181
182
    /**
183
     * The lowest price if the price is a range.
184
     *
185
     * @param float|float[]|int|int[] $minPrice
186
     *
187
     * @return static
188
     *
189
     * @see http://schema.org/minPrice
190
     */
191
    public function minPrice($minPrice)
192
    {
193
        return $this->setProperty('minPrice', $minPrice);
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 offer price of a product, or of a price component when attached to
227
     * PriceSpecification and its subtypes.
228
     * 
229
     * Usage guidelines:
230
     * 
231
     * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217
232
     * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD";
233
     * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)
234
     * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange
235
     * Tradings
236
     * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)
237
     * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including
238
     * [ambiguous
239
     * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)
240
     * such as '$' in the value.
241
     * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
242
     * decimal point. Avoid using these symbols as a readability separator.
243
     * * Note that both
244
     * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)
245
     * and Microdata syntax allow the use of a "content=" attribute for
246
     * publishing simple machine-readable values alongside more human-friendly
247
     * formatting.
248
     * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
249
     * NINE' (U+0039)) rather than superficially similiar Unicode symbols.
250
     *
251
     * @param float|float[]|int|int[]|string|string[] $price
252
     *
253
     * @return static
254
     *
255
     * @see http://schema.org/price
256
     */
257
    public function price($price)
258
    {
259
        return $this->setProperty('price', $price);
260
    }
261
262
    /**
263
     * This property links to all [[UnitPriceSpecification]] nodes that apply in
264
     * parallel for the [[CompoundPriceSpecification]] node.
265
     *
266
     * @param \Spatie\SchemaOrg\Contracts\UnitPriceSpecificationContract|\Spatie\SchemaOrg\Contracts\UnitPriceSpecificationContract[] $priceComponent
267
     *
268
     * @return static
269
     *
270
     * @see http://schema.org/priceComponent
271
     */
272
    public function priceComponent($priceComponent)
273
    {
274
        return $this->setProperty('priceComponent', $priceComponent);
275
    }
276
277
    /**
278
     * The currency of the price, or a price component when attached to
279
     * [[PriceSpecification]] and its subtypes.
280
     * 
281
     * Use standard formats: [ISO 4217 currency
282
     * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker
283
     * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for
284
     * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange
285
     * Tradings
286
     * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)
287
     * (LETS) and other currency types e.g. "Ithaca HOUR".
288
     *
289
     * @param string|string[] $priceCurrency
290
     *
291
     * @return static
292
     *
293
     * @see http://schema.org/priceCurrency
294
     */
295
    public function priceCurrency($priceCurrency)
296
    {
297
        return $this->setProperty('priceCurrency', $priceCurrency);
298
    }
299
300
    /**
301
     * URL of a reference Web page that unambiguously indicates the item's
302
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
303
     * official website.
304
     *
305
     * @param string|string[] $sameAs
306
     *
307
     * @return static
308
     *
309
     * @see http://schema.org/sameAs
310
     */
311
    public function sameAs($sameAs)
312
    {
313
        return $this->setProperty('sameAs', $sameAs);
314
    }
315
316
    /**
317
     * A CreativeWork or Event about this Thing.
318
     *
319
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
320
     *
321
     * @return static
322
     *
323
     * @see http://schema.org/subjectOf
324
     */
325
    public function subjectOf($subjectOf)
326
    {
327
        return $this->setProperty('subjectOf', $subjectOf);
328
    }
329
330
    /**
331
     * URL of the item.
332
     *
333
     * @param string|string[] $url
334
     *
335
     * @return static
336
     *
337
     * @see http://schema.org/url
338
     */
339
    public function url($url)
340
    {
341
        return $this->setProperty('url', $url);
342
    }
343
344
    /**
345
     * The date when the item becomes valid.
346
     *
347
     * @param \DateTimeInterface|\DateTimeInterface[] $validFrom
348
     *
349
     * @return static
350
     *
351
     * @see http://schema.org/validFrom
352
     */
353
    public function validFrom($validFrom)
354
    {
355
        return $this->setProperty('validFrom', $validFrom);
356
    }
357
358
    /**
359
     * The date after when the item is not valid. For example the end of an
360
     * offer, salary period, or a period of opening hours.
361
     *
362
     * @param \DateTimeInterface|\DateTimeInterface[] $validThrough
363
     *
364
     * @return static
365
     *
366
     * @see http://schema.org/validThrough
367
     */
368
    public function validThrough($validThrough)
369
    {
370
        return $this->setProperty('validThrough', $validThrough);
371
    }
372
373
    /**
374
     * Specifies whether the applicable value-added tax (VAT) is included in the
375
     * price specification or not.
376
     *
377
     * @param bool|bool[] $valueAddedTaxIncluded
378
     *
379
     * @return static
380
     *
381
     * @see http://schema.org/valueAddedTaxIncluded
382
     */
383
    public function valueAddedTaxIncluded($valueAddedTaxIncluded)
384
    {
385
        return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded);
386
    }
387
388
}
389

src/ContactPoint.php 1 location

@@ 16-352 (lines=337) @@
13
 * @see http://schema.org/ContactPoint
14
 *
15
 */
16
class ContactPoint extends BaseType implements ContactPointContract, 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 geographic area where a service or offered item is provided.
53
     *
54
     * @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
55
     *
56
     * @return static
57
     *
58
     * @see http://schema.org/areaServed
59
     */
60
    public function areaServed($areaServed)
61
    {
62
        return $this->setProperty('areaServed', $areaServed);
63
    }
64
65
    /**
66
     * A language someone may use with or at the item, service or place. Please
67
     * use one of the language codes from the [IETF BCP 47
68
     * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]]
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $availableLanguage
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/availableLanguage
75
     */
76
    public function availableLanguage($availableLanguage)
77
    {
78
        return $this->setProperty('availableLanguage', $availableLanguage);
79
    }
80
81
    /**
82
     * An option available on this contact point (e.g. a toll-free number or
83
     * support for hearing-impaired callers).
84
     *
85
     * @param \Spatie\SchemaOrg\Contracts\ContactPointOptionContract|\Spatie\SchemaOrg\Contracts\ContactPointOptionContract[] $contactOption
86
     *
87
     * @return static
88
     *
89
     * @see http://schema.org/contactOption
90
     */
91
    public function contactOption($contactOption)
92
    {
93
        return $this->setProperty('contactOption', $contactOption);
94
    }
95
96
    /**
97
     * A person or organization can have different contact points, for different
98
     * purposes. For example, a sales contact point, a PR contact point and so
99
     * on. This property is used to specify the kind of contact point.
100
     *
101
     * @param string|string[] $contactType
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/contactType
106
     */
107
    public function contactType($contactType)
108
    {
109
        return $this->setProperty('contactType', $contactType);
110
    }
111
112
    /**
113
     * A description of the item.
114
     *
115
     * @param string|string[] $description
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/description
120
     */
121
    public function description($description)
122
    {
123
        return $this->setProperty('description', $description);
124
    }
125
126
    /**
127
     * A sub property of description. A short description of the item used to
128
     * disambiguate from other, similar items. Information from other properties
129
     * (in particular, name) may be necessary for the description to be useful
130
     * for disambiguation.
131
     *
132
     * @param string|string[] $disambiguatingDescription
133
     *
134
     * @return static
135
     *
136
     * @see http://schema.org/disambiguatingDescription
137
     */
138
    public function disambiguatingDescription($disambiguatingDescription)
139
    {
140
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
141
    }
142
143
    /**
144
     * Email address.
145
     *
146
     * @param string|string[] $email
147
     *
148
     * @return static
149
     *
150
     * @see http://schema.org/email
151
     */
152
    public function email($email)
153
    {
154
        return $this->setProperty('email', $email);
155
    }
156
157
    /**
158
     * The fax number.
159
     *
160
     * @param string|string[] $faxNumber
161
     *
162
     * @return static
163
     *
164
     * @see http://schema.org/faxNumber
165
     */
166
    public function faxNumber($faxNumber)
167
    {
168
        return $this->setProperty('faxNumber', $faxNumber);
169
    }
170
171
    /**
172
     * The hours during which this service or contact is available.
173
     *
174
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $hoursAvailable
175
     *
176
     * @return static
177
     *
178
     * @see http://schema.org/hoursAvailable
179
     */
180
    public function hoursAvailable($hoursAvailable)
181
    {
182
        return $this->setProperty('hoursAvailable', $hoursAvailable);
183
    }
184
185
    /**
186
     * The identifier property represents any kind of identifier for any kind of
187
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
188
     * dedicated properties for representing many of these, either as textual
189
     * strings or as URL (URI) links. See [background
190
     * notes](/docs/datamodel.html#identifierBg) for more details.
191
     *
192
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
193
     *
194
     * @return static
195
     *
196
     * @see http://schema.org/identifier
197
     */
198
    public function identifier($identifier)
199
    {
200
        return $this->setProperty('identifier', $identifier);
201
    }
202
203
    /**
204
     * An image of the item. This can be a [[URL]] or a fully described
205
     * [[ImageObject]].
206
     *
207
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
208
     *
209
     * @return static
210
     *
211
     * @see http://schema.org/image
212
     */
213
    public function image($image)
214
    {
215
        return $this->setProperty('image', $image);
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
     * Indicates a potential Action, which describes an idealized action in
250
     * which this thing would play an 'object' role.
251
     *
252
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
253
     *
254
     * @return static
255
     *
256
     * @see http://schema.org/potentialAction
257
     */
258
    public function potentialAction($potentialAction)
259
    {
260
        return $this->setProperty('potentialAction', $potentialAction);
261
    }
262
263
    /**
264
     * The product or service this support contact point is related to (such as
265
     * product support for a particular product line). This can be a specific
266
     * product or product line (e.g. "iPhone") or a general category of products
267
     * or services (e.g. "smartphones").
268
     *
269
     * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|string|string[] $productSupported
270
     *
271
     * @return static
272
     *
273
     * @see http://schema.org/productSupported
274
     */
275
    public function productSupported($productSupported)
276
    {
277
        return $this->setProperty('productSupported', $productSupported);
278
    }
279
280
    /**
281
     * URL of a reference Web page that unambiguously indicates the item's
282
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
283
     * official website.
284
     *
285
     * @param string|string[] $sameAs
286
     *
287
     * @return static
288
     *
289
     * @see http://schema.org/sameAs
290
     */
291
    public function sameAs($sameAs)
292
    {
293
        return $this->setProperty('sameAs', $sameAs);
294
    }
295
296
    /**
297
     * The geographic area where the service is provided.
298
     *
299
     * @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[] $serviceArea
300
     *
301
     * @return static
302
     *
303
     * @see http://schema.org/serviceArea
304
     */
305
    public function serviceArea($serviceArea)
306
    {
307
        return $this->setProperty('serviceArea', $serviceArea);
308
    }
309
310
    /**
311
     * A CreativeWork or Event about this Thing.
312
     *
313
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
314
     *
315
     * @return static
316
     *
317
     * @see http://schema.org/subjectOf
318
     */
319
    public function subjectOf($subjectOf)
320
    {
321
        return $this->setProperty('subjectOf', $subjectOf);
322
    }
323
324
    /**
325
     * The telephone number.
326
     *
327
     * @param string|string[] $telephone
328
     *
329
     * @return static
330
     *
331
     * @see http://schema.org/telephone
332
     */
333
    public function telephone($telephone)
334
    {
335
        return $this->setProperty('telephone', $telephone);
336
    }
337
338
    /**
339
     * URL of the item.
340
     *
341
     * @param string|string[] $url
342
     *
343
     * @return static
344
     *
345
     * @see http://schema.org/url
346
     */
347
    public function url($url)
348
    {
349
        return $this->setProperty('url', $url);
350
    }
351
352
}
353

src/ControlAction.php 1 location

@@ 15-382 (lines=368) @@
12
 * @see http://schema.org/ControlAction
13
 *
14
 */
15
class ControlAction extends BaseType implements ControlActionContract, 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 description of the item.
81
     *
82
     * @param string|string[] $description
83
     *
84
     * @return static
85
     *
86
     * @see http://schema.org/description
87
     */
88
    public function description($description)
89
    {
90
        return $this->setProperty('description', $description);
91
    }
92
93
    /**
94
     * A sub property of description. A short description of the item used to
95
     * disambiguate from other, similar items. Information from other properties
96
     * (in particular, name) may be necessary for the description to be useful
97
     * for disambiguation.
98
     *
99
     * @param string|string[] $disambiguatingDescription
100
     *
101
     * @return static
102
     *
103
     * @see http://schema.org/disambiguatingDescription
104
     */
105
    public function disambiguatingDescription($disambiguatingDescription)
106
    {
107
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
108
    }
109
110
    /**
111
     * The endTime of something. For a reserved event or service (e.g.
112
     * FoodEstablishmentReservation), the time that it is expected to end. For
113
     * actions that span a period of time, when the action was performed. e.g.
114
     * John wrote a book from January to *December*. For media, including audio
115
     * and video, it's the time offset of the end of a clip within a larger
116
     * file.
117
     * 
118
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
119
     * when describing dates with times. This situation may be clarified in
120
     * future revisions.
121
     *
122
     * @param \DateTimeInterface|\DateTimeInterface[] $endTime
123
     *
124
     * @return static
125
     *
126
     * @see http://schema.org/endTime
127
     */
128
    public function endTime($endTime)
129
    {
130
        return $this->setProperty('endTime', $endTime);
131
    }
132
133
    /**
134
     * For failed actions, more information on the cause of the failure.
135
     *
136
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error
137
     *
138
     * @return static
139
     *
140
     * @see http://schema.org/error
141
     */
142
    public function error($error)
143
    {
144
        return $this->setProperty('error', $error);
145
    }
146
147
    /**
148
     * The identifier property represents any kind of identifier for any kind of
149
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
150
     * dedicated properties for representing many of these, either as textual
151
     * strings or as URL (URI) links. See [background
152
     * notes](/docs/datamodel.html#identifierBg) for more details.
153
     *
154
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
155
     *
156
     * @return static
157
     *
158
     * @see http://schema.org/identifier
159
     */
160
    public function identifier($identifier)
161
    {
162
        return $this->setProperty('identifier', $identifier);
163
    }
164
165
    /**
166
     * An image of the item. This can be a [[URL]] or a fully described
167
     * [[ImageObject]].
168
     *
169
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/image
174
     */
175
    public function image($image)
176
    {
177
        return $this->setProperty('image', $image);
178
    }
179
180
    /**
181
     * The object that helped the agent perform the action. e.g. John wrote a
182
     * book with *a pen*.
183
     *
184
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
185
     *
186
     * @return static
187
     *
188
     * @see http://schema.org/instrument
189
     */
190
    public function instrument($instrument)
191
    {
192
        return $this->setProperty('instrument', $instrument);
193
    }
194
195
    /**
196
     * The location of for example where the event is happening, an organization
197
     * is located, or where an action takes place.
198
     *
199
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
200
     *
201
     * @return static
202
     *
203
     * @see http://schema.org/location
204
     */
205
    public function location($location)
206
    {
207
        return $this->setProperty('location', $location);
208
    }
209
210
    /**
211
     * Indicates a page (or other CreativeWork) for which this thing is the main
212
     * entity being described. See [background
213
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
214
     *
215
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
216
     *
217
     * @return static
218
     *
219
     * @see http://schema.org/mainEntityOfPage
220
     */
221
    public function mainEntityOfPage($mainEntityOfPage)
222
    {
223
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
224
    }
225
226
    /**
227
     * The name of the item.
228
     *
229
     * @param string|string[] $name
230
     *
231
     * @return static
232
     *
233
     * @see http://schema.org/name
234
     */
235
    public function name($name)
236
    {
237
        return $this->setProperty('name', $name);
238
    }
239
240
    /**
241
     * The object upon which the action is carried out, whose state is kept
242
     * intact or changed. Also known as the semantic roles patient, affected or
243
     * undergoer (which change their state) or theme (which doesn't). e.g. John
244
     * read *a book*.
245
     *
246
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/object
251
     */
252
    public function object($object)
253
    {
254
        return $this->setProperty('object', $object);
255
    }
256
257
    /**
258
     * Other co-agents that participated in the action indirectly. e.g. John
259
     * wrote a book with *Steve*.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/participant
266
     */
267
    public function participant($participant)
268
    {
269
        return $this->setProperty('participant', $participant);
270
    }
271
272
    /**
273
     * Indicates a potential Action, which describes an idealized action in
274
     * which this thing would play an 'object' role.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/potentialAction
281
     */
282
    public function potentialAction($potentialAction)
283
    {
284
        return $this->setProperty('potentialAction', $potentialAction);
285
    }
286
287
    /**
288
     * The result produced in the action. e.g. John wrote *a book*.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/result
295
     */
296
    public function result($result)
297
    {
298
        return $this->setProperty('result', $result);
299
    }
300
301
    /**
302
     * URL of a reference Web page that unambiguously indicates the item's
303
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
304
     * official website.
305
     *
306
     * @param string|string[] $sameAs
307
     *
308
     * @return static
309
     *
310
     * @see http://schema.org/sameAs
311
     */
312
    public function sameAs($sameAs)
313
    {
314
        return $this->setProperty('sameAs', $sameAs);
315
    }
316
317
    /**
318
     * The startTime of something. For a reserved event or service (e.g.
319
     * FoodEstablishmentReservation), the time that it is expected to start. For
320
     * actions that span a period of time, when the action was performed. e.g.
321
     * John wrote a book from *January* to December. For media, including audio
322
     * and video, it's the time offset of the start of a clip within a larger
323
     * file.
324
     * 
325
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
326
     * when describing dates with times. This situation may be clarified in
327
     * future revisions.
328
     *
329
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/startTime
334
     */
335
    public function startTime($startTime)
336
    {
337
        return $this->setProperty('startTime', $startTime);
338
    }
339
340
    /**
341
     * A CreativeWork or Event about this Thing.
342
     *
343
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/subjectOf
348
     */
349
    public function subjectOf($subjectOf)
350
    {
351
        return $this->setProperty('subjectOf', $subjectOf);
352
    }
353
354
    /**
355
     * Indicates a target EntryPoint for an Action.
356
     *
357
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
358
     *
359
     * @return static
360
     *
361
     * @see http://schema.org/target
362
     */
363
    public function target($target)
364
    {
365
        return $this->setProperty('target', $target);
366
    }
367
368
    /**
369
     * URL of the item.
370
     *
371
     * @param string|string[] $url
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/url
376
     */
377
    public function url($url)
378
    {
379
        return $this->setProperty('url', $url);
380
    }
381
382
}
383

src/CreateAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/CreateAction
14
 *
15
 */
16
class CreateAction extends BaseType implements CreateActionContract, 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

src/DeactivateAction.php 1 location

@@ 17-384 (lines=368) @@
14
 * @see http://schema.org/DeactivateAction
15
 *
16
 */
17
class DeactivateAction extends BaseType implements DeactivateActionContract, ActionContract, ControlActionContract, 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 startTime of something. For a reserved event or service (e.g.
321
     * FoodEstablishmentReservation), the time that it is expected to start. For
322
     * actions that span a period of time, when the action was performed. e.g.
323
     * John wrote a book from *January* to December. For media, including audio
324
     * and video, it's the time offset of the start of a clip within a larger
325
     * file.
326
     * 
327
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
328
     * when describing dates with times. This situation may be clarified in
329
     * future revisions.
330
     *
331
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/startTime
336
     */
337
    public function startTime($startTime)
338
    {
339
        return $this->setProperty('startTime', $startTime);
340
    }
341
342
    /**
343
     * A CreativeWork or Event about this Thing.
344
     *
345
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
346
     *
347
     * @return static
348
     *
349
     * @see http://schema.org/subjectOf
350
     */
351
    public function subjectOf($subjectOf)
352
    {
353
        return $this->setProperty('subjectOf', $subjectOf);
354
    }
355
356
    /**
357
     * Indicates a target EntryPoint for an Action.
358
     *
359
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
360
     *
361
     * @return static
362
     *
363
     * @see http://schema.org/target
364
     */
365
    public function target($target)
366
    {
367
        return $this->setProperty('target', $target);
368
    }
369
370
    /**
371
     * URL of the item.
372
     *
373
     * @param string|string[] $url
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/url
378
     */
379
    public function url($url)
380
    {
381
        return $this->setProperty('url', $url);
382
    }
383
384
}
385

src/DiscoverAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/DiscoverAction
14
 *
15
 */
16
class DiscoverAction extends BaseType implements DiscoverActionContract, ActionContract, FindActionContract, 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

src/DrawAction.php 1 location

@@ 17-384 (lines=368) @@
14
 * @see http://schema.org/DrawAction
15
 *
16
 */
17
class DrawAction extends BaseType implements DrawActionContract, ActionContract, CreateActionContract, 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 startTime of something. For a reserved event or service (e.g.
321
     * FoodEstablishmentReservation), the time that it is expected to start. For
322
     * actions that span a period of time, when the action was performed. e.g.
323
     * John wrote a book from *January* to December. For media, including audio
324
     * and video, it's the time offset of the start of a clip within a larger
325
     * file.
326
     * 
327
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
328
     * when describing dates with times. This situation may be clarified in
329
     * future revisions.
330
     *
331
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/startTime
336
     */
337
    public function startTime($startTime)
338
    {
339
        return $this->setProperty('startTime', $startTime);
340
    }
341
342
    /**
343
     * A CreativeWork or Event about this Thing.
344
     *
345
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
346
     *
347
     * @return static
348
     *
349
     * @see http://schema.org/subjectOf
350
     */
351
    public function subjectOf($subjectOf)
352
    {
353
        return $this->setProperty('subjectOf', $subjectOf);
354
    }
355
356
    /**
357
     * Indicates a target EntryPoint for an Action.
358
     *
359
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
360
     *
361
     * @return static
362
     *
363
     * @see http://schema.org/target
364
     */
365
    public function target($target)
366
    {
367
        return $this->setProperty('target', $target);
368
    }
369
370
    /**
371
     * URL of the item.
372
     *
373
     * @param string|string[] $url
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/url
378
     */
379
    public function url($url)
380
    {
381
        return $this->setProperty('url', $url);
382
    }
383
384
}
385

src/FilmAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/FilmAction
14
 *
15
 */
16
class FilmAction extends BaseType implements FilmActionContract, 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 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

src/FindAction.php 1 location

@@ 20-387 (lines=368) @@
17
 * @see http://schema.org/FindAction
18
 *
19
 */
20
class FindAction extends BaseType implements FindActionContract, 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
     * The result produced in the action. e.g. John wrote *a book*.
294
     *
295
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
296
     *
297
     * @return static
298
     *
299
     * @see http://schema.org/result
300
     */
301
    public function result($result)
302
    {
303
        return $this->setProperty('result', $result);
304
    }
305
306
    /**
307
     * URL of a reference Web page that unambiguously indicates the item's
308
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
309
     * official website.
310
     *
311
     * @param string|string[] $sameAs
312
     *
313
     * @return static
314
     *
315
     * @see http://schema.org/sameAs
316
     */
317
    public function sameAs($sameAs)
318
    {
319
        return $this->setProperty('sameAs', $sameAs);
320
    }
321
322
    /**
323
     * The startTime of something. For a reserved event or service (e.g.
324
     * FoodEstablishmentReservation), the time that it is expected to start. For
325
     * actions that span a period of time, when the action was performed. e.g.
326
     * John wrote a book from *January* to December. For media, including audio
327
     * and video, it's the time offset of the start of a clip within a larger
328
     * file.
329
     * 
330
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
331
     * when describing dates with times. This situation may be clarified in
332
     * future revisions.
333
     *
334
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
335
     *
336
     * @return static
337
     *
338
     * @see http://schema.org/startTime
339
     */
340
    public function startTime($startTime)
341
    {
342
        return $this->setProperty('startTime', $startTime);
343
    }
344
345
    /**
346
     * A CreativeWork or Event about this Thing.
347
     *
348
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
349
     *
350
     * @return static
351
     *
352
     * @see http://schema.org/subjectOf
353
     */
354
    public function subjectOf($subjectOf)
355
    {
356
        return $this->setProperty('subjectOf', $subjectOf);
357
    }
358
359
    /**
360
     * Indicates a target EntryPoint for an Action.
361
     *
362
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
363
     *
364
     * @return static
365
     *
366
     * @see http://schema.org/target
367
     */
368
    public function target($target)
369
    {
370
        return $this->setProperty('target', $target);
371
    }
372
373
    /**
374
     * URL of the item.
375
     *
376
     * @param string|string[] $url
377
     *
378
     * @return static
379
     *
380
     * @see http://schema.org/url
381
     */
382
    public function url($url)
383
    {
384
        return $this->setProperty('url', $url);
385
    }
386
387
}
388

src/GeoCircle.php 1 location

@@ 22-363 (lines=342) @@
19
 * @see http://schema.org/GeoCircle
20
 *
21
 */
22
class GeoCircle extends BaseType implements GeoCircleContract, GeoShapeContract, IntangibleContract, StructuredValueContract, ThingContract
23
{
24
    /**
25
     * An additional type for the item, typically used for adding more specific
26
     * types from external vocabularies in microdata syntax. This is a
27
     * relationship between something and a class that the thing is in. In RDFa
28
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
29
     * attribute - for multiple types. Schema.org tools may have only weaker
30
     * understanding of extra types, in particular those defined externally.
31
     *
32
     * @param string|string[] $additionalType
33
     *
34
     * @return static
35
     *
36
     * @see http://schema.org/additionalType
37
     */
38
    public function additionalType($additionalType)
39
    {
40
        return $this->setProperty('additionalType', $additionalType);
41
    }
42
43
    /**
44
     * Physical address of the item.
45
     *
46
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
47
     *
48
     * @return static
49
     *
50
     * @see http://schema.org/address
51
     */
52
    public function address($address)
53
    {
54
        return $this->setProperty('address', $address);
55
    }
56
57
    /**
58
     * The country. For example, USA. You can also provide the two-letter [ISO
59
     * 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1).
60
     *
61
     * @param \Spatie\SchemaOrg\Contracts\CountryContract|\Spatie\SchemaOrg\Contracts\CountryContract[]|string|string[] $addressCountry
62
     *
63
     * @return static
64
     *
65
     * @see http://schema.org/addressCountry
66
     */
67
    public function addressCountry($addressCountry)
68
    {
69
        return $this->setProperty('addressCountry', $addressCountry);
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 box is the area enclosed by the rectangle formed by two points. The
88
     * first point is the lower corner, the second point is the upper corner. A
89
     * box is expressed as two points separated by a space character.
90
     *
91
     * @param string|string[] $box
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/box
96
     */
97
    public function box($box)
98
    {
99
        return $this->setProperty('box', $box);
100
    }
101
102
    /**
103
     * A circle is the circular region of a specified radius centered at a
104
     * specified latitude and longitude. A circle is expressed as a pair
105
     * followed by a radius in meters.
106
     *
107
     * @param string|string[] $circle
108
     *
109
     * @return static
110
     *
111
     * @see http://schema.org/circle
112
     */
113
    public function circle($circle)
114
    {
115
        return $this->setProperty('circle', $circle);
116
    }
117
118
    /**
119
     * A description of the item.
120
     *
121
     * @param string|string[] $description
122
     *
123
     * @return static
124
     *
125
     * @see http://schema.org/description
126
     */
127
    public function description($description)
128
    {
129
        return $this->setProperty('description', $description);
130
    }
131
132
    /**
133
     * A sub property of description. A short description of the item used to
134
     * disambiguate from other, similar items. Information from other properties
135
     * (in particular, name) may be necessary for the description to be useful
136
     * for disambiguation.
137
     *
138
     * @param string|string[] $disambiguatingDescription
139
     *
140
     * @return static
141
     *
142
     * @see http://schema.org/disambiguatingDescription
143
     */
144
    public function disambiguatingDescription($disambiguatingDescription)
145
    {
146
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
147
    }
148
149
    /**
150
     * The elevation of a location ([WGS
151
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be
152
     * of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft')
153
     * while numbers alone should be assumed to be a value in meters.
154
     *
155
     * @param float|float[]|int|int[]|string|string[] $elevation
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/elevation
160
     */
161
    public function elevation($elevation)
162
    {
163
        return $this->setProperty('elevation', $elevation);
164
    }
165
166
    /**
167
     * Indicates the GeoCoordinates at the centre of a GeoShape e.g. GeoCircle.
168
     *
169
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[] $geoMidpoint
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/geoMidpoint
174
     */
175
    public function geoMidpoint($geoMidpoint)
176
    {
177
        return $this->setProperty('geoMidpoint', $geoMidpoint);
178
    }
179
180
    /**
181
     * Indicates the approximate radius of a GeoCircle (metres unless indicated
182
     * otherwise via Distance notation).
183
     *
184
     * @param \Spatie\SchemaOrg\Contracts\DistanceContract|\Spatie\SchemaOrg\Contracts\DistanceContract[]|float|float[]|int|int[]|string|string[] $geoRadius
185
     *
186
     * @return static
187
     *
188
     * @see http://schema.org/geoRadius
189
     */
190
    public function geoRadius($geoRadius)
191
    {
192
        return $this->setProperty('geoRadius', $geoRadius);
193
    }
194
195
    /**
196
     * The identifier property represents any kind of identifier for any kind of
197
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
198
     * dedicated properties for representing many of these, either as textual
199
     * strings or as URL (URI) links. See [background
200
     * notes](/docs/datamodel.html#identifierBg) for more details.
201
     *
202
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
203
     *
204
     * @return static
205
     *
206
     * @see http://schema.org/identifier
207
     */
208
    public function identifier($identifier)
209
    {
210
        return $this->setProperty('identifier', $identifier);
211
    }
212
213
    /**
214
     * An image of the item. This can be a [[URL]] or a fully described
215
     * [[ImageObject]].
216
     *
217
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
218
     *
219
     * @return static
220
     *
221
     * @see http://schema.org/image
222
     */
223
    public function image($image)
224
    {
225
        return $this->setProperty('image', $image);
226
    }
227
228
    /**
229
     * A line is a point-to-point path consisting of two or more points. A line
230
     * is expressed as a series of two or more point objects separated by space.
231
     *
232
     * @param string|string[] $line
233
     *
234
     * @return static
235
     *
236
     * @see http://schema.org/line
237
     */
238
    public function line($line)
239
    {
240
        return $this->setProperty('line', $line);
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
     * A polygon is the area enclosed by a point-to-point path for which the
275
     * starting and ending points are the same. A polygon is expressed as a
276
     * series of four or more space delimited points where the first and final
277
     * points are identical.
278
     *
279
     * @param string|string[] $polygon
280
     *
281
     * @return static
282
     *
283
     * @see http://schema.org/polygon
284
     */
285
    public function polygon($polygon)
286
    {
287
        return $this->setProperty('polygon', $polygon);
288
    }
289
290
    /**
291
     * The postal code. For example, 94043.
292
     *
293
     * @param string|string[] $postalCode
294
     *
295
     * @return static
296
     *
297
     * @see http://schema.org/postalCode
298
     */
299
    public function postalCode($postalCode)
300
    {
301
        return $this->setProperty('postalCode', $postalCode);
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
     * URL of a reference Web page that unambiguously indicates the item's
321
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
322
     * official website.
323
     *
324
     * @param string|string[] $sameAs
325
     *
326
     * @return static
327
     *
328
     * @see http://schema.org/sameAs
329
     */
330
    public function sameAs($sameAs)
331
    {
332
        return $this->setProperty('sameAs', $sameAs);
333
    }
334
335
    /**
336
     * A CreativeWork or Event about this Thing.
337
     *
338
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
339
     *
340
     * @return static
341
     *
342
     * @see http://schema.org/subjectOf
343
     */
344
    public function subjectOf($subjectOf)
345
    {
346
        return $this->setProperty('subjectOf', $subjectOf);
347
    }
348
349
    /**
350
     * URL of the item.
351
     *
352
     * @param string|string[] $url
353
     *
354
     * @return static
355
     *
356
     * @see http://schema.org/url
357
     */
358
    public function url($url)
359
    {
360
        return $this->setProperty('url', $url);
361
    }
362
363
}
364

src/GeoShape.php 1 location

@@ 19-345 (lines=327) @@
16
 * @see http://schema.org/GeoShape
17
 *
18
 */
19
class GeoShape extends BaseType implements GeoShapeContract, IntangibleContract, StructuredValueContract, ThingContract
20
{
21
    /**
22
     * An additional type for the item, typically used for adding more specific
23
     * types from external vocabularies in microdata syntax. This is a
24
     * relationship between something and a class that the thing is in. In RDFa
25
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
26
     * attribute - for multiple types. Schema.org tools may have only weaker
27
     * understanding of extra types, in particular those defined externally.
28
     *
29
     * @param string|string[] $additionalType
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalType
34
     */
35
    public function additionalType($additionalType)
36
    {
37
        return $this->setProperty('additionalType', $additionalType);
38
    }
39
40
    /**
41
     * Physical address of the item.
42
     *
43
     * @param \Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $address
44
     *
45
     * @return static
46
     *
47
     * @see http://schema.org/address
48
     */
49
    public function address($address)
50
    {
51
        return $this->setProperty('address', $address);
52
    }
53
54
    /**
55
     * The country. For example, USA. You can also provide the two-letter [ISO
56
     * 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1).
57
     *
58
     * @param \Spatie\SchemaOrg\Contracts\CountryContract|\Spatie\SchemaOrg\Contracts\CountryContract[]|string|string[] $addressCountry
59
     *
60
     * @return static
61
     *
62
     * @see http://schema.org/addressCountry
63
     */
64
    public function addressCountry($addressCountry)
65
    {
66
        return $this->setProperty('addressCountry', $addressCountry);
67
    }
68
69
    /**
70
     * An alias for the item.
71
     *
72
     * @param string|string[] $alternateName
73
     *
74
     * @return static
75
     *
76
     * @see http://schema.org/alternateName
77
     */
78
    public function alternateName($alternateName)
79
    {
80
        return $this->setProperty('alternateName', $alternateName);
81
    }
82
83
    /**
84
     * A box is the area enclosed by the rectangle formed by two points. The
85
     * first point is the lower corner, the second point is the upper corner. A
86
     * box is expressed as two points separated by a space character.
87
     *
88
     * @param string|string[] $box
89
     *
90
     * @return static
91
     *
92
     * @see http://schema.org/box
93
     */
94
    public function box($box)
95
    {
96
        return $this->setProperty('box', $box);
97
    }
98
99
    /**
100
     * A circle is the circular region of a specified radius centered at a
101
     * specified latitude and longitude. A circle is expressed as a pair
102
     * followed by a radius in meters.
103
     *
104
     * @param string|string[] $circle
105
     *
106
     * @return static
107
     *
108
     * @see http://schema.org/circle
109
     */
110
    public function circle($circle)
111
    {
112
        return $this->setProperty('circle', $circle);
113
    }
114
115
    /**
116
     * A description of the item.
117
     *
118
     * @param string|string[] $description
119
     *
120
     * @return static
121
     *
122
     * @see http://schema.org/description
123
     */
124
    public function description($description)
125
    {
126
        return $this->setProperty('description', $description);
127
    }
128
129
    /**
130
     * A sub property of description. A short description of the item used to
131
     * disambiguate from other, similar items. Information from other properties
132
     * (in particular, name) may be necessary for the description to be useful
133
     * for disambiguation.
134
     *
135
     * @param string|string[] $disambiguatingDescription
136
     *
137
     * @return static
138
     *
139
     * @see http://schema.org/disambiguatingDescription
140
     */
141
    public function disambiguatingDescription($disambiguatingDescription)
142
    {
143
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
144
    }
145
146
    /**
147
     * The elevation of a location ([WGS
148
     * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be
149
     * of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft')
150
     * while numbers alone should be assumed to be a value in meters.
151
     *
152
     * @param float|float[]|int|int[]|string|string[] $elevation
153
     *
154
     * @return static
155
     *
156
     * @see http://schema.org/elevation
157
     */
158
    public function elevation($elevation)
159
    {
160
        return $this->setProperty('elevation', $elevation);
161
    }
162
163
    /**
164
     * Indicates the GeoCoordinates at the centre of a GeoShape e.g. GeoCircle.
165
     *
166
     * @param \Spatie\SchemaOrg\Contracts\GeoCoordinatesContract|\Spatie\SchemaOrg\Contracts\GeoCoordinatesContract[] $geoMidpoint
167
     *
168
     * @return static
169
     *
170
     * @see http://schema.org/geoMidpoint
171
     */
172
    public function geoMidpoint($geoMidpoint)
173
    {
174
        return $this->setProperty('geoMidpoint', $geoMidpoint);
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
     * A line is a point-to-point path consisting of two or more points. A line
212
     * is expressed as a series of two or more point objects separated by space.
213
     *
214
     * @param string|string[] $line
215
     *
216
     * @return static
217
     *
218
     * @see http://schema.org/line
219
     */
220
    public function line($line)
221
    {
222
        return $this->setProperty('line', $line);
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
     * A polygon is the area enclosed by a point-to-point path for which the
257
     * starting and ending points are the same. A polygon is expressed as a
258
     * series of four or more space delimited points where the first and final
259
     * points are identical.
260
     *
261
     * @param string|string[] $polygon
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/polygon
266
     */
267
    public function polygon($polygon)
268
    {
269
        return $this->setProperty('polygon', $polygon);
270
    }
271
272
    /**
273
     * The postal code. For example, 94043.
274
     *
275
     * @param string|string[] $postalCode
276
     *
277
     * @return static
278
     *
279
     * @see http://schema.org/postalCode
280
     */
281
    public function postalCode($postalCode)
282
    {
283
        return $this->setProperty('postalCode', $postalCode);
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
     * URL of a reference Web page that unambiguously indicates the item's
303
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
304
     * official website.
305
     *
306
     * @param string|string[] $sameAs
307
     *
308
     * @return static
309
     *
310
     * @see http://schema.org/sameAs
311
     */
312
    public function sameAs($sameAs)
313
    {
314
        return $this->setProperty('sameAs', $sameAs);
315
    }
316
317
    /**
318
     * A CreativeWork or Event about this Thing.
319
     *
320
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
321
     *
322
     * @return static
323
     *
324
     * @see http://schema.org/subjectOf
325
     */
326
    public function subjectOf($subjectOf)
327
    {
328
        return $this->setProperty('subjectOf', $subjectOf);
329
    }
330
331
    /**
332
     * URL of the item.
333
     *
334
     * @param string|string[] $url
335
     *
336
     * @return static
337
     *
338
     * @see http://schema.org/url
339
     */
340
    public function url($url)
341
    {
342
        return $this->setProperty('url', $url);
343
    }
344
345
}
346

src/IgnoreAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/IgnoreAction
14
 *
15
 */
16
class IgnoreAction extends BaseType implements IgnoreActionContract, ActionContract, AssessActionContract, 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

src/InteractAction.php 1 location

@@ 15-382 (lines=368) @@
12
 * @see http://schema.org/InteractAction
13
 *
14
 */
15
class InteractAction extends BaseType implements InteractActionContract, 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 description of the item.
81
     *
82
     * @param string|string[] $description
83
     *
84
     * @return static
85
     *
86
     * @see http://schema.org/description
87
     */
88
    public function description($description)
89
    {
90
        return $this->setProperty('description', $description);
91
    }
92
93
    /**
94
     * A sub property of description. A short description of the item used to
95
     * disambiguate from other, similar items. Information from other properties
96
     * (in particular, name) may be necessary for the description to be useful
97
     * for disambiguation.
98
     *
99
     * @param string|string[] $disambiguatingDescription
100
     *
101
     * @return static
102
     *
103
     * @see http://schema.org/disambiguatingDescription
104
     */
105
    public function disambiguatingDescription($disambiguatingDescription)
106
    {
107
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
108
    }
109
110
    /**
111
     * The endTime of something. For a reserved event or service (e.g.
112
     * FoodEstablishmentReservation), the time that it is expected to end. For
113
     * actions that span a period of time, when the action was performed. e.g.
114
     * John wrote a book from January to *December*. For media, including audio
115
     * and video, it's the time offset of the end of a clip within a larger
116
     * file.
117
     * 
118
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
119
     * when describing dates with times. This situation may be clarified in
120
     * future revisions.
121
     *
122
     * @param \DateTimeInterface|\DateTimeInterface[] $endTime
123
     *
124
     * @return static
125
     *
126
     * @see http://schema.org/endTime
127
     */
128
    public function endTime($endTime)
129
    {
130
        return $this->setProperty('endTime', $endTime);
131
    }
132
133
    /**
134
     * For failed actions, more information on the cause of the failure.
135
     *
136
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error
137
     *
138
     * @return static
139
     *
140
     * @see http://schema.org/error
141
     */
142
    public function error($error)
143
    {
144
        return $this->setProperty('error', $error);
145
    }
146
147
    /**
148
     * The identifier property represents any kind of identifier for any kind of
149
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
150
     * dedicated properties for representing many of these, either as textual
151
     * strings or as URL (URI) links. See [background
152
     * notes](/docs/datamodel.html#identifierBg) for more details.
153
     *
154
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
155
     *
156
     * @return static
157
     *
158
     * @see http://schema.org/identifier
159
     */
160
    public function identifier($identifier)
161
    {
162
        return $this->setProperty('identifier', $identifier);
163
    }
164
165
    /**
166
     * An image of the item. This can be a [[URL]] or a fully described
167
     * [[ImageObject]].
168
     *
169
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/image
174
     */
175
    public function image($image)
176
    {
177
        return $this->setProperty('image', $image);
178
    }
179
180
    /**
181
     * The object that helped the agent perform the action. e.g. John wrote a
182
     * book with *a pen*.
183
     *
184
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
185
     *
186
     * @return static
187
     *
188
     * @see http://schema.org/instrument
189
     */
190
    public function instrument($instrument)
191
    {
192
        return $this->setProperty('instrument', $instrument);
193
    }
194
195
    /**
196
     * The location of for example where the event is happening, an organization
197
     * is located, or where an action takes place.
198
     *
199
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
200
     *
201
     * @return static
202
     *
203
     * @see http://schema.org/location
204
     */
205
    public function location($location)
206
    {
207
        return $this->setProperty('location', $location);
208
    }
209
210
    /**
211
     * Indicates a page (or other CreativeWork) for which this thing is the main
212
     * entity being described. See [background
213
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
214
     *
215
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
216
     *
217
     * @return static
218
     *
219
     * @see http://schema.org/mainEntityOfPage
220
     */
221
    public function mainEntityOfPage($mainEntityOfPage)
222
    {
223
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
224
    }
225
226
    /**
227
     * The name of the item.
228
     *
229
     * @param string|string[] $name
230
     *
231
     * @return static
232
     *
233
     * @see http://schema.org/name
234
     */
235
    public function name($name)
236
    {
237
        return $this->setProperty('name', $name);
238
    }
239
240
    /**
241
     * The object upon which the action is carried out, whose state is kept
242
     * intact or changed. Also known as the semantic roles patient, affected or
243
     * undergoer (which change their state) or theme (which doesn't). e.g. John
244
     * read *a book*.
245
     *
246
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
247
     *
248
     * @return static
249
     *
250
     * @see http://schema.org/object
251
     */
252
    public function object($object)
253
    {
254
        return $this->setProperty('object', $object);
255
    }
256
257
    /**
258
     * Other co-agents that participated in the action indirectly. e.g. John
259
     * wrote a book with *Steve*.
260
     *
261
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
262
     *
263
     * @return static
264
     *
265
     * @see http://schema.org/participant
266
     */
267
    public function participant($participant)
268
    {
269
        return $this->setProperty('participant', $participant);
270
    }
271
272
    /**
273
     * Indicates a potential Action, which describes an idealized action in
274
     * which this thing would play an 'object' role.
275
     *
276
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
277
     *
278
     * @return static
279
     *
280
     * @see http://schema.org/potentialAction
281
     */
282
    public function potentialAction($potentialAction)
283
    {
284
        return $this->setProperty('potentialAction', $potentialAction);
285
    }
286
287
    /**
288
     * The result produced in the action. e.g. John wrote *a book*.
289
     *
290
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
291
     *
292
     * @return static
293
     *
294
     * @see http://schema.org/result
295
     */
296
    public function result($result)
297
    {
298
        return $this->setProperty('result', $result);
299
    }
300
301
    /**
302
     * URL of a reference Web page that unambiguously indicates the item's
303
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
304
     * official website.
305
     *
306
     * @param string|string[] $sameAs
307
     *
308
     * @return static
309
     *
310
     * @see http://schema.org/sameAs
311
     */
312
    public function sameAs($sameAs)
313
    {
314
        return $this->setProperty('sameAs', $sameAs);
315
    }
316
317
    /**
318
     * The startTime of something. For a reserved event or service (e.g.
319
     * FoodEstablishmentReservation), the time that it is expected to start. For
320
     * actions that span a period of time, when the action was performed. e.g.
321
     * John wrote a book from *January* to December. For media, including audio
322
     * and video, it's the time offset of the start of a clip within a larger
323
     * file.
324
     * 
325
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
326
     * when describing dates with times. This situation may be clarified in
327
     * future revisions.
328
     *
329
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
330
     *
331
     * @return static
332
     *
333
     * @see http://schema.org/startTime
334
     */
335
    public function startTime($startTime)
336
    {
337
        return $this->setProperty('startTime', $startTime);
338
    }
339
340
    /**
341
     * A CreativeWork or Event about this Thing.
342
     *
343
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
344
     *
345
     * @return static
346
     *
347
     * @see http://schema.org/subjectOf
348
     */
349
    public function subjectOf($subjectOf)
350
    {
351
        return $this->setProperty('subjectOf', $subjectOf);
352
    }
353
354
    /**
355
     * Indicates a target EntryPoint for an Action.
356
     *
357
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
358
     *
359
     * @return static
360
     *
361
     * @see http://schema.org/target
362
     */
363
    public function target($target)
364
    {
365
        return $this->setProperty('target', $target);
366
    }
367
368
    /**
369
     * URL of the item.
370
     *
371
     * @param string|string[] $url
372
     *
373
     * @return static
374
     *
375
     * @see http://schema.org/url
376
     */
377
    public function url($url)
378
    {
379
        return $this->setProperty('url', $url);
380
    }
381
382
}
383

src/LocationFeatureSpecification.php 1 location

@@ 19-372 (lines=354) @@
16
 * @see http://schema.org/LocationFeatureSpecification
17
 *
18
 */
19
class LocationFeatureSpecification extends BaseType implements LocationFeatureSpecificationContract, IntangibleContract, PropertyValueContract, StructuredValueContract, ThingContract
20
{
21
    /**
22
     * An additional type for the item, typically used for adding more specific
23
     * types from external vocabularies in microdata syntax. This is a
24
     * relationship between something and a class that the thing is in. In RDFa
25
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
26
     * attribute - for multiple types. Schema.org tools may have only weaker
27
     * understanding of extra types, in particular those defined externally.
28
     *
29
     * @param string|string[] $additionalType
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalType
34
     */
35
    public function additionalType($additionalType)
36
    {
37
        return $this->setProperty('additionalType', $additionalType);
38
    }
39
40
    /**
41
     * An alias for the item.
42
     *
43
     * @param string|string[] $alternateName
44
     *
45
     * @return static
46
     *
47
     * @see http://schema.org/alternateName
48
     */
49
    public function alternateName($alternateName)
50
    {
51
        return $this->setProperty('alternateName', $alternateName);
52
    }
53
54
    /**
55
     * A description of the item.
56
     *
57
     * @param string|string[] $description
58
     *
59
     * @return static
60
     *
61
     * @see http://schema.org/description
62
     */
63
    public function description($description)
64
    {
65
        return $this->setProperty('description', $description);
66
    }
67
68
    /**
69
     * A sub property of description. A short description of the item used to
70
     * disambiguate from other, similar items. Information from other properties
71
     * (in particular, name) may be necessary for the description to be useful
72
     * for disambiguation.
73
     *
74
     * @param string|string[] $disambiguatingDescription
75
     *
76
     * @return static
77
     *
78
     * @see http://schema.org/disambiguatingDescription
79
     */
80
    public function disambiguatingDescription($disambiguatingDescription)
81
    {
82
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
83
    }
84
85
    /**
86
     * The hours during which this service or contact is available.
87
     *
88
     * @param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $hoursAvailable
89
     *
90
     * @return static
91
     *
92
     * @see http://schema.org/hoursAvailable
93
     */
94
    public function hoursAvailable($hoursAvailable)
95
    {
96
        return $this->setProperty('hoursAvailable', $hoursAvailable);
97
    }
98
99
    /**
100
     * The identifier property represents any kind of identifier for any kind of
101
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
102
     * dedicated properties for representing many of these, either as textual
103
     * strings or as URL (URI) links. See [background
104
     * notes](/docs/datamodel.html#identifierBg) for more details.
105
     *
106
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
107
     *
108
     * @return static
109
     *
110
     * @see http://schema.org/identifier
111
     */
112
    public function identifier($identifier)
113
    {
114
        return $this->setProperty('identifier', $identifier);
115
    }
116
117
    /**
118
     * An image of the item. This can be a [[URL]] or a fully described
119
     * [[ImageObject]].
120
     *
121
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
122
     *
123
     * @return static
124
     *
125
     * @see http://schema.org/image
126
     */
127
    public function image($image)
128
    {
129
        return $this->setProperty('image', $image);
130
    }
131
132
    /**
133
     * Indicates a page (or other CreativeWork) for which this thing is the main
134
     * entity being described. See [background
135
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
136
     *
137
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
138
     *
139
     * @return static
140
     *
141
     * @see http://schema.org/mainEntityOfPage
142
     */
143
    public function mainEntityOfPage($mainEntityOfPage)
144
    {
145
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
146
    }
147
148
    /**
149
     * The upper value of some characteristic or property.
150
     *
151
     * @param float|float[]|int|int[] $maxValue
152
     *
153
     * @return static
154
     *
155
     * @see http://schema.org/maxValue
156
     */
157
    public function maxValue($maxValue)
158
    {
159
        return $this->setProperty('maxValue', $maxValue);
160
    }
161
162
    /**
163
     * The lower value of some characteristic or property.
164
     *
165
     * @param float|float[]|int|int[] $minValue
166
     *
167
     * @return static
168
     *
169
     * @see http://schema.org/minValue
170
     */
171
    public function minValue($minValue)
172
    {
173
        return $this->setProperty('minValue', $minValue);
174
    }
175
176
    /**
177
     * The name of the item.
178
     *
179
     * @param string|string[] $name
180
     *
181
     * @return static
182
     *
183
     * @see http://schema.org/name
184
     */
185
    public function name($name)
186
    {
187
        return $this->setProperty('name', $name);
188
    }
189
190
    /**
191
     * Indicates a potential Action, which describes an idealized action in
192
     * which this thing would play an 'object' role.
193
     *
194
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
195
     *
196
     * @return static
197
     *
198
     * @see http://schema.org/potentialAction
199
     */
200
    public function potentialAction($potentialAction)
201
    {
202
        return $this->setProperty('potentialAction', $potentialAction);
203
    }
204
205
    /**
206
     * A commonly used identifier for the characteristic represented by the
207
     * property, e.g. a manufacturer or a standard code for a property.
208
     * propertyID can be
209
     * (1) a prefixed string, mainly meant to be used with standards for product
210
     * properties; (2) a site-specific, non-prefixed string (e.g. the primary
211
     * key of the property or the vendor-specific id of the property), or (3)
212
     * a URL indicating the type of the property, either pointing to an external
213
     * vocabulary, or a Web resource that describes the property (e.g. a
214
     * glossary entry).
215
     * Standards bodies should promote a standard prefix for the identifiers of
216
     * properties from their standards.
217
     *
218
     * @param string|string[] $propertyID
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/propertyID
223
     */
224
    public function propertyID($propertyID)
225
    {
226
        return $this->setProperty('propertyID', $propertyID);
227
    }
228
229
    /**
230
     * URL of a reference Web page that unambiguously indicates the item's
231
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
232
     * official website.
233
     *
234
     * @param string|string[] $sameAs
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/sameAs
239
     */
240
    public function sameAs($sameAs)
241
    {
242
        return $this->setProperty('sameAs', $sameAs);
243
    }
244
245
    /**
246
     * A CreativeWork or Event about this Thing.
247
     *
248
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
249
     *
250
     * @return static
251
     *
252
     * @see http://schema.org/subjectOf
253
     */
254
    public function subjectOf($subjectOf)
255
    {
256
        return $this->setProperty('subjectOf', $subjectOf);
257
    }
258
259
    /**
260
     * The unit of measurement given using the UN/CEFACT Common Code (3
261
     * characters) or a URL. Other codes than the UN/CEFACT Common Code may be
262
     * used with a prefix followed by a colon.
263
     *
264
     * @param string|string[] $unitCode
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/unitCode
269
     */
270
    public function unitCode($unitCode)
271
    {
272
        return $this->setProperty('unitCode', $unitCode);
273
    }
274
275
    /**
276
     * A string or text indicating the unit of measurement. Useful if you cannot
277
     * provide a standard unit code for
278
     * <a href='unitCode'>unitCode</a>.
279
     *
280
     * @param string|string[] $unitText
281
     *
282
     * @return static
283
     *
284
     * @see http://schema.org/unitText
285
     */
286
    public function unitText($unitText)
287
    {
288
        return $this->setProperty('unitText', $unitText);
289
    }
290
291
    /**
292
     * URL of the item.
293
     *
294
     * @param string|string[] $url
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/url
299
     */
300
    public function url($url)
301
    {
302
        return $this->setProperty('url', $url);
303
    }
304
305
    /**
306
     * The date when the item becomes valid.
307
     *
308
     * @param \DateTimeInterface|\DateTimeInterface[] $validFrom
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/validFrom
313
     */
314
    public function validFrom($validFrom)
315
    {
316
        return $this->setProperty('validFrom', $validFrom);
317
    }
318
319
    /**
320
     * The date after when the item is not valid. For example the end of an
321
     * offer, salary period, or a period of opening hours.
322
     *
323
     * @param \DateTimeInterface|\DateTimeInterface[] $validThrough
324
     *
325
     * @return static
326
     *
327
     * @see http://schema.org/validThrough
328
     */
329
    public function validThrough($validThrough)
330
    {
331
        return $this->setProperty('validThrough', $validThrough);
332
    }
333
334
    /**
335
     * The value of the quantitative value or property value node.
336
     * 
337
     * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type
338
     * for values is 'Number'.
339
     * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or
340
     * 'StructuredValue'.
341
     * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
342
     * NINE' (U+0039)) rather than superficially similiar Unicode symbols.
343
     * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
344
     * decimal point. Avoid using these symbols as a readability separator.
345
     *
346
     * @param \Spatie\SchemaOrg\Contracts\StructuredValueContract|\Spatie\SchemaOrg\Contracts\StructuredValueContract[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value
347
     *
348
     * @return static
349
     *
350
     * @see http://schema.org/value
351
     */
352
    public function value($value)
353
    {
354
        return $this->setProperty('value', $value);
355
    }
356
357
    /**
358
     * A pointer to a secondary value that provides additional information on
359
     * the original value, e.g. a reference temperature.
360
     *
361
     * @param \Spatie\SchemaOrg\Contracts\EnumerationContract|\Spatie\SchemaOrg\Contracts\EnumerationContract[]|\Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|\Spatie\SchemaOrg\Contracts\QualitativeValueContract|\Spatie\SchemaOrg\Contracts\QualitativeValueContract[]|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|\Spatie\SchemaOrg\Contracts\StructuredValueContract|\Spatie\SchemaOrg\Contracts\StructuredValueContract[] $valueReference
362
     *
363
     * @return static
364
     *
365
     * @see http://schema.org/valueReference
366
     */
367
    public function valueReference($valueReference)
368
    {
369
        return $this->setProperty('valueReference', $valueReference);
370
    }
371
372
}
373

src/MarryAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/MarryAction
14
 *
15
 */
16
class MarryAction extends BaseType implements MarryActionContract, ActionContract, InteractActionContract, 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

src/OrganizeAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/OrganizeAction
14
 *
15
 */
16
class OrganizeAction extends BaseType implements OrganizeActionContract, 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

src/PaintAction.php 1 location

@@ 17-384 (lines=368) @@
14
 * @see http://schema.org/PaintAction
15
 *
16
 */
17
class PaintAction extends BaseType implements PaintActionContract, ActionContract, CreateActionContract, 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 startTime of something. For a reserved event or service (e.g.
321
     * FoodEstablishmentReservation), the time that it is expected to start. For
322
     * actions that span a period of time, when the action was performed. e.g.
323
     * John wrote a book from *January* to December. For media, including audio
324
     * and video, it's the time offset of the start of a clip within a larger
325
     * file.
326
     * 
327
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
328
     * when describing dates with times. This situation may be clarified in
329
     * future revisions.
330
     *
331
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/startTime
336
     */
337
    public function startTime($startTime)
338
    {
339
        return $this->setProperty('startTime', $startTime);
340
    }
341
342
    /**
343
     * A CreativeWork or Event about this Thing.
344
     *
345
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
346
     *
347
     * @return static
348
     *
349
     * @see http://schema.org/subjectOf
350
     */
351
    public function subjectOf($subjectOf)
352
    {
353
        return $this->setProperty('subjectOf', $subjectOf);
354
    }
355
356
    /**
357
     * Indicates a target EntryPoint for an Action.
358
     *
359
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
360
     *
361
     * @return static
362
     *
363
     * @see http://schema.org/target
364
     */
365
    public function target($target)
366
    {
367
        return $this->setProperty('target', $target);
368
    }
369
370
    /**
371
     * URL of the item.
372
     *
373
     * @param string|string[] $url
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/url
378
     */
379
    public function url($url)
380
    {
381
        return $this->setProperty('url', $url);
382
    }
383
384
}
385

src/ParentAudience.php 1 location

@@ 18-347 (lines=330) @@
15
 * @see http://schema.org/ParentAudience
16
 *
17
 */
18
class ParentAudience extends BaseType implements ParentAudienceContract, AudienceContract, IntangibleContract, PeopleAudienceContract, ThingContract
19
{
20
    /**
21
     * An additional type for the item, typically used for adding more specific
22
     * types from external vocabularies in microdata syntax. This is a
23
     * relationship between something and a class that the thing is in. In RDFa
24
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
25
     * attribute - for multiple types. Schema.org tools may have only weaker
26
     * understanding of extra types, in particular those defined externally.
27
     *
28
     * @param string|string[] $additionalType
29
     *
30
     * @return static
31
     *
32
     * @see http://schema.org/additionalType
33
     */
34
    public function additionalType($additionalType)
35
    {
36
        return $this->setProperty('additionalType', $additionalType);
37
    }
38
39
    /**
40
     * An alias for the item.
41
     *
42
     * @param string|string[] $alternateName
43
     *
44
     * @return static
45
     *
46
     * @see http://schema.org/alternateName
47
     */
48
    public function alternateName($alternateName)
49
    {
50
        return $this->setProperty('alternateName', $alternateName);
51
    }
52
53
    /**
54
     * The target group associated with a given audience (e.g. veterans, car
55
     * owners, musicians, etc.).
56
     *
57
     * @param string|string[] $audienceType
58
     *
59
     * @return static
60
     *
61
     * @see http://schema.org/audienceType
62
     */
63
    public function audienceType($audienceType)
64
    {
65
        return $this->setProperty('audienceType', $audienceType);
66
    }
67
68
    /**
69
     * Maximal age of the child.
70
     *
71
     * @param float|float[]|int|int[] $childMaxAge
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/childMaxAge
76
     */
77
    public function childMaxAge($childMaxAge)
78
    {
79
        return $this->setProperty('childMaxAge', $childMaxAge);
80
    }
81
82
    /**
83
     * Minimal age of the child.
84
     *
85
     * @param float|float[]|int|int[] $childMinAge
86
     *
87
     * @return static
88
     *
89
     * @see http://schema.org/childMinAge
90
     */
91
    public function childMinAge($childMinAge)
92
    {
93
        return $this->setProperty('childMinAge', $childMinAge);
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 geographic area associated with the audience.
129
     *
130
     * @param \Spatie\SchemaOrg\Contracts\AdministrativeAreaContract|\Spatie\SchemaOrg\Contracts\AdministrativeAreaContract[] $geographicArea
131
     *
132
     * @return static
133
     *
134
     * @see http://schema.org/geographicArea
135
     */
136
    public function geographicArea($geographicArea)
137
    {
138
        return $this->setProperty('geographicArea', $geographicArea);
139
    }
140
141
    /**
142
     * The identifier property represents any kind of identifier for any kind of
143
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
144
     * dedicated properties for representing many of these, either as textual
145
     * strings or as URL (URI) links. See [background
146
     * notes](/docs/datamodel.html#identifierBg) for more details.
147
     *
148
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
149
     *
150
     * @return static
151
     *
152
     * @see http://schema.org/identifier
153
     */
154
    public function identifier($identifier)
155
    {
156
        return $this->setProperty('identifier', $identifier);
157
    }
158
159
    /**
160
     * An image of the item. This can be a [[URL]] or a fully described
161
     * [[ImageObject]].
162
     *
163
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
164
     *
165
     * @return static
166
     *
167
     * @see http://schema.org/image
168
     */
169
    public function image($image)
170
    {
171
        return $this->setProperty('image', $image);
172
    }
173
174
    /**
175
     * Indicates a page (or other CreativeWork) for which this thing is the main
176
     * entity being described. See [background
177
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
178
     *
179
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
180
     *
181
     * @return static
182
     *
183
     * @see http://schema.org/mainEntityOfPage
184
     */
185
    public function mainEntityOfPage($mainEntityOfPage)
186
    {
187
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
188
    }
189
190
    /**
191
     * The name of the item.
192
     *
193
     * @param string|string[] $name
194
     *
195
     * @return static
196
     *
197
     * @see http://schema.org/name
198
     */
199
    public function name($name)
200
    {
201
        return $this->setProperty('name', $name);
202
    }
203
204
    /**
205
     * Indicates a potential Action, which describes an idealized action in
206
     * which this thing would play an 'object' role.
207
     *
208
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
209
     *
210
     * @return static
211
     *
212
     * @see http://schema.org/potentialAction
213
     */
214
    public function potentialAction($potentialAction)
215
    {
216
        return $this->setProperty('potentialAction', $potentialAction);
217
    }
218
219
    /**
220
     * Audiences defined by a person's gender.
221
     *
222
     * @param string|string[] $requiredGender
223
     *
224
     * @return static
225
     *
226
     * @see http://schema.org/requiredGender
227
     */
228
    public function requiredGender($requiredGender)
229
    {
230
        return $this->setProperty('requiredGender', $requiredGender);
231
    }
232
233
    /**
234
     * Audiences defined by a person's maximum age.
235
     *
236
     * @param int|int[] $requiredMaxAge
237
     *
238
     * @return static
239
     *
240
     * @see http://schema.org/requiredMaxAge
241
     */
242
    public function requiredMaxAge($requiredMaxAge)
243
    {
244
        return $this->setProperty('requiredMaxAge', $requiredMaxAge);
245
    }
246
247
    /**
248
     * Audiences defined by a person's minimum age.
249
     *
250
     * @param int|int[] $requiredMinAge
251
     *
252
     * @return static
253
     *
254
     * @see http://schema.org/requiredMinAge
255
     */
256
    public function requiredMinAge($requiredMinAge)
257
    {
258
        return $this->setProperty('requiredMinAge', $requiredMinAge);
259
    }
260
261
    /**
262
     * URL of a reference Web page that unambiguously indicates the item's
263
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
264
     * official website.
265
     *
266
     * @param string|string[] $sameAs
267
     *
268
     * @return static
269
     *
270
     * @see http://schema.org/sameAs
271
     */
272
    public function sameAs($sameAs)
273
    {
274
        return $this->setProperty('sameAs', $sameAs);
275
    }
276
277
    /**
278
     * A CreativeWork or Event about this Thing.
279
     *
280
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
281
     *
282
     * @return static
283
     *
284
     * @see http://schema.org/subjectOf
285
     */
286
    public function subjectOf($subjectOf)
287
    {
288
        return $this->setProperty('subjectOf', $subjectOf);
289
    }
290
291
    /**
292
     * The gender of the person or audience.
293
     *
294
     * @param string|string[] $suggestedGender
295
     *
296
     * @return static
297
     *
298
     * @see http://schema.org/suggestedGender
299
     */
300
    public function suggestedGender($suggestedGender)
301
    {
302
        return $this->setProperty('suggestedGender', $suggestedGender);
303
    }
304
305
    /**
306
     * Maximal age recommended for viewing content.
307
     *
308
     * @param float|float[]|int|int[] $suggestedMaxAge
309
     *
310
     * @return static
311
     *
312
     * @see http://schema.org/suggestedMaxAge
313
     */
314
    public function suggestedMaxAge($suggestedMaxAge)
315
    {
316
        return $this->setProperty('suggestedMaxAge', $suggestedMaxAge);
317
    }
318
319
    /**
320
     * Minimal age recommended for viewing content.
321
     *
322
     * @param float|float[]|int|int[] $suggestedMinAge
323
     *
324
     * @return static
325
     *
326
     * @see http://schema.org/suggestedMinAge
327
     */
328
    public function suggestedMinAge($suggestedMinAge)
329
    {
330
        return $this->setProperty('suggestedMinAge', $suggestedMinAge);
331
    }
332
333
    /**
334
     * URL of the item.
335
     *
336
     * @param string|string[] $url
337
     *
338
     * @return static
339
     *
340
     * @see http://schema.org/url
341
     */
342
    public function url($url)
343
    {
344
        return $this->setProperty('url', $url);
345
    }
346
347
}
348

src/PaymentChargeSpecification.php 1 location

@@ 17-399 (lines=383) @@
14
 * @see http://schema.org/PaymentChargeSpecification
15
 *
16
 */
17
class PaymentChargeSpecification extends BaseType implements PaymentChargeSpecificationContract, 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 payment method(s) to which the payment charge specification applies.
69
     *
70
     * @param \Spatie\SchemaOrg\Contracts\PaymentMethodContract|\Spatie\SchemaOrg\Contracts\PaymentMethodContract[] $appliesToPaymentMethod
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/appliesToPaymentMethod
75
     */
76
    public function appliesToPaymentMethod($appliesToPaymentMethod)
77
    {
78
        return $this->setProperty('appliesToPaymentMethod', $appliesToPaymentMethod);
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 transaction volume, in a monetary unit, for which the offer or price
130
     * specification is valid, e.g. for indicating a minimal purchasing volume,
131
     * to express free shipping above a certain order volume, or to limit the
132
     * acceptance of credit cards to purchases to a certain minimal amount.
133
     *
134
     * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[] $eligibleTransactionVolume
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/eligibleTransactionVolume
139
     */
140
    public function eligibleTransactionVolume($eligibleTransactionVolume)
141
    {
142
        return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume);
143
    }
144
145
    /**
146
     * The identifier property represents any kind of identifier for any kind of
147
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
148
     * dedicated properties for representing many of these, either as textual
149
     * strings or as URL (URI) links. See [background
150
     * notes](/docs/datamodel.html#identifierBg) for more details.
151
     *
152
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
153
     *
154
     * @return static
155
     *
156
     * @see http://schema.org/identifier
157
     */
158
    public function identifier($identifier)
159
    {
160
        return $this->setProperty('identifier', $identifier);
161
    }
162
163
    /**
164
     * An image of the item. This can be a [[URL]] or a fully described
165
     * [[ImageObject]].
166
     *
167
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
168
     *
169
     * @return static
170
     *
171
     * @see http://schema.org/image
172
     */
173
    public function image($image)
174
    {
175
        return $this->setProperty('image', $image);
176
    }
177
178
    /**
179
     * Indicates a page (or other CreativeWork) for which this thing is the main
180
     * entity being described. See [background
181
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
182
     *
183
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
184
     *
185
     * @return static
186
     *
187
     * @see http://schema.org/mainEntityOfPage
188
     */
189
    public function mainEntityOfPage($mainEntityOfPage)
190
    {
191
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
192
    }
193
194
    /**
195
     * The highest price if the price is a range.
196
     *
197
     * @param float|float[]|int|int[] $maxPrice
198
     *
199
     * @return static
200
     *
201
     * @see http://schema.org/maxPrice
202
     */
203
    public function maxPrice($maxPrice)
204
    {
205
        return $this->setProperty('maxPrice', $maxPrice);
206
    }
207
208
    /**
209
     * The lowest price if the price is a range.
210
     *
211
     * @param float|float[]|int|int[] $minPrice
212
     *
213
     * @return static
214
     *
215
     * @see http://schema.org/minPrice
216
     */
217
    public function minPrice($minPrice)
218
    {
219
        return $this->setProperty('minPrice', $minPrice);
220
    }
221
222
    /**
223
     * The name of the item.
224
     *
225
     * @param string|string[] $name
226
     *
227
     * @return static
228
     *
229
     * @see http://schema.org/name
230
     */
231
    public function name($name)
232
    {
233
        return $this->setProperty('name', $name);
234
    }
235
236
    /**
237
     * Indicates a potential Action, which describes an idealized action in
238
     * which this thing would play an 'object' role.
239
     *
240
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
241
     *
242
     * @return static
243
     *
244
     * @see http://schema.org/potentialAction
245
     */
246
    public function potentialAction($potentialAction)
247
    {
248
        return $this->setProperty('potentialAction', $potentialAction);
249
    }
250
251
    /**
252
     * The offer price of a product, or of a price component when attached to
253
     * PriceSpecification and its subtypes.
254
     * 
255
     * Usage guidelines:
256
     * 
257
     * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217
258
     * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD";
259
     * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)
260
     * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange
261
     * Tradings
262
     * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)
263
     * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including
264
     * [ambiguous
265
     * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)
266
     * such as '$' in the value.
267
     * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
268
     * decimal point. Avoid using these symbols as a readability separator.
269
     * * Note that both
270
     * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)
271
     * and Microdata syntax allow the use of a "content=" attribute for
272
     * publishing simple machine-readable values alongside more human-friendly
273
     * formatting.
274
     * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
275
     * NINE' (U+0039)) rather than superficially similiar Unicode symbols.
276
     *
277
     * @param float|float[]|int|int[]|string|string[] $price
278
     *
279
     * @return static
280
     *
281
     * @see http://schema.org/price
282
     */
283
    public function price($price)
284
    {
285
        return $this->setProperty('price', $price);
286
    }
287
288
    /**
289
     * The currency of the price, or a price component when attached to
290
     * [[PriceSpecification]] and its subtypes.
291
     * 
292
     * Use standard formats: [ISO 4217 currency
293
     * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker
294
     * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for
295
     * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange
296
     * Tradings
297
     * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)
298
     * (LETS) and other currency types e.g. "Ithaca HOUR".
299
     *
300
     * @param string|string[] $priceCurrency
301
     *
302
     * @return static
303
     *
304
     * @see http://schema.org/priceCurrency
305
     */
306
    public function priceCurrency($priceCurrency)
307
    {
308
        return $this->setProperty('priceCurrency', $priceCurrency);
309
    }
310
311
    /**
312
     * URL of a reference Web page that unambiguously indicates the item's
313
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
314
     * official website.
315
     *
316
     * @param string|string[] $sameAs
317
     *
318
     * @return static
319
     *
320
     * @see http://schema.org/sameAs
321
     */
322
    public function sameAs($sameAs)
323
    {
324
        return $this->setProperty('sameAs', $sameAs);
325
    }
326
327
    /**
328
     * A CreativeWork or Event about this Thing.
329
     *
330
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
331
     *
332
     * @return static
333
     *
334
     * @see http://schema.org/subjectOf
335
     */
336
    public function subjectOf($subjectOf)
337
    {
338
        return $this->setProperty('subjectOf', $subjectOf);
339
    }
340
341
    /**
342
     * URL of the item.
343
     *
344
     * @param string|string[] $url
345
     *
346
     * @return static
347
     *
348
     * @see http://schema.org/url
349
     */
350
    public function url($url)
351
    {
352
        return $this->setProperty('url', $url);
353
    }
354
355
    /**
356
     * The date when the item becomes valid.
357
     *
358
     * @param \DateTimeInterface|\DateTimeInterface[] $validFrom
359
     *
360
     * @return static
361
     *
362
     * @see http://schema.org/validFrom
363
     */
364
    public function validFrom($validFrom)
365
    {
366
        return $this->setProperty('validFrom', $validFrom);
367
    }
368
369
    /**
370
     * The date after when the item is not valid. For example the end of an
371
     * offer, salary period, or a period of opening hours.
372
     *
373
     * @param \DateTimeInterface|\DateTimeInterface[] $validThrough
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/validThrough
378
     */
379
    public function validThrough($validThrough)
380
    {
381
        return $this->setProperty('validThrough', $validThrough);
382
    }
383
384
    /**
385
     * Specifies whether the applicable value-added tax (VAT) is included in the
386
     * price specification or not.
387
     *
388
     * @param bool|bool[] $valueAddedTaxIncluded
389
     *
390
     * @return static
391
     *
392
     * @see http://schema.org/valueAddedTaxIncluded
393
     */
394
    public function valueAddedTaxIncluded($valueAddedTaxIncluded)
395
    {
396
        return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded);
397
    }
398
399
}
400

src/PhotographAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/PhotographAction
14
 *
15
 */
16
class PhotographAction extends BaseType implements PhotographActionContract, 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 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

src/PriceSpecification.php 1 location

@@ 19-372 (lines=354) @@
16
 * @see http://schema.org/PriceSpecification
17
 *
18
 */
19
class PriceSpecification extends BaseType implements PriceSpecificationContract, IntangibleContract, StructuredValueContract, ThingContract
20
{
21
    /**
22
     * An additional type for the item, typically used for adding more specific
23
     * types from external vocabularies in microdata syntax. This is a
24
     * relationship between something and a class that the thing is in. In RDFa
25
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
26
     * attribute - for multiple types. Schema.org tools may have only weaker
27
     * understanding of extra types, in particular those defined externally.
28
     *
29
     * @param string|string[] $additionalType
30
     *
31
     * @return static
32
     *
33
     * @see http://schema.org/additionalType
34
     */
35
    public function additionalType($additionalType)
36
    {
37
        return $this->setProperty('additionalType', $additionalType);
38
    }
39
40
    /**
41
     * An alias for the item.
42
     *
43
     * @param string|string[] $alternateName
44
     *
45
     * @return static
46
     *
47
     * @see http://schema.org/alternateName
48
     */
49
    public function alternateName($alternateName)
50
    {
51
        return $this->setProperty('alternateName', $alternateName);
52
    }
53
54
    /**
55
     * A description of the item.
56
     *
57
     * @param string|string[] $description
58
     *
59
     * @return static
60
     *
61
     * @see http://schema.org/description
62
     */
63
    public function description($description)
64
    {
65
        return $this->setProperty('description', $description);
66
    }
67
68
    /**
69
     * A sub property of description. A short description of the item used to
70
     * disambiguate from other, similar items. Information from other properties
71
     * (in particular, name) may be necessary for the description to be useful
72
     * for disambiguation.
73
     *
74
     * @param string|string[] $disambiguatingDescription
75
     *
76
     * @return static
77
     *
78
     * @see http://schema.org/disambiguatingDescription
79
     */
80
    public function disambiguatingDescription($disambiguatingDescription)
81
    {
82
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
83
    }
84
85
    /**
86
     * The interval and unit of measurement of ordering quantities for which the
87
     * offer or price specification is valid. This allows e.g. specifying that a
88
     * certain freight charge is valid only for a certain quantity.
89
     *
90
     * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $eligibleQuantity
91
     *
92
     * @return static
93
     *
94
     * @see http://schema.org/eligibleQuantity
95
     */
96
    public function eligibleQuantity($eligibleQuantity)
97
    {
98
        return $this->setProperty('eligibleQuantity', $eligibleQuantity);
99
    }
100
101
    /**
102
     * The transaction volume, in a monetary unit, for which the offer or price
103
     * specification is valid, e.g. for indicating a minimal purchasing volume,
104
     * to express free shipping above a certain order volume, or to limit the
105
     * acceptance of credit cards to purchases to a certain minimal amount.
106
     *
107
     * @param \Spatie\SchemaOrg\Contracts\PriceSpecificationContract|\Spatie\SchemaOrg\Contracts\PriceSpecificationContract[] $eligibleTransactionVolume
108
     *
109
     * @return static
110
     *
111
     * @see http://schema.org/eligibleTransactionVolume
112
     */
113
    public function eligibleTransactionVolume($eligibleTransactionVolume)
114
    {
115
        return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume);
116
    }
117
118
    /**
119
     * The identifier property represents any kind of identifier for any kind of
120
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
121
     * dedicated properties for representing many of these, either as textual
122
     * strings or as URL (URI) links. See [background
123
     * notes](/docs/datamodel.html#identifierBg) for more details.
124
     *
125
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
126
     *
127
     * @return static
128
     *
129
     * @see http://schema.org/identifier
130
     */
131
    public function identifier($identifier)
132
    {
133
        return $this->setProperty('identifier', $identifier);
134
    }
135
136
    /**
137
     * An image of the item. This can be a [[URL]] or a fully described
138
     * [[ImageObject]].
139
     *
140
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
141
     *
142
     * @return static
143
     *
144
     * @see http://schema.org/image
145
     */
146
    public function image($image)
147
    {
148
        return $this->setProperty('image', $image);
149
    }
150
151
    /**
152
     * Indicates a page (or other CreativeWork) for which this thing is the main
153
     * entity being described. See [background
154
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
155
     *
156
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
157
     *
158
     * @return static
159
     *
160
     * @see http://schema.org/mainEntityOfPage
161
     */
162
    public function mainEntityOfPage($mainEntityOfPage)
163
    {
164
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
165
    }
166
167
    /**
168
     * The highest price if the price is a range.
169
     *
170
     * @param float|float[]|int|int[] $maxPrice
171
     *
172
     * @return static
173
     *
174
     * @see http://schema.org/maxPrice
175
     */
176
    public function maxPrice($maxPrice)
177
    {
178
        return $this->setProperty('maxPrice', $maxPrice);
179
    }
180
181
    /**
182
     * The lowest price if the price is a range.
183
     *
184
     * @param float|float[]|int|int[] $minPrice
185
     *
186
     * @return static
187
     *
188
     * @see http://schema.org/minPrice
189
     */
190
    public function minPrice($minPrice)
191
    {
192
        return $this->setProperty('minPrice', $minPrice);
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 offer price of a product, or of a price component when attached to
226
     * PriceSpecification and its subtypes.
227
     * 
228
     * Usage guidelines:
229
     * 
230
     * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217
231
     * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD";
232
     * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)
233
     * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange
234
     * Tradings
235
     * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)
236
     * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including
237
     * [ambiguous
238
     * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)
239
     * such as '$' in the value.
240
     * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
241
     * decimal point. Avoid using these symbols as a readability separator.
242
     * * Note that both
243
     * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)
244
     * and Microdata syntax allow the use of a "content=" attribute for
245
     * publishing simple machine-readable values alongside more human-friendly
246
     * formatting.
247
     * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
248
     * NINE' (U+0039)) rather than superficially similiar Unicode symbols.
249
     *
250
     * @param float|float[]|int|int[]|string|string[] $price
251
     *
252
     * @return static
253
     *
254
     * @see http://schema.org/price
255
     */
256
    public function price($price)
257
    {
258
        return $this->setProperty('price', $price);
259
    }
260
261
    /**
262
     * The currency of the price, or a price component when attached to
263
     * [[PriceSpecification]] and its subtypes.
264
     * 
265
     * Use standard formats: [ISO 4217 currency
266
     * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker
267
     * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for
268
     * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange
269
     * Tradings
270
     * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)
271
     * (LETS) and other currency types e.g. "Ithaca HOUR".
272
     *
273
     * @param string|string[] $priceCurrency
274
     *
275
     * @return static
276
     *
277
     * @see http://schema.org/priceCurrency
278
     */
279
    public function priceCurrency($priceCurrency)
280
    {
281
        return $this->setProperty('priceCurrency', $priceCurrency);
282
    }
283
284
    /**
285
     * URL of a reference Web page that unambiguously indicates the item's
286
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
287
     * official website.
288
     *
289
     * @param string|string[] $sameAs
290
     *
291
     * @return static
292
     *
293
     * @see http://schema.org/sameAs
294
     */
295
    public function sameAs($sameAs)
296
    {
297
        return $this->setProperty('sameAs', $sameAs);
298
    }
299
300
    /**
301
     * A CreativeWork or Event about this Thing.
302
     *
303
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
304
     *
305
     * @return static
306
     *
307
     * @see http://schema.org/subjectOf
308
     */
309
    public function subjectOf($subjectOf)
310
    {
311
        return $this->setProperty('subjectOf', $subjectOf);
312
    }
313
314
    /**
315
     * URL of the item.
316
     *
317
     * @param string|string[] $url
318
     *
319
     * @return static
320
     *
321
     * @see http://schema.org/url
322
     */
323
    public function url($url)
324
    {
325
        return $this->setProperty('url', $url);
326
    }
327
328
    /**
329
     * The date when the item becomes valid.
330
     *
331
     * @param \DateTimeInterface|\DateTimeInterface[] $validFrom
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/validFrom
336
     */
337
    public function validFrom($validFrom)
338
    {
339
        return $this->setProperty('validFrom', $validFrom);
340
    }
341
342
    /**
343
     * The date after when the item is not valid. For example the end of an
344
     * offer, salary period, or a period of opening hours.
345
     *
346
     * @param \DateTimeInterface|\DateTimeInterface[] $validThrough
347
     *
348
     * @return static
349
     *
350
     * @see http://schema.org/validThrough
351
     */
352
    public function validThrough($validThrough)
353
    {
354
        return $this->setProperty('validThrough', $validThrough);
355
    }
356
357
    /**
358
     * Specifies whether the applicable value-added tax (VAT) is included in the
359
     * price specification or not.
360
     *
361
     * @param bool|bool[] $valueAddedTaxIncluded
362
     *
363
     * @return static
364
     *
365
     * @see http://schema.org/valueAddedTaxIncluded
366
     */
367
    public function valueAddedTaxIncluded($valueAddedTaxIncluded)
368
    {
369
        return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded);
370
    }
371
372
}
373

src/PropertyValueSpecification.php 1 location

@@ 15-366 (lines=352) @@
12
 * @see http://schema.org/PropertyValueSpecification
13
 *
14
 */
15
class PropertyValueSpecification extends BaseType implements PropertyValueSpecificationContract, IntangibleContract, ThingContract
16
{
17
    /**
18
     * An additional type for the item, typically used for adding more specific
19
     * types from external vocabularies in microdata syntax. This is a
20
     * relationship between something and a class that the thing is in. In RDFa
21
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
22
     * attribute - for multiple types. Schema.org tools may have only weaker
23
     * understanding of extra types, in particular those defined externally.
24
     *
25
     * @param string|string[] $additionalType
26
     *
27
     * @return static
28
     *
29
     * @see http://schema.org/additionalType
30
     */
31
    public function additionalType($additionalType)
32
    {
33
        return $this->setProperty('additionalType', $additionalType);
34
    }
35
36
    /**
37
     * An alias for the item.
38
     *
39
     * @param string|string[] $alternateName
40
     *
41
     * @return static
42
     *
43
     * @see http://schema.org/alternateName
44
     */
45
    public function alternateName($alternateName)
46
    {
47
        return $this->setProperty('alternateName', $alternateName);
48
    }
49
50
    /**
51
     * The default value of the input.  For properties that expect a literal,
52
     * the default is a literal value, for properties that expect an object,
53
     * it's an ID reference to one of the current values.
54
     *
55
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $defaultValue
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/defaultValue
60
     */
61
    public function defaultValue($defaultValue)
62
    {
63
        return $this->setProperty('defaultValue', $defaultValue);
64
    }
65
66
    /**
67
     * A description of the item.
68
     *
69
     * @param string|string[] $description
70
     *
71
     * @return static
72
     *
73
     * @see http://schema.org/description
74
     */
75
    public function description($description)
76
    {
77
        return $this->setProperty('description', $description);
78
    }
79
80
    /**
81
     * A sub property of description. A short description of the item used to
82
     * disambiguate from other, similar items. Information from other properties
83
     * (in particular, name) may be necessary for the description to be useful
84
     * for disambiguation.
85
     *
86
     * @param string|string[] $disambiguatingDescription
87
     *
88
     * @return static
89
     *
90
     * @see http://schema.org/disambiguatingDescription
91
     */
92
    public function disambiguatingDescription($disambiguatingDescription)
93
    {
94
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
95
    }
96
97
    /**
98
     * The identifier property represents any kind of identifier for any kind of
99
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
100
     * dedicated properties for representing many of these, either as textual
101
     * strings or as URL (URI) links. See [background
102
     * notes](/docs/datamodel.html#identifierBg) for more details.
103
     *
104
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
105
     *
106
     * @return static
107
     *
108
     * @see http://schema.org/identifier
109
     */
110
    public function identifier($identifier)
111
    {
112
        return $this->setProperty('identifier', $identifier);
113
    }
114
115
    /**
116
     * An image of the item. This can be a [[URL]] or a fully described
117
     * [[ImageObject]].
118
     *
119
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
120
     *
121
     * @return static
122
     *
123
     * @see http://schema.org/image
124
     */
125
    public function image($image)
126
    {
127
        return $this->setProperty('image', $image);
128
    }
129
130
    /**
131
     * Indicates a page (or other CreativeWork) for which this thing is the main
132
     * entity being described. See [background
133
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
134
     *
135
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
136
     *
137
     * @return static
138
     *
139
     * @see http://schema.org/mainEntityOfPage
140
     */
141
    public function mainEntityOfPage($mainEntityOfPage)
142
    {
143
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
144
    }
145
146
    /**
147
     * The upper value of some characteristic or property.
148
     *
149
     * @param float|float[]|int|int[] $maxValue
150
     *
151
     * @return static
152
     *
153
     * @see http://schema.org/maxValue
154
     */
155
    public function maxValue($maxValue)
156
    {
157
        return $this->setProperty('maxValue', $maxValue);
158
    }
159
160
    /**
161
     * The lower value of some characteristic or property.
162
     *
163
     * @param float|float[]|int|int[] $minValue
164
     *
165
     * @return static
166
     *
167
     * @see http://schema.org/minValue
168
     */
169
    public function minValue($minValue)
170
    {
171
        return $this->setProperty('minValue', $minValue);
172
    }
173
174
    /**
175
     * Whether multiple values are allowed for the property.  Default is false.
176
     *
177
     * @param bool|bool[] $multipleValues
178
     *
179
     * @return static
180
     *
181
     * @see http://schema.org/multipleValues
182
     */
183
    public function multipleValues($multipleValues)
184
    {
185
        return $this->setProperty('multipleValues', $multipleValues);
186
    }
187
188
    /**
189
     * The name of the item.
190
     *
191
     * @param string|string[] $name
192
     *
193
     * @return static
194
     *
195
     * @see http://schema.org/name
196
     */
197
    public function name($name)
198
    {
199
        return $this->setProperty('name', $name);
200
    }
201
202
    /**
203
     * Indicates a potential Action, which describes an idealized action in
204
     * which this thing would play an 'object' role.
205
     *
206
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
207
     *
208
     * @return static
209
     *
210
     * @see http://schema.org/potentialAction
211
     */
212
    public function potentialAction($potentialAction)
213
    {
214
        return $this->setProperty('potentialAction', $potentialAction);
215
    }
216
217
    /**
218
     * Whether or not a property is mutable.  Default is false. Specifying this
219
     * for a property that also has a value makes it act similar to a "hidden"
220
     * input in an HTML form.
221
     *
222
     * @param bool|bool[] $readonlyValue
223
     *
224
     * @return static
225
     *
226
     * @see http://schema.org/readonlyValue
227
     */
228
    public function readonlyValue($readonlyValue)
229
    {
230
        return $this->setProperty('readonlyValue', $readonlyValue);
231
    }
232
233
    /**
234
     * URL of a reference Web page that unambiguously indicates the item's
235
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
236
     * official website.
237
     *
238
     * @param string|string[] $sameAs
239
     *
240
     * @return static
241
     *
242
     * @see http://schema.org/sameAs
243
     */
244
    public function sameAs($sameAs)
245
    {
246
        return $this->setProperty('sameAs', $sameAs);
247
    }
248
249
    /**
250
     * The stepValue attribute indicates the granularity that is expected (and
251
     * required) of the value in a PropertyValueSpecification.
252
     *
253
     * @param float|float[]|int|int[] $stepValue
254
     *
255
     * @return static
256
     *
257
     * @see http://schema.org/stepValue
258
     */
259
    public function stepValue($stepValue)
260
    {
261
        return $this->setProperty('stepValue', $stepValue);
262
    }
263
264
    /**
265
     * A CreativeWork or Event about this Thing.
266
     *
267
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
268
     *
269
     * @return static
270
     *
271
     * @see http://schema.org/subjectOf
272
     */
273
    public function subjectOf($subjectOf)
274
    {
275
        return $this->setProperty('subjectOf', $subjectOf);
276
    }
277
278
    /**
279
     * URL of the item.
280
     *
281
     * @param string|string[] $url
282
     *
283
     * @return static
284
     *
285
     * @see http://schema.org/url
286
     */
287
    public function url($url)
288
    {
289
        return $this->setProperty('url', $url);
290
    }
291
292
    /**
293
     * Specifies the allowed range for number of characters in a literal value.
294
     *
295
     * @param float|float[]|int|int[] $valueMaxLength
296
     *
297
     * @return static
298
     *
299
     * @see http://schema.org/valueMaxLength
300
     */
301
    public function valueMaxLength($valueMaxLength)
302
    {
303
        return $this->setProperty('valueMaxLength', $valueMaxLength);
304
    }
305
306
    /**
307
     * Specifies the minimum allowed range for number of characters in a literal
308
     * value.
309
     *
310
     * @param float|float[]|int|int[] $valueMinLength
311
     *
312
     * @return static
313
     *
314
     * @see http://schema.org/valueMinLength
315
     */
316
    public function valueMinLength($valueMinLength)
317
    {
318
        return $this->setProperty('valueMinLength', $valueMinLength);
319
    }
320
321
    /**
322
     * Indicates the name of the PropertyValueSpecification to be used in URL
323
     * templates and form encoding in a manner analogous to HTML's input@name.
324
     *
325
     * @param string|string[] $valueName
326
     *
327
     * @return static
328
     *
329
     * @see http://schema.org/valueName
330
     */
331
    public function valueName($valueName)
332
    {
333
        return $this->setProperty('valueName', $valueName);
334
    }
335
336
    /**
337
     * Specifies a regular expression for testing literal values according to
338
     * the HTML spec.
339
     *
340
     * @param string|string[] $valuePattern
341
     *
342
     * @return static
343
     *
344
     * @see http://schema.org/valuePattern
345
     */
346
    public function valuePattern($valuePattern)
347
    {
348
        return $this->setProperty('valuePattern', $valuePattern);
349
    }
350
351
    /**
352
     * Whether the property must be filled in to complete the action.  Default
353
     * is false.
354
     *
355
     * @param bool|bool[] $valueRequired
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/valueRequired
360
     */
361
    public function valueRequired($valueRequired)
362
    {
363
        return $this->setProperty('valueRequired', $valueRequired);
364
    }
365
366
}
367

src/ReactAction.php 1 location

@@ 17-384 (lines=368) @@
14
 * @see http://schema.org/ReactAction
15
 *
16
 */
17
class ReactAction extends BaseType implements ReactActionContract, 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
     * 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 startTime of something. For a reserved event or service (e.g.
321
     * FoodEstablishmentReservation), the time that it is expected to start. For
322
     * actions that span a period of time, when the action was performed. e.g.
323
     * John wrote a book from *January* to December. For media, including audio
324
     * and video, it's the time offset of the start of a clip within a larger
325
     * file.
326
     * 
327
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
328
     * when describing dates with times. This situation may be clarified in
329
     * future revisions.
330
     *
331
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/startTime
336
     */
337
    public function startTime($startTime)
338
    {
339
        return $this->setProperty('startTime', $startTime);
340
    }
341
342
    /**
343
     * A CreativeWork or Event about this Thing.
344
     *
345
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
346
     *
347
     * @return static
348
     *
349
     * @see http://schema.org/subjectOf
350
     */
351
    public function subjectOf($subjectOf)
352
    {
353
        return $this->setProperty('subjectOf', $subjectOf);
354
    }
355
356
    /**
357
     * Indicates a target EntryPoint for an Action.
358
     *
359
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
360
     *
361
     * @return static
362
     *
363
     * @see http://schema.org/target
364
     */
365
    public function target($target)
366
    {
367
        return $this->setProperty('target', $target);
368
    }
369
370
    /**
371
     * URL of the item.
372
     *
373
     * @param string|string[] $url
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/url
378
     */
379
    public function url($url)
380
    {
381
        return $this->setProperty('url', $url);
382
    }
383
384
}
385

src/RegisterAction.php 1 location

@@ 25-392 (lines=368) @@
22
 * @see http://schema.org/RegisterAction
23
 *
24
 */
25
class RegisterAction extends BaseType implements RegisterActionContract, 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
     * The identifier property represents any kind of identifier for any kind of
159
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
160
     * dedicated properties for representing many of these, either as textual
161
     * strings or as URL (URI) links. See [background
162
     * notes](/docs/datamodel.html#identifierBg) for more details.
163
     *
164
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
165
     *
166
     * @return static
167
     *
168
     * @see http://schema.org/identifier
169
     */
170
    public function identifier($identifier)
171
    {
172
        return $this->setProperty('identifier', $identifier);
173
    }
174
175
    /**
176
     * An image of the item. This can be a [[URL]] or a fully described
177
     * [[ImageObject]].
178
     *
179
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
180
     *
181
     * @return static
182
     *
183
     * @see http://schema.org/image
184
     */
185
    public function image($image)
186
    {
187
        return $this->setProperty('image', $image);
188
    }
189
190
    /**
191
     * The object that helped the agent perform the action. e.g. John wrote a
192
     * book with *a pen*.
193
     *
194
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
195
     *
196
     * @return static
197
     *
198
     * @see http://schema.org/instrument
199
     */
200
    public function instrument($instrument)
201
    {
202
        return $this->setProperty('instrument', $instrument);
203
    }
204
205
    /**
206
     * The location of for example where the event is happening, an organization
207
     * is located, or where an action takes place.
208
     *
209
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
210
     *
211
     * @return static
212
     *
213
     * @see http://schema.org/location
214
     */
215
    public function location($location)
216
    {
217
        return $this->setProperty('location', $location);
218
    }
219
220
    /**
221
     * Indicates a page (or other CreativeWork) for which this thing is the main
222
     * entity being described. See [background
223
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
224
     *
225
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
226
     *
227
     * @return static
228
     *
229
     * @see http://schema.org/mainEntityOfPage
230
     */
231
    public function mainEntityOfPage($mainEntityOfPage)
232
    {
233
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
234
    }
235
236
    /**
237
     * The name of the item.
238
     *
239
     * @param string|string[] $name
240
     *
241
     * @return static
242
     *
243
     * @see http://schema.org/name
244
     */
245
    public function name($name)
246
    {
247
        return $this->setProperty('name', $name);
248
    }
249
250
    /**
251
     * The object upon which the action is carried out, whose state is kept
252
     * intact or changed. Also known as the semantic roles patient, affected or
253
     * undergoer (which change their state) or theme (which doesn't). e.g. John
254
     * read *a book*.
255
     *
256
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
257
     *
258
     * @return static
259
     *
260
     * @see http://schema.org/object
261
     */
262
    public function object($object)
263
    {
264
        return $this->setProperty('object', $object);
265
    }
266
267
    /**
268
     * Other co-agents that participated in the action indirectly. e.g. John
269
     * wrote a book with *Steve*.
270
     *
271
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
272
     *
273
     * @return static
274
     *
275
     * @see http://schema.org/participant
276
     */
277
    public function participant($participant)
278
    {
279
        return $this->setProperty('participant', $participant);
280
    }
281
282
    /**
283
     * Indicates a potential Action, which describes an idealized action in
284
     * which this thing would play an 'object' role.
285
     *
286
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
287
     *
288
     * @return static
289
     *
290
     * @see http://schema.org/potentialAction
291
     */
292
    public function potentialAction($potentialAction)
293
    {
294
        return $this->setProperty('potentialAction', $potentialAction);
295
    }
296
297
    /**
298
     * The result produced in the action. e.g. John wrote *a book*.
299
     *
300
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
301
     *
302
     * @return static
303
     *
304
     * @see http://schema.org/result
305
     */
306
    public function result($result)
307
    {
308
        return $this->setProperty('result', $result);
309
    }
310
311
    /**
312
     * URL of a reference Web page that unambiguously indicates the item's
313
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
314
     * official website.
315
     *
316
     * @param string|string[] $sameAs
317
     *
318
     * @return static
319
     *
320
     * @see http://schema.org/sameAs
321
     */
322
    public function sameAs($sameAs)
323
    {
324
        return $this->setProperty('sameAs', $sameAs);
325
    }
326
327
    /**
328
     * The startTime of something. For a reserved event or service (e.g.
329
     * FoodEstablishmentReservation), the time that it is expected to start. For
330
     * actions that span a period of time, when the action was performed. e.g.
331
     * John wrote a book from *January* to December. For media, including audio
332
     * and video, it's the time offset of the start of a clip within a larger
333
     * file.
334
     * 
335
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
336
     * when describing dates with times. This situation may be clarified in
337
     * future revisions.
338
     *
339
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
340
     *
341
     * @return static
342
     *
343
     * @see http://schema.org/startTime
344
     */
345
    public function startTime($startTime)
346
    {
347
        return $this->setProperty('startTime', $startTime);
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
     * Indicates a target EntryPoint for an Action.
366
     *
367
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
368
     *
369
     * @return static
370
     *
371
     * @see http://schema.org/target
372
     */
373
    public function target($target)
374
    {
375
        return $this->setProperty('target', $target);
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

src/ResumeAction.php 1 location

@@ 17-384 (lines=368) @@
14
 * @see http://schema.org/ResumeAction
15
 *
16
 */
17
class ResumeAction extends BaseType implements ResumeActionContract, ActionContract, ControlActionContract, 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 startTime of something. For a reserved event or service (e.g.
321
     * FoodEstablishmentReservation), the time that it is expected to start. For
322
     * actions that span a period of time, when the action was performed. e.g.
323
     * John wrote a book from *January* to December. For media, including audio
324
     * and video, it's the time offset of the start of a clip within a larger
325
     * file.
326
     * 
327
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
328
     * when describing dates with times. This situation may be clarified in
329
     * future revisions.
330
     *
331
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/startTime
336
     */
337
    public function startTime($startTime)
338
    {
339
        return $this->setProperty('startTime', $startTime);
340
    }
341
342
    /**
343
     * A CreativeWork or Event about this Thing.
344
     *
345
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
346
     *
347
     * @return static
348
     *
349
     * @see http://schema.org/subjectOf
350
     */
351
    public function subjectOf($subjectOf)
352
    {
353
        return $this->setProperty('subjectOf', $subjectOf);
354
    }
355
356
    /**
357
     * Indicates a target EntryPoint for an Action.
358
     *
359
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
360
     *
361
     * @return static
362
     *
363
     * @see http://schema.org/target
364
     */
365
    public function target($target)
366
    {
367
        return $this->setProperty('target', $target);
368
    }
369
370
    /**
371
     * URL of the item.
372
     *
373
     * @param string|string[] $url
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/url
378
     */
379
    public function url($url)
380
    {
381
        return $this->setProperty('url', $url);
382
    }
383
384
}
385

src/SubscribeAction.php 1 location

@@ 27-394 (lines=368) @@
24
 * @see http://schema.org/SubscribeAction
25
 *
26
 */
27
class SubscribeAction extends BaseType implements SubscribeActionContract, ActionContract, InteractActionContract, ThingContract
28
{
29
    /**
30
     * Indicates the current disposition of the Action.
31
     *
32
     * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus
33
     *
34
     * @return static
35
     *
36
     * @see http://schema.org/actionStatus
37
     */
38
    public function actionStatus($actionStatus)
39
    {
40
        return $this->setProperty('actionStatus', $actionStatus);
41
    }
42
43
    /**
44
     * An additional type for the item, typically used for adding more specific
45
     * types from external vocabularies in microdata syntax. This is a
46
     * relationship between something and a class that the thing is in. In RDFa
47
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
48
     * attribute - for multiple types. Schema.org tools may have only weaker
49
     * understanding of extra types, in particular those defined externally.
50
     *
51
     * @param string|string[] $additionalType
52
     *
53
     * @return static
54
     *
55
     * @see http://schema.org/additionalType
56
     */
57
    public function additionalType($additionalType)
58
    {
59
        return $this->setProperty('additionalType', $additionalType);
60
    }
61
62
    /**
63
     * The direct performer or driver of the action (animate or inanimate). e.g.
64
     * *John* wrote a book.
65
     *
66
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent
67
     *
68
     * @return static
69
     *
70
     * @see http://schema.org/agent
71
     */
72
    public function agent($agent)
73
    {
74
        return $this->setProperty('agent', $agent);
75
    }
76
77
    /**
78
     * An alias for the item.
79
     *
80
     * @param string|string[] $alternateName
81
     *
82
     * @return static
83
     *
84
     * @see http://schema.org/alternateName
85
     */
86
    public function alternateName($alternateName)
87
    {
88
        return $this->setProperty('alternateName', $alternateName);
89
    }
90
91
    /**
92
     * A description of the item.
93
     *
94
     * @param string|string[] $description
95
     *
96
     * @return static
97
     *
98
     * @see http://schema.org/description
99
     */
100
    public function description($description)
101
    {
102
        return $this->setProperty('description', $description);
103
    }
104
105
    /**
106
     * A sub property of description. A short description of the item used to
107
     * disambiguate from other, similar items. Information from other properties
108
     * (in particular, name) may be necessary for the description to be useful
109
     * for disambiguation.
110
     *
111
     * @param string|string[] $disambiguatingDescription
112
     *
113
     * @return static
114
     *
115
     * @see http://schema.org/disambiguatingDescription
116
     */
117
    public function disambiguatingDescription($disambiguatingDescription)
118
    {
119
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
120
    }
121
122
    /**
123
     * The endTime of something. For a reserved event or service (e.g.
124
     * FoodEstablishmentReservation), the time that it is expected to end. For
125
     * actions that span a period of time, when the action was performed. e.g.
126
     * John wrote a book from January to *December*. For media, including audio
127
     * and video, it's the time offset of the end of a clip within a larger
128
     * file.
129
     * 
130
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
131
     * when describing dates with times. This situation may be clarified in
132
     * future revisions.
133
     *
134
     * @param \DateTimeInterface|\DateTimeInterface[] $endTime
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/endTime
139
     */
140
    public function endTime($endTime)
141
    {
142
        return $this->setProperty('endTime', $endTime);
143
    }
144
145
    /**
146
     * For failed actions, more information on the cause of the failure.
147
     *
148
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error
149
     *
150
     * @return static
151
     *
152
     * @see http://schema.org/error
153
     */
154
    public function error($error)
155
    {
156
        return $this->setProperty('error', $error);
157
    }
158
159
    /**
160
     * The identifier property represents any kind of identifier for any kind of
161
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
162
     * dedicated properties for representing many of these, either as textual
163
     * strings or as URL (URI) links. See [background
164
     * notes](/docs/datamodel.html#identifierBg) for more details.
165
     *
166
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
167
     *
168
     * @return static
169
     *
170
     * @see http://schema.org/identifier
171
     */
172
    public function identifier($identifier)
173
    {
174
        return $this->setProperty('identifier', $identifier);
175
    }
176
177
    /**
178
     * An image of the item. This can be a [[URL]] or a fully described
179
     * [[ImageObject]].
180
     *
181
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
182
     *
183
     * @return static
184
     *
185
     * @see http://schema.org/image
186
     */
187
    public function image($image)
188
    {
189
        return $this->setProperty('image', $image);
190
    }
191
192
    /**
193
     * The object that helped the agent perform the action. e.g. John wrote a
194
     * book with *a pen*.
195
     *
196
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
197
     *
198
     * @return static
199
     *
200
     * @see http://schema.org/instrument
201
     */
202
    public function instrument($instrument)
203
    {
204
        return $this->setProperty('instrument', $instrument);
205
    }
206
207
    /**
208
     * The location of for example where the event is happening, an organization
209
     * is located, or where an action takes place.
210
     *
211
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
212
     *
213
     * @return static
214
     *
215
     * @see http://schema.org/location
216
     */
217
    public function location($location)
218
    {
219
        return $this->setProperty('location', $location);
220
    }
221
222
    /**
223
     * Indicates a page (or other CreativeWork) for which this thing is the main
224
     * entity being described. See [background
225
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
226
     *
227
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
228
     *
229
     * @return static
230
     *
231
     * @see http://schema.org/mainEntityOfPage
232
     */
233
    public function mainEntityOfPage($mainEntityOfPage)
234
    {
235
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
236
    }
237
238
    /**
239
     * The name of the item.
240
     *
241
     * @param string|string[] $name
242
     *
243
     * @return static
244
     *
245
     * @see http://schema.org/name
246
     */
247
    public function name($name)
248
    {
249
        return $this->setProperty('name', $name);
250
    }
251
252
    /**
253
     * The object upon which the action is carried out, whose state is kept
254
     * intact or changed. Also known as the semantic roles patient, affected or
255
     * undergoer (which change their state) or theme (which doesn't). e.g. John
256
     * read *a book*.
257
     *
258
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
259
     *
260
     * @return static
261
     *
262
     * @see http://schema.org/object
263
     */
264
    public function object($object)
265
    {
266
        return $this->setProperty('object', $object);
267
    }
268
269
    /**
270
     * Other co-agents that participated in the action indirectly. e.g. John
271
     * wrote a book with *Steve*.
272
     *
273
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
274
     *
275
     * @return static
276
     *
277
     * @see http://schema.org/participant
278
     */
279
    public function participant($participant)
280
    {
281
        return $this->setProperty('participant', $participant);
282
    }
283
284
    /**
285
     * Indicates a potential Action, which describes an idealized action in
286
     * which this thing would play an 'object' role.
287
     *
288
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
289
     *
290
     * @return static
291
     *
292
     * @see http://schema.org/potentialAction
293
     */
294
    public function potentialAction($potentialAction)
295
    {
296
        return $this->setProperty('potentialAction', $potentialAction);
297
    }
298
299
    /**
300
     * The result produced in the action. e.g. John wrote *a book*.
301
     *
302
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
303
     *
304
     * @return static
305
     *
306
     * @see http://schema.org/result
307
     */
308
    public function result($result)
309
    {
310
        return $this->setProperty('result', $result);
311
    }
312
313
    /**
314
     * URL of a reference Web page that unambiguously indicates the item's
315
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
316
     * official website.
317
     *
318
     * @param string|string[] $sameAs
319
     *
320
     * @return static
321
     *
322
     * @see http://schema.org/sameAs
323
     */
324
    public function sameAs($sameAs)
325
    {
326
        return $this->setProperty('sameAs', $sameAs);
327
    }
328
329
    /**
330
     * The startTime of something. For a reserved event or service (e.g.
331
     * FoodEstablishmentReservation), the time that it is expected to start. For
332
     * actions that span a period of time, when the action was performed. e.g.
333
     * John wrote a book from *January* to December. For media, including audio
334
     * and video, it's the time offset of the start of a clip within a larger
335
     * file.
336
     * 
337
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
338
     * when describing dates with times. This situation may be clarified in
339
     * future revisions.
340
     *
341
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
342
     *
343
     * @return static
344
     *
345
     * @see http://schema.org/startTime
346
     */
347
    public function startTime($startTime)
348
    {
349
        return $this->setProperty('startTime', $startTime);
350
    }
351
352
    /**
353
     * A CreativeWork or Event about this Thing.
354
     *
355
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
356
     *
357
     * @return static
358
     *
359
     * @see http://schema.org/subjectOf
360
     */
361
    public function subjectOf($subjectOf)
362
    {
363
        return $this->setProperty('subjectOf', $subjectOf);
364
    }
365
366
    /**
367
     * Indicates a target EntryPoint for an Action.
368
     *
369
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
370
     *
371
     * @return static
372
     *
373
     * @see http://schema.org/target
374
     */
375
    public function target($target)
376
    {
377
        return $this->setProperty('target', $target);
378
    }
379
380
    /**
381
     * URL of the item.
382
     *
383
     * @param string|string[] $url
384
     *
385
     * @return static
386
     *
387
     * @see http://schema.org/url
388
     */
389
    public function url($url)
390
    {
391
        return $this->setProperty('url', $url);
392
    }
393
394
}
395

src/SuspendAction.php 1 location

@@ 17-384 (lines=368) @@
14
 * @see http://schema.org/SuspendAction
15
 *
16
 */
17
class SuspendAction extends BaseType implements SuspendActionContract, ActionContract, ControlActionContract, 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 startTime of something. For a reserved event or service (e.g.
321
     * FoodEstablishmentReservation), the time that it is expected to start. For
322
     * actions that span a period of time, when the action was performed. e.g.
323
     * John wrote a book from *January* to December. For media, including audio
324
     * and video, it's the time offset of the start of a clip within a larger
325
     * file.
326
     * 
327
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
328
     * when describing dates with times. This situation may be clarified in
329
     * future revisions.
330
     *
331
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
332
     *
333
     * @return static
334
     *
335
     * @see http://schema.org/startTime
336
     */
337
    public function startTime($startTime)
338
    {
339
        return $this->setProperty('startTime', $startTime);
340
    }
341
342
    /**
343
     * A CreativeWork or Event about this Thing.
344
     *
345
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
346
     *
347
     * @return static
348
     *
349
     * @see http://schema.org/subjectOf
350
     */
351
    public function subjectOf($subjectOf)
352
    {
353
        return $this->setProperty('subjectOf', $subjectOf);
354
    }
355
356
    /**
357
     * Indicates a target EntryPoint for an Action.
358
     *
359
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
360
     *
361
     * @return static
362
     *
363
     * @see http://schema.org/target
364
     */
365
    public function target($target)
366
    {
367
        return $this->setProperty('target', $target);
368
    }
369
370
    /**
371
     * URL of the item.
372
     *
373
     * @param string|string[] $url
374
     *
375
     * @return static
376
     *
377
     * @see http://schema.org/url
378
     */
379
    public function url($url)
380
    {
381
        return $this->setProperty('url', $url);
382
    }
383
384
}
385

src/TieAction.php 1 location

@@ 16-383 (lines=368) @@
13
 * @see http://schema.org/TieAction
14
 *
15
 */
16
class TieAction extends BaseType implements TieActionContract, 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

src/TrainTrip.php 1 location

@@ 16-353 (lines=338) @@
13
 * @see http://schema.org/TrainTrip
14
 *
15
 */
16
class TrainTrip extends BaseType implements TrainTripContract, IntangibleContract, ThingContract, TripContract
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 platform where the train arrives.
53
     *
54
     * @param string|string[] $arrivalPlatform
55
     *
56
     * @return static
57
     *
58
     * @see http://schema.org/arrivalPlatform
59
     */
60
    public function arrivalPlatform($arrivalPlatform)
61
    {
62
        return $this->setProperty('arrivalPlatform', $arrivalPlatform);
63
    }
64
65
    /**
66
     * The station where the train trip ends.
67
     *
68
     * @param \Spatie\SchemaOrg\Contracts\TrainStationContract|\Spatie\SchemaOrg\Contracts\TrainStationContract[] $arrivalStation
69
     *
70
     * @return static
71
     *
72
     * @see http://schema.org/arrivalStation
73
     */
74
    public function arrivalStation($arrivalStation)
75
    {
76
        return $this->setProperty('arrivalStation', $arrivalStation);
77
    }
78
79
    /**
80
     * The expected arrival time.
81
     *
82
     * @param \DateTimeInterface|\DateTimeInterface[] $arrivalTime
83
     *
84
     * @return static
85
     *
86
     * @see http://schema.org/arrivalTime
87
     */
88
    public function arrivalTime($arrivalTime)
89
    {
90
        return $this->setProperty('arrivalTime', $arrivalTime);
91
    }
92
93
    /**
94
     * The platform from which the train departs.
95
     *
96
     * @param string|string[] $departurePlatform
97
     *
98
     * @return static
99
     *
100
     * @see http://schema.org/departurePlatform
101
     */
102
    public function departurePlatform($departurePlatform)
103
    {
104
        return $this->setProperty('departurePlatform', $departurePlatform);
105
    }
106
107
    /**
108
     * The station from which the train departs.
109
     *
110
     * @param \Spatie\SchemaOrg\Contracts\TrainStationContract|\Spatie\SchemaOrg\Contracts\TrainStationContract[] $departureStation
111
     *
112
     * @return static
113
     *
114
     * @see http://schema.org/departureStation
115
     */
116
    public function departureStation($departureStation)
117
    {
118
        return $this->setProperty('departureStation', $departureStation);
119
    }
120
121
    /**
122
     * The expected departure time.
123
     *
124
     * @param \DateTimeInterface|\DateTimeInterface[] $departureTime
125
     *
126
     * @return static
127
     *
128
     * @see http://schema.org/departureTime
129
     */
130
    public function departureTime($departureTime)
131
    {
132
        return $this->setProperty('departureTime', $departureTime);
133
    }
134
135
    /**
136
     * A description of the item.
137
     *
138
     * @param string|string[] $description
139
     *
140
     * @return static
141
     *
142
     * @see http://schema.org/description
143
     */
144
    public function description($description)
145
    {
146
        return $this->setProperty('description', $description);
147
    }
148
149
    /**
150
     * A sub property of description. A short description of the item used to
151
     * disambiguate from other, similar items. Information from other properties
152
     * (in particular, name) may be necessary for the description to be useful
153
     * for disambiguation.
154
     *
155
     * @param string|string[] $disambiguatingDescription
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/disambiguatingDescription
160
     */
161
    public function disambiguatingDescription($disambiguatingDescription)
162
    {
163
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
164
    }
165
166
    /**
167
     * The identifier property represents any kind of identifier for any kind of
168
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
169
     * dedicated properties for representing many of these, either as textual
170
     * strings or as URL (URI) links. See [background
171
     * notes](/docs/datamodel.html#identifierBg) for more details.
172
     *
173
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
174
     *
175
     * @return static
176
     *
177
     * @see http://schema.org/identifier
178
     */
179
    public function identifier($identifier)
180
    {
181
        return $this->setProperty('identifier', $identifier);
182
    }
183
184
    /**
185
     * An image of the item. This can be a [[URL]] or a fully described
186
     * [[ImageObject]].
187
     *
188
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/image
193
     */
194
    public function image($image)
195
    {
196
        return $this->setProperty('image', $image);
197
    }
198
199
    /**
200
     * Indicates a page (or other CreativeWork) for which this thing is the main
201
     * entity being described. See [background
202
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
203
     *
204
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
205
     *
206
     * @return static
207
     *
208
     * @see http://schema.org/mainEntityOfPage
209
     */
210
    public function mainEntityOfPage($mainEntityOfPage)
211
    {
212
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
213
    }
214
215
    /**
216
     * The name of the item.
217
     *
218
     * @param string|string[] $name
219
     *
220
     * @return static
221
     *
222
     * @see http://schema.org/name
223
     */
224
    public function name($name)
225
    {
226
        return $this->setProperty('name', $name);
227
    }
228
229
    /**
230
     * An offer to provide this item&#x2014;for example, an offer to sell a
231
     * product, rent the DVD of a movie, perform a service, or give away tickets
232
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
233
     * offered, i.e. sell, lease, etc. This property can also be used to
234
     * describe a [[Demand]]. While this property is listed as expected on a
235
     * number of common types, it can be used in others. In that case, using a
236
     * second type, such as Product or a subtype of Product, can clarify the
237
     * nature of the offer.
238
     *
239
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
240
     *
241
     * @return static
242
     *
243
     * @see http://schema.org/offers
244
     */
245
    public function offers($offers)
246
    {
247
        return $this->setProperty('offers', $offers);
248
    }
249
250
    /**
251
     * Indicates a potential Action, which describes an idealized action in
252
     * which this thing would play an 'object' role.
253
     *
254
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
255
     *
256
     * @return static
257
     *
258
     * @see http://schema.org/potentialAction
259
     */
260
    public function potentialAction($potentialAction)
261
    {
262
        return $this->setProperty('potentialAction', $potentialAction);
263
    }
264
265
    /**
266
     * The service provider, service operator, or service performer; the goods
267
     * producer. Another party (a seller) may offer those services or goods on
268
     * behalf of the provider. A provider may also serve as the seller.
269
     *
270
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider
271
     *
272
     * @return static
273
     *
274
     * @see http://schema.org/provider
275
     */
276
    public function provider($provider)
277
    {
278
        return $this->setProperty('provider', $provider);
279
    }
280
281
    /**
282
     * URL of a reference Web page that unambiguously indicates the item's
283
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
284
     * official website.
285
     *
286
     * @param string|string[] $sameAs
287
     *
288
     * @return static
289
     *
290
     * @see http://schema.org/sameAs
291
     */
292
    public function sameAs($sameAs)
293
    {
294
        return $this->setProperty('sameAs', $sameAs);
295
    }
296
297
    /**
298
     * A CreativeWork or Event about this Thing.
299
     *
300
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
301
     *
302
     * @return static
303
     *
304
     * @see http://schema.org/subjectOf
305
     */
306
    public function subjectOf($subjectOf)
307
    {
308
        return $this->setProperty('subjectOf', $subjectOf);
309
    }
310
311
    /**
312
     * The name of the train (e.g. The Orient Express).
313
     *
314
     * @param string|string[] $trainName
315
     *
316
     * @return static
317
     *
318
     * @see http://schema.org/trainName
319
     */
320
    public function trainName($trainName)
321
    {
322
        return $this->setProperty('trainName', $trainName);
323
    }
324
325
    /**
326
     * The unique identifier for the train.
327
     *
328
     * @param string|string[] $trainNumber
329
     *
330
     * @return static
331
     *
332
     * @see http://schema.org/trainNumber
333
     */
334
    public function trainNumber($trainNumber)
335
    {
336
        return $this->setProperty('trainNumber', $trainNumber);
337
    }
338
339
    /**
340
     * URL of the item.
341
     *
342
     * @param string|string[] $url
343
     *
344
     * @return static
345
     *
346
     * @see http://schema.org/url
347
     */
348
    public function url($url)
349
    {
350
        return $this->setProperty('url', $url);
351
    }
352
353
}
354

src/UnRegisterAction.php 1 location

@@ 23-390 (lines=368) @@
20
 * @see http://schema.org/UnRegisterAction
21
 *
22
 */
23
class UnRegisterAction extends BaseType implements UnRegisterActionContract, ActionContract, InteractActionContract, 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 startTime of something. For a reserved event or service (e.g.
327
     * FoodEstablishmentReservation), the time that it is expected to start. For
328
     * actions that span a period of time, when the action was performed. e.g.
329
     * John wrote a book from *January* to December. For media, including audio
330
     * and video, it's the time offset of the start of a clip within a larger
331
     * file.
332
     * 
333
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
334
     * when describing dates with times. This situation may be clarified in
335
     * future revisions.
336
     *
337
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
338
     *
339
     * @return static
340
     *
341
     * @see http://schema.org/startTime
342
     */
343
    public function startTime($startTime)
344
    {
345
        return $this->setProperty('startTime', $startTime);
346
    }
347
348
    /**
349
     * A CreativeWork or Event about this Thing.
350
     *
351
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
352
     *
353
     * @return static
354
     *
355
     * @see http://schema.org/subjectOf
356
     */
357
    public function subjectOf($subjectOf)
358
    {
359
        return $this->setProperty('subjectOf', $subjectOf);
360
    }
361
362
    /**
363
     * Indicates a target EntryPoint for an Action.
364
     *
365
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
366
     *
367
     * @return static
368
     *
369
     * @see http://schema.org/target
370
     */
371
    public function target($target)
372
    {
373
        return $this->setProperty('target', $target);
374
    }
375
376
    /**
377
     * URL of the item.
378
     *
379
     * @param string|string[] $url
380
     *
381
     * @return static
382
     *
383
     * @see http://schema.org/url
384
     */
385
    public function url($url)
386
    {
387
        return $this->setProperty('url', $url);
388
    }
389
390
}
391