Cohensive\OEmbed\HtmlBuilder

Complexity

Total Complexity

34

Size/Duplication

Total Lines	202
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	type()	0	3	1
A	ampHtml()	0	3	1
A	html()	0	16	4
A	toArray()	0	5	1
A	script()	0	3	1
A	video()	0	27	6
A	getTypeOptions()	0	7	2
A	src()	0	17	4
A	addUrlParam()	0	4	2
B	applyOptions()	0	35	8
A	iframe()	0	11	3

<?php
namespace Cohensive\OEmbed;

class HtmlBuilder
{
    const TYPE_RAW = 'raw';
    const TYPE_IFRAME = 'iframe';
    const TYPE_VIDEO = 'video';

    public function __construct(
        protected string $type,
        protected string|array $html,
        protected ?string $script = null
    ) {
    }

    /**
     * Returns current type.
     */
    public function type(): string
    {
        return $this->type;
    }

    /**
     * Returns HTML code for media provider.
     */
    public function html(array $options = [], bool $amp = false): string
    {
        if (is_array($this->html)) {
            $attrs = $this->applyOptions($this->html, $options);

            if ($this->type === self::TYPE_IFRAME) {
                return $this->iframe($attrs, $amp);
            }

            if ($this->type === self::TYPE_VIDEO) {
                return $this->video($attrs, $amp);
            }

            return '';
        } else {
            return $this->html;
        }
    }

    /**
     * Return AMP-friendly HTML for media provider.
     */
    public function ampHtml(array $options = []): string
    {
        return $this->html($options, true);
    }

    /**
     * Returns URL for a given media provider embed. Returned url type depends on embed type:
     * iframe - string
     * video - string[]
     * raw - null
     */
    public function src(array $options = []): string | array | null

The type Cohensive\OEmbed\null was not found. Maybe you did not declare it correctly or list all dependencies?

    {
        if (is_array($this->html)) {
            $attrs = $this->applyOptions($this->html, $options);

            if ($this->type === self::TYPE_IFRAME) {
                return $attrs['src'] ?? null;

The expression return $attrs['src'] ?? null could return the type null which is incompatible with the type-hinted return Cohensive\OEmbed\null|array|string. Consider adding an additional type-check to rule them out.

            }

            if ($this->type === self::TYPE_VIDEO) {
                return array_map(function ($source) {
                    return $source['src'];
                }, $attrs['source']);
            }
        }

        return null;

The expression return null returns the type null which is incompatible with the type-hinted return Cohensive\OEmbed\null|array|string.

    }

    /**
     * Constructs <iframe> HTML-element based on array of provider attributes.
     */
    protected function iframe(array $attrs, bool $amp = false): string
    {
        $tag = $amp ? 'amp-iframe' : 'iframe';

        $html = "<$tag";
        foreach ($attrs as $attr => $val) {
            $html .= sprintf(' %s="%s"', $attr, $val);
        }
        $html .= "></$tag>";

        return $html;
    }

    /**
     * Constructs <video> HTML-element based on an array of provider attributes.
     */
    protected function video(array $attrs, bool $amp = false): string
    {
        $tag = $amp ? 'amp-video' : 'video';

        $inner = '';

        $html = "<$tag";
        foreach ($attrs as $attr => $val) {
            if (is_array($val)) {
                foreach ($val as $child) {
                    $inner .= "<$attr";
                    foreach ($child as $iattr => $ival) {
                        $inner .= sprintf(' %s="%s"', $iattr, $ival);
                    }
                    $inner .= ">";
                }
            } else {
                $html .= sprintf(' %s="%s"', $attr, $val);
            }
        }
        $html .= ">";

        $html .= $inner;

        $html .= "</$tag>";

        return $html;
    }

    /**
     * Returns script source if available.
     */
    public function script(): ?string
    {
        return $this->script;
    }

    /**
     * Converts class to an array.
     */
    public function toArray(): array
    {
        return [
            'type' => $this->type,
            'html' => $this->html,
        ];
    }

    /**
     * Extracts and returns an array of options for a current HTML element type.
     */
    protected function getTypeOptions(array $options): array
    {
        if (isset($options['html'])) {
            return $options['html'][$this->type] ?? [];
        }

        return [];
    }

    /**
     * Merge and apply local and global options to the provider attributes.
     */
    protected function applyOptions(array $attrs, array $options): array
    {
        $width = $options['width'] ?? null;
        $height = $options['height'] ?? null;

        if (isset($attrs['width']) && isset($attrs['height'])) {
            $ratio = $attrs['width'] / $attrs['height'];

            if ($width) {
                $attrs['width'] = $width;
            } else {
                $attrs['width'] = round($attrs['height'] * $ratio);
            }

            if ($height) {
                $attrs['height'] = $height;
            } else {
                $attrs['height'] = round($attrs['width'] / $ratio);
            }
        }

        if (isset($options['autoplay']) && $options['autoplay']) {
            $attrs['autoplay'] = $options['autoplay'];

            // We can remove autoplay option if type is "iframe" after we change "src" attribute.
            if ($this->type === self::TYPE_IFRAME) {
                $attrs['src'] = $this->addUrlParam($attrs['src'], sprintf('%s=%s', 'autoplay', $attrs['autoplay']));
                unset($attrs['autoplay']);
            }
        }

        $typeOptions = $this->getTypeOptions($options);
        $attrs = array_merge($attrs, $typeOptions);

        return $attrs;
    }

    /**
     * Append custom parameter to the end of the url.
     */
    protected function addUrlParam(string $url, string $param): string
    {
        $operator = strpos($url, '?') >= 0 ? '&' : '?';
        return $url . $operator . $param;
    }
}