Code Duplication    Length = 231-271 lines in 26 locations

src/AlignmentObject.php 1 location

@@ 16-277 (lines=262) @@
13
 * @see http://schema.org/AlignmentObject
14
 *
15
 */
16
class AlignmentObject extends BaseType implements AlignmentObjectContract, IntangibleContract, ThingContract
17
{
18
    /**
19
     * An additional type for the item, typically used for adding more specific
20
     * types from external vocabularies in microdata syntax. This is a
21
     * relationship between something and a class that the thing is in. In RDFa
22
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
23
     * attribute - for multiple types. Schema.org tools may have only weaker
24
     * understanding of extra types, in particular those defined externally.
25
     *
26
     * @param string|string[] $additionalType
27
     *
28
     * @return static
29
     *
30
     * @see http://schema.org/additionalType
31
     */
32
    public function additionalType($additionalType)
33
    {
34
        return $this->setProperty('additionalType', $additionalType);
35
    }
36
37
    /**
38
     * A category of alignment between the learning resource and the framework
39
     * node. Recommended values include: 'assesses', 'teaches', 'requires',
40
     * 'textComplexity', 'readingLevel', 'educationalSubject', and
41
     * 'educationalLevel'.
42
     *
43
     * @param string|string[] $alignmentType
44
     *
45
     * @return static
46
     *
47
     * @see http://schema.org/alignmentType
48
     */
49
    public function alignmentType($alignmentType)
50
    {
51
        return $this->setProperty('alignmentType', $alignmentType);
52
    }
53
54
    /**
55
     * An alias for the item.
56
     *
57
     * @param string|string[] $alternateName
58
     *
59
     * @return static
60
     *
61
     * @see http://schema.org/alternateName
62
     */
63
    public function alternateName($alternateName)
64
    {
65
        return $this->setProperty('alternateName', $alternateName);
66
    }
67
68
    /**
69
     * A description of the item.
70
     *
71
     * @param string|string[] $description
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/description
76
     */
77
    public function description($description)
78
    {
79
        return $this->setProperty('description', $description);
80
    }
81
82
    /**
83
     * A sub property of description. A short description of the item used to
84
     * disambiguate from other, similar items. Information from other properties
85
     * (in particular, name) may be necessary for the description to be useful
86
     * for disambiguation.
87
     *
88
     * @param string|string[] $disambiguatingDescription
89
     *
90
     * @return static
91
     *
92
     * @see http://schema.org/disambiguatingDescription
93
     */
94
    public function disambiguatingDescription($disambiguatingDescription)
95
    {
96
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
97
    }
98
99
    /**
100
     * The framework to which the resource being described is aligned.
101
     *
102
     * @param string|string[] $educationalFramework
103
     *
104
     * @return static
105
     *
106
     * @see http://schema.org/educationalFramework
107
     */
108
    public function educationalFramework($educationalFramework)
109
    {
110
        return $this->setProperty('educationalFramework', $educationalFramework);
111
    }
112
113
    /**
114
     * The identifier property represents any kind of identifier for any kind of
115
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
116
     * dedicated properties for representing many of these, either as textual
117
     * strings or as URL (URI) links. See [background
118
     * notes](/docs/datamodel.html#identifierBg) for more details.
119
     *
120
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
121
     *
122
     * @return static
123
     *
124
     * @see http://schema.org/identifier
125
     */
126
    public function identifier($identifier)
127
    {
128
        return $this->setProperty('identifier', $identifier);
129
    }
130
131
    /**
132
     * An image of the item. This can be a [[URL]] or a fully described
133
     * [[ImageObject]].
134
     *
135
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
136
     *
137
     * @return static
138
     *
139
     * @see http://schema.org/image
140
     */
141
    public function image($image)
142
    {
143
        return $this->setProperty('image', $image);
144
    }
145
146
    /**
147
     * Indicates a page (or other CreativeWork) for which this thing is the main
148
     * entity being described. See [background
149
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
150
     *
151
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
152
     *
153
     * @return static
154
     *
155
     * @see http://schema.org/mainEntityOfPage
156
     */
157
    public function mainEntityOfPage($mainEntityOfPage)
158
    {
159
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
160
    }
161
162
    /**
163
     * The name of the item.
164
     *
165
     * @param string|string[] $name
166
     *
167
     * @return static
168
     *
169
     * @see http://schema.org/name
170
     */
171
    public function name($name)
172
    {
173
        return $this->setProperty('name', $name);
174
    }
175
176
    /**
177
     * Indicates a potential Action, which describes an idealized action in
178
     * which this thing would play an 'object' role.
179
     *
180
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
181
     *
182
     * @return static
183
     *
184
     * @see http://schema.org/potentialAction
185
     */
186
    public function potentialAction($potentialAction)
187
    {
188
        return $this->setProperty('potentialAction', $potentialAction);
189
    }
190
191
    /**
192
     * URL of a reference Web page that unambiguously indicates the item's
193
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
194
     * official website.
195
     *
196
     * @param string|string[] $sameAs
197
     *
198
     * @return static
199
     *
200
     * @see http://schema.org/sameAs
201
     */
202
    public function sameAs($sameAs)
203
    {
204
        return $this->setProperty('sameAs', $sameAs);
205
    }
206
207
    /**
208
     * A CreativeWork or Event about this Thing.
209
     *
210
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
211
     *
212
     * @return static
213
     *
214
     * @see http://schema.org/subjectOf
215
     */
216
    public function subjectOf($subjectOf)
217
    {
218
        return $this->setProperty('subjectOf', $subjectOf);
219
    }
220
221
    /**
222
     * The description of a node in an established educational framework.
223
     *
224
     * @param string|string[] $targetDescription
225
     *
226
     * @return static
227
     *
228
     * @see http://schema.org/targetDescription
229
     */
230
    public function targetDescription($targetDescription)
231
    {
232
        return $this->setProperty('targetDescription', $targetDescription);
233
    }
234
235
    /**
236
     * The name of a node in an established educational framework.
237
     *
238
     * @param string|string[] $targetName
239
     *
240
     * @return static
241
     *
242
     * @see http://schema.org/targetName
243
     */
244
    public function targetName($targetName)
245
    {
246
        return $this->setProperty('targetName', $targetName);
247
    }
248
249
    /**
250
     * The URL of a node in an established educational framework.
251
     *
252
     * @param string|string[] $targetUrl
253
     *
254
     * @return static
255
     *
256
     * @see http://schema.org/targetUrl
257
     */
258
    public function targetUrl($targetUrl)
259
    {
260
        return $this->setProperty('targetUrl', $targetUrl);
261
    }
262
263
    /**
264
     * URL of the item.
265
     *
266
     * @param string|string[] $url
267
     *
268
     * @return static
269
     *
270
     * @see http://schema.org/url
271
     */
272
    public function url($url)
273
    {
274
        return $this->setProperty('url', $url);
275
    }
276
277
}
278

src/Brand.php 1 location

@@ 16-261 (lines=246) @@
13
 * @see http://schema.org/Brand
14
 *
15
 */
16
class Brand extends BaseType implements BrandContract, IntangibleContract, ThingContract
17
{
18
    /**
19
     * An additional type for the item, typically used for adding more specific
20
     * types from external vocabularies in microdata syntax. This is a
21
     * relationship between something and a class that the thing is in. In RDFa
22
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
23
     * attribute - for multiple types. Schema.org tools may have only weaker
24
     * understanding of extra types, in particular those defined externally.
25
     *
26
     * @param string|string[] $additionalType
27
     *
28
     * @return static
29
     *
30
     * @see http://schema.org/additionalType
31
     */
32
    public function additionalType($additionalType)
33
    {
34
        return $this->setProperty('additionalType', $additionalType);
35
    }
36
37
    /**
38
     * The overall rating, based on a collection of reviews or ratings, of the
39
     * item.
40
     *
41
     * @param \Spatie\SchemaOrg\Contracts\AggregateRatingContract|\Spatie\SchemaOrg\Contracts\AggregateRatingContract[] $aggregateRating
42
     *
43
     * @return static
44
     *
45
     * @see http://schema.org/aggregateRating
46
     */
47
    public function aggregateRating($aggregateRating)
48
    {
49
        return $this->setProperty('aggregateRating', $aggregateRating);
50
    }
51
52
    /**
53
     * An alias for the item.
54
     *
55
     * @param string|string[] $alternateName
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/alternateName
60
     */
61
    public function alternateName($alternateName)
62
    {
63
        return $this->setProperty('alternateName', $alternateName);
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
     * An associated logo.
132
     *
133
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $logo
134
     *
135
     * @return static
136
     *
137
     * @see http://schema.org/logo
138
     */
139
    public function logo($logo)
140
    {
141
        return $this->setProperty('logo', $logo);
142
    }
143
144
    /**
145
     * Indicates a page (or other CreativeWork) for which this thing is the main
146
     * entity being described. See [background
147
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
148
     *
149
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
150
     *
151
     * @return static
152
     *
153
     * @see http://schema.org/mainEntityOfPage
154
     */
155
    public function mainEntityOfPage($mainEntityOfPage)
156
    {
157
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
158
    }
159
160
    /**
161
     * The name of the item.
162
     *
163
     * @param string|string[] $name
164
     *
165
     * @return static
166
     *
167
     * @see http://schema.org/name
168
     */
169
    public function name($name)
170
    {
171
        return $this->setProperty('name', $name);
172
    }
173
174
    /**
175
     * Indicates a potential Action, which describes an idealized action in
176
     * which this thing would play an 'object' role.
177
     *
178
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
179
     *
180
     * @return static
181
     *
182
     * @see http://schema.org/potentialAction
183
     */
184
    public function potentialAction($potentialAction)
185
    {
186
        return $this->setProperty('potentialAction', $potentialAction);
187
    }
188
189
    /**
190
     * A review of the item.
191
     *
192
     * @param \Spatie\SchemaOrg\Contracts\ReviewContract|\Spatie\SchemaOrg\Contracts\ReviewContract[] $review
193
     *
194
     * @return static
195
     *
196
     * @see http://schema.org/review
197
     */
198
    public function review($review)
199
    {
200
        return $this->setProperty('review', $review);
201
    }
202
203
    /**
204
     * URL of a reference Web page that unambiguously indicates the item's
205
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
206
     * official website.
207
     *
208
     * @param string|string[] $sameAs
209
     *
210
     * @return static
211
     *
212
     * @see http://schema.org/sameAs
213
     */
214
    public function sameAs($sameAs)
215
    {
216
        return $this->setProperty('sameAs', $sameAs);
217
    }
218
219
    /**
220
     * A slogan or motto associated with the item.
221
     *
222
     * @param string|string[] $slogan
223
     *
224
     * @return static
225
     *
226
     * @see http://schema.org/slogan
227
     */
228
    public function slogan($slogan)
229
    {
230
        return $this->setProperty('slogan', $slogan);
231
    }
232
233
    /**
234
     * A CreativeWork or Event about this Thing.
235
     *
236
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
237
     *
238
     * @return static
239
     *
240
     * @see http://schema.org/subjectOf
241
     */
242
    public function subjectOf($subjectOf)
243
    {
244
        return $this->setProperty('subjectOf', $subjectOf);
245
    }
246
247
    /**
248
     * URL of the item.
249
     *
250
     * @param string|string[] $url
251
     *
252
     * @return static
253
     *
254
     * @see http://schema.org/url
255
     */
256
    public function url($url)
257
    {
258
        return $this->setProperty('url', $url);
259
    }
260
261
}
262

src/BreadcrumbList.php 1 location

@@ 26-269 (lines=244) @@
23
 * @see http://schema.org/BreadcrumbList
24
 *
25
 */
26
class BreadcrumbList extends BaseType implements BreadcrumbListContract, IntangibleContract, ItemListContract, ThingContract
27
{
28
    /**
29
     * An additional type for the item, typically used for adding more specific
30
     * types from external vocabularies in microdata syntax. This is a
31
     * relationship between something and a class that the thing is in. In RDFa
32
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
33
     * attribute - for multiple types. Schema.org tools may have only weaker
34
     * understanding of extra types, in particular those defined externally.
35
     *
36
     * @param string|string[] $additionalType
37
     *
38
     * @return static
39
     *
40
     * @see http://schema.org/additionalType
41
     */
42
    public function additionalType($additionalType)
43
    {
44
        return $this->setProperty('additionalType', $additionalType);
45
    }
46
47
    /**
48
     * An alias for the item.
49
     *
50
     * @param string|string[] $alternateName
51
     *
52
     * @return static
53
     *
54
     * @see http://schema.org/alternateName
55
     */
56
    public function alternateName($alternateName)
57
    {
58
        return $this->setProperty('alternateName', $alternateName);
59
    }
60
61
    /**
62
     * A description of the item.
63
     *
64
     * @param string|string[] $description
65
     *
66
     * @return static
67
     *
68
     * @see http://schema.org/description
69
     */
70
    public function description($description)
71
    {
72
        return $this->setProperty('description', $description);
73
    }
74
75
    /**
76
     * A sub property of description. A short description of the item used to
77
     * disambiguate from other, similar items. Information from other properties
78
     * (in particular, name) may be necessary for the description to be useful
79
     * for disambiguation.
80
     *
81
     * @param string|string[] $disambiguatingDescription
82
     *
83
     * @return static
84
     *
85
     * @see http://schema.org/disambiguatingDescription
86
     */
87
    public function disambiguatingDescription($disambiguatingDescription)
88
    {
89
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
90
    }
91
92
    /**
93
     * The identifier property represents any kind of identifier for any kind of
94
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
95
     * dedicated properties for representing many of these, either as textual
96
     * strings or as URL (URI) links. See [background
97
     * notes](/docs/datamodel.html#identifierBg) for more details.
98
     *
99
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
100
     *
101
     * @return static
102
     *
103
     * @see http://schema.org/identifier
104
     */
105
    public function identifier($identifier)
106
    {
107
        return $this->setProperty('identifier', $identifier);
108
    }
109
110
    /**
111
     * An image of the item. This can be a [[URL]] or a fully described
112
     * [[ImageObject]].
113
     *
114
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
115
     *
116
     * @return static
117
     *
118
     * @see http://schema.org/image
119
     */
120
    public function image($image)
121
    {
122
        return $this->setProperty('image', $image);
123
    }
124
125
    /**
126
     * For itemListElement values, you can use simple strings (e.g. "Peter",
127
     * "Paul", "Mary"), existing entities, or use ListItem.
128
     * 
129
     * Text values are best if the elements in the list are plain strings.
130
     * Existing entities are best for a simple, unordered list of existing
131
     * things in your data. ListItem is used with ordered lists when you want to
132
     * provide additional context about the element in that list or when the
133
     * same item might be in different places in different lists.
134
     * 
135
     * Note: The order of elements in your mark-up is not sufficient for
136
     * indicating the order or elements.  Use ListItem with a 'position'
137
     * property in such cases.
138
     *
139
     * @param \Spatie\SchemaOrg\Contracts\ListItemContract|\Spatie\SchemaOrg\Contracts\ListItemContract[]|\Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $itemListElement
140
     *
141
     * @return static
142
     *
143
     * @see http://schema.org/itemListElement
144
     */
145
    public function itemListElement($itemListElement)
146
    {
147
        return $this->setProperty('itemListElement', $itemListElement);
148
    }
149
150
    /**
151
     * Type of ordering (e.g. Ascending, Descending, Unordered).
152
     *
153
     * @param \Spatie\SchemaOrg\Contracts\ItemListOrderTypeContract|\Spatie\SchemaOrg\Contracts\ItemListOrderTypeContract[]|string|string[] $itemListOrder
154
     *
155
     * @return static
156
     *
157
     * @see http://schema.org/itemListOrder
158
     */
159
    public function itemListOrder($itemListOrder)
160
    {
161
        return $this->setProperty('itemListOrder', $itemListOrder);
162
    }
163
164
    /**
165
     * Indicates a page (or other CreativeWork) for which this thing is the main
166
     * entity being described. See [background
167
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
168
     *
169
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
170
     *
171
     * @return static
172
     *
173
     * @see http://schema.org/mainEntityOfPage
174
     */
175
    public function mainEntityOfPage($mainEntityOfPage)
176
    {
177
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
178
    }
179
180
    /**
181
     * The name of the item.
182
     *
183
     * @param string|string[] $name
184
     *
185
     * @return static
186
     *
187
     * @see http://schema.org/name
188
     */
189
    public function name($name)
190
    {
191
        return $this->setProperty('name', $name);
192
    }
193
194
    /**
195
     * The number of items in an ItemList. Note that some descriptions might not
196
     * fully describe all items in a list (e.g., multi-page pagination); in such
197
     * cases, the numberOfItems would be for the entire list.
198
     *
199
     * @param int|int[] $numberOfItems
200
     *
201
     * @return static
202
     *
203
     * @see http://schema.org/numberOfItems
204
     */
205
    public function numberOfItems($numberOfItems)
206
    {
207
        return $this->setProperty('numberOfItems', $numberOfItems);
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
     * URL of a reference Web page that unambiguously indicates the item's
227
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
228
     * official website.
229
     *
230
     * @param string|string[] $sameAs
231
     *
232
     * @return static
233
     *
234
     * @see http://schema.org/sameAs
235
     */
236
    public function sameAs($sameAs)
237
    {
238
        return $this->setProperty('sameAs', $sameAs);
239
    }
240
241
    /**
242
     * A CreativeWork or Event about this Thing.
243
     *
244
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
245
     *
246
     * @return static
247
     *
248
     * @see http://schema.org/subjectOf
249
     */
250
    public function subjectOf($subjectOf)
251
    {
252
        return $this->setProperty('subjectOf', $subjectOf);
253
    }
254
255
    /**
256
     * URL of the item.
257
     *
258
     * @param string|string[] $url
259
     *
260
     * @return static
261
     *
262
     * @see http://schema.org/url
263
     */
264
    public function url($url)
265
    {
266
        return $this->setProperty('url', $url);
267
    }
268
269
}
270

src/BusinessAudience.php 1 location

@@ 17-276 (lines=260) @@
14
 * @see http://schema.org/BusinessAudience
15
 *
16
 */
17
class BusinessAudience extends BaseType implements BusinessAudienceContract, AudienceContract, IntangibleContract, ThingContract
18
{
19
    /**
20
     * An additional type for the item, typically used for adding more specific
21
     * types from external vocabularies in microdata syntax. This is a
22
     * relationship between something and a class that the thing is in. In RDFa
23
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
24
     * attribute - for multiple types. Schema.org tools may have only weaker
25
     * understanding of extra types, in particular those defined externally.
26
     *
27
     * @param string|string[] $additionalType
28
     *
29
     * @return static
30
     *
31
     * @see http://schema.org/additionalType
32
     */
33
    public function additionalType($additionalType)
34
    {
35
        return $this->setProperty('additionalType', $additionalType);
36
    }
37
38
    /**
39
     * An alias for the item.
40
     *
41
     * @param string|string[] $alternateName
42
     *
43
     * @return static
44
     *
45
     * @see http://schema.org/alternateName
46
     */
47
    public function alternateName($alternateName)
48
    {
49
        return $this->setProperty('alternateName', $alternateName);
50
    }
51
52
    /**
53
     * The target group associated with a given audience (e.g. veterans, car
54
     * owners, musicians, etc.).
55
     *
56
     * @param string|string[] $audienceType
57
     *
58
     * @return static
59
     *
60
     * @see http://schema.org/audienceType
61
     */
62
    public function audienceType($audienceType)
63
    {
64
        return $this->setProperty('audienceType', $audienceType);
65
    }
66
67
    /**
68
     * A description of the item.
69
     *
70
     * @param string|string[] $description
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/description
75
     */
76
    public function description($description)
77
    {
78
        return $this->setProperty('description', $description);
79
    }
80
81
    /**
82
     * A sub property of description. A short description of the item used to
83
     * disambiguate from other, similar items. Information from other properties
84
     * (in particular, name) may be necessary for the description to be useful
85
     * for disambiguation.
86
     *
87
     * @param string|string[] $disambiguatingDescription
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/disambiguatingDescription
92
     */
93
    public function disambiguatingDescription($disambiguatingDescription)
94
    {
95
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
96
    }
97
98
    /**
99
     * The geographic area associated with the audience.
100
     *
101
     * @param \Spatie\SchemaOrg\Contracts\AdministrativeAreaContract|\Spatie\SchemaOrg\Contracts\AdministrativeAreaContract[] $geographicArea
102
     *
103
     * @return static
104
     *
105
     * @see http://schema.org/geographicArea
106
     */
107
    public function geographicArea($geographicArea)
108
    {
109
        return $this->setProperty('geographicArea', $geographicArea);
110
    }
111
112
    /**
113
     * The identifier property represents any kind of identifier for any kind of
114
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
115
     * dedicated properties for representing many of these, either as textual
116
     * strings or as URL (URI) links. See [background
117
     * notes](/docs/datamodel.html#identifierBg) for more details.
118
     *
119
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
120
     *
121
     * @return static
122
     *
123
     * @see http://schema.org/identifier
124
     */
125
    public function identifier($identifier)
126
    {
127
        return $this->setProperty('identifier', $identifier);
128
    }
129
130
    /**
131
     * An image of the item. This can be a [[URL]] or a fully described
132
     * [[ImageObject]].
133
     *
134
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/image
139
     */
140
    public function image($image)
141
    {
142
        return $this->setProperty('image', $image);
143
    }
144
145
    /**
146
     * Indicates a page (or other CreativeWork) for which this thing is the main
147
     * entity being described. See [background
148
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
149
     *
150
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
151
     *
152
     * @return static
153
     *
154
     * @see http://schema.org/mainEntityOfPage
155
     */
156
    public function mainEntityOfPage($mainEntityOfPage)
157
    {
158
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
159
    }
160
161
    /**
162
     * The name of the item.
163
     *
164
     * @param string|string[] $name
165
     *
166
     * @return static
167
     *
168
     * @see http://schema.org/name
169
     */
170
    public function name($name)
171
    {
172
        return $this->setProperty('name', $name);
173
    }
174
175
    /**
176
     * The number of employees in an organization e.g. business.
177
     *
178
     * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $numberOfEmployees
179
     *
180
     * @return static
181
     *
182
     * @see http://schema.org/numberOfEmployees
183
     */
184
    public function numberOfEmployees($numberOfEmployees)
185
    {
186
        return $this->setProperty('numberOfEmployees', $numberOfEmployees);
187
    }
188
189
    /**
190
     * Indicates a potential Action, which describes an idealized action in
191
     * which this thing would play an 'object' role.
192
     *
193
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
194
     *
195
     * @return static
196
     *
197
     * @see http://schema.org/potentialAction
198
     */
199
    public function potentialAction($potentialAction)
200
    {
201
        return $this->setProperty('potentialAction', $potentialAction);
202
    }
203
204
    /**
205
     * URL of a reference Web page that unambiguously indicates the item's
206
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
207
     * official website.
208
     *
209
     * @param string|string[] $sameAs
210
     *
211
     * @return static
212
     *
213
     * @see http://schema.org/sameAs
214
     */
215
    public function sameAs($sameAs)
216
    {
217
        return $this->setProperty('sameAs', $sameAs);
218
    }
219
220
    /**
221
     * A CreativeWork or Event about this Thing.
222
     *
223
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
224
     *
225
     * @return static
226
     *
227
     * @see http://schema.org/subjectOf
228
     */
229
    public function subjectOf($subjectOf)
230
    {
231
        return $this->setProperty('subjectOf', $subjectOf);
232
    }
233
234
    /**
235
     * URL of the item.
236
     *
237
     * @param string|string[] $url
238
     *
239
     * @return static
240
     *
241
     * @see http://schema.org/url
242
     */
243
    public function url($url)
244
    {
245
        return $this->setProperty('url', $url);
246
    }
247
248
    /**
249
     * The size of the business in annual revenue.
250
     *
251
     * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $yearlyRevenue
252
     *
253
     * @return static
254
     *
255
     * @see http://schema.org/yearlyRevenue
256
     */
257
    public function yearlyRevenue($yearlyRevenue)
258
    {
259
        return $this->setProperty('yearlyRevenue', $yearlyRevenue);
260
    }
261
262
    /**
263
     * The age of the business.
264
     *
265
     * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $yearsInOperation
266
     *
267
     * @return static
268
     *
269
     * @see http://schema.org/yearsInOperation
270
     */
271
    public function yearsInOperation($yearsInOperation)
272
    {
273
        return $this->setProperty('yearsInOperation', $yearsInOperation);
274
    }
275
276
}
277

src/DataFeedItem.php 1 location

@@ 15-262 (lines=248) @@
12
 * @see http://schema.org/DataFeedItem
13
 *
14
 */
15
class DataFeedItem extends BaseType implements DataFeedItemContract, 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 date on which the CreativeWork was created or the item was added to a
52
     * DataFeed.
53
     *
54
     * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated
55
     *
56
     * @return static
57
     *
58
     * @see http://schema.org/dateCreated
59
     */
60
    public function dateCreated($dateCreated)
61
    {
62
        return $this->setProperty('dateCreated', $dateCreated);
63
    }
64
65
    /**
66
     * The datetime the item was removed from the DataFeed.
67
     *
68
     * @param \DateTimeInterface|\DateTimeInterface[] $dateDeleted
69
     *
70
     * @return static
71
     *
72
     * @see http://schema.org/dateDeleted
73
     */
74
    public function dateDeleted($dateDeleted)
75
    {
76
        return $this->setProperty('dateDeleted', $dateDeleted);
77
    }
78
79
    /**
80
     * The date on which the CreativeWork was most recently modified or when the
81
     * item's entry was modified within a DataFeed.
82
     *
83
     * @param \DateTimeInterface|\DateTimeInterface[] $dateModified
84
     *
85
     * @return static
86
     *
87
     * @see http://schema.org/dateModified
88
     */
89
    public function dateModified($dateModified)
90
    {
91
        return $this->setProperty('dateModified', $dateModified);
92
    }
93
94
    /**
95
     * A description of the item.
96
     *
97
     * @param string|string[] $description
98
     *
99
     * @return static
100
     *
101
     * @see http://schema.org/description
102
     */
103
    public function description($description)
104
    {
105
        return $this->setProperty('description', $description);
106
    }
107
108
    /**
109
     * A sub property of description. A short description of the item used to
110
     * disambiguate from other, similar items. Information from other properties
111
     * (in particular, name) may be necessary for the description to be useful
112
     * for disambiguation.
113
     *
114
     * @param string|string[] $disambiguatingDescription
115
     *
116
     * @return static
117
     *
118
     * @see http://schema.org/disambiguatingDescription
119
     */
120
    public function disambiguatingDescription($disambiguatingDescription)
121
    {
122
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
123
    }
124
125
    /**
126
     * The identifier property represents any kind of identifier for any kind of
127
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
128
     * dedicated properties for representing many of these, either as textual
129
     * strings or as URL (URI) links. See [background
130
     * notes](/docs/datamodel.html#identifierBg) for more details.
131
     *
132
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
133
     *
134
     * @return static
135
     *
136
     * @see http://schema.org/identifier
137
     */
138
    public function identifier($identifier)
139
    {
140
        return $this->setProperty('identifier', $identifier);
141
    }
142
143
    /**
144
     * An image of the item. This can be a [[URL]] or a fully described
145
     * [[ImageObject]].
146
     *
147
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
148
     *
149
     * @return static
150
     *
151
     * @see http://schema.org/image
152
     */
153
    public function image($image)
154
    {
155
        return $this->setProperty('image', $image);
156
    }
157
158
    /**
159
     * An entity represented by an entry in a list or data feed (e.g. an
160
     * 'artist' in a list of 'artists')’.
161
     *
162
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $item
163
     *
164
     * @return static
165
     *
166
     * @see http://schema.org/item
167
     */
168
    public function item($item)
169
    {
170
        return $this->setProperty('item', $item);
171
    }
172
173
    /**
174
     * Indicates a page (or other CreativeWork) for which this thing is the main
175
     * entity being described. See [background
176
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
177
     *
178
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
179
     *
180
     * @return static
181
     *
182
     * @see http://schema.org/mainEntityOfPage
183
     */
184
    public function mainEntityOfPage($mainEntityOfPage)
185
    {
186
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
187
    }
188
189
    /**
190
     * The name of the item.
191
     *
192
     * @param string|string[] $name
193
     *
194
     * @return static
195
     *
196
     * @see http://schema.org/name
197
     */
198
    public function name($name)
199
    {
200
        return $this->setProperty('name', $name);
201
    }
202
203
    /**
204
     * Indicates a potential Action, which describes an idealized action in
205
     * which this thing would play an 'object' role.
206
     *
207
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
208
     *
209
     * @return static
210
     *
211
     * @see http://schema.org/potentialAction
212
     */
213
    public function potentialAction($potentialAction)
214
    {
215
        return $this->setProperty('potentialAction', $potentialAction);
216
    }
217
218
    /**
219
     * URL of a reference Web page that unambiguously indicates the item's
220
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
221
     * official website.
222
     *
223
     * @param string|string[] $sameAs
224
     *
225
     * @return static
226
     *
227
     * @see http://schema.org/sameAs
228
     */
229
    public function sameAs($sameAs)
230
    {
231
        return $this->setProperty('sameAs', $sameAs);
232
    }
233
234
    /**
235
     * A CreativeWork or Event about this Thing.
236
     *
237
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
238
     *
239
     * @return static
240
     *
241
     * @see http://schema.org/subjectOf
242
     */
243
    public function subjectOf($subjectOf)
244
    {
245
        return $this->setProperty('subjectOf', $subjectOf);
246
    }
247
248
    /**
249
     * URL of the item.
250
     *
251
     * @param string|string[] $url
252
     *
253
     * @return static
254
     *
255
     * @see http://schema.org/url
256
     */
257
    public function url($url)
258
    {
259
        return $this->setProperty('url', $url);
260
    }
261
262
}
263

src/EducationalAudience.php 1 location

@@ 16-247 (lines=232) @@
13
 * @see http://schema.org/EducationalAudience
14
 *
15
 */
16
class EducationalAudience extends BaseType implements EducationalAudienceContract, AudienceContract, IntangibleContract, ThingContract
17
{
18
    /**
19
     * An additional type for the item, typically used for adding more specific
20
     * types from external vocabularies in microdata syntax. This is a
21
     * relationship between something and a class that the thing is in. In RDFa
22
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
23
     * attribute - for multiple types. Schema.org tools may have only weaker
24
     * understanding of extra types, in particular those defined externally.
25
     *
26
     * @param string|string[] $additionalType
27
     *
28
     * @return static
29
     *
30
     * @see http://schema.org/additionalType
31
     */
32
    public function additionalType($additionalType)
33
    {
34
        return $this->setProperty('additionalType', $additionalType);
35
    }
36
37
    /**
38
     * An alias for the item.
39
     *
40
     * @param string|string[] $alternateName
41
     *
42
     * @return static
43
     *
44
     * @see http://schema.org/alternateName
45
     */
46
    public function alternateName($alternateName)
47
    {
48
        return $this->setProperty('alternateName', $alternateName);
49
    }
50
51
    /**
52
     * The target group associated with a given audience (e.g. veterans, car
53
     * owners, musicians, etc.).
54
     *
55
     * @param string|string[] $audienceType
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/audienceType
60
     */
61
    public function audienceType($audienceType)
62
    {
63
        return $this->setProperty('audienceType', $audienceType);
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
     * An educationalRole of an EducationalAudience.
99
     *
100
     * @param string|string[] $educationalRole
101
     *
102
     * @return static
103
     *
104
     * @see http://schema.org/educationalRole
105
     */
106
    public function educationalRole($educationalRole)
107
    {
108
        return $this->setProperty('educationalRole', $educationalRole);
109
    }
110
111
    /**
112
     * The geographic area associated with the audience.
113
     *
114
     * @param \Spatie\SchemaOrg\Contracts\AdministrativeAreaContract|\Spatie\SchemaOrg\Contracts\AdministrativeAreaContract[] $geographicArea
115
     *
116
     * @return static
117
     *
118
     * @see http://schema.org/geographicArea
119
     */
120
    public function geographicArea($geographicArea)
121
    {
122
        return $this->setProperty('geographicArea', $geographicArea);
123
    }
124
125
    /**
126
     * The identifier property represents any kind of identifier for any kind of
127
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
128
     * dedicated properties for representing many of these, either as textual
129
     * strings or as URL (URI) links. See [background
130
     * notes](/docs/datamodel.html#identifierBg) for more details.
131
     *
132
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
133
     *
134
     * @return static
135
     *
136
     * @see http://schema.org/identifier
137
     */
138
    public function identifier($identifier)
139
    {
140
        return $this->setProperty('identifier', $identifier);
141
    }
142
143
    /**
144
     * An image of the item. This can be a [[URL]] or a fully described
145
     * [[ImageObject]].
146
     *
147
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
148
     *
149
     * @return static
150
     *
151
     * @see http://schema.org/image
152
     */
153
    public function image($image)
154
    {
155
        return $this->setProperty('image', $image);
156
    }
157
158
    /**
159
     * Indicates a page (or other CreativeWork) for which this thing is the main
160
     * entity being described. See [background
161
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
162
     *
163
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
164
     *
165
     * @return static
166
     *
167
     * @see http://schema.org/mainEntityOfPage
168
     */
169
    public function mainEntityOfPage($mainEntityOfPage)
170
    {
171
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
172
    }
173
174
    /**
175
     * The name of the item.
176
     *
177
     * @param string|string[] $name
178
     *
179
     * @return static
180
     *
181
     * @see http://schema.org/name
182
     */
183
    public function name($name)
184
    {
185
        return $this->setProperty('name', $name);
186
    }
187
188
    /**
189
     * Indicates a potential Action, which describes an idealized action in
190
     * which this thing would play an 'object' role.
191
     *
192
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
193
     *
194
     * @return static
195
     *
196
     * @see http://schema.org/potentialAction
197
     */
198
    public function potentialAction($potentialAction)
199
    {
200
        return $this->setProperty('potentialAction', $potentialAction);
201
    }
202
203
    /**
204
     * URL of a reference Web page that unambiguously indicates the item's
205
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
206
     * official website.
207
     *
208
     * @param string|string[] $sameAs
209
     *
210
     * @return static
211
     *
212
     * @see http://schema.org/sameAs
213
     */
214
    public function sameAs($sameAs)
215
    {
216
        return $this->setProperty('sameAs', $sameAs);
217
    }
218
219
    /**
220
     * A CreativeWork or Event about this Thing.
221
     *
222
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
223
     *
224
     * @return static
225
     *
226
     * @see http://schema.org/subjectOf
227
     */
228
    public function subjectOf($subjectOf)
229
    {
230
        return $this->setProperty('subjectOf', $subjectOf);
231
    }
232
233
    /**
234
     * URL of the item.
235
     *
236
     * @param string|string[] $url
237
     *
238
     * @return static
239
     *
240
     * @see http://schema.org/url
241
     */
242
    public function url($url)
243
    {
244
        return $this->setProperty('url', $url);
245
    }
246
247
}
248

src/EndorsementRating.php 1 location

@@ 28-298 (lines=271) @@
25
 * @see http://schema.org/EndorsementRating
26
 *
27
 */
28
class EndorsementRating extends BaseType implements EndorsementRatingContract, IntangibleContract, RatingContract, ThingContract
29
{
30
    /**
31
     * An additional type for the item, typically used for adding more specific
32
     * types from external vocabularies in microdata syntax. This is a
33
     * relationship between something and a class that the thing is in. In RDFa
34
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
35
     * attribute - for multiple types. Schema.org tools may have only weaker
36
     * understanding of extra types, in particular those defined externally.
37
     *
38
     * @param string|string[] $additionalType
39
     *
40
     * @return static
41
     *
42
     * @see http://schema.org/additionalType
43
     */
44
    public function additionalType($additionalType)
45
    {
46
        return $this->setProperty('additionalType', $additionalType);
47
    }
48
49
    /**
50
     * An alias for the item.
51
     *
52
     * @param string|string[] $alternateName
53
     *
54
     * @return static
55
     *
56
     * @see http://schema.org/alternateName
57
     */
58
    public function alternateName($alternateName)
59
    {
60
        return $this->setProperty('alternateName', $alternateName);
61
    }
62
63
    /**
64
     * The author of this content or rating. Please note that author is special
65
     * in that HTML 5 provides a special mechanism for indicating authorship via
66
     * the rel tag. That is equivalent to this and may be used interchangeably.
67
     *
68
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $author
69
     *
70
     * @return static
71
     *
72
     * @see http://schema.org/author
73
     */
74
    public function author($author)
75
    {
76
        return $this->setProperty('author', $author);
77
    }
78
79
    /**
80
     * The highest value allowed in this rating system. If bestRating is
81
     * omitted, 5 is assumed.
82
     *
83
     * @param float|float[]|int|int[]|string|string[] $bestRating
84
     *
85
     * @return static
86
     *
87
     * @see http://schema.org/bestRating
88
     */
89
    public function bestRating($bestRating)
90
    {
91
        return $this->setProperty('bestRating', $bestRating);
92
    }
93
94
    /**
95
     * A description of the item.
96
     *
97
     * @param string|string[] $description
98
     *
99
     * @return static
100
     *
101
     * @see http://schema.org/description
102
     */
103
    public function description($description)
104
    {
105
        return $this->setProperty('description', $description);
106
    }
107
108
    /**
109
     * A sub property of description. A short description of the item used to
110
     * disambiguate from other, similar items. Information from other properties
111
     * (in particular, name) may be necessary for the description to be useful
112
     * for disambiguation.
113
     *
114
     * @param string|string[] $disambiguatingDescription
115
     *
116
     * @return static
117
     *
118
     * @see http://schema.org/disambiguatingDescription
119
     */
120
    public function disambiguatingDescription($disambiguatingDescription)
121
    {
122
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
123
    }
124
125
    /**
126
     * The identifier property represents any kind of identifier for any kind of
127
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
128
     * dedicated properties for representing many of these, either as textual
129
     * strings or as URL (URI) links. See [background
130
     * notes](/docs/datamodel.html#identifierBg) for more details.
131
     *
132
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
133
     *
134
     * @return static
135
     *
136
     * @see http://schema.org/identifier
137
     */
138
    public function identifier($identifier)
139
    {
140
        return $this->setProperty('identifier', $identifier);
141
    }
142
143
    /**
144
     * An image of the item. This can be a [[URL]] or a fully described
145
     * [[ImageObject]].
146
     *
147
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
148
     *
149
     * @return static
150
     *
151
     * @see http://schema.org/image
152
     */
153
    public function image($image)
154
    {
155
        return $this->setProperty('image', $image);
156
    }
157
158
    /**
159
     * Indicates a page (or other CreativeWork) for which this thing is the main
160
     * entity being described. See [background
161
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
162
     *
163
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
164
     *
165
     * @return static
166
     *
167
     * @see http://schema.org/mainEntityOfPage
168
     */
169
    public function mainEntityOfPage($mainEntityOfPage)
170
    {
171
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
172
    }
173
174
    /**
175
     * The name of the item.
176
     *
177
     * @param string|string[] $name
178
     *
179
     * @return static
180
     *
181
     * @see http://schema.org/name
182
     */
183
    public function name($name)
184
    {
185
        return $this->setProperty('name', $name);
186
    }
187
188
    /**
189
     * Indicates a potential Action, which describes an idealized action in
190
     * which this thing would play an 'object' role.
191
     *
192
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
193
     *
194
     * @return static
195
     *
196
     * @see http://schema.org/potentialAction
197
     */
198
    public function potentialAction($potentialAction)
199
    {
200
        return $this->setProperty('potentialAction', $potentialAction);
201
    }
202
203
    /**
204
     * The rating for the content.
205
     * 
206
     * Usage guidelines:
207
     * 
208
     * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
209
     * NINE' (U+0039)) rather than superficially similiar Unicode symbols.
210
     * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
211
     * decimal point. Avoid using these symbols as a readability separator.
212
     *
213
     * @param float|float[]|int|int[]|string|string[] $ratingValue
214
     *
215
     * @return static
216
     *
217
     * @see http://schema.org/ratingValue
218
     */
219
    public function ratingValue($ratingValue)
220
    {
221
        return $this->setProperty('ratingValue', $ratingValue);
222
    }
223
224
    /**
225
     * This Review or Rating is relevant to this part or facet of the
226
     * itemReviewed.
227
     *
228
     * @param string|string[] $reviewAspect
229
     *
230
     * @return static
231
     *
232
     * @see http://schema.org/reviewAspect
233
     */
234
    public function reviewAspect($reviewAspect)
235
    {
236
        return $this->setProperty('reviewAspect', $reviewAspect);
237
    }
238
239
    /**
240
     * URL of a reference Web page that unambiguously indicates the item's
241
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
242
     * official website.
243
     *
244
     * @param string|string[] $sameAs
245
     *
246
     * @return static
247
     *
248
     * @see http://schema.org/sameAs
249
     */
250
    public function sameAs($sameAs)
251
    {
252
        return $this->setProperty('sameAs', $sameAs);
253
    }
254
255
    /**
256
     * A CreativeWork or Event about this Thing.
257
     *
258
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
259
     *
260
     * @return static
261
     *
262
     * @see http://schema.org/subjectOf
263
     */
264
    public function subjectOf($subjectOf)
265
    {
266
        return $this->setProperty('subjectOf', $subjectOf);
267
    }
268
269
    /**
270
     * URL of the item.
271
     *
272
     * @param string|string[] $url
273
     *
274
     * @return static
275
     *
276
     * @see http://schema.org/url
277
     */
278
    public function url($url)
279
    {
280
        return $this->setProperty('url', $url);
281
    }
282
283
    /**
284
     * The lowest value allowed in this rating system. If worstRating is
285
     * omitted, 1 is assumed.
286
     *
287
     * @param float|float[]|int|int[]|string|string[] $worstRating
288
     *
289
     * @return static
290
     *
291
     * @see http://schema.org/worstRating
292
     */
293
    public function worstRating($worstRating)
294
    {
295
        return $this->setProperty('worstRating', $worstRating);
296
    }
297
298
}
299

src/GameServer.php 1 location

@@ 15-245 (lines=231) @@
12
 * @see http://schema.org/GameServer
13
 *
14
 */
15
class GameServer extends BaseType implements GameServerContract, 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
     * A description of the item.
52
     *
53
     * @param string|string[] $description
54
     *
55
     * @return static
56
     *
57
     * @see http://schema.org/description
58
     */
59
    public function description($description)
60
    {
61
        return $this->setProperty('description', $description);
62
    }
63
64
    /**
65
     * A sub property of description. A short description of the item used to
66
     * disambiguate from other, similar items. Information from other properties
67
     * (in particular, name) may be necessary for the description to be useful
68
     * for disambiguation.
69
     *
70
     * @param string|string[] $disambiguatingDescription
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/disambiguatingDescription
75
     */
76
    public function disambiguatingDescription($disambiguatingDescription)
77
    {
78
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
79
    }
80
81
    /**
82
     * Video game which is played on this server.
83
     *
84
     * @param \Spatie\SchemaOrg\Contracts\VideoGameContract|\Spatie\SchemaOrg\Contracts\VideoGameContract[] $game
85
     *
86
     * @return static
87
     *
88
     * @see http://schema.org/game
89
     */
90
    public function game($game)
91
    {
92
        return $this->setProperty('game', $game);
93
    }
94
95
    /**
96
     * The identifier property represents any kind of identifier for any kind of
97
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
98
     * dedicated properties for representing many of these, either as textual
99
     * strings or as URL (URI) links. See [background
100
     * notes](/docs/datamodel.html#identifierBg) for more details.
101
     *
102
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
103
     *
104
     * @return static
105
     *
106
     * @see http://schema.org/identifier
107
     */
108
    public function identifier($identifier)
109
    {
110
        return $this->setProperty('identifier', $identifier);
111
    }
112
113
    /**
114
     * An image of the item. This can be a [[URL]] or a fully described
115
     * [[ImageObject]].
116
     *
117
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
118
     *
119
     * @return static
120
     *
121
     * @see http://schema.org/image
122
     */
123
    public function image($image)
124
    {
125
        return $this->setProperty('image', $image);
126
    }
127
128
    /**
129
     * Indicates a page (or other CreativeWork) for which this thing is the main
130
     * entity being described. See [background
131
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
132
     *
133
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
134
     *
135
     * @return static
136
     *
137
     * @see http://schema.org/mainEntityOfPage
138
     */
139
    public function mainEntityOfPage($mainEntityOfPage)
140
    {
141
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
142
    }
143
144
    /**
145
     * The name of the item.
146
     *
147
     * @param string|string[] $name
148
     *
149
     * @return static
150
     *
151
     * @see http://schema.org/name
152
     */
153
    public function name($name)
154
    {
155
        return $this->setProperty('name', $name);
156
    }
157
158
    /**
159
     * Number of players on the server.
160
     *
161
     * @param int|int[] $playersOnline
162
     *
163
     * @return static
164
     *
165
     * @see http://schema.org/playersOnline
166
     */
167
    public function playersOnline($playersOnline)
168
    {
169
        return $this->setProperty('playersOnline', $playersOnline);
170
    }
171
172
    /**
173
     * Indicates a potential Action, which describes an idealized action in
174
     * which this thing would play an 'object' role.
175
     *
176
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
177
     *
178
     * @return static
179
     *
180
     * @see http://schema.org/potentialAction
181
     */
182
    public function potentialAction($potentialAction)
183
    {
184
        return $this->setProperty('potentialAction', $potentialAction);
185
    }
186
187
    /**
188
     * URL of a reference Web page that unambiguously indicates the item's
189
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
190
     * official website.
191
     *
192
     * @param string|string[] $sameAs
193
     *
194
     * @return static
195
     *
196
     * @see http://schema.org/sameAs
197
     */
198
    public function sameAs($sameAs)
199
    {
200
        return $this->setProperty('sameAs', $sameAs);
201
    }
202
203
    /**
204
     * Status of a game server.
205
     *
206
     * @param \Spatie\SchemaOrg\Contracts\GameServerStatusContract|\Spatie\SchemaOrg\Contracts\GameServerStatusContract[] $serverStatus
207
     *
208
     * @return static
209
     *
210
     * @see http://schema.org/serverStatus
211
     */
212
    public function serverStatus($serverStatus)
213
    {
214
        return $this->setProperty('serverStatus', $serverStatus);
215
    }
216
217
    /**
218
     * A CreativeWork or Event about this Thing.
219
     *
220
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
221
     *
222
     * @return static
223
     *
224
     * @see http://schema.org/subjectOf
225
     */
226
    public function subjectOf($subjectOf)
227
    {
228
        return $this->setProperty('subjectOf', $subjectOf);
229
    }
230
231
    /**
232
     * URL of the item.
233
     *
234
     * @param string|string[] $url
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/url
239
     */
240
    public function url($url)
241
    {
242
        return $this->setProperty('url', $url);
243
    }
244
245
}
246

src/HowToItem.php 1 location

@@ 17-276 (lines=260) @@
14
 * @see http://schema.org/HowToItem
15
 *
16
 */
17
class HowToItem extends BaseType implements HowToItemContract, IntangibleContract, ListItemContract, 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
     * A description of the item.
54
     *
55
     * @param string|string[] $description
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/description
60
     */
61
    public function description($description)
62
    {
63
        return $this->setProperty('description', $description);
64
    }
65
66
    /**
67
     * A sub property of description. A short description of the item used to
68
     * disambiguate from other, similar items. Information from other properties
69
     * (in particular, name) may be necessary for the description to be useful
70
     * for disambiguation.
71
     *
72
     * @param string|string[] $disambiguatingDescription
73
     *
74
     * @return static
75
     *
76
     * @see http://schema.org/disambiguatingDescription
77
     */
78
    public function disambiguatingDescription($disambiguatingDescription)
79
    {
80
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
81
    }
82
83
    /**
84
     * The identifier property represents any kind of identifier for any kind of
85
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
86
     * dedicated properties for representing many of these, either as textual
87
     * strings or as URL (URI) links. See [background
88
     * notes](/docs/datamodel.html#identifierBg) for more details.
89
     *
90
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
91
     *
92
     * @return static
93
     *
94
     * @see http://schema.org/identifier
95
     */
96
    public function identifier($identifier)
97
    {
98
        return $this->setProperty('identifier', $identifier);
99
    }
100
101
    /**
102
     * An image of the item. This can be a [[URL]] or a fully described
103
     * [[ImageObject]].
104
     *
105
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
106
     *
107
     * @return static
108
     *
109
     * @see http://schema.org/image
110
     */
111
    public function image($image)
112
    {
113
        return $this->setProperty('image', $image);
114
    }
115
116
    /**
117
     * An entity represented by an entry in a list or data feed (e.g. an
118
     * 'artist' in a list of 'artists')’.
119
     *
120
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $item
121
     *
122
     * @return static
123
     *
124
     * @see http://schema.org/item
125
     */
126
    public function item($item)
127
    {
128
        return $this->setProperty('item', $item);
129
    }
130
131
    /**
132
     * Indicates a page (or other CreativeWork) for which this thing is the main
133
     * entity being described. See [background
134
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
135
     *
136
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
137
     *
138
     * @return static
139
     *
140
     * @see http://schema.org/mainEntityOfPage
141
     */
142
    public function mainEntityOfPage($mainEntityOfPage)
143
    {
144
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
145
    }
146
147
    /**
148
     * The name of the item.
149
     *
150
     * @param string|string[] $name
151
     *
152
     * @return static
153
     *
154
     * @see http://schema.org/name
155
     */
156
    public function name($name)
157
    {
158
        return $this->setProperty('name', $name);
159
    }
160
161
    /**
162
     * A link to the ListItem that follows the current one.
163
     *
164
     * @param \Spatie\SchemaOrg\Contracts\ListItemContract|\Spatie\SchemaOrg\Contracts\ListItemContract[] $nextItem
165
     *
166
     * @return static
167
     *
168
     * @see http://schema.org/nextItem
169
     */
170
    public function nextItem($nextItem)
171
    {
172
        return $this->setProperty('nextItem', $nextItem);
173
    }
174
175
    /**
176
     * The position of an item in a series or sequence of items.
177
     *
178
     * @param int|int[]|string|string[] $position
179
     *
180
     * @return static
181
     *
182
     * @see http://schema.org/position
183
     */
184
    public function position($position)
185
    {
186
        return $this->setProperty('position', $position);
187
    }
188
189
    /**
190
     * Indicates a potential Action, which describes an idealized action in
191
     * which this thing would play an 'object' role.
192
     *
193
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
194
     *
195
     * @return static
196
     *
197
     * @see http://schema.org/potentialAction
198
     */
199
    public function potentialAction($potentialAction)
200
    {
201
        return $this->setProperty('potentialAction', $potentialAction);
202
    }
203
204
    /**
205
     * A link to the ListItem that preceeds the current one.
206
     *
207
     * @param \Spatie\SchemaOrg\Contracts\ListItemContract|\Spatie\SchemaOrg\Contracts\ListItemContract[] $previousItem
208
     *
209
     * @return static
210
     *
211
     * @see http://schema.org/previousItem
212
     */
213
    public function previousItem($previousItem)
214
    {
215
        return $this->setProperty('previousItem', $previousItem);
216
    }
217
218
    /**
219
     * The required quantity of the item(s).
220
     *
221
     * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|float|float[]|int|int[]|string|string[] $requiredQuantity
222
     *
223
     * @return static
224
     *
225
     * @see http://schema.org/requiredQuantity
226
     */
227
    public function requiredQuantity($requiredQuantity)
228
    {
229
        return $this->setProperty('requiredQuantity', $requiredQuantity);
230
    }
231
232
    /**
233
     * URL of a reference Web page that unambiguously indicates the item's
234
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
235
     * official website.
236
     *
237
     * @param string|string[] $sameAs
238
     *
239
     * @return static
240
     *
241
     * @see http://schema.org/sameAs
242
     */
243
    public function sameAs($sameAs)
244
    {
245
        return $this->setProperty('sameAs', $sameAs);
246
    }
247
248
    /**
249
     * A CreativeWork or Event about this Thing.
250
     *
251
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
252
     *
253
     * @return static
254
     *
255
     * @see http://schema.org/subjectOf
256
     */
257
    public function subjectOf($subjectOf)
258
    {
259
        return $this->setProperty('subjectOf', $subjectOf);
260
    }
261
262
    /**
263
     * URL of the item.
264
     *
265
     * @param string|string[] $url
266
     *
267
     * @return static
268
     *
269
     * @see http://schema.org/url
270
     */
271
    public function url($url)
272
    {
273
        return $this->setProperty('url', $url);
274
    }
275
276
}
277

src/HowToTool.php 1 location

@@ 18-277 (lines=260) @@
15
 * @see http://schema.org/HowToTool
16
 *
17
 */
18
class HowToTool extends BaseType implements HowToToolContract, HowToItemContract, IntangibleContract, ListItemContract, 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
     * A description of the item.
55
     *
56
     * @param string|string[] $description
57
     *
58
     * @return static
59
     *
60
     * @see http://schema.org/description
61
     */
62
    public function description($description)
63
    {
64
        return $this->setProperty('description', $description);
65
    }
66
67
    /**
68
     * A sub property of description. A short description of the item used to
69
     * disambiguate from other, similar items. Information from other properties
70
     * (in particular, name) may be necessary for the description to be useful
71
     * for disambiguation.
72
     *
73
     * @param string|string[] $disambiguatingDescription
74
     *
75
     * @return static
76
     *
77
     * @see http://schema.org/disambiguatingDescription
78
     */
79
    public function disambiguatingDescription($disambiguatingDescription)
80
    {
81
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
82
    }
83
84
    /**
85
     * The identifier property represents any kind of identifier for any kind of
86
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
87
     * dedicated properties for representing many of these, either as textual
88
     * strings or as URL (URI) links. See [background
89
     * notes](/docs/datamodel.html#identifierBg) for more details.
90
     *
91
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
92
     *
93
     * @return static
94
     *
95
     * @see http://schema.org/identifier
96
     */
97
    public function identifier($identifier)
98
    {
99
        return $this->setProperty('identifier', $identifier);
100
    }
101
102
    /**
103
     * An image of the item. This can be a [[URL]] or a fully described
104
     * [[ImageObject]].
105
     *
106
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
107
     *
108
     * @return static
109
     *
110
     * @see http://schema.org/image
111
     */
112
    public function image($image)
113
    {
114
        return $this->setProperty('image', $image);
115
    }
116
117
    /**
118
     * An entity represented by an entry in a list or data feed (e.g. an
119
     * 'artist' in a list of 'artists')’.
120
     *
121
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $item
122
     *
123
     * @return static
124
     *
125
     * @see http://schema.org/item
126
     */
127
    public function item($item)
128
    {
129
        return $this->setProperty('item', $item);
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 name of the item.
150
     *
151
     * @param string|string[] $name
152
     *
153
     * @return static
154
     *
155
     * @see http://schema.org/name
156
     */
157
    public function name($name)
158
    {
159
        return $this->setProperty('name', $name);
160
    }
161
162
    /**
163
     * A link to the ListItem that follows the current one.
164
     *
165
     * @param \Spatie\SchemaOrg\Contracts\ListItemContract|\Spatie\SchemaOrg\Contracts\ListItemContract[] $nextItem
166
     *
167
     * @return static
168
     *
169
     * @see http://schema.org/nextItem
170
     */
171
    public function nextItem($nextItem)
172
    {
173
        return $this->setProperty('nextItem', $nextItem);
174
    }
175
176
    /**
177
     * The position of an item in a series or sequence of items.
178
     *
179
     * @param int|int[]|string|string[] $position
180
     *
181
     * @return static
182
     *
183
     * @see http://schema.org/position
184
     */
185
    public function position($position)
186
    {
187
        return $this->setProperty('position', $position);
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 link to the ListItem that preceeds the current one.
207
     *
208
     * @param \Spatie\SchemaOrg\Contracts\ListItemContract|\Spatie\SchemaOrg\Contracts\ListItemContract[] $previousItem
209
     *
210
     * @return static
211
     *
212
     * @see http://schema.org/previousItem
213
     */
214
    public function previousItem($previousItem)
215
    {
216
        return $this->setProperty('previousItem', $previousItem);
217
    }
218
219
    /**
220
     * The required quantity of the item(s).
221
     *
222
     * @param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[]|float|float[]|int|int[]|string|string[] $requiredQuantity
223
     *
224
     * @return static
225
     *
226
     * @see http://schema.org/requiredQuantity
227
     */
228
    public function requiredQuantity($requiredQuantity)
229
    {
230
        return $this->setProperty('requiredQuantity', $requiredQuantity);
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
     * A CreativeWork or Event about this Thing.
251
     *
252
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
253
     *
254
     * @return static
255
     *
256
     * @see http://schema.org/subjectOf
257
     */
258
    public function subjectOf($subjectOf)
259
    {
260
        return $this->setProperty('subjectOf', $subjectOf);
261
    }
262
263
    /**
264
     * URL of the item.
265
     *
266
     * @param string|string[] $url
267
     *
268
     * @return static
269
     *
270
     * @see http://schema.org/url
271
     */
272
    public function url($url)
273
    {
274
        return $this->setProperty('url', $url);
275
    }
276
277
}
278

src/ItemList.php 1 location

@@ 17-260 (lines=244) @@
14
 * @see http://schema.org/ItemList
15
 *
16
 */
17
class ItemList extends BaseType implements ItemListContract, IntangibleContract, ThingContract
18
{
19
    /**
20
     * An additional type for the item, typically used for adding more specific
21
     * types from external vocabularies in microdata syntax. This is a
22
     * relationship between something and a class that the thing is in. In RDFa
23
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
24
     * attribute - for multiple types. Schema.org tools may have only weaker
25
     * understanding of extra types, in particular those defined externally.
26
     *
27
     * @param string|string[] $additionalType
28
     *
29
     * @return static
30
     *
31
     * @see http://schema.org/additionalType
32
     */
33
    public function additionalType($additionalType)
34
    {
35
        return $this->setProperty('additionalType', $additionalType);
36
    }
37
38
    /**
39
     * An alias for the item.
40
     *
41
     * @param string|string[] $alternateName
42
     *
43
     * @return static
44
     *
45
     * @see http://schema.org/alternateName
46
     */
47
    public function alternateName($alternateName)
48
    {
49
        return $this->setProperty('alternateName', $alternateName);
50
    }
51
52
    /**
53
     * A description of the item.
54
     *
55
     * @param string|string[] $description
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/description
60
     */
61
    public function description($description)
62
    {
63
        return $this->setProperty('description', $description);
64
    }
65
66
    /**
67
     * A sub property of description. A short description of the item used to
68
     * disambiguate from other, similar items. Information from other properties
69
     * (in particular, name) may be necessary for the description to be useful
70
     * for disambiguation.
71
     *
72
     * @param string|string[] $disambiguatingDescription
73
     *
74
     * @return static
75
     *
76
     * @see http://schema.org/disambiguatingDescription
77
     */
78
    public function disambiguatingDescription($disambiguatingDescription)
79
    {
80
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
81
    }
82
83
    /**
84
     * The identifier property represents any kind of identifier for any kind of
85
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
86
     * dedicated properties for representing many of these, either as textual
87
     * strings or as URL (URI) links. See [background
88
     * notes](/docs/datamodel.html#identifierBg) for more details.
89
     *
90
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
91
     *
92
     * @return static
93
     *
94
     * @see http://schema.org/identifier
95
     */
96
    public function identifier($identifier)
97
    {
98
        return $this->setProperty('identifier', $identifier);
99
    }
100
101
    /**
102
     * An image of the item. This can be a [[URL]] or a fully described
103
     * [[ImageObject]].
104
     *
105
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
106
     *
107
     * @return static
108
     *
109
     * @see http://schema.org/image
110
     */
111
    public function image($image)
112
    {
113
        return $this->setProperty('image', $image);
114
    }
115
116
    /**
117
     * For itemListElement values, you can use simple strings (e.g. "Peter",
118
     * "Paul", "Mary"), existing entities, or use ListItem.
119
     * 
120
     * Text values are best if the elements in the list are plain strings.
121
     * Existing entities are best for a simple, unordered list of existing
122
     * things in your data. ListItem is used with ordered lists when you want to
123
     * provide additional context about the element in that list or when the
124
     * same item might be in different places in different lists.
125
     * 
126
     * Note: The order of elements in your mark-up is not sufficient for
127
     * indicating the order or elements.  Use ListItem with a 'position'
128
     * property in such cases.
129
     *
130
     * @param \Spatie\SchemaOrg\Contracts\ListItemContract|\Spatie\SchemaOrg\Contracts\ListItemContract[]|\Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $itemListElement
131
     *
132
     * @return static
133
     *
134
     * @see http://schema.org/itemListElement
135
     */
136
    public function itemListElement($itemListElement)
137
    {
138
        return $this->setProperty('itemListElement', $itemListElement);
139
    }
140
141
    /**
142
     * Type of ordering (e.g. Ascending, Descending, Unordered).
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\ItemListOrderTypeContract|\Spatie\SchemaOrg\Contracts\ItemListOrderTypeContract[]|string|string[] $itemListOrder
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/itemListOrder
149
     */
150
    public function itemListOrder($itemListOrder)
151
    {
152
        return $this->setProperty('itemListOrder', $itemListOrder);
153
    }
154
155
    /**
156
     * Indicates a page (or other CreativeWork) for which this thing is the main
157
     * entity being described. See [background
158
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
159
     *
160
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
161
     *
162
     * @return static
163
     *
164
     * @see http://schema.org/mainEntityOfPage
165
     */
166
    public function mainEntityOfPage($mainEntityOfPage)
167
    {
168
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
169
    }
170
171
    /**
172
     * The name of the item.
173
     *
174
     * @param string|string[] $name
175
     *
176
     * @return static
177
     *
178
     * @see http://schema.org/name
179
     */
180
    public function name($name)
181
    {
182
        return $this->setProperty('name', $name);
183
    }
184
185
    /**
186
     * The number of items in an ItemList. Note that some descriptions might not
187
     * fully describe all items in a list (e.g., multi-page pagination); in such
188
     * cases, the numberOfItems would be for the entire list.
189
     *
190
     * @param int|int[] $numberOfItems
191
     *
192
     * @return static
193
     *
194
     * @see http://schema.org/numberOfItems
195
     */
196
    public function numberOfItems($numberOfItems)
197
    {
198
        return $this->setProperty('numberOfItems', $numberOfItems);
199
    }
200
201
    /**
202
     * Indicates a potential Action, which describes an idealized action in
203
     * which this thing would play an 'object' role.
204
     *
205
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/potentialAction
210
     */
211
    public function potentialAction($potentialAction)
212
    {
213
        return $this->setProperty('potentialAction', $potentialAction);
214
    }
215
216
    /**
217
     * URL of a reference Web page that unambiguously indicates the item's
218
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
219
     * official website.
220
     *
221
     * @param string|string[] $sameAs
222
     *
223
     * @return static
224
     *
225
     * @see http://schema.org/sameAs
226
     */
227
    public function sameAs($sameAs)
228
    {
229
        return $this->setProperty('sameAs', $sameAs);
230
    }
231
232
    /**
233
     * A CreativeWork or Event about this Thing.
234
     *
235
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
236
     *
237
     * @return static
238
     *
239
     * @see http://schema.org/subjectOf
240
     */
241
    public function subjectOf($subjectOf)
242
    {
243
        return $this->setProperty('subjectOf', $subjectOf);
244
    }
245
246
    /**
247
     * URL of the item.
248
     *
249
     * @param string|string[] $url
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/url
254
     */
255
    public function url($url)
256
    {
257
        return $this->setProperty('url', $url);
258
    }
259
260
}
261

src/ListItem.php 1 location

@@ 15-260 (lines=246) @@
12
 * @see http://schema.org/ListItem
13
 *
14
 */
15
class ListItem extends BaseType implements ListItemContract, 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
     * A description of the item.
52
     *
53
     * @param string|string[] $description
54
     *
55
     * @return static
56
     *
57
     * @see http://schema.org/description
58
     */
59
    public function description($description)
60
    {
61
        return $this->setProperty('description', $description);
62
    }
63
64
    /**
65
     * A sub property of description. A short description of the item used to
66
     * disambiguate from other, similar items. Information from other properties
67
     * (in particular, name) may be necessary for the description to be useful
68
     * for disambiguation.
69
     *
70
     * @param string|string[] $disambiguatingDescription
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/disambiguatingDescription
75
     */
76
    public function disambiguatingDescription($disambiguatingDescription)
77
    {
78
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
79
    }
80
81
    /**
82
     * The identifier property represents any kind of identifier for any kind of
83
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
84
     * dedicated properties for representing many of these, either as textual
85
     * strings or as URL (URI) links. See [background
86
     * notes](/docs/datamodel.html#identifierBg) for more details.
87
     *
88
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
89
     *
90
     * @return static
91
     *
92
     * @see http://schema.org/identifier
93
     */
94
    public function identifier($identifier)
95
    {
96
        return $this->setProperty('identifier', $identifier);
97
    }
98
99
    /**
100
     * An image of the item. This can be a [[URL]] or a fully described
101
     * [[ImageObject]].
102
     *
103
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
104
     *
105
     * @return static
106
     *
107
     * @see http://schema.org/image
108
     */
109
    public function image($image)
110
    {
111
        return $this->setProperty('image', $image);
112
    }
113
114
    /**
115
     * An entity represented by an entry in a list or data feed (e.g. an
116
     * 'artist' in a list of 'artists')’.
117
     *
118
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $item
119
     *
120
     * @return static
121
     *
122
     * @see http://schema.org/item
123
     */
124
    public function item($item)
125
    {
126
        return $this->setProperty('item', $item);
127
    }
128
129
    /**
130
     * Indicates a page (or other CreativeWork) for which this thing is the main
131
     * entity being described. See [background
132
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
133
     *
134
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/mainEntityOfPage
139
     */
140
    public function mainEntityOfPage($mainEntityOfPage)
141
    {
142
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
143
    }
144
145
    /**
146
     * The name of the item.
147
     *
148
     * @param string|string[] $name
149
     *
150
     * @return static
151
     *
152
     * @see http://schema.org/name
153
     */
154
    public function name($name)
155
    {
156
        return $this->setProperty('name', $name);
157
    }
158
159
    /**
160
     * A link to the ListItem that follows the current one.
161
     *
162
     * @param \Spatie\SchemaOrg\Contracts\ListItemContract|\Spatie\SchemaOrg\Contracts\ListItemContract[] $nextItem
163
     *
164
     * @return static
165
     *
166
     * @see http://schema.org/nextItem
167
     */
168
    public function nextItem($nextItem)
169
    {
170
        return $this->setProperty('nextItem', $nextItem);
171
    }
172
173
    /**
174
     * The position of an item in a series or sequence of items.
175
     *
176
     * @param int|int[]|string|string[] $position
177
     *
178
     * @return static
179
     *
180
     * @see http://schema.org/position
181
     */
182
    public function position($position)
183
    {
184
        return $this->setProperty('position', $position);
185
    }
186
187
    /**
188
     * Indicates a potential Action, which describes an idealized action in
189
     * which this thing would play an 'object' role.
190
     *
191
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
192
     *
193
     * @return static
194
     *
195
     * @see http://schema.org/potentialAction
196
     */
197
    public function potentialAction($potentialAction)
198
    {
199
        return $this->setProperty('potentialAction', $potentialAction);
200
    }
201
202
    /**
203
     * A link to the ListItem that preceeds the current one.
204
     *
205
     * @param \Spatie\SchemaOrg\Contracts\ListItemContract|\Spatie\SchemaOrg\Contracts\ListItemContract[] $previousItem
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/previousItem
210
     */
211
    public function previousItem($previousItem)
212
    {
213
        return $this->setProperty('previousItem', $previousItem);
214
    }
215
216
    /**
217
     * URL of a reference Web page that unambiguously indicates the item's
218
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
219
     * official website.
220
     *
221
     * @param string|string[] $sameAs
222
     *
223
     * @return static
224
     *
225
     * @see http://schema.org/sameAs
226
     */
227
    public function sameAs($sameAs)
228
    {
229
        return $this->setProperty('sameAs', $sameAs);
230
    }
231
232
    /**
233
     * A CreativeWork or Event about this Thing.
234
     *
235
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
236
     *
237
     * @return static
238
     *
239
     * @see http://schema.org/subjectOf
240
     */
241
    public function subjectOf($subjectOf)
242
    {
243
        return $this->setProperty('subjectOf', $subjectOf);
244
    }
245
246
    /**
247
     * URL of the item.
248
     *
249
     * @param string|string[] $url
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/url
254
     */
255
    public function url($url)
256
    {
257
        return $this->setProperty('url', $url);
258
    }
259
260
}
261

src/MonetaryAmount.php 1 location

@@ 20-281 (lines=262) @@
17
 * @see http://schema.org/MonetaryAmount
18
 *
19
 */
20
class MonetaryAmount extends BaseType implements MonetaryAmountContract, IntangibleContract, 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
     * The currency in which the monetary amount is expressed.
57
     * 
58
     * Use standard formats: [ISO 4217 currency
59
     * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker
60
     * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for
61
     * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange
62
     * Tradings
63
     * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)
64
     * (LETS) and other currency types e.g. "Ithaca HOUR".
65
     *
66
     * @param string|string[] $currency
67
     *
68
     * @return static
69
     *
70
     * @see http://schema.org/currency
71
     */
72
    public function currency($currency)
73
    {
74
        return $this->setProperty('currency', $currency);
75
    }
76
77
    /**
78
     * A description of the item.
79
     *
80
     * @param string|string[] $description
81
     *
82
     * @return static
83
     *
84
     * @see http://schema.org/description
85
     */
86
    public function description($description)
87
    {
88
        return $this->setProperty('description', $description);
89
    }
90
91
    /**
92
     * A sub property of description. A short description of the item used to
93
     * disambiguate from other, similar items. Information from other properties
94
     * (in particular, name) may be necessary for the description to be useful
95
     * for disambiguation.
96
     *
97
     * @param string|string[] $disambiguatingDescription
98
     *
99
     * @return static
100
     *
101
     * @see http://schema.org/disambiguatingDescription
102
     */
103
    public function disambiguatingDescription($disambiguatingDescription)
104
    {
105
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
106
    }
107
108
    /**
109
     * The identifier property represents any kind of identifier for any kind of
110
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
111
     * dedicated properties for representing many of these, either as textual
112
     * strings or as URL (URI) links. See [background
113
     * notes](/docs/datamodel.html#identifierBg) for more details.
114
     *
115
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
116
     *
117
     * @return static
118
     *
119
     * @see http://schema.org/identifier
120
     */
121
    public function identifier($identifier)
122
    {
123
        return $this->setProperty('identifier', $identifier);
124
    }
125
126
    /**
127
     * An image of the item. This can be a [[URL]] or a fully described
128
     * [[ImageObject]].
129
     *
130
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
131
     *
132
     * @return static
133
     *
134
     * @see http://schema.org/image
135
     */
136
    public function image($image)
137
    {
138
        return $this->setProperty('image', $image);
139
    }
140
141
    /**
142
     * Indicates a page (or other CreativeWork) for which this thing is the main
143
     * entity being described. See [background
144
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
145
     *
146
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
147
     *
148
     * @return static
149
     *
150
     * @see http://schema.org/mainEntityOfPage
151
     */
152
    public function mainEntityOfPage($mainEntityOfPage)
153
    {
154
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
155
    }
156
157
    /**
158
     * The upper value of some characteristic or property.
159
     *
160
     * @param float|float[]|int|int[] $maxValue
161
     *
162
     * @return static
163
     *
164
     * @see http://schema.org/maxValue
165
     */
166
    public function maxValue($maxValue)
167
    {
168
        return $this->setProperty('maxValue', $maxValue);
169
    }
170
171
    /**
172
     * The lower value of some characteristic or property.
173
     *
174
     * @param float|float[]|int|int[] $minValue
175
     *
176
     * @return static
177
     *
178
     * @see http://schema.org/minValue
179
     */
180
    public function minValue($minValue)
181
    {
182
        return $this->setProperty('minValue', $minValue);
183
    }
184
185
    /**
186
     * The name of the item.
187
     *
188
     * @param string|string[] $name
189
     *
190
     * @return static
191
     *
192
     * @see http://schema.org/name
193
     */
194
    public function name($name)
195
    {
196
        return $this->setProperty('name', $name);
197
    }
198
199
    /**
200
     * Indicates a potential Action, which describes an idealized action in
201
     * which this thing would play an 'object' role.
202
     *
203
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/potentialAction
208
     */
209
    public function potentialAction($potentialAction)
210
    {
211
        return $this->setProperty('potentialAction', $potentialAction);
212
    }
213
214
    /**
215
     * URL of a reference Web page that unambiguously indicates the item's
216
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
217
     * official website.
218
     *
219
     * @param string|string[] $sameAs
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/sameAs
224
     */
225
    public function sameAs($sameAs)
226
    {
227
        return $this->setProperty('sameAs', $sameAs);
228
    }
229
230
    /**
231
     * A CreativeWork or Event about this Thing.
232
     *
233
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
234
     *
235
     * @return static
236
     *
237
     * @see http://schema.org/subjectOf
238
     */
239
    public function subjectOf($subjectOf)
240
    {
241
        return $this->setProperty('subjectOf', $subjectOf);
242
    }
243
244
    /**
245
     * URL of the item.
246
     *
247
     * @param string|string[] $url
248
     *
249
     * @return static
250
     *
251
     * @see http://schema.org/url
252
     */
253
    public function url($url)
254
    {
255
        return $this->setProperty('url', $url);
256
    }
257
258
    /**
259
     * The value of the quantitative value or property value node.
260
     * 
261
     * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type
262
     * for values is 'Number'.
263
     * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or
264
     * 'StructuredValue'.
265
     * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
266
     * NINE' (U+0039)) rather than superficially similiar Unicode symbols.
267
     * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
268
     * decimal point. Avoid using these symbols as a readability separator.
269
     *
270
     * @param \Spatie\SchemaOrg\Contracts\StructuredValueContract|\Spatie\SchemaOrg\Contracts\StructuredValueContract[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value
271
     *
272
     * @return static
273
     *
274
     * @see http://schema.org/value
275
     */
276
    public function value($value)
277
    {
278
        return $this->setProperty('value', $value);
279
    }
280
281
}
282

src/OfferCatalog.php 1 location

@@ 17-260 (lines=244) @@
14
 * @see http://schema.org/OfferCatalog
15
 *
16
 */
17
class OfferCatalog extends BaseType implements OfferCatalogContract, IntangibleContract, ItemListContract, 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
     * A description of the item.
54
     *
55
     * @param string|string[] $description
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/description
60
     */
61
    public function description($description)
62
    {
63
        return $this->setProperty('description', $description);
64
    }
65
66
    /**
67
     * A sub property of description. A short description of the item used to
68
     * disambiguate from other, similar items. Information from other properties
69
     * (in particular, name) may be necessary for the description to be useful
70
     * for disambiguation.
71
     *
72
     * @param string|string[] $disambiguatingDescription
73
     *
74
     * @return static
75
     *
76
     * @see http://schema.org/disambiguatingDescription
77
     */
78
    public function disambiguatingDescription($disambiguatingDescription)
79
    {
80
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
81
    }
82
83
    /**
84
     * The identifier property represents any kind of identifier for any kind of
85
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
86
     * dedicated properties for representing many of these, either as textual
87
     * strings or as URL (URI) links. See [background
88
     * notes](/docs/datamodel.html#identifierBg) for more details.
89
     *
90
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
91
     *
92
     * @return static
93
     *
94
     * @see http://schema.org/identifier
95
     */
96
    public function identifier($identifier)
97
    {
98
        return $this->setProperty('identifier', $identifier);
99
    }
100
101
    /**
102
     * An image of the item. This can be a [[URL]] or a fully described
103
     * [[ImageObject]].
104
     *
105
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
106
     *
107
     * @return static
108
     *
109
     * @see http://schema.org/image
110
     */
111
    public function image($image)
112
    {
113
        return $this->setProperty('image', $image);
114
    }
115
116
    /**
117
     * For itemListElement values, you can use simple strings (e.g. "Peter",
118
     * "Paul", "Mary"), existing entities, or use ListItem.
119
     * 
120
     * Text values are best if the elements in the list are plain strings.
121
     * Existing entities are best for a simple, unordered list of existing
122
     * things in your data. ListItem is used with ordered lists when you want to
123
     * provide additional context about the element in that list or when the
124
     * same item might be in different places in different lists.
125
     * 
126
     * Note: The order of elements in your mark-up is not sufficient for
127
     * indicating the order or elements.  Use ListItem with a 'position'
128
     * property in such cases.
129
     *
130
     * @param \Spatie\SchemaOrg\Contracts\ListItemContract|\Spatie\SchemaOrg\Contracts\ListItemContract[]|\Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $itemListElement
131
     *
132
     * @return static
133
     *
134
     * @see http://schema.org/itemListElement
135
     */
136
    public function itemListElement($itemListElement)
137
    {
138
        return $this->setProperty('itemListElement', $itemListElement);
139
    }
140
141
    /**
142
     * Type of ordering (e.g. Ascending, Descending, Unordered).
143
     *
144
     * @param \Spatie\SchemaOrg\Contracts\ItemListOrderTypeContract|\Spatie\SchemaOrg\Contracts\ItemListOrderTypeContract[]|string|string[] $itemListOrder
145
     *
146
     * @return static
147
     *
148
     * @see http://schema.org/itemListOrder
149
     */
150
    public function itemListOrder($itemListOrder)
151
    {
152
        return $this->setProperty('itemListOrder', $itemListOrder);
153
    }
154
155
    /**
156
     * Indicates a page (or other CreativeWork) for which this thing is the main
157
     * entity being described. See [background
158
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
159
     *
160
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
161
     *
162
     * @return static
163
     *
164
     * @see http://schema.org/mainEntityOfPage
165
     */
166
    public function mainEntityOfPage($mainEntityOfPage)
167
    {
168
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
169
    }
170
171
    /**
172
     * The name of the item.
173
     *
174
     * @param string|string[] $name
175
     *
176
     * @return static
177
     *
178
     * @see http://schema.org/name
179
     */
180
    public function name($name)
181
    {
182
        return $this->setProperty('name', $name);
183
    }
184
185
    /**
186
     * The number of items in an ItemList. Note that some descriptions might not
187
     * fully describe all items in a list (e.g., multi-page pagination); in such
188
     * cases, the numberOfItems would be for the entire list.
189
     *
190
     * @param int|int[] $numberOfItems
191
     *
192
     * @return static
193
     *
194
     * @see http://schema.org/numberOfItems
195
     */
196
    public function numberOfItems($numberOfItems)
197
    {
198
        return $this->setProperty('numberOfItems', $numberOfItems);
199
    }
200
201
    /**
202
     * Indicates a potential Action, which describes an idealized action in
203
     * which this thing would play an 'object' role.
204
     *
205
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/potentialAction
210
     */
211
    public function potentialAction($potentialAction)
212
    {
213
        return $this->setProperty('potentialAction', $potentialAction);
214
    }
215
216
    /**
217
     * URL of a reference Web page that unambiguously indicates the item's
218
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
219
     * official website.
220
     *
221
     * @param string|string[] $sameAs
222
     *
223
     * @return static
224
     *
225
     * @see http://schema.org/sameAs
226
     */
227
    public function sameAs($sameAs)
228
    {
229
        return $this->setProperty('sameAs', $sameAs);
230
    }
231
232
    /**
233
     * A CreativeWork or Event about this Thing.
234
     *
235
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
236
     *
237
     * @return static
238
     *
239
     * @see http://schema.org/subjectOf
240
     */
241
    public function subjectOf($subjectOf)
242
    {
243
        return $this->setProperty('subjectOf', $subjectOf);
244
    }
245
246
    /**
247
     * URL of the item.
248
     *
249
     * @param string|string[] $url
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/url
254
     */
255
    public function url($url)
256
    {
257
        return $this->setProperty('url', $url);
258
    }
259
260
}
261

src/OpeningHoursSpecification.php 1 location

@@ 24-283 (lines=260) @@
21
 * @see http://schema.org/OpeningHoursSpecification
22
 *
23
 */
24
class OpeningHoursSpecification extends BaseType implements OpeningHoursSpecificationContract, IntangibleContract, StructuredValueContract, ThingContract
25
{
26
    /**
27
     * An additional type for the item, typically used for adding more specific
28
     * types from external vocabularies in microdata syntax. This is a
29
     * relationship between something and a class that the thing is in. In RDFa
30
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
31
     * attribute - for multiple types. Schema.org tools may have only weaker
32
     * understanding of extra types, in particular those defined externally.
33
     *
34
     * @param string|string[] $additionalType
35
     *
36
     * @return static
37
     *
38
     * @see http://schema.org/additionalType
39
     */
40
    public function additionalType($additionalType)
41
    {
42
        return $this->setProperty('additionalType', $additionalType);
43
    }
44
45
    /**
46
     * An alias for the item.
47
     *
48
     * @param string|string[] $alternateName
49
     *
50
     * @return static
51
     *
52
     * @see http://schema.org/alternateName
53
     */
54
    public function alternateName($alternateName)
55
    {
56
        return $this->setProperty('alternateName', $alternateName);
57
    }
58
59
    /**
60
     * The closing hour of the place or service on the given day(s) of the week.
61
     *
62
     * @param \DateTimeInterface|\DateTimeInterface[] $closes
63
     *
64
     * @return static
65
     *
66
     * @see http://schema.org/closes
67
     */
68
    public function closes($closes)
69
    {
70
        return $this->setProperty('closes', $closes);
71
    }
72
73
    /**
74
     * The day of the week for which these opening hours are valid.
75
     *
76
     * @param \Spatie\SchemaOrg\Contracts\DayOfWeekContract|\Spatie\SchemaOrg\Contracts\DayOfWeekContract[] $dayOfWeek
77
     *
78
     * @return static
79
     *
80
     * @see http://schema.org/dayOfWeek
81
     */
82
    public function dayOfWeek($dayOfWeek)
83
    {
84
        return $this->setProperty('dayOfWeek', $dayOfWeek);
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 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 name of the item.
169
     *
170
     * @param string|string[] $name
171
     *
172
     * @return static
173
     *
174
     * @see http://schema.org/name
175
     */
176
    public function name($name)
177
    {
178
        return $this->setProperty('name', $name);
179
    }
180
181
    /**
182
     * The opening hour of the place or service on the given day(s) of the week.
183
     *
184
     * @param \DateTimeInterface|\DateTimeInterface[] $opens
185
     *
186
     * @return static
187
     *
188
     * @see http://schema.org/opens
189
     */
190
    public function opens($opens)
191
    {
192
        return $this->setProperty('opens', $opens);
193
    }
194
195
    /**
196
     * Indicates a potential Action, which describes an idealized action in
197
     * which this thing would play an 'object' role.
198
     *
199
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
200
     *
201
     * @return static
202
     *
203
     * @see http://schema.org/potentialAction
204
     */
205
    public function potentialAction($potentialAction)
206
    {
207
        return $this->setProperty('potentialAction', $potentialAction);
208
    }
209
210
    /**
211
     * URL of a reference Web page that unambiguously indicates the item's
212
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
213
     * official website.
214
     *
215
     * @param string|string[] $sameAs
216
     *
217
     * @return static
218
     *
219
     * @see http://schema.org/sameAs
220
     */
221
    public function sameAs($sameAs)
222
    {
223
        return $this->setProperty('sameAs', $sameAs);
224
    }
225
226
    /**
227
     * A CreativeWork or Event about this Thing.
228
     *
229
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
230
     *
231
     * @return static
232
     *
233
     * @see http://schema.org/subjectOf
234
     */
235
    public function subjectOf($subjectOf)
236
    {
237
        return $this->setProperty('subjectOf', $subjectOf);
238
    }
239
240
    /**
241
     * URL of the item.
242
     *
243
     * @param string|string[] $url
244
     *
245
     * @return static
246
     *
247
     * @see http://schema.org/url
248
     */
249
    public function url($url)
250
    {
251
        return $this->setProperty('url', $url);
252
    }
253
254
    /**
255
     * The date when the item becomes valid.
256
     *
257
     * @param \DateTimeInterface|\DateTimeInterface[] $validFrom
258
     *
259
     * @return static
260
     *
261
     * @see http://schema.org/validFrom
262
     */
263
    public function validFrom($validFrom)
264
    {
265
        return $this->setProperty('validFrom', $validFrom);
266
    }
267
268
    /**
269
     * The date after when the item is not valid. For example the end of an
270
     * offer, salary period, or a period of opening hours.
271
     *
272
     * @param \DateTimeInterface|\DateTimeInterface[] $validThrough
273
     *
274
     * @return static
275
     *
276
     * @see http://schema.org/validThrough
277
     */
278
    public function validThrough($validThrough)
279
    {
280
        return $this->setProperty('validThrough', $validThrough);
281
    }
282
283
}
284

src/OrderItem.php 1 location

@@ 16-275 (lines=260) @@
13
 * @see http://schema.org/OrderItem
14
 *
15
 */
16
class OrderItem extends BaseType implements OrderItemContract, IntangibleContract, ThingContract
17
{
18
    /**
19
     * An additional type for the item, typically used for adding more specific
20
     * types from external vocabularies in microdata syntax. This is a
21
     * relationship between something and a class that the thing is in. In RDFa
22
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
23
     * attribute - for multiple types. Schema.org tools may have only weaker
24
     * understanding of extra types, in particular those defined externally.
25
     *
26
     * @param string|string[] $additionalType
27
     *
28
     * @return static
29
     *
30
     * @see http://schema.org/additionalType
31
     */
32
    public function additionalType($additionalType)
33
    {
34
        return $this->setProperty('additionalType', $additionalType);
35
    }
36
37
    /**
38
     * An alias for the item.
39
     *
40
     * @param string|string[] $alternateName
41
     *
42
     * @return static
43
     *
44
     * @see http://schema.org/alternateName
45
     */
46
    public function alternateName($alternateName)
47
    {
48
        return $this->setProperty('alternateName', $alternateName);
49
    }
50
51
    /**
52
     * A description of the item.
53
     *
54
     * @param string|string[] $description
55
     *
56
     * @return static
57
     *
58
     * @see http://schema.org/description
59
     */
60
    public function description($description)
61
    {
62
        return $this->setProperty('description', $description);
63
    }
64
65
    /**
66
     * A sub property of description. A short description of the item used to
67
     * disambiguate from other, similar items. Information from other properties
68
     * (in particular, name) may be necessary for the description to be useful
69
     * for disambiguation.
70
     *
71
     * @param string|string[] $disambiguatingDescription
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/disambiguatingDescription
76
     */
77
    public function disambiguatingDescription($disambiguatingDescription)
78
    {
79
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
80
    }
81
82
    /**
83
     * The identifier property represents any kind of identifier for any kind of
84
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
85
     * dedicated properties for representing many of these, either as textual
86
     * strings or as URL (URI) links. See [background
87
     * notes](/docs/datamodel.html#identifierBg) for more details.
88
     *
89
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
90
     *
91
     * @return static
92
     *
93
     * @see http://schema.org/identifier
94
     */
95
    public function identifier($identifier)
96
    {
97
        return $this->setProperty('identifier', $identifier);
98
    }
99
100
    /**
101
     * An image of the item. This can be a [[URL]] or a fully described
102
     * [[ImageObject]].
103
     *
104
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
105
     *
106
     * @return static
107
     *
108
     * @see http://schema.org/image
109
     */
110
    public function image($image)
111
    {
112
        return $this->setProperty('image', $image);
113
    }
114
115
    /**
116
     * Indicates a page (or other CreativeWork) for which this thing is the main
117
     * entity being described. See [background
118
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
119
     *
120
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
121
     *
122
     * @return static
123
     *
124
     * @see http://schema.org/mainEntityOfPage
125
     */
126
    public function mainEntityOfPage($mainEntityOfPage)
127
    {
128
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
129
    }
130
131
    /**
132
     * The name of the item.
133
     *
134
     * @param string|string[] $name
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/name
139
     */
140
    public function name($name)
141
    {
142
        return $this->setProperty('name', $name);
143
    }
144
145
    /**
146
     * The delivery of the parcel related to this order or order item.
147
     *
148
     * @param \Spatie\SchemaOrg\Contracts\ParcelDeliveryContract|\Spatie\SchemaOrg\Contracts\ParcelDeliveryContract[] $orderDelivery
149
     *
150
     * @return static
151
     *
152
     * @see http://schema.org/orderDelivery
153
     */
154
    public function orderDelivery($orderDelivery)
155
    {
156
        return $this->setProperty('orderDelivery', $orderDelivery);
157
    }
158
159
    /**
160
     * The identifier of the order item.
161
     *
162
     * @param string|string[] $orderItemNumber
163
     *
164
     * @return static
165
     *
166
     * @see http://schema.org/orderItemNumber
167
     */
168
    public function orderItemNumber($orderItemNumber)
169
    {
170
        return $this->setProperty('orderItemNumber', $orderItemNumber);
171
    }
172
173
    /**
174
     * The current status of the order item.
175
     *
176
     * @param \Spatie\SchemaOrg\Contracts\OrderStatusContract|\Spatie\SchemaOrg\Contracts\OrderStatusContract[] $orderItemStatus
177
     *
178
     * @return static
179
     *
180
     * @see http://schema.org/orderItemStatus
181
     */
182
    public function orderItemStatus($orderItemStatus)
183
    {
184
        return $this->setProperty('orderItemStatus', $orderItemStatus);
185
    }
186
187
    /**
188
     * The number of the item ordered. If the property is not set, assume the
189
     * quantity is one.
190
     *
191
     * @param float|float[]|int|int[] $orderQuantity
192
     *
193
     * @return static
194
     *
195
     * @see http://schema.org/orderQuantity
196
     */
197
    public function orderQuantity($orderQuantity)
198
    {
199
        return $this->setProperty('orderQuantity', $orderQuantity);
200
    }
201
202
    /**
203
     * The item ordered.
204
     *
205
     * @param \Spatie\SchemaOrg\Contracts\OrderItemContract|\Spatie\SchemaOrg\Contracts\OrderItemContract[]|\Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|\Spatie\SchemaOrg\Contracts\ServiceContract|\Spatie\SchemaOrg\Contracts\ServiceContract[] $orderedItem
206
     *
207
     * @return static
208
     *
209
     * @see http://schema.org/orderedItem
210
     */
211
    public function orderedItem($orderedItem)
212
    {
213
        return $this->setProperty('orderedItem', $orderedItem);
214
    }
215
216
    /**
217
     * Indicates a potential Action, which describes an idealized action in
218
     * which this thing would play an 'object' role.
219
     *
220
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
221
     *
222
     * @return static
223
     *
224
     * @see http://schema.org/potentialAction
225
     */
226
    public function potentialAction($potentialAction)
227
    {
228
        return $this->setProperty('potentialAction', $potentialAction);
229
    }
230
231
    /**
232
     * URL of a reference Web page that unambiguously indicates the item's
233
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
234
     * official website.
235
     *
236
     * @param string|string[] $sameAs
237
     *
238
     * @return static
239
     *
240
     * @see http://schema.org/sameAs
241
     */
242
    public function sameAs($sameAs)
243
    {
244
        return $this->setProperty('sameAs', $sameAs);
245
    }
246
247
    /**
248
     * A CreativeWork or Event about this Thing.
249
     *
250
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
251
     *
252
     * @return static
253
     *
254
     * @see http://schema.org/subjectOf
255
     */
256
    public function subjectOf($subjectOf)
257
    {
258
        return $this->setProperty('subjectOf', $subjectOf);
259
    }
260
261
    /**
262
     * URL of the item.
263
     *
264
     * @param string|string[] $url
265
     *
266
     * @return static
267
     *
268
     * @see http://schema.org/url
269
     */
270
    public function url($url)
271
    {
272
        return $this->setProperty('url', $url);
273
    }
274
275
}
276

src/OrganizationRole.php 1 location

@@ 16-282 (lines=267) @@
13
 * @see http://schema.org/OrganizationRole
14
 *
15
 */
16
class OrganizationRole extends BaseType implements OrganizationRoleContract, IntangibleContract, RoleContract, 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
     * A description of the item.
53
     *
54
     * @param string|string[] $description
55
     *
56
     * @return static
57
     *
58
     * @see http://schema.org/description
59
     */
60
    public function description($description)
61
    {
62
        return $this->setProperty('description', $description);
63
    }
64
65
    /**
66
     * A sub property of description. A short description of the item used to
67
     * disambiguate from other, similar items. Information from other properties
68
     * (in particular, name) may be necessary for the description to be useful
69
     * for disambiguation.
70
     *
71
     * @param string|string[] $disambiguatingDescription
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/disambiguatingDescription
76
     */
77
    public function disambiguatingDescription($disambiguatingDescription)
78
    {
79
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
80
    }
81
82
    /**
83
     * The end date and time of the item (in [ISO 8601 date
84
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
85
     *
86
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
87
     *
88
     * @return static
89
     *
90
     * @see http://schema.org/endDate
91
     */
92
    public function endDate($endDate)
93
    {
94
        return $this->setProperty('endDate', $endDate);
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 name of the item.
148
     *
149
     * @param string|string[] $name
150
     *
151
     * @return static
152
     *
153
     * @see http://schema.org/name
154
     */
155
    public function name($name)
156
    {
157
        return $this->setProperty('name', $name);
158
    }
159
160
    /**
161
     * A position played, performed or filled by a person or organization, as
162
     * part of an organization. For example, an athlete in a SportsTeam might
163
     * play in the position named 'Quarterback'.
164
     *
165
     * @param string|string[] $namedPosition
166
     *
167
     * @return static
168
     *
169
     * @see http://schema.org/namedPosition
170
     */
171
    public function namedPosition($namedPosition)
172
    {
173
        return $this->setProperty('namedPosition', $namedPosition);
174
    }
175
176
    /**
177
     * A number associated with a role in an organization, for example, the
178
     * number on an athlete's jersey.
179
     *
180
     * @param float|float[]|int|int[] $numberedPosition
181
     *
182
     * @return static
183
     *
184
     * @see http://schema.org/numberedPosition
185
     */
186
    public function numberedPosition($numberedPosition)
187
    {
188
        return $this->setProperty('numberedPosition', $numberedPosition);
189
    }
190
191
    /**
192
     * Indicates a potential Action, which describes an idealized action in
193
     * which this thing would play an 'object' role.
194
     *
195
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
196
     *
197
     * @return static
198
     *
199
     * @see http://schema.org/potentialAction
200
     */
201
    public function potentialAction($potentialAction)
202
    {
203
        return $this->setProperty('potentialAction', $potentialAction);
204
    }
205
206
    /**
207
     * A role played, performed or filled by a person or organization. For
208
     * example, the team of creators for a comic book might fill the roles named
209
     * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might
210
     * play in the position named 'Quarterback'.
211
     *
212
     * @param string|string[] $roleName
213
     *
214
     * @return static
215
     *
216
     * @see http://schema.org/roleName
217
     */
218
    public function roleName($roleName)
219
    {
220
        return $this->setProperty('roleName', $roleName);
221
    }
222
223
    /**
224
     * URL of a reference Web page that unambiguously indicates the item's
225
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
226
     * official website.
227
     *
228
     * @param string|string[] $sameAs
229
     *
230
     * @return static
231
     *
232
     * @see http://schema.org/sameAs
233
     */
234
    public function sameAs($sameAs)
235
    {
236
        return $this->setProperty('sameAs', $sameAs);
237
    }
238
239
    /**
240
     * The start date and time of the item (in [ISO 8601 date
241
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
242
     *
243
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
244
     *
245
     * @return static
246
     *
247
     * @see http://schema.org/startDate
248
     */
249
    public function startDate($startDate)
250
    {
251
        return $this->setProperty('startDate', $startDate);
252
    }
253
254
    /**
255
     * A CreativeWork or Event about this Thing.
256
     *
257
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
258
     *
259
     * @return static
260
     *
261
     * @see http://schema.org/subjectOf
262
     */
263
    public function subjectOf($subjectOf)
264
    {
265
        return $this->setProperty('subjectOf', $subjectOf);
266
    }
267
268
    /**
269
     * URL of the item.
270
     *
271
     * @param string|string[] $url
272
     *
273
     * @return static
274
     *
275
     * @see http://schema.org/url
276
     */
277
    public function url($url)
278
    {
279
        return $this->setProperty('url', $url);
280
    }
281
282
}
283

src/OwnershipInfo.php 1 location

@@ 17-261 (lines=245) @@
14
 * @see http://schema.org/OwnershipInfo
15
 *
16
 */
17
class OwnershipInfo extends BaseType implements OwnershipInfoContract, IntangibleContract, StructuredValueContract, ThingContract
18
{
19
    /**
20
     * The organization or person from which the product was acquired.
21
     *
22
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $acquiredFrom
23
     *
24
     * @return static
25
     *
26
     * @see http://schema.org/acquiredFrom
27
     */
28
    public function acquiredFrom($acquiredFrom)
29
    {
30
        return $this->setProperty('acquiredFrom', $acquiredFrom);
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
     * An alias for the item.
54
     *
55
     * @param string|string[] $alternateName
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/alternateName
60
     */
61
    public function alternateName($alternateName)
62
    {
63
        return $this->setProperty('alternateName', $alternateName);
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 name of the item.
148
     *
149
     * @param string|string[] $name
150
     *
151
     * @return static
152
     *
153
     * @see http://schema.org/name
154
     */
155
    public function name($name)
156
    {
157
        return $this->setProperty('name', $name);
158
    }
159
160
    /**
161
     * The date and time of obtaining the product.
162
     *
163
     * @param \DateTimeInterface|\DateTimeInterface[] $ownedFrom
164
     *
165
     * @return static
166
     *
167
     * @see http://schema.org/ownedFrom
168
     */
169
    public function ownedFrom($ownedFrom)
170
    {
171
        return $this->setProperty('ownedFrom', $ownedFrom);
172
    }
173
174
    /**
175
     * The date and time of giving up ownership on the product.
176
     *
177
     * @param \DateTimeInterface|\DateTimeInterface[] $ownedThrough
178
     *
179
     * @return static
180
     *
181
     * @see http://schema.org/ownedThrough
182
     */
183
    public function ownedThrough($ownedThrough)
184
    {
185
        return $this->setProperty('ownedThrough', $ownedThrough);
186
    }
187
188
    /**
189
     * Indicates a potential Action, which describes an idealized action in
190
     * which this thing would play an 'object' role.
191
     *
192
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
193
     *
194
     * @return static
195
     *
196
     * @see http://schema.org/potentialAction
197
     */
198
    public function potentialAction($potentialAction)
199
    {
200
        return $this->setProperty('potentialAction', $potentialAction);
201
    }
202
203
    /**
204
     * URL of a reference Web page that unambiguously indicates the item's
205
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
206
     * official website.
207
     *
208
     * @param string|string[] $sameAs
209
     *
210
     * @return static
211
     *
212
     * @see http://schema.org/sameAs
213
     */
214
    public function sameAs($sameAs)
215
    {
216
        return $this->setProperty('sameAs', $sameAs);
217
    }
218
219
    /**
220
     * A CreativeWork or Event about this Thing.
221
     *
222
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
223
     *
224
     * @return static
225
     *
226
     * @see http://schema.org/subjectOf
227
     */
228
    public function subjectOf($subjectOf)
229
    {
230
        return $this->setProperty('subjectOf', $subjectOf);
231
    }
232
233
    /**
234
     * The product that this structured value is referring to.
235
     *
236
     * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|\Spatie\SchemaOrg\Contracts\ServiceContract|\Spatie\SchemaOrg\Contracts\ServiceContract[] $typeOfGood
237
     *
238
     * @return static
239
     *
240
     * @see http://schema.org/typeOfGood
241
     */
242
    public function typeOfGood($typeOfGood)
243
    {
244
        return $this->setProperty('typeOfGood', $typeOfGood);
245
    }
246
247
    /**
248
     * URL of the item.
249
     *
250
     * @param string|string[] $url
251
     *
252
     * @return static
253
     *
254
     * @see http://schema.org/url
255
     */
256
    public function url($url)
257
    {
258
        return $this->setProperty('url', $url);
259
    }
260
261
}
262

src/PerformanceRole.php 1 location

@@ 17-283 (lines=267) @@
14
 * @see http://schema.org/PerformanceRole
15
 *
16
 */
17
class PerformanceRole extends BaseType implements PerformanceRoleContract, IntangibleContract, RoleContract, 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 name of a character played in some acting or performing role, i.e. in
54
     * a PerformanceRole.
55
     *
56
     * @param string|string[] $characterName
57
     *
58
     * @return static
59
     *
60
     * @see http://schema.org/characterName
61
     */
62
    public function characterName($characterName)
63
    {
64
        return $this->setProperty('characterName', $characterName);
65
    }
66
67
    /**
68
     * A description of the item.
69
     *
70
     * @param string|string[] $description
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/description
75
     */
76
    public function description($description)
77
    {
78
        return $this->setProperty('description', $description);
79
    }
80
81
    /**
82
     * A sub property of description. A short description of the item used to
83
     * disambiguate from other, similar items. Information from other properties
84
     * (in particular, name) may be necessary for the description to be useful
85
     * for disambiguation.
86
     *
87
     * @param string|string[] $disambiguatingDescription
88
     *
89
     * @return static
90
     *
91
     * @see http://schema.org/disambiguatingDescription
92
     */
93
    public function disambiguatingDescription($disambiguatingDescription)
94
    {
95
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
96
    }
97
98
    /**
99
     * The end date and time of the item (in [ISO 8601 date
100
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
101
     *
102
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
103
     *
104
     * @return static
105
     *
106
     * @see http://schema.org/endDate
107
     */
108
    public function endDate($endDate)
109
    {
110
        return $this->setProperty('endDate', $endDate);
111
    }
112
113
    /**
114
     * The identifier property represents any kind of identifier for any kind of
115
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
116
     * dedicated properties for representing many of these, either as textual
117
     * strings or as URL (URI) links. See [background
118
     * notes](/docs/datamodel.html#identifierBg) for more details.
119
     *
120
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
121
     *
122
     * @return static
123
     *
124
     * @see http://schema.org/identifier
125
     */
126
    public function identifier($identifier)
127
    {
128
        return $this->setProperty('identifier', $identifier);
129
    }
130
131
    /**
132
     * An image of the item. This can be a [[URL]] or a fully described
133
     * [[ImageObject]].
134
     *
135
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
136
     *
137
     * @return static
138
     *
139
     * @see http://schema.org/image
140
     */
141
    public function image($image)
142
    {
143
        return $this->setProperty('image', $image);
144
    }
145
146
    /**
147
     * Indicates a page (or other CreativeWork) for which this thing is the main
148
     * entity being described. See [background
149
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
150
     *
151
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
152
     *
153
     * @return static
154
     *
155
     * @see http://schema.org/mainEntityOfPage
156
     */
157
    public function mainEntityOfPage($mainEntityOfPage)
158
    {
159
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
160
    }
161
162
    /**
163
     * The name of the item.
164
     *
165
     * @param string|string[] $name
166
     *
167
     * @return static
168
     *
169
     * @see http://schema.org/name
170
     */
171
    public function name($name)
172
    {
173
        return $this->setProperty('name', $name);
174
    }
175
176
    /**
177
     * A position played, performed or filled by a person or organization, as
178
     * part of an organization. For example, an athlete in a SportsTeam might
179
     * play in the position named 'Quarterback'.
180
     *
181
     * @param string|string[] $namedPosition
182
     *
183
     * @return static
184
     *
185
     * @see http://schema.org/namedPosition
186
     */
187
    public function namedPosition($namedPosition)
188
    {
189
        return $this->setProperty('namedPosition', $namedPosition);
190
    }
191
192
    /**
193
     * Indicates a potential Action, which describes an idealized action in
194
     * which this thing would play an 'object' role.
195
     *
196
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
197
     *
198
     * @return static
199
     *
200
     * @see http://schema.org/potentialAction
201
     */
202
    public function potentialAction($potentialAction)
203
    {
204
        return $this->setProperty('potentialAction', $potentialAction);
205
    }
206
207
    /**
208
     * A role played, performed or filled by a person or organization. For
209
     * example, the team of creators for a comic book might fill the roles named
210
     * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might
211
     * play in the position named 'Quarterback'.
212
     *
213
     * @param string|string[] $roleName
214
     *
215
     * @return static
216
     *
217
     * @see http://schema.org/roleName
218
     */
219
    public function roleName($roleName)
220
    {
221
        return $this->setProperty('roleName', $roleName);
222
    }
223
224
    /**
225
     * URL of a reference Web page that unambiguously indicates the item's
226
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
227
     * official website.
228
     *
229
     * @param string|string[] $sameAs
230
     *
231
     * @return static
232
     *
233
     * @see http://schema.org/sameAs
234
     */
235
    public function sameAs($sameAs)
236
    {
237
        return $this->setProperty('sameAs', $sameAs);
238
    }
239
240
    /**
241
     * The start date and time of the item (in [ISO 8601 date
242
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
243
     *
244
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
245
     *
246
     * @return static
247
     *
248
     * @see http://schema.org/startDate
249
     */
250
    public function startDate($startDate)
251
    {
252
        return $this->setProperty('startDate', $startDate);
253
    }
254
255
    /**
256
     * A CreativeWork or Event about this Thing.
257
     *
258
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
259
     *
260
     * @return static
261
     *
262
     * @see http://schema.org/subjectOf
263
     */
264
    public function subjectOf($subjectOf)
265
    {
266
        return $this->setProperty('subjectOf', $subjectOf);
267
    }
268
269
    /**
270
     * URL of the item.
271
     *
272
     * @param string|string[] $url
273
     *
274
     * @return static
275
     *
276
     * @see http://schema.org/url
277
     */
278
    public function url($url)
279
    {
280
        return $this->setProperty('url', $url);
281
    }
282
283
}
284

src/ProgramMembership.php 1 location

@@ 16-276 (lines=261) @@
13
 * @see http://schema.org/ProgramMembership
14
 *
15
 */
16
class ProgramMembership extends BaseType implements ProgramMembershipContract, IntangibleContract, ThingContract
17
{
18
    /**
19
     * An additional type for the item, typically used for adding more specific
20
     * types from external vocabularies in microdata syntax. This is a
21
     * relationship between something and a class that the thing is in. In RDFa
22
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
23
     * attribute - for multiple types. Schema.org tools may have only weaker
24
     * understanding of extra types, in particular those defined externally.
25
     *
26
     * @param string|string[] $additionalType
27
     *
28
     * @return static
29
     *
30
     * @see http://schema.org/additionalType
31
     */
32
    public function additionalType($additionalType)
33
    {
34
        return $this->setProperty('additionalType', $additionalType);
35
    }
36
37
    /**
38
     * An alias for the item.
39
     *
40
     * @param string|string[] $alternateName
41
     *
42
     * @return static
43
     *
44
     * @see http://schema.org/alternateName
45
     */
46
    public function alternateName($alternateName)
47
    {
48
        return $this->setProperty('alternateName', $alternateName);
49
    }
50
51
    /**
52
     * A description of the item.
53
     *
54
     * @param string|string[] $description
55
     *
56
     * @return static
57
     *
58
     * @see http://schema.org/description
59
     */
60
    public function description($description)
61
    {
62
        return $this->setProperty('description', $description);
63
    }
64
65
    /**
66
     * A sub property of description. A short description of the item used to
67
     * disambiguate from other, similar items. Information from other properties
68
     * (in particular, name) may be necessary for the description to be useful
69
     * for disambiguation.
70
     *
71
     * @param string|string[] $disambiguatingDescription
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/disambiguatingDescription
76
     */
77
    public function disambiguatingDescription($disambiguatingDescription)
78
    {
79
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
80
    }
81
82
    /**
83
     * The organization (airline, travelers' club, etc.) the membership is made
84
     * with.
85
     *
86
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $hostingOrganization
87
     *
88
     * @return static
89
     *
90
     * @see http://schema.org/hostingOrganization
91
     */
92
    public function hostingOrganization($hostingOrganization)
93
    {
94
        return $this->setProperty('hostingOrganization', $hostingOrganization);
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
     * A member of an Organization or a ProgramMembership. Organizations can be
148
     * members of organizations; ProgramMembership is typically for individuals.
149
     *
150
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $member
151
     *
152
     * @return static
153
     *
154
     * @see http://schema.org/member
155
     */
156
    public function member($member)
157
    {
158
        return $this->setProperty('member', $member);
159
    }
160
161
    /**
162
     * A member of this organization.
163
     *
164
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $members
165
     *
166
     * @return static
167
     *
168
     * @see http://schema.org/members
169
     */
170
    public function members($members)
171
    {
172
        return $this->setProperty('members', $members);
173
    }
174
175
    /**
176
     * A unique identifier for the membership.
177
     *
178
     * @param string|string[] $membershipNumber
179
     *
180
     * @return static
181
     *
182
     * @see http://schema.org/membershipNumber
183
     */
184
    public function membershipNumber($membershipNumber)
185
    {
186
        return $this->setProperty('membershipNumber', $membershipNumber);
187
    }
188
189
    /**
190
     * The name of the item.
191
     *
192
     * @param string|string[] $name
193
     *
194
     * @return static
195
     *
196
     * @see http://schema.org/name
197
     */
198
    public function name($name)
199
    {
200
        return $this->setProperty('name', $name);
201
    }
202
203
    /**
204
     * Indicates a potential Action, which describes an idealized action in
205
     * which this thing would play an 'object' role.
206
     *
207
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
208
     *
209
     * @return static
210
     *
211
     * @see http://schema.org/potentialAction
212
     */
213
    public function potentialAction($potentialAction)
214
    {
215
        return $this->setProperty('potentialAction', $potentialAction);
216
    }
217
218
    /**
219
     * The program providing the membership.
220
     *
221
     * @param string|string[] $programName
222
     *
223
     * @return static
224
     *
225
     * @see http://schema.org/programName
226
     */
227
    public function programName($programName)
228
    {
229
        return $this->setProperty('programName', $programName);
230
    }
231
232
    /**
233
     * URL of a reference Web page that unambiguously indicates the item's
234
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
235
     * official website.
236
     *
237
     * @param string|string[] $sameAs
238
     *
239
     * @return static
240
     *
241
     * @see http://schema.org/sameAs
242
     */
243
    public function sameAs($sameAs)
244
    {
245
        return $this->setProperty('sameAs', $sameAs);
246
    }
247
248
    /**
249
     * A CreativeWork or Event about this Thing.
250
     *
251
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
252
     *
253
     * @return static
254
     *
255
     * @see http://schema.org/subjectOf
256
     */
257
    public function subjectOf($subjectOf)
258
    {
259
        return $this->setProperty('subjectOf', $subjectOf);
260
    }
261
262
    /**
263
     * URL of the item.
264
     *
265
     * @param string|string[] $url
266
     *
267
     * @return static
268
     *
269
     * @see http://schema.org/url
270
     */
271
    public function url($url)
272
    {
273
        return $this->setProperty('url', $url);
274
    }
275
276
}
277

src/QuantitativeValueDistribution.php 1 location

@@ 16-274 (lines=259) @@
13
 * @see http://schema.org/QuantitativeValueDistribution
14
 *
15
 */
16
class QuantitativeValueDistribution extends BaseType implements QuantitativeValueDistributionContract, 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
     * A description of the item.
53
     *
54
     * @param string|string[] $description
55
     *
56
     * @return static
57
     *
58
     * @see http://schema.org/description
59
     */
60
    public function description($description)
61
    {
62
        return $this->setProperty('description', $description);
63
    }
64
65
    /**
66
     * A sub property of description. A short description of the item used to
67
     * disambiguate from other, similar items. Information from other properties
68
     * (in particular, name) may be necessary for the description to be useful
69
     * for disambiguation.
70
     *
71
     * @param string|string[] $disambiguatingDescription
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/disambiguatingDescription
76
     */
77
    public function disambiguatingDescription($disambiguatingDescription)
78
    {
79
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
80
    }
81
82
    /**
83
     * The identifier property represents any kind of identifier for any kind of
84
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
85
     * dedicated properties for representing many of these, either as textual
86
     * strings or as URL (URI) links. See [background
87
     * notes](/docs/datamodel.html#identifierBg) for more details.
88
     *
89
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
90
     *
91
     * @return static
92
     *
93
     * @see http://schema.org/identifier
94
     */
95
    public function identifier($identifier)
96
    {
97
        return $this->setProperty('identifier', $identifier);
98
    }
99
100
    /**
101
     * An image of the item. This can be a [[URL]] or a fully described
102
     * [[ImageObject]].
103
     *
104
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
105
     *
106
     * @return static
107
     *
108
     * @see http://schema.org/image
109
     */
110
    public function image($image)
111
    {
112
        return $this->setProperty('image', $image);
113
    }
114
115
    /**
116
     * Indicates a page (or other CreativeWork) for which this thing is the main
117
     * entity being described. See [background
118
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
119
     *
120
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
121
     *
122
     * @return static
123
     *
124
     * @see http://schema.org/mainEntityOfPage
125
     */
126
    public function mainEntityOfPage($mainEntityOfPage)
127
    {
128
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
129
    }
130
131
    /**
132
     * The median value.
133
     *
134
     * @param float|float[]|int|int[] $median
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/median
139
     */
140
    public function median($median)
141
    {
142
        return $this->setProperty('median', $median);
143
    }
144
145
    /**
146
     * The name of the item.
147
     *
148
     * @param string|string[] $name
149
     *
150
     * @return static
151
     *
152
     * @see http://schema.org/name
153
     */
154
    public function name($name)
155
    {
156
        return $this->setProperty('name', $name);
157
    }
158
159
    /**
160
     * The 10th percentile value.
161
     *
162
     * @param float|float[]|int|int[] $percentile10
163
     *
164
     * @return static
165
     *
166
     * @see http://schema.org/percentile10
167
     */
168
    public function percentile10($percentile10)
169
    {
170
        return $this->setProperty('percentile10', $percentile10);
171
    }
172
173
    /**
174
     * The 25th percentile value.
175
     *
176
     * @param float|float[]|int|int[] $percentile25
177
     *
178
     * @return static
179
     *
180
     * @see http://schema.org/percentile25
181
     */
182
    public function percentile25($percentile25)
183
    {
184
        return $this->setProperty('percentile25', $percentile25);
185
    }
186
187
    /**
188
     * The 75th percentile value.
189
     *
190
     * @param float|float[]|int|int[] $percentile75
191
     *
192
     * @return static
193
     *
194
     * @see http://schema.org/percentile75
195
     */
196
    public function percentile75($percentile75)
197
    {
198
        return $this->setProperty('percentile75', $percentile75);
199
    }
200
201
    /**
202
     * The 90th percentile value.
203
     *
204
     * @param float|float[]|int|int[] $percentile90
205
     *
206
     * @return static
207
     *
208
     * @see http://schema.org/percentile90
209
     */
210
    public function percentile90($percentile90)
211
    {
212
        return $this->setProperty('percentile90', $percentile90);
213
    }
214
215
    /**
216
     * Indicates a potential Action, which describes an idealized action in
217
     * which this thing would play an 'object' role.
218
     *
219
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/potentialAction
224
     */
225
    public function potentialAction($potentialAction)
226
    {
227
        return $this->setProperty('potentialAction', $potentialAction);
228
    }
229
230
    /**
231
     * URL of a reference Web page that unambiguously indicates the item's
232
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
233
     * official website.
234
     *
235
     * @param string|string[] $sameAs
236
     *
237
     * @return static
238
     *
239
     * @see http://schema.org/sameAs
240
     */
241
    public function sameAs($sameAs)
242
    {
243
        return $this->setProperty('sameAs', $sameAs);
244
    }
245
246
    /**
247
     * A CreativeWork or Event about this Thing.
248
     *
249
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
250
     *
251
     * @return static
252
     *
253
     * @see http://schema.org/subjectOf
254
     */
255
    public function subjectOf($subjectOf)
256
    {
257
        return $this->setProperty('subjectOf', $subjectOf);
258
    }
259
260
    /**
261
     * URL of the item.
262
     *
263
     * @param string|string[] $url
264
     *
265
     * @return static
266
     *
267
     * @see http://schema.org/url
268
     */
269
    public function url($url)
270
    {
271
        return $this->setProperty('url', $url);
272
    }
273
274
}
275

src/Rating.php 1 location

@@ 15-285 (lines=271) @@
12
 * @see http://schema.org/Rating
13
 *
14
 */
15
class Rating extends BaseType implements RatingContract, 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 author of this content or rating. Please note that author is special
52
     * in that HTML 5 provides a special mechanism for indicating authorship via
53
     * the rel tag. That is equivalent to this and may be used interchangeably.
54
     *
55
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $author
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/author
60
     */
61
    public function author($author)
62
    {
63
        return $this->setProperty('author', $author);
64
    }
65
66
    /**
67
     * The highest value allowed in this rating system. If bestRating is
68
     * omitted, 5 is assumed.
69
     *
70
     * @param float|float[]|int|int[]|string|string[] $bestRating
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/bestRating
75
     */
76
    public function bestRating($bestRating)
77
    {
78
        return $this->setProperty('bestRating', $bestRating);
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 identifier property represents any kind of identifier for any kind of
114
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
115
     * dedicated properties for representing many of these, either as textual
116
     * strings or as URL (URI) links. See [background
117
     * notes](/docs/datamodel.html#identifierBg) for more details.
118
     *
119
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
120
     *
121
     * @return static
122
     *
123
     * @see http://schema.org/identifier
124
     */
125
    public function identifier($identifier)
126
    {
127
        return $this->setProperty('identifier', $identifier);
128
    }
129
130
    /**
131
     * An image of the item. This can be a [[URL]] or a fully described
132
     * [[ImageObject]].
133
     *
134
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
135
     *
136
     * @return static
137
     *
138
     * @see http://schema.org/image
139
     */
140
    public function image($image)
141
    {
142
        return $this->setProperty('image', $image);
143
    }
144
145
    /**
146
     * Indicates a page (or other CreativeWork) for which this thing is the main
147
     * entity being described. See [background
148
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
149
     *
150
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
151
     *
152
     * @return static
153
     *
154
     * @see http://schema.org/mainEntityOfPage
155
     */
156
    public function mainEntityOfPage($mainEntityOfPage)
157
    {
158
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
159
    }
160
161
    /**
162
     * The name of the item.
163
     *
164
     * @param string|string[] $name
165
     *
166
     * @return static
167
     *
168
     * @see http://schema.org/name
169
     */
170
    public function name($name)
171
    {
172
        return $this->setProperty('name', $name);
173
    }
174
175
    /**
176
     * Indicates a potential Action, which describes an idealized action in
177
     * which this thing would play an 'object' role.
178
     *
179
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
180
     *
181
     * @return static
182
     *
183
     * @see http://schema.org/potentialAction
184
     */
185
    public function potentialAction($potentialAction)
186
    {
187
        return $this->setProperty('potentialAction', $potentialAction);
188
    }
189
190
    /**
191
     * The rating for the content.
192
     * 
193
     * Usage guidelines:
194
     * 
195
     * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT
196
     * NINE' (U+0039)) rather than superficially similiar Unicode symbols.
197
     * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a
198
     * decimal point. Avoid using these symbols as a readability separator.
199
     *
200
     * @param float|float[]|int|int[]|string|string[] $ratingValue
201
     *
202
     * @return static
203
     *
204
     * @see http://schema.org/ratingValue
205
     */
206
    public function ratingValue($ratingValue)
207
    {
208
        return $this->setProperty('ratingValue', $ratingValue);
209
    }
210
211
    /**
212
     * This Review or Rating is relevant to this part or facet of the
213
     * itemReviewed.
214
     *
215
     * @param string|string[] $reviewAspect
216
     *
217
     * @return static
218
     *
219
     * @see http://schema.org/reviewAspect
220
     */
221
    public function reviewAspect($reviewAspect)
222
    {
223
        return $this->setProperty('reviewAspect', $reviewAspect);
224
    }
225
226
    /**
227
     * URL of a reference Web page that unambiguously indicates the item's
228
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
229
     * official website.
230
     *
231
     * @param string|string[] $sameAs
232
     *
233
     * @return static
234
     *
235
     * @see http://schema.org/sameAs
236
     */
237
    public function sameAs($sameAs)
238
    {
239
        return $this->setProperty('sameAs', $sameAs);
240
    }
241
242
    /**
243
     * A CreativeWork or Event about this Thing.
244
     *
245
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
246
     *
247
     * @return static
248
     *
249
     * @see http://schema.org/subjectOf
250
     */
251
    public function subjectOf($subjectOf)
252
    {
253
        return $this->setProperty('subjectOf', $subjectOf);
254
    }
255
256
    /**
257
     * URL of the item.
258
     *
259
     * @param string|string[] $url
260
     *
261
     * @return static
262
     *
263
     * @see http://schema.org/url
264
     */
265
    public function url($url)
266
    {
267
        return $this->setProperty('url', $url);
268
    }
269
270
    /**
271
     * The lowest value allowed in this rating system. If worstRating is
272
     * omitted, 1 is assumed.
273
     *
274
     * @param float|float[]|int|int[]|string|string[] $worstRating
275
     *
276
     * @return static
277
     *
278
     * @see http://schema.org/worstRating
279
     */
280
    public function worstRating($worstRating)
281
    {
282
        return $this->setProperty('worstRating', $worstRating);
283
    }
284
285
}
286

src/Role.php 1 location

@@ 22-273 (lines=252) @@
19
 * @see http://schema.org/Role
20
 *
21
 */
22
class Role extends BaseType implements RoleContract, IntangibleContract, 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
     * An alias for the item.
45
     *
46
     * @param string|string[] $alternateName
47
     *
48
     * @return static
49
     *
50
     * @see http://schema.org/alternateName
51
     */
52
    public function alternateName($alternateName)
53
    {
54
        return $this->setProperty('alternateName', $alternateName);
55
    }
56
57
    /**
58
     * A description of the item.
59
     *
60
     * @param string|string[] $description
61
     *
62
     * @return static
63
     *
64
     * @see http://schema.org/description
65
     */
66
    public function description($description)
67
    {
68
        return $this->setProperty('description', $description);
69
    }
70
71
    /**
72
     * A sub property of description. A short description of the item used to
73
     * disambiguate from other, similar items. Information from other properties
74
     * (in particular, name) may be necessary for the description to be useful
75
     * for disambiguation.
76
     *
77
     * @param string|string[] $disambiguatingDescription
78
     *
79
     * @return static
80
     *
81
     * @see http://schema.org/disambiguatingDescription
82
     */
83
    public function disambiguatingDescription($disambiguatingDescription)
84
    {
85
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
86
    }
87
88
    /**
89
     * The end date and time of the item (in [ISO 8601 date
90
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
91
     *
92
     * @param \DateTimeInterface|\DateTimeInterface[] $endDate
93
     *
94
     * @return static
95
     *
96
     * @see http://schema.org/endDate
97
     */
98
    public function endDate($endDate)
99
    {
100
        return $this->setProperty('endDate', $endDate);
101
    }
102
103
    /**
104
     * The identifier property represents any kind of identifier for any kind of
105
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
106
     * dedicated properties for representing many of these, either as textual
107
     * strings or as URL (URI) links. See [background
108
     * notes](/docs/datamodel.html#identifierBg) for more details.
109
     *
110
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
111
     *
112
     * @return static
113
     *
114
     * @see http://schema.org/identifier
115
     */
116
    public function identifier($identifier)
117
    {
118
        return $this->setProperty('identifier', $identifier);
119
    }
120
121
    /**
122
     * An image of the item. This can be a [[URL]] or a fully described
123
     * [[ImageObject]].
124
     *
125
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
126
     *
127
     * @return static
128
     *
129
     * @see http://schema.org/image
130
     */
131
    public function image($image)
132
    {
133
        return $this->setProperty('image', $image);
134
    }
135
136
    /**
137
     * Indicates a page (or other CreativeWork) for which this thing is the main
138
     * entity being described. See [background
139
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
140
     *
141
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
142
     *
143
     * @return static
144
     *
145
     * @see http://schema.org/mainEntityOfPage
146
     */
147
    public function mainEntityOfPage($mainEntityOfPage)
148
    {
149
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
150
    }
151
152
    /**
153
     * The name of the item.
154
     *
155
     * @param string|string[] $name
156
     *
157
     * @return static
158
     *
159
     * @see http://schema.org/name
160
     */
161
    public function name($name)
162
    {
163
        return $this->setProperty('name', $name);
164
    }
165
166
    /**
167
     * A position played, performed or filled by a person or organization, as
168
     * part of an organization. For example, an athlete in a SportsTeam might
169
     * play in the position named 'Quarterback'.
170
     *
171
     * @param string|string[] $namedPosition
172
     *
173
     * @return static
174
     *
175
     * @see http://schema.org/namedPosition
176
     */
177
    public function namedPosition($namedPosition)
178
    {
179
        return $this->setProperty('namedPosition', $namedPosition);
180
    }
181
182
    /**
183
     * Indicates a potential Action, which describes an idealized action in
184
     * which this thing would play an 'object' role.
185
     *
186
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
187
     *
188
     * @return static
189
     *
190
     * @see http://schema.org/potentialAction
191
     */
192
    public function potentialAction($potentialAction)
193
    {
194
        return $this->setProperty('potentialAction', $potentialAction);
195
    }
196
197
    /**
198
     * A role played, performed or filled by a person or organization. For
199
     * example, the team of creators for a comic book might fill the roles named
200
     * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might
201
     * play in the position named 'Quarterback'.
202
     *
203
     * @param string|string[] $roleName
204
     *
205
     * @return static
206
     *
207
     * @see http://schema.org/roleName
208
     */
209
    public function roleName($roleName)
210
    {
211
        return $this->setProperty('roleName', $roleName);
212
    }
213
214
    /**
215
     * URL of a reference Web page that unambiguously indicates the item's
216
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
217
     * official website.
218
     *
219
     * @param string|string[] $sameAs
220
     *
221
     * @return static
222
     *
223
     * @see http://schema.org/sameAs
224
     */
225
    public function sameAs($sameAs)
226
    {
227
        return $this->setProperty('sameAs', $sameAs);
228
    }
229
230
    /**
231
     * The start date and time of the item (in [ISO 8601 date
232
     * format](http://en.wikipedia.org/wiki/ISO_8601)).
233
     *
234
     * @param \DateTimeInterface|\DateTimeInterface[] $startDate
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/startDate
239
     */
240
    public function startDate($startDate)
241
    {
242
        return $this->setProperty('startDate', $startDate);
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
     * URL of the item.
261
     *
262
     * @param string|string[] $url
263
     *
264
     * @return static
265
     *
266
     * @see http://schema.org/url
267
     */
268
    public function url($url)
269
    {
270
        return $this->setProperty('url', $url);
271
    }
272
273
}
274

src/Seat.php 1 location

@@ 15-259 (lines=245) @@
12
 * @see http://schema.org/Seat
13
 *
14
 */
15
class Seat extends BaseType implements SeatContract, 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
     * A description of the item.
52
     *
53
     * @param string|string[] $description
54
     *
55
     * @return static
56
     *
57
     * @see http://schema.org/description
58
     */
59
    public function description($description)
60
    {
61
        return $this->setProperty('description', $description);
62
    }
63
64
    /**
65
     * A sub property of description. A short description of the item used to
66
     * disambiguate from other, similar items. Information from other properties
67
     * (in particular, name) may be necessary for the description to be useful
68
     * for disambiguation.
69
     *
70
     * @param string|string[] $disambiguatingDescription
71
     *
72
     * @return static
73
     *
74
     * @see http://schema.org/disambiguatingDescription
75
     */
76
    public function disambiguatingDescription($disambiguatingDescription)
77
    {
78
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
79
    }
80
81
    /**
82
     * The identifier property represents any kind of identifier for any kind of
83
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
84
     * dedicated properties for representing many of these, either as textual
85
     * strings or as URL (URI) links. See [background
86
     * notes](/docs/datamodel.html#identifierBg) for more details.
87
     *
88
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
89
     *
90
     * @return static
91
     *
92
     * @see http://schema.org/identifier
93
     */
94
    public function identifier($identifier)
95
    {
96
        return $this->setProperty('identifier', $identifier);
97
    }
98
99
    /**
100
     * An image of the item. This can be a [[URL]] or a fully described
101
     * [[ImageObject]].
102
     *
103
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
104
     *
105
     * @return static
106
     *
107
     * @see http://schema.org/image
108
     */
109
    public function image($image)
110
    {
111
        return $this->setProperty('image', $image);
112
    }
113
114
    /**
115
     * Indicates a page (or other CreativeWork) for which this thing is the main
116
     * entity being described. See [background
117
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
118
     *
119
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
120
     *
121
     * @return static
122
     *
123
     * @see http://schema.org/mainEntityOfPage
124
     */
125
    public function mainEntityOfPage($mainEntityOfPage)
126
    {
127
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
128
    }
129
130
    /**
131
     * The name of the item.
132
     *
133
     * @param string|string[] $name
134
     *
135
     * @return static
136
     *
137
     * @see http://schema.org/name
138
     */
139
    public function name($name)
140
    {
141
        return $this->setProperty('name', $name);
142
    }
143
144
    /**
145
     * Indicates a potential Action, which describes an idealized action in
146
     * which this thing would play an 'object' role.
147
     *
148
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
149
     *
150
     * @return static
151
     *
152
     * @see http://schema.org/potentialAction
153
     */
154
    public function potentialAction($potentialAction)
155
    {
156
        return $this->setProperty('potentialAction', $potentialAction);
157
    }
158
159
    /**
160
     * URL of a reference Web page that unambiguously indicates the item's
161
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
162
     * official website.
163
     *
164
     * @param string|string[] $sameAs
165
     *
166
     * @return static
167
     *
168
     * @see http://schema.org/sameAs
169
     */
170
    public function sameAs($sameAs)
171
    {
172
        return $this->setProperty('sameAs', $sameAs);
173
    }
174
175
    /**
176
     * The location of the reserved seat (e.g., 27).
177
     *
178
     * @param string|string[] $seatNumber
179
     *
180
     * @return static
181
     *
182
     * @see http://schema.org/seatNumber
183
     */
184
    public function seatNumber($seatNumber)
185
    {
186
        return $this->setProperty('seatNumber', $seatNumber);
187
    }
188
189
    /**
190
     * The row location of the reserved seat (e.g., B).
191
     *
192
     * @param string|string[] $seatRow
193
     *
194
     * @return static
195
     *
196
     * @see http://schema.org/seatRow
197
     */
198
    public function seatRow($seatRow)
199
    {
200
        return $this->setProperty('seatRow', $seatRow);
201
    }
202
203
    /**
204
     * The section location of the reserved seat (e.g. Orchestra).
205
     *
206
     * @param string|string[] $seatSection
207
     *
208
     * @return static
209
     *
210
     * @see http://schema.org/seatSection
211
     */
212
    public function seatSection($seatSection)
213
    {
214
        return $this->setProperty('seatSection', $seatSection);
215
    }
216
217
    /**
218
     * The type/class of the seat.
219
     *
220
     * @param \Spatie\SchemaOrg\Contracts\QualitativeValueContract|\Spatie\SchemaOrg\Contracts\QualitativeValueContract[]|string|string[] $seatingType
221
     *
222
     * @return static
223
     *
224
     * @see http://schema.org/seatingType
225
     */
226
    public function seatingType($seatingType)
227
    {
228
        return $this->setProperty('seatingType', $seatingType);
229
    }
230
231
    /**
232
     * A CreativeWork or Event about this Thing.
233
     *
234
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
235
     *
236
     * @return static
237
     *
238
     * @see http://schema.org/subjectOf
239
     */
240
    public function subjectOf($subjectOf)
241
    {
242
        return $this->setProperty('subjectOf', $subjectOf);
243
    }
244
245
    /**
246
     * URL of the item.
247
     *
248
     * @param string|string[] $url
249
     *
250
     * @return static
251
     *
252
     * @see http://schema.org/url
253
     */
254
    public function url($url)
255
    {
256
        return $this->setProperty('url', $url);
257
    }
258
259
}
260

src/Trip.php 1 location

@@ 15-268 (lines=254) @@
12
 * @see http://schema.org/Trip
13
 *
14
 */
15
class Trip extends BaseType implements TripContract, 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 expected arrival time.
52
     *
53
     * @param \DateTimeInterface|\DateTimeInterface[] $arrivalTime
54
     *
55
     * @return static
56
     *
57
     * @see http://schema.org/arrivalTime
58
     */
59
    public function arrivalTime($arrivalTime)
60
    {
61
        return $this->setProperty('arrivalTime', $arrivalTime);
62
    }
63
64
    /**
65
     * The expected departure time.
66
     *
67
     * @param \DateTimeInterface|\DateTimeInterface[] $departureTime
68
     *
69
     * @return static
70
     *
71
     * @see http://schema.org/departureTime
72
     */
73
    public function departureTime($departureTime)
74
    {
75
        return $this->setProperty('departureTime', $departureTime);
76
    }
77
78
    /**
79
     * A description of the item.
80
     *
81
     * @param string|string[] $description
82
     *
83
     * @return static
84
     *
85
     * @see http://schema.org/description
86
     */
87
    public function description($description)
88
    {
89
        return $this->setProperty('description', $description);
90
    }
91
92
    /**
93
     * A sub property of description. A short description of the item used to
94
     * disambiguate from other, similar items. Information from other properties
95
     * (in particular, name) may be necessary for the description to be useful
96
     * for disambiguation.
97
     *
98
     * @param string|string[] $disambiguatingDescription
99
     *
100
     * @return static
101
     *
102
     * @see http://schema.org/disambiguatingDescription
103
     */
104
    public function disambiguatingDescription($disambiguatingDescription)
105
    {
106
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
107
    }
108
109
    /**
110
     * The identifier property represents any kind of identifier for any kind of
111
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
112
     * dedicated properties for representing many of these, either as textual
113
     * strings or as URL (URI) links. See [background
114
     * notes](/docs/datamodel.html#identifierBg) for more details.
115
     *
116
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
117
     *
118
     * @return static
119
     *
120
     * @see http://schema.org/identifier
121
     */
122
    public function identifier($identifier)
123
    {
124
        return $this->setProperty('identifier', $identifier);
125
    }
126
127
    /**
128
     * An image of the item. This can be a [[URL]] or a fully described
129
     * [[ImageObject]].
130
     *
131
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
132
     *
133
     * @return static
134
     *
135
     * @see http://schema.org/image
136
     */
137
    public function image($image)
138
    {
139
        return $this->setProperty('image', $image);
140
    }
141
142
    /**
143
     * Indicates a page (or other CreativeWork) for which this thing is the main
144
     * entity being described. See [background
145
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
146
     *
147
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
148
     *
149
     * @return static
150
     *
151
     * @see http://schema.org/mainEntityOfPage
152
     */
153
    public function mainEntityOfPage($mainEntityOfPage)
154
    {
155
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
156
    }
157
158
    /**
159
     * The name of the item.
160
     *
161
     * @param string|string[] $name
162
     *
163
     * @return static
164
     *
165
     * @see http://schema.org/name
166
     */
167
    public function name($name)
168
    {
169
        return $this->setProperty('name', $name);
170
    }
171
172
    /**
173
     * An offer to provide this item—for example, an offer to sell a
174
     * product, rent the DVD of a movie, perform a service, or give away tickets
175
     * to an event. Use [[businessFunction]] to indicate the kind of transaction
176
     * offered, i.e. sell, lease, etc. This property can also be used to
177
     * describe a [[Demand]]. While this property is listed as expected on a
178
     * number of common types, it can be used in others. In that case, using a
179
     * second type, such as Product or a subtype of Product, can clarify the
180
     * nature of the offer.
181
     *
182
     * @param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[]|\Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $offers
183
     *
184
     * @return static
185
     *
186
     * @see http://schema.org/offers
187
     */
188
    public function offers($offers)
189
    {
190
        return $this->setProperty('offers', $offers);
191
    }
192
193
    /**
194
     * Indicates a potential Action, which describes an idealized action in
195
     * which this thing would play an 'object' role.
196
     *
197
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
198
     *
199
     * @return static
200
     *
201
     * @see http://schema.org/potentialAction
202
     */
203
    public function potentialAction($potentialAction)
204
    {
205
        return $this->setProperty('potentialAction', $potentialAction);
206
    }
207
208
    /**
209
     * The service provider, service operator, or service performer; the goods
210
     * producer. Another party (a seller) may offer those services or goods on
211
     * behalf of the provider. A provider may also serve as the seller.
212
     *
213
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider
214
     *
215
     * @return static
216
     *
217
     * @see http://schema.org/provider
218
     */
219
    public function provider($provider)
220
    {
221
        return $this->setProperty('provider', $provider);
222
    }
223
224
    /**
225
     * URL of a reference Web page that unambiguously indicates the item's
226
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
227
     * official website.
228
     *
229
     * @param string|string[] $sameAs
230
     *
231
     * @return static
232
     *
233
     * @see http://schema.org/sameAs
234
     */
235
    public function sameAs($sameAs)
236
    {
237
        return $this->setProperty('sameAs', $sameAs);
238
    }
239
240
    /**
241
     * A CreativeWork or Event about this Thing.
242
     *
243
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
244
     *
245
     * @return static
246
     *
247
     * @see http://schema.org/subjectOf
248
     */
249
    public function subjectOf($subjectOf)
250
    {
251
        return $this->setProperty('subjectOf', $subjectOf);
252
    }
253
254
    /**
255
     * URL of the item.
256
     *
257
     * @param string|string[] $url
258
     *
259
     * @return static
260
     *
261
     * @see http://schema.org/url
262
     */
263
    public function url($url)
264
    {
265
        return $this->setProperty('url', $url);
266
    }
267
268
}
269

src/TypeAndQuantityNode.php 1 location

@@ 17-281 (lines=265) @@
14
 * @see http://schema.org/TypeAndQuantityNode
15
 *
16
 */
17
class TypeAndQuantityNode extends BaseType implements TypeAndQuantityNodeContract, IntangibleContract, 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 quantity of the goods included in the offer.
54
     *
55
     * @param float|float[]|int|int[] $amountOfThisGood
56
     *
57
     * @return static
58
     *
59
     * @see http://schema.org/amountOfThisGood
60
     */
61
    public function amountOfThisGood($amountOfThisGood)
62
    {
63
        return $this->setProperty('amountOfThisGood', $amountOfThisGood);
64
    }
65
66
    /**
67
     * The business function (e.g. sell, lease, repair, dispose) of the offer or
68
     * component of a bundle (TypeAndQuantityNode). The default is
69
     * http://purl.org/goodrelations/v1#Sell.
70
     *
71
     * @param \Spatie\SchemaOrg\Contracts\BusinessFunctionContract|\Spatie\SchemaOrg\Contracts\BusinessFunctionContract[] $businessFunction
72
     *
73
     * @return static
74
     *
75
     * @see http://schema.org/businessFunction
76
     */
77
    public function businessFunction($businessFunction)
78
    {
79
        return $this->setProperty('businessFunction', $businessFunction);
80
    }
81
82
    /**
83
     * A description of the item.
84
     *
85
     * @param string|string[] $description
86
     *
87
     * @return static
88
     *
89
     * @see http://schema.org/description
90
     */
91
    public function description($description)
92
    {
93
        return $this->setProperty('description', $description);
94
    }
95
96
    /**
97
     * A sub property of description. A short description of the item used to
98
     * disambiguate from other, similar items. Information from other properties
99
     * (in particular, name) may be necessary for the description to be useful
100
     * for disambiguation.
101
     *
102
     * @param string|string[] $disambiguatingDescription
103
     *
104
     * @return static
105
     *
106
     * @see http://schema.org/disambiguatingDescription
107
     */
108
    public function disambiguatingDescription($disambiguatingDescription)
109
    {
110
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
111
    }
112
113
    /**
114
     * The identifier property represents any kind of identifier for any kind of
115
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
116
     * dedicated properties for representing many of these, either as textual
117
     * strings or as URL (URI) links. See [background
118
     * notes](/docs/datamodel.html#identifierBg) for more details.
119
     *
120
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
121
     *
122
     * @return static
123
     *
124
     * @see http://schema.org/identifier
125
     */
126
    public function identifier($identifier)
127
    {
128
        return $this->setProperty('identifier', $identifier);
129
    }
130
131
    /**
132
     * An image of the item. This can be a [[URL]] or a fully described
133
     * [[ImageObject]].
134
     *
135
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
136
     *
137
     * @return static
138
     *
139
     * @see http://schema.org/image
140
     */
141
    public function image($image)
142
    {
143
        return $this->setProperty('image', $image);
144
    }
145
146
    /**
147
     * Indicates a page (or other CreativeWork) for which this thing is the main
148
     * entity being described. See [background
149
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
150
     *
151
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
152
     *
153
     * @return static
154
     *
155
     * @see http://schema.org/mainEntityOfPage
156
     */
157
    public function mainEntityOfPage($mainEntityOfPage)
158
    {
159
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
160
    }
161
162
    /**
163
     * The name of the item.
164
     *
165
     * @param string|string[] $name
166
     *
167
     * @return static
168
     *
169
     * @see http://schema.org/name
170
     */
171
    public function name($name)
172
    {
173
        return $this->setProperty('name', $name);
174
    }
175
176
    /**
177
     * Indicates a potential Action, which describes an idealized action in
178
     * which this thing would play an 'object' role.
179
     *
180
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
181
     *
182
     * @return static
183
     *
184
     * @see http://schema.org/potentialAction
185
     */
186
    public function potentialAction($potentialAction)
187
    {
188
        return $this->setProperty('potentialAction', $potentialAction);
189
    }
190
191
    /**
192
     * URL of a reference Web page that unambiguously indicates the item's
193
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
194
     * official website.
195
     *
196
     * @param string|string[] $sameAs
197
     *
198
     * @return static
199
     *
200
     * @see http://schema.org/sameAs
201
     */
202
    public function sameAs($sameAs)
203
    {
204
        return $this->setProperty('sameAs', $sameAs);
205
    }
206
207
    /**
208
     * A CreativeWork or Event about this Thing.
209
     *
210
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
211
     *
212
     * @return static
213
     *
214
     * @see http://schema.org/subjectOf
215
     */
216
    public function subjectOf($subjectOf)
217
    {
218
        return $this->setProperty('subjectOf', $subjectOf);
219
    }
220
221
    /**
222
     * The product that this structured value is referring to.
223
     *
224
     * @param \Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[]|\Spatie\SchemaOrg\Contracts\ServiceContract|\Spatie\SchemaOrg\Contracts\ServiceContract[] $typeOfGood
225
     *
226
     * @return static
227
     *
228
     * @see http://schema.org/typeOfGood
229
     */
230
    public function typeOfGood($typeOfGood)
231
    {
232
        return $this->setProperty('typeOfGood', $typeOfGood);
233
    }
234
235
    /**
236
     * The unit of measurement given using the UN/CEFACT Common Code (3
237
     * characters) or a URL. Other codes than the UN/CEFACT Common Code may be
238
     * used with a prefix followed by a colon.
239
     *
240
     * @param string|string[] $unitCode
241
     *
242
     * @return static
243
     *
244
     * @see http://schema.org/unitCode
245
     */
246
    public function unitCode($unitCode)
247
    {
248
        return $this->setProperty('unitCode', $unitCode);
249
    }
250
251
    /**
252
     * A string or text indicating the unit of measurement. Useful if you cannot
253
     * provide a standard unit code for
254
     * <a href='unitCode'>unitCode</a>.
255
     *
256
     * @param string|string[] $unitText
257
     *
258
     * @return static
259
     *
260
     * @see http://schema.org/unitText
261
     */
262
    public function unitText($unitText)
263
    {
264
        return $this->setProperty('unitText', $unitText);
265
    }
266
267
    /**
268
     * URL of the item.
269
     *
270
     * @param string|string[] $url
271
     *
272
     * @return static
273
     *
274
     * @see http://schema.org/url
275
     */
276
    public function url($url)
277
    {
278
        return $this->setProperty('url', $url);
279
    }
280
281
}
282