wilderamorim / structured-data

src/Schema.php

<?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;

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

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

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

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

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

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

    /**
     * @link 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;

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.

    }
}