WebPage::sameAs() - Code Metrics - Inspection of "alter namespace WilderAmorim to ElePHPant" - wilderamorim/structured-data - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (fcb3e8)

by Wilder

created 2020-03-16 16:27 UTC

WebPage::sameAs() A

↳ Parent: WebPage

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php


namespace ElePHPant\StructuredData;

/**
 * Class WebPage
 * @package ElePHPant\StructuredData
 */
class WebPage extends Schema
{
    /**
     * @var \stdClass
     */
    protected $data;

    /**
     * @see https://schema.org/WebPage
     */
    const TYPE = 'WebPage';

    /**
     * WebPage constructor.
     */
    public function __construct()
    {
        $this->data = new \stdClass();
        parent::__construct();
    }

    /**
     * @return object
     */
    public function header(): object
    {
        return $this->data->header;
    }

    /**
     * @return string
     */
    public function name(): string
    {
        return $this->data->name;
    }

    /**
     * @return string
     */
    public function url(): string
    {
        return $this->data->url;
    }

    /**
     * @return string
     */
    public function description(): string
    {
        return $this->data->description;
    }

    /**
     * @return array|null
     */
    public function sameAs(): ?array
    {
        return $this->webPageSameAs;
    }

    /**
     * @param string $name
     * @param string $description
     * @param string $image
     * @param string $url
     * @param string $inLanguage
     * @return WebPage
     */
    public function start(
        string $name,
        string $description,
        string $image,
        string $url,
        string $inLanguage = 'en-US'
    ): WebPage {
        $this->data->name = $name;
        $this->data->url = $url;
        $this->data->description = $description;
        $this->data->image = $image;
        $this->data->inLanguage = $inLanguage;

        $this->webPageName = $this->data->name;
        $this->webPageUrl = $this->data->url;

        $this->data->header = (object)[
            '@context' => Schema::CONTEXT,
            '@type' => self::TYPE,
            'name' => $this->data->name,
            'description' => $this->data->description,
            'image' => $this->data->image,
            'url' => $this->data->url,
            'inLanguage' => $this->data->inLanguage
        ];
        return $this;
    }

    /**
     * @see https://schema.org/isPartOf
     *
     * @param string $logo
     * @param string $image
     * @param string $type
     * @param array|null $sameAs
     * @return WebPage
     */
    public function isPartOf(string $logo, string $image, string $type = 'WebSite', ?array $sameAs = null): WebPage
    {
        $this->webPageSameAs = $sameAs;

        $this->data->isPartOf = (object)[
            '@type' => $type,
            'name' => $this->data->name,
            'url' => $this->data->url,
            'publisher' => $this->organization($logo, $image)
        ];
        return $this;
    }

    /**
     * @see https://schema.org/about
     *
     * @param string $image
     * @return WebPage
     */
    public function about(string $image): WebPage
    {
        $this->data->about = $this->organization($image, $image);
        return $this;
    }

    /**
     * @see https://schema.org/creator
     *
     * @param string $organizationImage
     * @param string $addressLocality
     * @param string $addressRegion
     * @param string $postalCode
     * @param string $streetAddress
     * @param string $personName
     * @param string $personImage
     * @param array|null $sameAs
     * @return WebPage
     */
    public function creator(
        string $organizationImage,
        string $addressLocality,
        string $addressRegion,
        string $postalCode,
        string $streetAddress,
        string $personName,
        string $personImage,
        ?array $sameAs = null
    ): WebPage {
        $address = [
            'addressLocality' => $addressLocality,
            'addressRegion' => $addressRegion,
            'postalCode' => $postalCode,
            'streetAddress' => $streetAddress
        ];

        $this->data->organization = $this->organization($organizationImage, $organizationImage, $address);
        $this->data->person = $this->person($personName, $personImage, $sameAs);

        $this->data->creator = [
            'organization' => $this->data->organization,
            'person' => $this->data->person
        ];
        return $this;
    }

    /**
     * @return object
     */
    public function data(): object
    {
        $this->data = (object)[
            'header' => $this->header(),
            'isPartOf' => (object)$this->data->isPartOf,
            'about' => (object)$this->data->about,
            'creator' => $this->data->creator,
            'organization' => $this->organization,
            'image' => $this->imageObject
        ];
        return $this->data;
    }

    /**
     * @param bool $tag
     * @return string
     */
    public function render(bool $tag = false): string
    {
        $render = [
            '@context' => Schema::CONTEXT,
            '@type' => self::TYPE,
            'name' => $this->data->name,
            'description' => $this->data->description,
            'image' => $this->data->image,
            'url' => $this->data->url,
            'inLanguage' => $this->data->inLanguage,
            'isPartOf' => [$this->data->isPartOf],
            'about' => [$this->data->about],
            'creator' => [$this->data->organization, $this->data->person],
        ];

        if ($tag) {
            return '<script type="application/ld+json">' . $this->json($render) . '</script>';
        }

        return $this->json($render);
    }

    /**
     * Responsible method for debug all data
     */
    public function debug(): void
    {
        var_dump($this->data());

    }
}

1			<?php
2
3
4			namespace ElePHPant\StructuredData;
5
6			/**
7			* Class WebPage
8			* @package ElePHPant\StructuredData
9			*/
10			class WebPage extends Schema
11			{
12			/**
13			* @var \stdClass
14			*/
15			protected $data;
16
17			/**
18			* @see https://schema.org/WebPage
19			*/
20			const TYPE = 'WebPage';
21
22			/**
23			* WebPage constructor.
24			*/
25			public function __construct()
26			{
27			$this->data = new \stdClass();
28			parent::__construct();
29			}
30
31			/**
32			* @return object
33			*/
34			public function header(): object
35			{
36			return $this->data->header;
37			}
38
39			/**
40			* @return string
41			*/
42			public function name(): string
43			{
44			return $this->data->name;
45			}
46
47			/**
48			* @return string
49			*/
50			public function url(): string
51			{
52			return $this->data->url;
53			}
54
55			/**
56			* @return string
57			*/
58			public function description(): string
59			{
60			return $this->data->description;
61			}
62
63			/**
64			* @return array\|null
65			*/
66			public function sameAs(): ?array
67			{
68			return $this->webPageSameAs;
69			}
70
71			/**
72			* @param string $name
73			* @param string $description
74			* @param string $image
75			* @param string $url
76			* @param string $inLanguage
77			* @return WebPage
78			*/
79			public function start(
80			string $name,
81			string $description,
82			string $image,
83			string $url,
84			string $inLanguage = 'en-US'
85			): WebPage {
86			$this->data->name = $name;
87			$this->data->url = $url;
88			$this->data->description = $description;
89			$this->data->image = $image;
90			$this->data->inLanguage = $inLanguage;
91
92			$this->webPageName = $this->data->name;
93			$this->webPageUrl = $this->data->url;
94
95			$this->data->header = (object)[
96			'@context' => Schema::CONTEXT,
97			'@type' => self::TYPE,
98			'name' => $this->data->name,
99			'description' => $this->data->description,
100			'image' => $this->data->image,
101			'url' => $this->data->url,
102			'inLanguage' => $this->data->inLanguage
103			];
104			return $this;
105			}
106
107			/**
108			* @see https://schema.org/isPartOf
109			*
110			* @param string $logo
111			* @param string $image
112			* @param string $type
113			* @param array\|null $sameAs
114			* @return WebPage
115			*/
116			public function isPartOf(string $logo, string $image, string $type = 'WebSite', ?array $sameAs = null): WebPage
117			{
118			$this->webPageSameAs = $sameAs;
119
120			$this->data->isPartOf = (object)[
121			'@type' => $type,
122			'name' => $this->data->name,
123			'url' => $this->data->url,
124			'publisher' => $this->organization($logo, $image)
125			];
126			return $this;
127			}
128
129			/**
130			* @see https://schema.org/about
131			*
132			* @param string $image
133			* @return WebPage
134			*/
135			public function about(string $image): WebPage
136			{
137			$this->data->about = $this->organization($image, $image);
138			return $this;
139			}
140
141			/**
142			* @see https://schema.org/creator
143			*
144			* @param string $organizationImage
145			* @param string $addressLocality
146			* @param string $addressRegion
147			* @param string $postalCode
148			* @param string $streetAddress
149			* @param string $personName
150			* @param string $personImage
151			* @param array\|null $sameAs
152			* @return WebPage
153			*/
154			public function creator(
155			string $organizationImage,
156			string $addressLocality,
157			string $addressRegion,
158			string $postalCode,
159			string $streetAddress,
160			string $personName,
161			string $personImage,
162			?array $sameAs = null
163			): WebPage {
164			$address = [
165			'addressLocality' => $addressLocality,
166			'addressRegion' => $addressRegion,
167			'postalCode' => $postalCode,
168			'streetAddress' => $streetAddress
169			];
170
171			$this->data->organization = $this->organization($organizationImage, $organizationImage, $address);
172			$this->data->person = $this->person($personName, $personImage, $sameAs);
173
174			$this->data->creator = [
175			'organization' => $this->data->organization,
176			'person' => $this->data->person
177			];
178			return $this;
179			}
180
181			/**
182			* @return object
183			*/
184			public function data(): object
185			{
186			$this->data = (object)[
187			'header' => $this->header(),
188			'isPartOf' => (object)$this->data->isPartOf,
189			'about' => (object)$this->data->about,
190			'creator' => $this->data->creator,
191			'organization' => $this->organization,
192			'image' => $this->imageObject
193			];
194			return $this->data;
195			}
196
197			/**
198			* @param bool $tag
199			* @return string
200			*/
201			public function render(bool $tag = false): string
202			{
203			$render = [
204			'@context' => Schema::CONTEXT,
205			'@type' => self::TYPE,
206			'name' => $this->data->name,
207			'description' => $this->data->description,
208			'image' => $this->data->image,
209			'url' => $this->data->url,
210			'inLanguage' => $this->data->inLanguage,
211			'isPartOf' => [$this->data->isPartOf],
212			'about' => [$this->data->about],
213			'creator' => [$this->data->organization, $this->data->person],
214			];
215
216			if ($tag) {
217			return '<script type="application/ld+json">' . $this->json($render) . '</script>';
218			}
219
220			return $this->json($render);
221			}
222
223			/**
224			* Responsible method for debug all data
225			*/
226			public function debug(): void
227			{
228			var_dump($this->data());
			0 ignored issues – show Security Debugging Code introduced 2020-03-01 17:07 UTC by Report Bug Copy Issue Report `var_dump($this->data())` looks like debug code. Are you sure you do not want to remove it? Loading history...
229			}
230			}

wilderamorim / structured-data

Branch — master (fcb3e8)

WebPage::sameAs() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like