ArriveAction::image()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 4
Ratio 100 %

Importance

Changes 0
Metric Value
dl 4
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
3
namespace Spatie\SchemaOrg;
4
5
use \Spatie\SchemaOrg\Contracts\ArriveActionContract;
6
use \Spatie\SchemaOrg\Contracts\ActionContract;
7
use \Spatie\SchemaOrg\Contracts\MoveActionContract;
8
use \Spatie\SchemaOrg\Contracts\ThingContract;
9
10
/**
11
 * The act of arriving at a place. An agent arrives at a destination from a
12
 * fromLocation, optionally with participants.
13
 *
14
 * @see http://schema.org/ArriveAction
15
 *
16
 */
17 View Code Duplication
class ArriveAction extends BaseType implements ArriveActionContract, ActionContract, MoveActionContract, ThingContract
0 ignored issues
show
Duplication introduced by
This class seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

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