Lullabot/mpx-php

View on GitHub
src/DataService/Media/Rating.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
<?php

namespace Lullabot\Mpx\DataService\Media;

/**
 * Represents a content advisory rating, for example, an MPAA rating of PG-13.
 *
 * @see https://docs.theplatform.com/help/media-rating-object
 */
class Rating
{
    /**
     * The content's rating.
     *
     * @var string
     */
    protected $rating;

    /**
     * The URI of a rating scheme.
     *
     * @var string
     */
    protected $scheme;

    /**
     * The content's subratings.
     *
     * @var string[]
     */
    protected $subRatings = [];

    /**
     * Returns the content's rating.
     */
    public function getRating(): ?string
    {
        return $this->rating;
    }

    /**
     * Set the content's rating.
     */
    public function setRating(?string $rating)
    {
        $this->rating = $rating;
    }

    /**
     * Returns the URI of a rating scheme.
     */
    public function getScheme(): ?string
    {
        return $this->scheme;
    }

    /**
     * Set the URI of a rating scheme.
     */
    public function setScheme(?string $scheme)
    {
        $this->scheme = $scheme;
    }

    /**
     * Returns the content's subratings.
     *
     * @return string[]
     */
    public function getSubRatings(): array
    {
        return $this->subRatings;
    }

    /**
     * Set the content's subratings.
     *
     * @param string[] $subRatings
     */
    public function setSubRatings(array $subRatings)
    {
        $this->subRatings = $subRatings;
    }
}