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