SilverStripe\View\Shortcodes\EmbedShortcodeProvider

Complexity

Total Complexity

24

Size/Duplication

Total Lines	158
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	photoEmbed()	0	5	1
B	embedForTemplate()	0	16	7
A	get_shortcodes()	0	3	1
A	linkEmbed()	0	9	2
A	videoEmbed()	0	17	3
C	handle_shortcode()	0	50	10

<?php

namespace SilverStripe\View\Shortcodes;

use SilverStripe\Core\Convert;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\View\Embed\Embeddable;
use SilverStripe\View\Embed\EmbedResource;
use SilverStripe\View\HTML;
use SilverStripe\View\Parsers\ShortcodeHandler;
use Embed\Adapters\Adapter;
use Embed\Embed;
use SilverStripe\View\Parsers\ShortcodeParser;

/**
 * Provider for the [embed] shortcode tag used by the embedding service
 * in the HTML Editor field.
 * Provides the html needed for the frontend and the editor field itself.
 */
class EmbedShortcodeProvider implements ShortcodeHandler
{

    /**
     * Gets the list of shortcodes provided by this handler
     *
     * @return mixed
     */
    public static function get_shortcodes()
    {
        return array('embed');
    }

    /**
     * Embed shortcode parser from Oembed. This is a temporary workaround.
     * Oembed class has been replaced with the Embed external service.
     *
     * @param array $arguments
     * @param string $content
     * @param ShortcodeParser $parser
     * @param string $shortcode
     * @param array $extra
     *
     * @return string
     */
    public static function handle_shortcode($arguments, $content, $parser, $shortcode, $extra = array())
    {
        // Get service URL
        if (!empty($content)) {
            $serviceURL = $content;
        } elseif (!empty($arguments['url'])) {
            $serviceURL = $arguments['url'];
        } else {
            return '';
        }

        // See https://github.com/oscarotero/Embed#example-with-all-options for service arguments
        $serviceArguments = [];
        if (!empty($arguments['width'])) {
            $serviceArguments['min_image_width'] = $arguments['width'];
        }
        if (!empty($arguments['height'])) {
            $serviceArguments['min_image_height'] = $arguments['height'];
        }

        /** @var EmbedResource $embed */
        $embed = Injector::inst()->create(Embeddable::class, $serviceURL);
        if (!empty($serviceArguments)) {
            $embed->setOptions(array_merge($serviceArguments, (array) $embed->getOptions()));
        }

        // Allow resolver to be mocked
        $dispatcher = null;

The assignment to $dispatcher is dead and can be removed.

        if (isset($extra['resolver'])) {
            $dispatcher = Injector::inst()->create(
                $extra['resolver']['class'],
                $serviceURL,
                $extra['resolver']['config']
            );
            $embed->setDispatcher($dispatcher);
        }

        // Process embed
        $embed = $embed->getEmbed();

        // Convert embed object into HTML
        if ($embed && $embed instanceof Adapter) {

$embed is always a sub-type of Embed\Adapters\Adapter. If $embed can have other possible types, add them to src/View/Shortcodes/EmbedShortcodeProvider.php:65.

            $result = static::embedForTemplate($embed, $arguments);
            if ($result) {
                return $result;
            }
        }

        // Fallback to link to service
        return static::linkEmbed($arguments, $serviceURL, $serviceURL);
    }

    /**
     * @param Adapter $embed
     * @param array $arguments Additional shortcode params
     * @return string
     */
    public static function embedForTemplate($embed, $arguments)
    {
        switch ($embed->getType()) {
            case 'video':
            case 'rich':
                // Attempt to inherit width (but leave height auto)
                if (empty($arguments['width']) && $embed->getWidth()) {

The expression $embed->getWidth() of type null|integer is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

                    $arguments['width'] = $embed->getWidth();
                }
                return self::videoEmbed($arguments, $embed->getCode());
            case 'link':
                return self::linkEmbed($arguments, $embed->getUrl(), $embed->getTitle());
            case 'photo':
                return self::photoEmbed($arguments, $embed->getUrl());
            default:
                return null;
        }
    }

    /**
     * Build video embed tag
     *
     * @param array $arguments
     * @param string $content Raw HTML content
     * @return string
     */
    protected static function videoEmbed($arguments, $content)
    {
        // Ensure outer div has given width (but leave height auto)
        if (!empty($arguments['width'])) {
            $arguments['style'] = 'width: ' . intval($arguments['width']) . 'px;';
        }

        // Convert caption to <p>
        if (!empty($arguments['caption'])) {
            $xmlCaption = Convert::raw2xml($arguments['caption']);
            $content .= "\n<p class=\"caption\">{$xmlCaption}</p>";
        }
        unset($arguments['width']);
        unset($arguments['height']);
        unset($arguments['url']);
        unset($arguments['caption']);
        return HTML::createTag('div', $arguments, $content);
    }

    /**
     * Build <a> embed tag
     *
     * @param array $arguments
     * @param string $href
     * @param string $title Default title
     * @return string
     */
    protected static function linkEmbed($arguments, $href, $title)
    {
        $title = !empty($arguments['caption']) ? ($arguments['caption']) : $title;
        unset($arguments['caption']);
        unset($arguments['width']);
        unset($arguments['height']);
        unset($arguments['url']);
        $arguments['href'] = $href;
        return HTML::createTag('a', $arguments, Convert::raw2xml($title));

It seems like SilverStripe\Core\Convert::raw2xml($title) can also be of type array; however, parameter $content of SilverStripe\View\HTML::createTag() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * Build img embed tag
     *
     * @param array $arguments
     * @param string $src
     * @return string
     */
    protected static function photoEmbed($arguments, $src)
    {
        $arguments['src'] = $src;
        unset($arguments['url']);
        return HTML::createTag('img', $arguments);
    }
}