SignpostMarv\DaftObject\SchemaOrg\CreativeWork\WebPage

Complexity

Total Complexity

16

Size/Duplication

Total Lines	272
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	GetPrimaryImageOfPage()	0	12	1
A	GetMainContentOfPage()	0	12	1
A	GetReviewedBy()	0	12	1
A	GetSignificantLink()	0	12	1
A	GetLastReviewed()	0	12	1
A	GetRelatedLink()	0	12	1
A	GetSpecialty()	0	12	1
A	GetBreadcrumb()	0	12	1
A	SetSignificantLink()	0	6	1
A	SetSpecialty()	0	5	1
A	SetReviewedBy()	0	5	1
A	SetRelatedLink()	0	6	1
A	SetBreadcrumb()	0	6	1
A	SetMainContentOfPage()	0	5	1
A	SetPrimaryImageOfPage()	0	5	1
A	SetLastReviewed()	0	5	1

<?php
/**
* @author SignpostMarv
*/
declare(strict_types=1);

namespace SignpostMarv\DaftObject\SchemaOrg\CreativeWork;

use SignpostMarv\DaftObject\SchemaOrg\CreativeWork as Base;
use SignpostMarv\DaftObject\SchemaOrg\DaftObjectTraits;
use SignpostMarv\DaftObject\SchemaOrg\DataTypes\Date;
use SignpostMarv\DaftObject\SchemaOrg\Intangible\Enumeration\Specialty;
use SignpostMarv\DaftObject\SchemaOrg\Intangible\ItemList\BreadcrumbList;
use SignpostMarv\DaftObject\SchemaOrg\Intangible\SpeakableSpecification;
use SignpostMarv\DaftObject\SchemaOrg\Organization;
use SignpostMarv\DaftObject\SchemaOrg\Person;
use SignpostMarv\DaftObject\SchemaOrg\TypeUtilities;

/**
* @property array<int, string|BreadcrumbList> $breadcrumb
* @property array<int, Date> $lastReviewed
* @property array<int, WebPageElement> $mainContentOfPage
* @property array<int, MediaObject\ImageObject> $primaryImageOfPage
* @property array<int, string> $relatedLink
* @property array<int, Organization|Person> $reviewedBy
* @property array<int, string> $significantLink
* @property array<int, string|SpeakableSpecification> $speakable
* @property array<int, Specialty> $specialty
*/
class WebPage extends Base
{
    use DaftObjectTraits\HasSpeakable;

    const SCHEMA_ORG_TYPE = 'WebPage';

    const PROPERTIES = [
        'breadcrumb',
        'lastReviewed',
        'mainContentOfPage',
        'primaryImageOfPage',
        'relatedLink',
        'reviewedBy',
        'significantLink',
        'speakable',
        'specialty',
    ];

    const PROPERTIES_WITH_MULTI_TYPED_ARRAYS = [
        'breadcrumb' => [
            'string',
            BreadcrumbList::class,
        ],
        'lastReviewed' => [
            Date::class,
        ],
        'mainContentOfPage' => [
            WebPageElement::class,
        ],
        'primaryImageOfPage' => [
            MediaObject\ImageObject::class,
        ],
        'relatedLink' => [
            'string',
        ],
        'reviewedBy' => [
            Organization::class,
            Person::class,
        ],
        'significantLink' => [
            'string',
        ],
        'speakable' => TypeUtilities::MULTI_TYPE_DICT__speakable,
        'specialty' => [
            Specialty::class,
        ],
    ];

    /**
    * @return array<int, string|BreadcrumbList>
    */
    public function GetBreadcrumb() : array
    {
        /**
        * @var array<int, string|BreadcrumbList>
        */
        $out = TypeUtilities::ExpectRetrievedValueIsArray(
            'breadcrumb',
            $this->RetrievePropertyValueFromData('breadcrumb'),
            static::class
        );

        return $out;
    }

    /**
    * @param array<int, string|BreadcrumbList> $value
    */
    public function SetBreadcrumb(array $value) : void
    {
        $this->NudgePropertyValue(
            'breadcrumb',
            $value,
            true
        );
    }

    /**
    * @return array<int, Date>
    */
    public function GetLastReviewed() : array
    {
        /**
        * @var array<int, Date>
        */
        $out = TypeUtilities::ExpectRetrievedValueIsArray(
            'lastReviewed',
            $this->RetrievePropertyValueFromData('lastReviewed'),
            static::class
        );

        return $out;
    }

    /**
    * @param array<int, Date> $value
    */
    public function SetLastReviewed(array $value) : void
    {
        $this->NudgePropertyValue(
            'lastReviewed',
            $value
        );
    }

    /**
    * @return array<int, WebPageElement>
    */
    public function GetMainContentOfPage() : array
    {
        /**
        * @var array<int, WebPageElement>
        */
        $out = TypeUtilities::ExpectRetrievedValueIsArray(
            'mainContentOfPage',
            $this->RetrievePropertyValueFromData('mainContentOfPage'),
            static::class
        );

        return $out;
    }

    /**
    * @param array<int, WebPageElement> $value
    */
    public function SetMainContentOfPage(array $value) : void
    {
        $this->NudgePropertyValue(
            'mainContentOfPage',
            $value
        );
    }

    /**
    * @return array<int, MediaObject\ImageObject>
    */
    public function GetPrimaryImageOfPage() : array
    {
        /**
        * @var array<int, MediaObject\ImageObject>
        */
        $out = TypeUtilities::ExpectRetrievedValueIsArray(
            'primaryImageOfPage',
            $this->RetrievePropertyValueFromData('primaryImageOfPage'),
            static::class
        );

        return $out;
    }

    /**
    * @param array<int, MediaObject\ImageObject> $value
    */
    public function SetPrimaryImageOfPage(array $value) : void
    {
        $this->NudgePropertyValue(
            'primaryImageOfPage',
            $value
        );
    }

    /**
    * @return array<int, string>
    */
    public function GetRelatedLink() : array
    {
        /**
        * @var array<int, string>
        */
        $out = TypeUtilities::ExpectRetrievedValueIsArray(
            'relatedLink',
            $this->RetrievePropertyValueFromData('relatedLink'),
            static::class
        );

        return $out;
    }

    /**
    * @param array<int, string> $value
    */
    public function SetRelatedLink(array $value) : void
    {
        $this->NudgePropertyValue(
            'relatedLink',
            $value,
            true
        );
    }

    /**
    * @return array<int, Organization|Person>
    */
    public function GetReviewedBy() : array
    {
        /**
        * @var array<int, Organization|Person>
        */
        $out = TypeUtilities::ExpectRetrievedValueIsArray(
            'reviewedBy',
            $this->RetrievePropertyValueFromData('reviewedBy'),
            static::class
        );

        return $out;
    }

    /**
    * @param array<int, Organization|Person> $value
    */
    public function SetReviewedBy(array $value) : void
    {
        $this->NudgePropertyValue(
            'reviewedBy',
            $value
        );
    }

    /**
    * @return array<int, string>
    */
    public function GetSignificantLink() : array
    {
        /**
        * @var array<int, string>
        */
        $out = TypeUtilities::ExpectRetrievedValueIsArray(
            'significantLink',
            $this->RetrievePropertyValueFromData('significantLink'),
            static::class
        );

        return $out;
    }

    /**
    * @param array<int, string> $value
    */
    public function SetSignificantLink(array $value) : void
    {
        $this->NudgePropertyValue(
            'significantLink',
            $value,
            true
        );
    }

    /**
    * @return array<int, Specialty>
    */
    public function GetSpecialty() : array
    {
        /**
        * @var array<int, Specialty>
        */
        $out = TypeUtilities::ExpectRetrievedValueIsArray(
            'specialty',
            $this->RetrievePropertyValueFromData('specialty'),
            static::class
        );

        return $out;
    }

    /**
    * @param array<int, Specialty> $value
    */
    public function SetSpecialty(array $value) : void
    {
        $this->NudgePropertyValue(
            'specialty',
            $value
        );
    }
}