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

ActionStatusType::identifier() A
last analyzed 2020-07-24 13:17 UTC

↳ Parent: ActionStatusType

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\ActionStatusTypeContract;
use \Spatie\SchemaOrg\Contracts\EnumerationContract;
use \Spatie\SchemaOrg\Contracts\IntangibleContract;
use \Spatie\SchemaOrg\Contracts\ThingContract;

/**
 * The status of an Action.
 *
 * @see http://schema.org/ActionStatusType
 *
 */
class ActionStatusType extends BaseType implements ActionStatusTypeContract, EnumerationContract, IntangibleContract, ThingContract
{
    /**
     * An in-progress action (e.g, while watching the movie, or driving to a
     * location).
     *
     * @see http://schema.org/ActiveActionStatus
     */
     const ActiveActionStatus = 'http://schema.org/ActiveActionStatus';

    /**
     * An action that has already taken place.
     *
     * @see http://schema.org/CompletedActionStatus
     */
     const CompletedActionStatus = 'http://schema.org/CompletedActionStatus';

    /**
     * An action that failed to complete. The action's error property and the
     * HTTP return code contain more information about the failure.
     *
     * @see http://schema.org/FailedActionStatus
     */
     const FailedActionStatus = 'http://schema.org/FailedActionStatus';

    /**
     * A description of an action that is supported.
     *
     * @see http://schema.org/PotentialActionStatus
     */
     const PotentialActionStatus = 'http://schema.org/PotentialActionStatus';

    /**
     * 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);
    }

    /**
     * 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 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);
    }

    /**
     * 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);
    }

    /**
     * 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);
    }

    /**
     * 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);
    }

    /**
     * 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);
    }

    /**
     * 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\ActionStatusTypeContract;
6			use \Spatie\SchemaOrg\Contracts\EnumerationContract;
7			use \Spatie\SchemaOrg\Contracts\IntangibleContract;
8			use \Spatie\SchemaOrg\Contracts\ThingContract;
9
10			/**
11			* The status of an Action.
12			*
13			* @see http://schema.org/ActionStatusType
14			*
15			*/
16			class ActionStatusType extends BaseType implements ActionStatusTypeContract, EnumerationContract, IntangibleContract, ThingContract
17			{
18			/**
19			* An in-progress action (e.g, while watching the movie, or driving to a
20			* location).
21			*
22			* @see http://schema.org/ActiveActionStatus
23			*/
24			const ActiveActionStatus = 'http://schema.org/ActiveActionStatus';
25
26			/**
27			* An action that has already taken place.
28			*
29			* @see http://schema.org/CompletedActionStatus
30			*/
31			const CompletedActionStatus = 'http://schema.org/CompletedActionStatus';
32
33			/**
34			* An action that failed to complete. The action's error property and the
35			* HTTP return code contain more information about the failure.
36			*
37			* @see http://schema.org/FailedActionStatus
38			*/
39			const FailedActionStatus = 'http://schema.org/FailedActionStatus';
40
41			/**
42			* A description of an action that is supported.
43			*
44			* @see http://schema.org/PotentialActionStatus
45			*/
46			const PotentialActionStatus = 'http://schema.org/PotentialActionStatus';
47
48			/**
49			* An additional type for the item, typically used for adding more specific
50			* types from external vocabularies in microdata syntax. This is a
51			* relationship between something and a class that the thing is in. In RDFa
52			* syntax, it is better to use the native RDFa syntax - the 'typeof'
53			* attribute - for multiple types. Schema.org tools may have only weaker
54			* understanding of extra types, in particular those defined externally.
55			*
56			* @param string\|string[] $additionalType
57			*
58			* @return static
59			*
60			* @see http://schema.org/additionalType
61			*/
62			public function additionalType($additionalType)
63			{
64			return $this->setProperty('additionalType', $additionalType);
65			}
66
67			/**
68			* An alias for the item.
69			*
70			* @param string\|string[] $alternateName
71			*
72			* @return static
73			*
74			* @see http://schema.org/alternateName
75			*/
76			public function alternateName($alternateName)
77			{
78			return $this->setProperty('alternateName', $alternateName);
79			}
80
81			/**
82			* A description of the item.
83			*
84			* @param string\|string[] $description
85			*
86			* @return static
87			*
88			* @see http://schema.org/description
89			*/
90			public function description($description)
91			{
92			return $this->setProperty('description', $description);
93			}
94
95			/**
96			* A sub property of description. A short description of the item used to
97			* disambiguate from other, similar items. Information from other properties
98			* (in particular, name) may be necessary for the description to be useful
99			* for disambiguation.
100			*
101			* @param string\|string[] $disambiguatingDescription
102			*
103			* @return static
104			*
105			* @see http://schema.org/disambiguatingDescription
106			*/
107			public function disambiguatingDescription($disambiguatingDescription)
108			{
109			return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
110			}
111
112			/**
113			* The 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			* URL of a reference Web page that unambiguously indicates the item's
192			* identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
193			* official website.
194			*
195			* @param string\|string[] $sameAs
196			*
197			* @return static
198			*
199			* @see http://schema.org/sameAs
200			*/
201			public function sameAs($sameAs)
202			{
203			return $this->setProperty('sameAs', $sameAs);
204			}
205
206			/**
207			* A CreativeWork or Event about this Thing.
208			*
209			* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract\|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]\|\Spatie\SchemaOrg\Contracts\EventContract\|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
210			*
211			* @return static
212			*
213			* @see http://schema.org/subjectOf
214			*/
215			public function subjectOf($subjectOf)
216			{
217			return $this->setProperty('subjectOf', $subjectOf);
218			}
219
220			/**
221			* URL of the item.
222			*
223			* @param string\|string[] $url
224			*
225			* @return static
226			*
227			* @see http://schema.org/url
228			*/
229			public function url($url)
230			{
231			return $this->setProperty('url', $url);
232			}
233
234			}
235

spatie / schema-org

ActionStatusType::identifier() A last analyzed 2020-07-24 13:17 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ActionStatusType::identifier() A
last analyzed 2020-07-24 13:17 UTC