AgreeAction::alternateName() - Code Metrics - spatie/schema-org - Measure and Improve Code Quality continuously with Scrutinizer

AgreeAction::alternateName() A
last analyzed 2020-07-24 13:17 UTC

↳ Parent: AgreeAction

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Spatie\SchemaOrg;

use \Spatie\SchemaOrg\Contracts\AgreeActionContract;
use \Spatie\SchemaOrg\Contracts\ActionContract;
use \Spatie\SchemaOrg\Contracts\AssessActionContract;
use \Spatie\SchemaOrg\Contracts\ReactActionContract;
use \Spatie\SchemaOrg\Contracts\ThingContract;

/**
 * The act of expressing a consistency of opinion with the object. An agent
 * agrees to/about an object (a proposition, topic or theme) with participants.
 *
 * @see http://schema.org/AgreeAction
 *
 */
class AgreeAction extends BaseType implements AgreeActionContract, ActionContract, AssessActionContract, ReactActionContract, ThingContract
{
    /**
     * Indicates the current disposition of the Action.
     *
     * @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus
     *
     * @return static
     *
     * @see http://schema.org/actionStatus
     */
    public function actionStatus($actionStatus)
    {
        return $this->setProperty('actionStatus', $actionStatus);
    }

    /**
     * An additional type for the item, typically used for adding more specific
     * types from external vocabularies in microdata syntax. This is a
     * relationship between something and a class that the thing is in. In RDFa
     * syntax, it is better to use the native RDFa syntax - the 'typeof'
     * attribute - for multiple types. Schema.org tools may have only weaker
     * understanding of extra types, in particular those defined externally.
     *
     * @param string|string[] $additionalType
     *
     * @return static
     *
     * @see http://schema.org/additionalType
     */
    public function additionalType($additionalType)
    {
        return $this->setProperty('additionalType', $additionalType);
    }

    /**
     * The direct performer or driver of the action (animate or inanimate). e.g.
     * *John* wrote a book.
     *
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent
     *
     * @return static
     *
     * @see http://schema.org/agent
     */
    public function agent($agent)
    {
        return $this->setProperty('agent', $agent);
    }

    /**
     * An alias for the item.
     *
     * @param string|string[] $alternateName
     *
     * @return static
     *
     * @see http://schema.org/alternateName
     */
    public function alternateName($alternateName)
    {
        return $this->setProperty('alternateName', $alternateName);
    }

    /**
     * A description of the item.
     *
     * @param string|string[] $description
     *
     * @return static
     *
     * @see http://schema.org/description
     */
    public function description($description)
    {
        return $this->setProperty('description', $description);
    }

    /**
     * A sub property of description. A short description of the item used to
     * disambiguate from other, similar items. Information from other properties
     * (in particular, name) may be necessary for the description to be useful
     * for disambiguation.
     *
     * @param string|string[] $disambiguatingDescription
     *
     * @return static
     *
     * @see http://schema.org/disambiguatingDescription
     */
    public function disambiguatingDescription($disambiguatingDescription)
    {
        return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
    }

    /**
     * The endTime of something. For a reserved event or service (e.g.
     * FoodEstablishmentReservation), the time that it is expected to end. For
     * actions that span a period of time, when the action was performed. e.g.
     * John wrote a book from January to *December*. For media, including audio
     * and video, it's the time offset of the end of a clip within a larger
     * file.
     * 
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
     * when describing dates with times. This situation may be clarified in
     * future revisions.
     *
     * @param \DateTimeInterface|\DateTimeInterface[] $endTime
     *
     * @return static
     *
     * @see http://schema.org/endTime
     */
    public function endTime($endTime)
    {
        return $this->setProperty('endTime', $endTime);
    }

    /**
     * For failed actions, more information on the cause of the failure.
     *
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error
     *
     * @return static
     *
     * @see http://schema.org/error
     */
    public function error($error)
    {
        return $this->setProperty('error', $error);
    }

    /**
     * The identifier property represents any kind of identifier for any kind of
     * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
     * dedicated properties for representing many of these, either as textual
     * strings or as URL (URI) links. See [background
     * notes](/docs/datamodel.html#identifierBg) for more details.
     *
     * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
     *
     * @return static
     *
     * @see http://schema.org/identifier
     */
    public function identifier($identifier)
    {
        return $this->setProperty('identifier', $identifier);
    }

    /**
     * An image of the item. This can be a [[URL]] or a fully described
     * [[ImageObject]].
     *
     * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
     *
     * @return static
     *
     * @see http://schema.org/image
     */
    public function image($image)
    {
        return $this->setProperty('image', $image);
    }

    /**
     * The object that helped the agent perform the action. e.g. John wrote a
     * book with *a pen*.
     *
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
     *
     * @return static
     *
     * @see http://schema.org/instrument
     */
    public function instrument($instrument)
    {
        return $this->setProperty('instrument', $instrument);
    }

    /**
     * The location of for example where the event is happening, an organization
     * is located, or where an action takes place.
     *
     * @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|string|string[] $location
     *
     * @return static
     *
     * @see http://schema.org/location
     */
    public function location($location)
    {
        return $this->setProperty('location', $location);
    }

    /**
     * Indicates a page (or other CreativeWork) for which this thing is the main
     * entity being described. See [background
     * notes](/docs/datamodel.html#mainEntityBackground) for details.
     *
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
     *
     * @return static
     *
     * @see http://schema.org/mainEntityOfPage
     */
    public function mainEntityOfPage($mainEntityOfPage)
    {
        return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
    }

    /**
     * The name of the item.
     *
     * @param string|string[] $name
     *
     * @return static
     *
     * @see http://schema.org/name
     */
    public function name($name)
    {
        return $this->setProperty('name', $name);
    }

    /**
     * The object upon which the action is carried out, whose state is kept
     * intact or changed. Also known as the semantic roles patient, affected or
     * undergoer (which change their state) or theme (which doesn't). e.g. John
     * read *a book*.
     *
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
     *
     * @return static
     *
     * @see http://schema.org/object
     */
    public function object($object)
    {
        return $this->setProperty('object', $object);
    }

    /**
     * Other co-agents that participated in the action indirectly. e.g. John
     * wrote a book with *Steve*.
     *
     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
     *
     * @return static
     *
     * @see http://schema.org/participant
     */
    public function participant($participant)
    {
        return $this->setProperty('participant', $participant);
    }

    /**
     * Indicates a potential Action, which describes an idealized action in
     * which this thing would play an 'object' role.
     *
     * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
     *
     * @return static
     *
     * @see http://schema.org/potentialAction
     */
    public function potentialAction($potentialAction)
    {
        return $this->setProperty('potentialAction', $potentialAction);
    }

    /**
     * The result produced in the action. e.g. John wrote *a book*.
     *
     * @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
     *
     * @return static
     *
     * @see http://schema.org/result
     */
    public function result($result)
    {
        return $this->setProperty('result', $result);
    }

    /**
     * URL of a reference Web page that unambiguously indicates the item's
     * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
     * official website.
     *
     * @param string|string[] $sameAs
     *
     * @return static
     *
     * @see http://schema.org/sameAs
     */
    public function sameAs($sameAs)
    {
        return $this->setProperty('sameAs', $sameAs);
    }

    /**
     * The startTime of something. For a reserved event or service (e.g.
     * FoodEstablishmentReservation), the time that it is expected to start. For
     * actions that span a period of time, when the action was performed. e.g.
     * John wrote a book from *January* to December. For media, including audio
     * and video, it's the time offset of the start of a clip within a larger
     * file.
     * 
     * Note that Event uses startDate/endDate instead of startTime/endTime, even
     * when describing dates with times. This situation may be clarified in
     * future revisions.
     *
     * @param \DateTimeInterface|\DateTimeInterface[] $startTime
     *
     * @return static
     *
     * @see http://schema.org/startTime
     */
    public function startTime($startTime)
    {
        return $this->setProperty('startTime', $startTime);
    }

    /**
     * A CreativeWork or Event about this Thing.
     *
     * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
     *
     * @return static
     *
     * @see http://schema.org/subjectOf
     */
    public function subjectOf($subjectOf)
    {
        return $this->setProperty('subjectOf', $subjectOf);
    }

    /**
     * Indicates a target EntryPoint for an Action.
     *
     * @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[] $target
     *
     * @return static
     *
     * @see http://schema.org/target
     */
    public function target($target)
    {
        return $this->setProperty('target', $target);
    }

    /**
     * URL of the item.
     *
     * @param string|string[] $url
     *
     * @return static
     *
     * @see http://schema.org/url
     */
    public function url($url)
    {
        return $this->setProperty('url', $url);
    }

}


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

spatie / schema-org

AgreeAction::alternateName() A last analyzed 2020-07-24 13:17 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AgreeAction::alternateName() A
last analyzed 2020-07-24 13:17 UTC