Arcanedev\EmbedVideo\Parsers\AbstractParser

Complexity

Total Complexity

25

Size/Duplication

Total Lines	309
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

95.65%

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	url()	0	4	1
A	setUrl()	0	7	1
A	setPatterns()	0	6	1
A	attributes()	0	4	1
A	setAttributes()	0	6	1
A	queries()	0	4	1
A	iframe()	0	9	1
A	getCached()	0	4	1
	videoId()	0	1	?
	defaultQueries()	0	1	?
	getIframePattern()	0	1	?
	getIframeReplacer()	0	1	?
A	parse()	0	16	3
B	parseProtocol()	0	12	5
A	parseTimestamp()	0	14	4
A	hasTimestampOption()	0	5	2
A	parseCustomParsing()	0	4	1
A	reset()	0	5	1

<?php namespace Arcanedev\EmbedVideo\Parsers;

use Arcanedev\EmbedVideo\Contracts\Parser;
use Arcanedev\EmbedVideo\Entities\Iframe;
use Illuminate\Support\Arr;

/**
 * Class     AbstractParser
 *
 * @package  Arcanedev\EmbedVideo\Parsers
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
abstract class AbstractParser implements Parser
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */
    /**
     * The given URL to be parsed.
     *
     * @var string|null
     */
    protected $url;

    /**
     * The parser's URL patterns.
     *
     * @var array
     */
    protected $patterns   = [];

    /**
     * The iframe attribute.
     *
     * @var array
     */
    protected $attributes = [];

    /**
     * @var array
     */
    protected $cachedMatches;

    /**
     * Use a secure HTTP Protocol.
     *
     * @var bool
     */
    protected $useSecure = true;

    /**
     * The HTTP Protocol.
     *
     * @var string
     */
    protected $protocol = 'https';

    /**
     * Timestamp pattern and param.
     *
     * @var array
     */
    protected $timestamp = [
        'pattern' => null,
        'param'   => null,
    ];

    /**
     * The URL Queries.
     *
     * @var array
     */
    protected $queries = [];

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */
    /**
     * AbstractParser constructor.
     *
     * @param  array  $options
     */
    public function __construct(array $options)
    {
        $this->queries = $this->defaultQueries();
//        $this->setPatterns(Arr::get($options, 'patterns', []));
        $this->setAttributes(Arr::get($options, 'attributes', []));

    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */
    /**
     * Get the URL.
     *
     * @return string|null
     */
    public function url()
    {
        return $this->url;
    }

    /**
     * Set the URL.
     *
     * @param  string  $url
     *
     * @return self
     */
    protected function setUrl($url)
    {
        $this->url = $url;
        $this->reset();

        return $this;
    }

    /**
     * Set the URL patterns.
     *
     * @param  array  $patterns
     *
     * @return self
     */
    public function setPatterns(array $patterns)
    {
        $this->patterns = $patterns;

        return $this;
    }

    /**
     * Get the attributes.
     *
     * @return array
     */
    public function attributes()
    {
        return $this->attributes;
    }

    /**
     * Set the attributes.
     *
     * @param  array  $attributes
     *
     * @return self
     */
    public function setAttributes(array $attributes)
    {
        $this->attributes = $attributes;

        return $this;
    }

    /**
     * Get the URL queries.
     *
     * @return array
     */
    public function queries()
    {
        return $this->queries;
    }

    /**
     * Create an iframe entity.
     *
     * @return \Arcanedev\EmbedVideo\Entities\Iframe
     */
    public function iframe()
    {
        return new Iframe(
            $this->getIframePattern(),
            $this->getIframeReplacer(),
            $this->queries(),
            $this->attributes()
        );
    }

    /**
     * Get value from cached matches.
     *
     * @param  int         $key
     * @param  mixed|null  $default
     *
     * @return mixed
     */
    public function getCached($key, $default = null)
    {
        return Arr::get($this->cachedMatches, $key, $default);
    }

    /**
     * Get the video id from cached matches.
     *
     * @return mixed
     */
    abstract protected function videoId();

    /**
     * Get the default URL queries.
     *
     * @return array
     */
    abstract protected function defaultQueries();

    /**
     * Get the iframe pattern.
     *
     * @return string
     */
    abstract protected function getIframePattern();

    /**
     * Get the iframe replace.
     *
     * @return array
     */
    abstract protected function getIframeReplacer();

    /* -----------------------------------------------------------------
     |  Main method
     | -----------------------------------------------------------------
     */
    /**
     * Parse the given url.
     *
     * @param  string  $url
     *
     * @return self
     */
    public function parse($url)
    {
        $this->setUrl($url);

        foreach ($this->patterns as $pattern) {
            if (preg_match('~'.$pattern.'~imu', $this->url, $matches)) {
                $this->cachedMatches = $matches;
                $this->parseProtocol();
                $this->parseTimestamp();
                $this->parseCustomParsing();
                break;
            }
        }

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */
    /**
     * Parse the HTTP protocol.
     *
     * @throws \Exception
     */
    private function parseProtocol()
    {
        $protocol = $this->cachedMatches[1];

        if ( ! in_array($protocol, ['http://', 'https://']))
            $protocol = 'http://';

        if (is_null($this->url))
            throw new \Exception('Cannot detect protocol if URL or provider were not set.');

        $this->protocol = ($this->useSecure || $protocol === 'https://') ? 'https' : 'http';
    }

    /**
     * Parse the timestamp.
     */
    protected function parseTimestamp()
    {
        if ( ! $this->hasTimestampOption()) return;

        if (preg_match('~'.$this->timestamp['pattern'].'~imu', $this->url, $matches)) {
            unset($matches[0]);
            $multipliers = [3600, 60, 1];
            $timestamp   = 0;
            foreach (array_values($matches) as $key => $match) {
                $timestamp += (int) $match * $multipliers[$key];
            }
            $this->queries[$this->timestamp['param']] = $timestamp;
        }
    }

    /**
     * Check if the parser has a defined timestamp parsing.
     *
     * @return bool
     */
    protected function hasTimestampOption()
    {
        return is_string(Arr::get($this->timestamp, 'pattern'))
            && is_string(Arr::get($this->timestamp, 'param'));
    }

    /**
     * Enable to perform custom parsing.
     */
    protected function parseCustomParsing()
    {
        //
    }

    /**
     * Reset the parser.
     */
    private function reset()
    {
        $this->cachedMatches = [];
        $this->queries       = $this->defaultQueries();
    }
}