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

ActionAccessSpecification::description() A
last analyzed 2020-07-24 13:17 UTC

↳ Parent: ActionAccessSpecification

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

/**
 * A set of requirements that a must be fulfilled in order to perform an Action.
 *
 * @see http://schema.org/ActionAccessSpecification
 *
 */
class ActionAccessSpecification extends BaseType implements ActionAccessSpecificationContract, IntangibleContract, ThingContract
{
    /**
     * 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);
    }

    /**
     * 
     *
     * @param  $availabilityEnds
     *
     * @return static
     *
     * @see http://schema.org/availabilityEnds
     */
    public function availabilityEnds($availabilityEnds)
    {
        return $this->setProperty('availabilityEnds', $availabilityEnds);
    }

    /**
     * 
     *
     * @param  $availabilityStarts
     *
     * @return static
     *
     * @see http://schema.org/availabilityStarts
     */
    public function availabilityStarts($availabilityStarts)
    {
        return $this->setProperty('availabilityStarts', $availabilityStarts);
    }

    /**
     * 
     *
     * @param  $category
     *
     * @return static
     *
     * @see http://schema.org/category
     */
    public function category($category)
    {
        return $this->setProperty('category', $category);
    }

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

    /**
     * 
     *
     * @param  $eligibleRegion
     *
     * @return static
     *
     * @see http://schema.org/eligibleRegion
     */
    public function eligibleRegion($eligibleRegion)
    {
        return $this->setProperty('eligibleRegion', $eligibleRegion);
    }

    /**
     * 
     *
     * @param  $expectsAcceptanceOf
     *
     * @return static
     *
     * @see http://schema.org/expectsAcceptanceOf
     */
    public function expectsAcceptanceOf($expectsAcceptanceOf)
    {
        return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf);
    }

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

    /**
     * 
     *
     * @param \Spatie\SchemaOrg\Contracts\MediaSubscriptionContract|\Spatie\SchemaOrg\Contracts\MediaSubscriptionContract[] $requiresSubscription
     *
     * @return static
     *
     * @see http://schema.org/requiresSubscription
     */
    public function requiresSubscription($requiresSubscription)
    {
        return $this->setProperty('requiresSubscription', $requiresSubscription);
    }

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

spatie / schema-org

ActionAccessSpecification::description() A last analyzed 2020-07-24 13:17 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ActionAccessSpecification::description() A
last analyzed 2020-07-24 13:17 UTC