Lullabot/mpx-php

<?php

namespace Lullabot\Mpx\Service\Player;

use GuzzleHttp\Psr7\Query;
use GuzzleHttp\Psr7\Uri;
use Lullabot\Mpx\DataService\PublicIdentifierInterface;
use Lullabot\Mpx\DataService\PublicIdWithGuidInterface;
use Lullabot\Mpx\ToUriInterface;
use Psr\Http\Message\UriInterface;

/**
 * Represents a player URL, suitable for embedding with an iframe.
 *
 * By default, URLs are generated using the media public ID.
 *
 * @see https://docs.theplatform.com/help/displaying-mpx-players-to-your-audience
 * @see https://docs.theplatform.com/help/generate-a-player-url-for-a-media
 */
class Url implements ToUriInterface, \Stringable
{
    /**
     * The base URL for all players.
     */
    final public const BASE_URL = 'https://player.theplatform.com/p/';

    /**
     * Should autoPlay be overridden?
     */
    private ?bool $autoPlay = null;

    /**
     * Should the playAll setting be overridden?
     */
    private ?bool $playAll = null;

    /**
     * Should this player URL be rendered so it can be embedded?
     *
     * @see https://docs.theplatform.com/help/displaying-mpx-players-to-your-audience#tp-toc17
     */
    private ?bool $embed = null;

    /**
     * Should this player URL be rendered using media GUIDs instead of public IDs?
     */
    private ?bool $byGuid = null;

    /**
     * Url constructor.
     *
     * @param PublicIdentifierInterface $account The account the player is owned by.
     * @param PublicIdentifierInterface $player  The player to play $media with.
     * @param PublicIdWithGuidInterface $media   The media to play.
     */
    public function __construct(private readonly PublicIdentifierInterface $account, private readonly PublicIdentifierInterface $player, private readonly PublicIdWithGuidInterface $media)
    {
    }

    /**
     * Return the URL for this player and media.
     */
    public function toUri(): UriInterface
    {
        $str = $this::BASE_URL.$this->account->getPid().'/'.$this->player->getPid();

        if ($this->embed) {
            $str .= '/embed';
        }

        if ($this->byGuid) {
            $ownerId = $this->media->getOwnerId();
            $parts = explode('/', $ownerId);
            $numeric_id = end($parts);

            $uri = new Uri($str.'/select/media/guid/'.$numeric_id.'/'.$this->media->getGuid());
        } else {
            $uri = new Uri($str.'/select/media/'.$this->media->getPid());
        }

        $query_parts = [];

        // We use isset() so that if the values have never been explicitly set
        // the player configuration is used instead.
        if (isset($this->autoPlay)) {
            $query_parts['autoPlay'] = $this->autoPlay ? 'true' : 'false';
        }

        if (isset($this->playAll)) {
            $query_parts['playAll'] = $this->playAll ? 'true' : 'false';
        }

        $uri = $uri->withQuery(Query::build($query_parts));

        return $uri;
    }

    /**
     * Returns the URL of this player as a string.
     *
     * @return string The player URL.
     */
    public function __toString(): string
    {
        return (string) $this->toUri();
    }

    /**
     * Override the player's autoplay setting for this URL.
     *
     * @see https://docs.theplatform.com/help/player-player-autoplay
     *
     * @param bool $autoPlay True to enable autoPlay, false otherwise.
     */
    public function withAutoplay(bool $autoPlay): self
    {
        if ($this->autoPlay === $autoPlay) {
            return $this;
        }

        $url = clone $this;
        $url->autoPlay = $autoPlay;

        return $url;
    }

    /**
     * Override the player's playAll setting for playlist auto-advance for this URL.
     *
     * @see https://docs.theplatform.com/help/player-player-playall
     */
    public function withPlayAll(bool $playAll): self
    {
        if ($this->playAll === $playAll) {
            return $this;
        }

        $url = clone $this;
        $url->playAll = $playAll;

        return $url;
    }

    public function withEmbed(bool $embed): self
    {
        if ($this->embed === $embed) {
            return $this;
        }

        $url = clone $this;
        $url->embed = $embed;

        return $url;
    }

    /**
     * Return a Url using media reference GUIDs instead of media public IDs.
     */
    public function withMediaByGuid(): self
    {
        if ($this->byGuid) {
            return $this;
        }

        $url = clone $this;
        $url->byGuid = true;

        return $url;
    }

    /**
     * Return a Url using media public IDs instead of media reference Ids.
     */
    public function withMediaByPublicId(): self
    {
        if (!$this->byGuid) {
            return $this;
        }

        $url = clone $this;
        $url->byGuid = false;

        return $url;
    }
}