JsonLd::service() - Code Metrics - Inspection of "Json ld added intangible and service" - luyadev/luya - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1930)

by Basil

created 2020-04-23 11:45 UTC

JsonLd::service() A

↳ Parent: JsonLd

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 luya\web;

use luya\web\jsonld\Service;
use Yii;
use yii\helpers\Json;
use yii\base\BaseObject;
use luya\Exception;
use luya\web\jsonld\Person;
use luya\web\jsonld\Event;
use luya\web\jsonld\Place;
use luya\web\jsonld\LiveBlogPosting;
use luya\web\jsonld\Article;
use luya\web\jsonld\BlogPosting;
use luya\web\jsonld\CreativeWork;
use luya\web\jsonld\Organization;
use luya\web\jsonld\SocialMediaPosting;
use luya\web\jsonld\Thing;
use luya\web\jsonld\ImageObject;
use luya\web\jsonld\AggregateRating;
use luya\web\jsonld\Rating;
use luya\web\jsonld\Comment;
use luya\web\jsonld\ContactPoint;
use luya\web\jsonld\Country;
use luya\web\jsonld\Offer;
use luya\web\jsonld\PostalAddress;
use luya\web\jsonld\PropertyValue;

/**
 * Registerin Microdata as JsonLD.
 *
 * In order to register a json ld tag just call:
 *
 * ```php
 * JsonLd::person()
 *    ->setGivenName('Albert')
 *    ->setFamilyName('Einstein')
 *    ->setBirthPlace('Ulm, Germany');
 * ```
 *
 * Or any other tags. This will register the json ld output into the layout file of the view.
 *
 * @see https://schema.org/docs/schemas.html
 * @author Basil Suter <[email protected]>
 * @since 1.0.0
 */
class JsonLd extends BaseObject
{
    /**
     * Register new Article.
     *
     * An article, such as a news article or piece of investigative report.
     * Newspapers and magazines have articles of many different types and this is intended to cover them all.
     *
     * @param array $config Optional config array to provided article data via setter methods.
     * @return \luya\web\jsonld\Article
     * @since 1.0.1
     */
    public static function article(array $config = [])
    {
        return self::addGraph((new Article($config)));

    }

    /**
     * Register new Blog Posting.
     *
     * @param array $config Optional config array to provided blog posting data via setter methods.
     * @return \luya\web\jsonld\BlogPosting
     * @since 1.0.1
     */
    public static function blogPosting(array $config = [])
    {
        return self::addGraph((new BlogPosting($config)));

    }

    /**
     * Register new Thing.
     *
     * @param array $config Optional config array to provided person data via setter methods.
     * @return \luya\web\jsonld\Thing
     */
    public static function thing(array $config = [])
    {
        return self::addGraph((new Thing($config)));

    }

    /**
     * Register new CreativeWork.
     *
     * The most generic kind of creative work, including books, movies, photographs, software programs, etc.
     *
     * @param array $config Optional config array to provided creative work data via setter methods.
     * @return \luya\web\jsonld\CreativeWork
     * @since 1.0.1
     */
    public static function creativeWork(array $config = [])
    {
        return self::addGraph((new CreativeWork($config)));

    }
    
    /**
     * Register new Event.
     *
     * An event happening at a certain time and location, such as a concert, lecture, or festival.
     *
     * @param array $config
     * @return \luya\web\jsonld\Event
     */
    public static function event(array $config = [])
    {
        return self::addGraph((new Event($config)));

    }

    /**
     * Register new Live Blog Posting.
     *
     * A blog post intended to provide a rolling textual coverage of an ongoing event through continuous updates.
     *
     * @param array $config Optional config array to provided live blog posting data via setter methods.
     * @return \luya\web\jsonld\LiveBlogPosting
     * @since 1.0.1
     */
    public static function liveBlogPosting(array $config = [])
    {
        return self::addGraph((new LiveBlogPosting($config)));

    }

    /**
     * Register new Organization.
     *
     * An organization such as a school, NGO, corporation, club, etc.
     *
     * @param array $config Optional config array to provided organization data via setter methods.
     * @return \luya\web\jsonld\Organization
     */
    public static function organization(array $config = [])
    {
        return self::addGraph((new Organization($config)));

    }
    
    /**
     * Register new Person.
     *
     * A person (alive, dead, undead, or fictional).
     *
     * @param array $config Optional config array to provided person data via setter methods.
     * @return \luya\web\jsonld\Person
     */
    public static function person(array $config = [])
    {
        return self::addGraph((new Person($config)));

    }

    /**
     * Register new Place
     *
     * Entities that have a somewhat fixed, physical extension.
     *
     * @param array $config Optional config array to provided place data via setter methods.
     * @return \luya\web\jsonld\Place
     */
    public static function place(array $config = [])
    {
        return self::addGraph((new Place($config)));

    }

    /**
     * Register new Social Media Posting.
     *
     * A post to a social media platform, including blog posts, tweets, Facebook posts, etc.
     *
     * @param array $config Optional config array to provided social media posting data via setter methods.
     * @return \luya\web\jsonld\SocialMediaPosting
     * @since 1.0.1
     */
    public static function socialMediaPosting(array $config = [])
    {
        return self::addGraph((new SocialMediaPosting($config)));

    }

    /**
     * Register new Image Object.
     *
     * @param array $config
     * @return \luya\web\jsonld\ImageObject
     * @since 1.0.3
     */
    public static function imageObject(array $config = [])
    {
        return self::addGraph((new ImageObject($config)));

    }
    
    /**
     * Register new Aggregated Rating.
     *
     * @param array $config
     * @return \luya\web\jsonld\AggregateRating
     * @since 1.0.3
     */
    public static function aggregateRating(array $config = [])
    {
        return self::addGraph((new AggregateRating($config)));

    }

    /**
     * Register new Rating.
     *
     * @param array $config
     * @return \luya\web\jsonld\Rating
     * @since 1.0.3
     */
    public static function rating(array $config = [])
    {
        return self::addGraph((new Rating($config)));

    }
    
    /**
     * Register new Comment.
     *
     * @param array $config
     * @return \luya\web\jsonld\Comment
     * @since 1.0.3
     */
    public static function comment(array $config = [])
    {
        return self::addGraph((new Comment($config)));

    }
    
    /**
     * Register new Contact Point.
     *
     * This is mainly used for addresses or user coordinates like email, telephone etc.
     *
     * @param array $config
     * @return \luya\web\jsonld\ContactPoint
     * @since 1.0.3
     */
    public static function contactPoint(array $config = [])
    {
        return self::addGraph((new ContactPoint($config)));

    }
    
    /**
     * Register new Country.
     *
     * @param array $config
     * @return \luya\web\jsonld\Country
     * @since 1.0.3
     */
    public static function country(array $config = [])
    {
        return self::addGraph((new Country($config)));

    }

    /**
     * Register new Offer.
     *
     * This is used for selling products.
     *
     * @param array $config
     * @return \luya\web\jsonld\Offer
     * @since 1.0.3
     */
    public static function offer(array $config = [])
    {
        return self::addGraph((new Offer($config)));

    }
    
    /**
     * Register new Postal Address.
     *
     * @param array $config
     * @return \luya\web\jsonld\PostalAddress
     * @since 1.0.3
     */
    public static function postalAddress(array $config = [])

    {
        return self::addGraph((new PostalAddress()));

    }
    
    /**
     * Register new Property Value.
     *
     * @param array $config
     * @return \luya\web\jsonld\PropertyValue
     * @since 1.0.3
     */
    public static function propertyValue(array $config = [])
    {
        return self::addGraph((new PropertyValue($config)));

    }

    /**
     * Register a new service
     *
     * @param array $config
     * @return \luya\web\jsonld\Service
     * @since 1.0.19
     */
    public static function service(array $config = [])
    {
        return self::addGraph((new Service($config)));

    }
    
    /**
     * Register graph data.
     *
     * @param \luya\web\jsonld\BaseThing|array $data Can be either an array or an object based on {{luya\web\jsonld\BaseThing}} which contains the Arrayable Inteface.
     * @return array|object
     */
    public static function addGraph($data)
    {
        self::registerView();
        
        if (is_scalar($data)) {
            throw new Exception("Data must be either an array or an object of type luya\web\jsonld\BaseThing.");
        }
        
        Yii::$app->view->params['@context'] = 'https://schema.org';
        Yii::$app->view->params['@graph'][] = $data;
        
        return $data;
    }
    
    /**
     * Reset the JsonLd Data.
     *
     * This method is mainly usefull when working with unit tests for JsonLd.
     */
    public static function reset()
    {
        self::$_view = null;
        Yii::$app->view->params['@graph'] = [];
    }
    
    private static $_view;
    
    /**
     * Register the view file an observe the event which then reads the data from @graph params key.
     */
    protected static function registerView()
    {
        if (self::$_view === null) {
            Yii::$app->view->on(View::EVENT_BEGIN_BODY, function ($event) {
                echo '<script type="application/ld+json">' . Json::encode($event->sender->params) . '</script>';
            });
                    
            self::$_view = true;
        }
    }
}


1			<?php
2
3			namespace luya\web;
4
5			use luya\web\jsonld\Service;
6			use Yii;
7			use yii\helpers\Json;
8			use yii\base\BaseObject;
9			use luya\Exception;
10			use luya\web\jsonld\Person;
11			use luya\web\jsonld\Event;
12			use luya\web\jsonld\Place;
13			use luya\web\jsonld\LiveBlogPosting;
14			use luya\web\jsonld\Article;
15			use luya\web\jsonld\BlogPosting;
16			use luya\web\jsonld\CreativeWork;
17			use luya\web\jsonld\Organization;
18			use luya\web\jsonld\SocialMediaPosting;
19			use luya\web\jsonld\Thing;
20			use luya\web\jsonld\ImageObject;
21			use luya\web\jsonld\AggregateRating;
22			use luya\web\jsonld\Rating;
23			use luya\web\jsonld\Comment;
24			use luya\web\jsonld\ContactPoint;
25			use luya\web\jsonld\Country;
26			use luya\web\jsonld\Offer;
27			use luya\web\jsonld\PostalAddress;
28			use luya\web\jsonld\PropertyValue;
29
30			/**
31			* Registerin Microdata as JsonLD.
32			*
33			* In order to register a json ld tag just call:
34			*
35			* ```php
36			* JsonLd::person()
37			* ->setGivenName('Albert')
38			* ->setFamilyName('Einstein')
39			* ->setBirthPlace('Ulm, Germany');
40			* ```
41			*
42			* Or any other tags. This will register the json ld output into the layout file of the view.
43			*
44			* @see https://schema.org/docs/schemas.html
45			* @author Basil Suter <[email protected]>
46			* @since 1.0.0
47			*/
48			class JsonLd extends BaseObject
49			{
50			/**
51			* Register new Article.
52			*
53			* An article, such as a news article or piece of investigative report.
54			* Newspapers and magazines have articles of many different types and this is intended to cover them all.
55			*
56			* @param array $config Optional config array to provided article data via setter methods.
57			* @return \luya\web\jsonld\Article
58			* @since 1.0.1
59			*/
60			public static function article(array $config = [])
61			{
62			return self::addGraph((new Article($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-12-21 00:01 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...onld\Article($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 62 which is incompatible with the return type documented by `luya\web\JsonLd::article` of type `luya\web\jsonld\Article`. Loading history...
63			}
64
65			/**
66			* Register new Blog Posting.
67			*
68			* @param array $config Optional config array to provided blog posting data via setter methods.
69			* @return \luya\web\jsonld\BlogPosting
70			* @since 1.0.1
71			*/
72			public static function blogPosting(array $config = [])
73			{
74			return self::addGraph((new BlogPosting($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-12-21 00:01 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...\BlogPosting($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 74 which is incompatible with the return type documented by `luya\web\JsonLd::blogPosting` of type `luya\web\jsonld\BlogPosting`. Loading history...
75			}
76
77			/**
78			* Register new Thing.
79			*
80			* @param array $config Optional config array to provided person data via setter methods.
81			* @return \luya\web\jsonld\Thing
82			*/
83			public static function thing(array $config = [])
84			{
85			return self::addGraph((new Thing($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-11-14 09:34 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...jsonld\Thing($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 85 which is incompatible with the return type documented by `luya\web\JsonLd::thing` of type `luya\web\jsonld\Thing`. Loading history...
86			}
87
88			/**
89			* Register new CreativeWork.
90			*
91			* The most generic kind of creative work, including books, movies, photographs, software programs, etc.
92			*
93			* @param array $config Optional config array to provided creative work data via setter methods.
94			* @return \luya\web\jsonld\CreativeWork
95			* @since 1.0.1
96			*/
97			public static function creativeWork(array $config = [])
98			{
99			return self::addGraph((new CreativeWork($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-12-20 18:39 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...CreativeWork($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 99 which is incompatible with the return type documented by `luya\web\JsonLd::creativeWork` of type `luya\web\jsonld\CreativeWork`. Loading history...
100			}
101
102			/**
103			* Register new Event.
104			*
105			* An event happening at a certain time and location, such as a concert, lecture, or festival.
106			*
107			* @param array $config
108			* @return \luya\web\jsonld\Event
109			*/
110			public static function event(array $config = [])
111			{
112			return self::addGraph((new Event($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-10-21 14:07 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...jsonld\Event($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 112 which is incompatible with the return type documented by `luya\web\JsonLd::event` of type `luya\web\jsonld\Event`. Loading history...
113			}
114
115			/**
116			* Register new Live Blog Posting.
117			*
118			* A blog post intended to provide a rolling textual coverage of an ongoing event through continuous updates.
119			*
120			* @param array $config Optional config array to provided live blog posting data via setter methods.
121			* @return \luya\web\jsonld\LiveBlogPosting
122			* @since 1.0.1
123			*/
124			public static function liveBlogPosting(array $config = [])
125			{
126			return self::addGraph((new LiveBlogPosting($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-12-27 16:09 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...eBlogPosting($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 126 which is incompatible with the return type documented by `luya\web\JsonLd::liveBlogPosting` of type `luya\web\jsonld\LiveBlogPosting`. Loading history...
127			}
128
129			/**
130			* Register new Organization.
131			*
132			* An organization such as a school, NGO, corporation, club, etc.
133			*
134			* @param array $config Optional config array to provided organization data via setter methods.
135			* @return \luya\web\jsonld\Organization
136			*/
137			public static function organization(array $config = [])
138			{
139			return self::addGraph((new Organization($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-11-14 09:34 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...Organization($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 139 which is incompatible with the return type documented by `luya\web\JsonLd::organization` of type `luya\web\jsonld\Organization`. Loading history...
140			}
141
142			/**
143			* Register new Person.
144			*
145			* A person (alive, dead, undead, or fictional).
146			*
147			* @param array $config Optional config array to provided person data via setter methods.
148			* @return \luya\web\jsonld\Person
149			*/
150			public static function person(array $config = [])
151			{
152			return self::addGraph((new Person($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-10-21 14:07 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...sonld\Person($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 152 which is incompatible with the return type documented by `luya\web\JsonLd::person` of type `luya\web\jsonld\Person`. Loading history...
153			}
154
155			/**
156			* Register new Place
157			*
158			* Entities that have a somewhat fixed, physical extension.
159			*
160			* @param array $config Optional config array to provided place data via setter methods.
161			* @return \luya\web\jsonld\Place
162			*/
163			public static function place(array $config = [])
164			{
165			return self::addGraph((new Place($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-11-28 13:25 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...jsonld\Place($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 165 which is incompatible with the return type documented by `luya\web\JsonLd::place` of type `luya\web\jsonld\Place`. Loading history...
166			}
167
168			/**
169			* Register new Social Media Posting.
170			*
171			* A post to a social media platform, including blog posts, tweets, Facebook posts, etc.
172			*
173			* @param array $config Optional config array to provided social media posting data via setter methods.
174			* @return \luya\web\jsonld\SocialMediaPosting
175			* @since 1.0.1
176			*/
177			public static function socialMediaPosting(array $config = [])
178			{
179			return self::addGraph((new SocialMediaPosting($config)));
			0 ignored issues – show Bug Compatibility introduced 2017-12-21 00:01 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...MediaPosting($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 179 which is incompatible with the return type documented by `luya\web\JsonLd::socialMediaPosting` of type `luya\web\jsonld\SocialMediaPosting`. Loading history...
180			}
181
182			/**
183			* Register new Image Object.
184			*
185			* @param array $config
186			* @return \luya\web\jsonld\ImageObject
187			* @since 1.0.3
188			*/
189			public static function imageObject(array $config = [])
190			{
191			return self::addGraph((new ImageObject($config)));
			0 ignored issues – show Bug Compatibility introduced 2018-01-24 11:38 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...\ImageObject($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 191 which is incompatible with the return type documented by `luya\web\JsonLd::imageObject` of type `luya\web\jsonld\ImageObject`. Loading history...
192			}
193
194			/**
195			* Register new Aggregated Rating.
196			*
197			* @param array $config
198			* @return \luya\web\jsonld\AggregateRating
199			* @since 1.0.3
200			*/
201			public static function aggregateRating(array $config = [])
202			{
203			return self::addGraph((new AggregateRating($config)));
			0 ignored issues – show Bug Compatibility introduced 2018-01-24 11:38 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...regateRating($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 203 which is incompatible with the return type documented by `luya\web\JsonLd::aggregateRating` of type `luya\web\jsonld\AggregateRating`. Loading history...
204			}
205
206			/**
207			* Register new Rating.
208			*
209			* @param array $config
210			* @return \luya\web\jsonld\Rating
211			* @since 1.0.3
212			*/
213			public static function rating(array $config = [])
214			{
215			return self::addGraph((new Rating($config)));
			0 ignored issues – show Bug Compatibility introduced 2018-01-24 11:38 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...sonld\Rating($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 215 which is incompatible with the return type documented by `luya\web\JsonLd::rating` of type `luya\web\jsonld\Rating`. Loading history...
216			}
217
218			/**
219			* Register new Comment.
220			*
221			* @param array $config
222			* @return \luya\web\jsonld\Comment
223			* @since 1.0.3
224			*/
225			public static function comment(array $config = [])
226			{
227			return self::addGraph((new Comment($config)));
			0 ignored issues – show Bug Compatibility introduced 2018-01-24 11:38 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...onld\Comment($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 227 which is incompatible with the return type documented by `luya\web\JsonLd::comment` of type `luya\web\jsonld\Comment`. Loading history...
228			}
229
230			/**
231			* Register new Contact Point.
232			*
233			* This is mainly used for addresses or user coordinates like email, telephone etc.
234			*
235			* @param array $config
236			* @return \luya\web\jsonld\ContactPoint
237			* @since 1.0.3
238			*/
239			public static function contactPoint(array $config = [])
240			{
241			return self::addGraph((new ContactPoint($config)));
			0 ignored issues – show Bug Compatibility introduced 2018-04-29 10:31 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...ContactPoint($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 241 which is incompatible with the return type documented by `luya\web\JsonLd::contactPoint` of type `luya\web\jsonld\ContactPoint`. Loading history...
242			}
243
244			/**
245			* Register new Country.
246			*
247			* @param array $config
248			* @return \luya\web\jsonld\Country
249			* @since 1.0.3
250			*/
251			public static function country(array $config = [])
252			{
253			return self::addGraph((new Country($config)));
			0 ignored issues – show Bug Compatibility introduced 2018-01-24 11:38 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...onld\Country($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 253 which is incompatible with the return type documented by `luya\web\JsonLd::country` of type `luya\web\jsonld\Country`. Loading history...
254			}
255
256			/**
257			* Register new Offer.
258			*
259			* This is used for selling products.
260			*
261			* @param array $config
262			* @return \luya\web\jsonld\Offer
263			* @since 1.0.3
264			*/
265			public static function offer(array $config = [])
266			{
267			return self::addGraph((new Offer($config)));
			0 ignored issues – show Bug Compatibility introduced 2018-01-24 11:38 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...jsonld\Offer($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 267 which is incompatible with the return type documented by `luya\web\JsonLd::offer` of type `luya\web\jsonld\Offer`. Loading history...
268			}
269
270			/**
271			* Register new Postal Address.
272			*
273			* @param array $config
274			* @return \luya\web\jsonld\PostalAddress
275			* @since 1.0.3
276			*/
277			public static function postalAddress(array $config = [])
			0 ignored issues – show Unused Code introduced 2018-01-24 11:38 UTC by Report Bug Copy Issue Report The parameter `$config` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
278			{
279			return self::addGraph((new PostalAddress()));
			0 ignored issues – show Bug Compatibility introduced 2018-01-24 11:38 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...sonld\PostalAddress());` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 279 which is incompatible with the return type documented by `luya\web\JsonLd::postalAddress` of type `luya\web\jsonld\PostalAddress`. Loading history...
280			}
281
282			/**
283			* Register new Property Value.
284			*
285			* @param array $config
286			* @return \luya\web\jsonld\PropertyValue
287			* @since 1.0.3
288			*/
289			public static function propertyValue(array $config = [])
290			{
291			return self::addGraph((new PropertyValue($config)));
			0 ignored issues – show Bug Compatibility introduced 2018-01-24 11:38 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...ropertyValue($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 291 which is incompatible with the return type documented by `luya\web\JsonLd::propertyValue` of type `luya\web\jsonld\PropertyValue`. Loading history...
292			}
293
294			/**
295			* Register a new service
296			*
297			* @param array $config
298			* @return \luya\web\jsonld\Service
299			* @since 1.0.19
300			*/
301			public static function service(array $config = [])
302			{
303			return self::addGraph((new Service($config)));
			0 ignored issues – show Bug Compatibility introduced 2019-06-13 15:37 UTC by Report Bug Copy Issue Report The expression `self::addGraph(new \luya...onld\Service($config));` of type `luya\web\jsonld\BaseThing\|array` adds the type `array` to the return on line 303 which is incompatible with the return type documented by `luya\web\JsonLd::service` of type `luya\web\jsonld\Service`. Loading history...
304			}
305
306			/**
307			* Register graph data.
308			*
309			* @param \luya\web\jsonld\BaseThing\|array $data Can be either an array or an object based on {{luya\web\jsonld\BaseThing}} which contains the Arrayable Inteface.
310			* @return array\|object
311			*/
312			public static function addGraph($data)
313			{
314			self::registerView();
315
316			if (is_scalar($data)) {
317			throw new Exception("Data must be either an array or an object of type luya\web\jsonld\BaseThing.");
318			}
319
320			Yii::$app->view->params['@context'] = 'https://schema.org';
321			Yii::$app->view->params['@graph'][] = $data;
322
323			return $data;
324			}
325
326			/**
327			* Reset the JsonLd Data.
328			*
329			* This method is mainly usefull when working with unit tests for JsonLd.
330			*/
331			public static function reset()
332			{
333			self::$_view = null;
334			Yii::$app->view->params['@graph'] = [];
335			}
336
337			private static $_view;
338
339			/**
340			* Register the view file an observe the event which then reads the data from @graph params key.
341			*/
342			protected static function registerView()
343			{
344			if (self::$_view === null) {
345			Yii::$app->view->on(View::EVENT_BEGIN_BODY, function ($event) {
346			echo '<script type="application/ld+json">' . Json::encode($event->sender->params) . '</script>';
347			});
348
349			self::$_view = true;
350			}
351			}
352			}
353

luyadev / luya

Pull Request — master (#1930)

JsonLd::service() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like