Schema::json() - 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

Schema::json() A

↳ Parent: Schema

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	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php


namespace ElePHPant\StructuredData;

/**
 * Class Schema
 * @package ElePHPant\StructuredData
 */
abstract class Schema
{
    /** @var */
    protected $person;

    /** @var */
    protected $organization;

    /** @var */
    protected $imageObject;

    /** @var */
    protected $webPageName;

    /** @var */
    protected $webPageUrl;

    /** @var */
    protected $webPageSameAs;

    /**
     * @see http://schema.org
     */
    const CONTEXT = 'http://schema.org';

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

    /**
     * Schema constructor.
     */
    public function __construct()
    {
        //
    }

    /**
     * @see https://schema.org/Person
     *
     * @param string $name
     * @param string $image
     * @param array|null $sameAs
     * @return object
     */
    protected function person(string $name, string $image, ?array $sameAs = null): object
    {
        $this->person = (object)[
            '@type' => 'Person',
            'name' => $name,
            'image' => $image,
            'sameAs' => $sameAs
        ];
        return $this->person;
    }

    /**
     * @see https://schema.org/Organization
     *
     * @param string $logo
     * @param string $image
     * @param array|null $address
     * @return object
     */
    protected function organization(
        string $logo,
        string $image,
        ?array $address = null
    ): object {
        $logo = $this->imageObject($logo, null, null);
        $image = $this->imageObject($image, null, null);
        $this->organization = [
            '@type' => 'Organization',
            'name' => $this->webPageName,
            'url' => $this->webPageUrl,
            'logo' => $logo,
            'image' => $image,
            'sameAs' => ($this->webPageSameAs ?? null)
        ];

        if (!is_null($address)) {
            $this->organization['address'] = $this->postalAddress(
                $address['addressLocality'],
                $address['addressRegion'],
                $address['postalCode'],
                $address['streetAddress']
            );
        }
        return (object)$this->organization;
    }

    /**
     * @see https://schema.org/PostalAddress
     *
     * @param string $addressLocality
     * @param string $addressRegion
     * @param string $postalCode
     * @param string $streetAddress
     * @return array
     */
    protected function postalAddress(
        string $addressLocality,
        string $addressRegion,
        string $postalCode,
        string $streetAddress
    ): array {
        $postalAddress = [
            '@type' => 'PostalAddress',
            'addressLocality' => $addressLocality,
            'addressRegion' => $addressRegion,
            'postalCode' => $postalCode,
            'streetAddress' => $streetAddress
        ];
        return $postalAddress;
    }

    /**
     * @see https://schema.org/ImageObject
     *
     * @param string $url
     * @param int|null $width
     * @param int|null $height
     * @return array
     */
    protected function imageObject(string $url, ?int $width = 1280, ?int $height = 720): array
    {
        $this->imageObject = [
            '@type' => 'ImageObject',
            'url' => $url,
            'width' => $width,
            'height' => $height,
            'caption' => $this->webPageName
        ];
        return $this->imageObject;

    }

    /**
     * @param array $schema
     * @return string
     */
    protected function json(array $schema): string
    {
        return json_encode($schema, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
    }

    /**
     * @param string $date
     * @return string
     */
    protected function setDate(string $date): string
    {
        $date = (strpos($date, ' ') ? explode(' ', $date)[0] : $date);

        $date = str_replace('/', '-', $date);
        $date = explode('-', $date);

        if (strlen($date[0]) == 4) {
            $date = "{$date[0]}-{$date[1]}-$date[2]";
        }

        if (strlen($date[2]) == 4) {
            $date = "{$date[2]}-{$date[1]}-$date[0]";
        }

        return $date;

    }
}

1			<?php
2
3
4			namespace ElePHPant\StructuredData;
5
6			/**
7			* Class Schema
8			* @package ElePHPant\StructuredData
9			*/
10			abstract class Schema
11			{
12			/** @var */
13			protected $person;
14
15			/** @var */
16			protected $organization;
17
18			/** @var */
19			protected $imageObject;
20
21			/** @var */
22			protected $webPageName;
23
24			/** @var */
25			protected $webPageUrl;
26
27			/** @var */
28			protected $webPageSameAs;
29
30			/**
31			* @see http://schema.org
32			*/
33			const CONTEXT = 'http://schema.org';
34
35			/**
36			* @see https://schema.org/WebPage
37			*/
38			const TYPE = 'WebPage';
39
40			/**
41			* Schema constructor.
42			*/
43			public function __construct()
44			{
45			//
46			}
47
48			/**
49			* @see https://schema.org/Person
50			*
51			* @param string $name
52			* @param string $image
53			* @param array\|null $sameAs
54			* @return object
55			*/
56			protected function person(string $name, string $image, ?array $sameAs = null): object
57			{
58			$this->person = (object)[
59			'@type' => 'Person',
60			'name' => $name,
61			'image' => $image,
62			'sameAs' => $sameAs
63			];
64			return $this->person;
65			}
66
67			/**
68			* @see https://schema.org/Organization
69			*
70			* @param string $logo
71			* @param string $image
72			* @param array\|null $address
73			* @return object
74			*/
75			protected function organization(
76			string $logo,
77			string $image,
78			?array $address = null
79			): object {
80			$logo = $this->imageObject($logo, null, null);
81			$image = $this->imageObject($image, null, null);
82			$this->organization = [
83			'@type' => 'Organization',
84			'name' => $this->webPageName,
85			'url' => $this->webPageUrl,
86			'logo' => $logo,
87			'image' => $image,
88			'sameAs' => ($this->webPageSameAs ?? null)
89			];
90
91			if (!is_null($address)) {
92			$this->organization['address'] = $this->postalAddress(
93			$address['addressLocality'],
94			$address['addressRegion'],
95			$address['postalCode'],
96			$address['streetAddress']
97			);
98			}
99			return (object)$this->organization;
100			}
101
102			/**
103			* @see https://schema.org/PostalAddress
104			*
105			* @param string $addressLocality
106			* @param string $addressRegion
107			* @param string $postalCode
108			* @param string $streetAddress
109			* @return array
110			*/
111			protected function postalAddress(
112			string $addressLocality,
113			string $addressRegion,
114			string $postalCode,
115			string $streetAddress
116			): array {
117			$postalAddress = [
118			'@type' => 'PostalAddress',
119			'addressLocality' => $addressLocality,
120			'addressRegion' => $addressRegion,
121			'postalCode' => $postalCode,
122			'streetAddress' => $streetAddress
123			];
124			return $postalAddress;
125			}
126
127			/**
128			* @see https://schema.org/ImageObject
129			*
130			* @param string $url
131			* @param int\|null $width
132			* @param int\|null $height
133			* @return array
134			*/
135			protected function imageObject(string $url, ?int $width = 1280, ?int $height = 720): array
136			{
137			$this->imageObject = [
138			'@type' => 'ImageObject',
139			'url' => $url,
140			'width' => $width,
141			'height' => $height,
142			'caption' => $this->webPageName
143			];
144			return $this->imageObject;
145
146			}
147
148			/**
149			* @param array $schema
150			* @return string
151			*/
152			protected function json(array $schema): string
153			{
154			return json_encode($schema, JSON_UNESCAPED_SLASHES \| JSON_UNESCAPED_UNICODE);
155			}
156
157			/**
158			* @param string $date
159			* @return string
160			*/
161			protected function setDate(string $date): string
162			{
163			$date = (strpos($date, ' ') ? explode(' ', $date)[0] : $date);
164
165			$date = str_replace('/', '-', $date);
166			$date = explode('-', $date);
167
168			if (strlen($date[0]) == 4) {
169			$date = "{$date[0]}-{$date[1]}-$date[2]";
170			}
171
172			if (strlen($date[2]) == 4) {
173			$date = "{$date[2]}-{$date[1]}-$date[0]";
174			}
175
176			return $date;
			0 ignored issues – show Bug Best Practice introduced 2020-02-27 15:20 UTC by Report Bug Copy Issue Report The expression `return $date` could return the type `string[]` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
177			}
178			}

wilderamorim / structured-data

Branch — master (fcb3e8)

Schema::json() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like