luya\web\jsonld\Rating

Complexity

Total Complexity

11

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	3

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	typeDefintion()	0	4	1
A	setAuthor()	0	6	1
A	getAuthor()	0	4	1
A	setBestRating()	0	6	1
A	getBestRating()	0	4	1
A	setRatingValue()	0	6	1
A	getRatingValue()	0	4	1
A	setReviewAspect()	0	5	1
A	getReviewAspect()	0	4	1
A	setWorstRating()	0	6	1
A	getWorstRating()	0	4	1

<?php

namespace luya\web\jsonld;

use luya\helpers\ObjectHelper;
use yii\base\InvalidConfigException;


/**
 * JsonLd Rating.
 *
 * @see http://schema.org/Rating
 * @author Basil Suter <basil@nadar.io>
 * @since 1.0.3
 */
class Rating extends BaseThing
{
    /**
     * @inheritdoc
     */
    public function typeDefintion()
    {
        return 'Rating';
    }

    private $_author;

    /**
     * Set Author
     * 
     * The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
     *
     * @param Organization|Person $author
     * @return static
     */
    public function setAuthor($author)
    {
        ObjectHelper::isInstanceOf($author, [Organization::class, Person::class]);

$author is of type object<luya\web\jsonld\Organization>|object<luya\web\jsonld\Person>, but the function expects a string.

        $this->_author = $author;
        return $this;
    }

    /**
     * Get Author
     *
     * @return Organization|Person
     */
    public function getAuthor()
    {
        return $this->_author;
    }

    private $_bestRating;

    /**
     * Set best Rating.
     * 
     * The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed.
     *
     * @param RangeValue $bestRating
     * @return static
     */
    public function setBestRating(RangeValue $bestRating)
    {
        $bestRating->ensureRange(1,5);
        $this->_bestRating = $bestRating->getValue();
        return $this;
    }

    /**
     * Get best rating
     *
     * @return integer
     */
    public function getBestRating()
    {
        return $this->_bestRating;
    }

    private $_ratingValue;

    /**
     * Set Rating Value.
     * 
     * The rating for the content.
     *
     * @param RangeValue $ratingValue
     * @return static
     */
    public function setRatingValue(RangeValue $ratingValue)
    {
        $ratingValue->ensureRange(1,5);
        $this->_ratingValue = $ratingValue->getValue();
        return $this;
    }

    /**
     * Get Rating Value.
     *
     * @return integer
     */
    public function getRatingValue()
    {
        return $this->_ratingValue;
    }
    
    private $_reviewAspect;

    /**
     * Set Review Aspect.
     * 
     * This Review or Rating is relevant to this part or facet of the itemReviewed.
     *
     * @param string $reviewAspect
     * @return static
     */
    public function setReviewAspect($reviewAspect)
    {
        $this->_reviewAspect = $reviewAspect;
        return $this;
    }

    /**
     * Get Review Aspect.
     *
     * @return string
     */
    public function getReviewAspect()
    {
        return $this->_reviewAspect;
    }

    private $_worstRating;

    /**
     * Set Worst Rating.
     *
     * The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed.
     * 
     * @param RangeValue $worstRating
     * @return static
     */
    public function setWorstRating(RangeValue $worstRating)
    {
        $worstRating->ensureRange(1,5);
        $this->_worstRating = $worstRating->getValue();
        return $this;
    }

    /**
     * Get Worst Rating
     *
     * @return integer
     */
    public function getWorstRating()
    {
        return $this->_worstRating;
    }
}