Jclyons52\PagePreview\Preview

Complexity

Total Complexity

19

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

97.14%

Importance

Changes	10
Bugs	1	Features	4

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	fetch()	0	14	1
A	title()	0	4	1
A	metaKeywords()	0	11	1
B	meta()	0	22	5
A	images()	0	10	2
B	render()	0	27	4
A	formatUrl()	0	12	4

<?php

namespace Jclyons52\PagePreview;

use GuzzleHttp\Client;
use Jclyons52\PHPQuery\Document;
use League\Plates\Engine;

class Preview
{
    /**
     * body from guzzle request
     * @var string
     */
    protected $result;

    /**
     * Guzzle client
     * @var \GuzzleHttp\Client
     */
    protected $client;

    /**
     * PHPQuery document object that will be used to select elements
     * @var \Jclyons52\PHPQuery\Document
     */
    public $document;

    /**
     * reference to the url parameter the user passes into the fetch method
     * @var string
     */
    public $url;

    /**
     * destructured array of url components from parse_url
     * @var array
     */
    protected $urlComponents;

    public function __construct(Client $client)
    {
        $this->client = $client;
    }

    /**
     * @param string $url
     * @return Document
     */
    public function fetch($url)
    {
        $this->url = $url;

        $this->urlComponents = parse_url($url);

It seems like parse_url($url) can also be of type false. However, the property $urlComponents is declared as type array. Maybe add an additional type check?

        $this->result = $this->client->request('GET', $url);

It seems like $this->client->request('GET', $url) of type object<Psr\Http\Message\ResponseInterface> is incompatible with the declared type string of property $result.

        $body = $this->result->getBody()->getContents();

        $this->document = new Document($body);

        return $this->document;
    }

    /**
     * @return string
     */
    public function title()
    {
        return $this->document->querySelector('title')->text();
    }

    /**
     * @return mixed
     */
    public function metaKeywords()
    {
        $keywordString = $this->document->querySelector('meta[name="keywords"]')->attr('content');

        $keywords = explode(',', $keywordString);

        return array_map(function ($word) {
            return trim($word);

        }, $keywords);
    }

    /**
     * @param string $element
     * @return array
     */
    public function meta($element = null)
    {
        $selector = "meta";
        if ($element) {

The expression $element of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $selector .= "[name='{$element}']";
            $metaTags =  $this->document->querySelector($selector);
            if ($metaTags === null) {
                return null;
            }
            return  $metaTags->attr('content');
        }
        $metaTags = $this->document->querySelectorAll($selector);

        if ($metaTags === []) {
            return null;
        }
        $values = [];
        foreach ($metaTags as $meta) {
            $values[$meta->attr('name')] = $meta->attr('content');
        }
        return $values;
    }

    /**
     * get source attributes of all image tags on the page
     * @return array<String>
     */
    public function images()
    {
        $images = $this->document->querySelectorAll('img');
        $urls = $images->attr('src');
        $result = [];
        foreach ($urls as $url) {
            $result[] = $this->formatUrl($url);
        }
        return $result;
    }

    /**
     * returns a string of the link preview html
     * @param  string $type     template name to be selected
     * @param  string $viewPath path to templates folder
     * @return string           html for link preview
     */
    public function render($type = 'media', $viewPath = null)
    {
        if ($viewPath === null) {
            $viewPath = __DIR__ . '/Templates';
        }
        $title = $this->meta('title');

        if (!$title) {
            $title = $this->title();
        }
        $images = $this->images();
        if (count($images) > 0) {
            $image = $images[0];
        } else {
            $image = '#';
        }

        $description = $this->meta('description');

        $templates = new Engine($viewPath);

        return $templates->render($type, [
            'title' => $title,
            'image' => $image,
            'body' => $description, 'url' => $this->url
        ]);
    }

    /**
     * @param string $url
     * @return string
     */
    private function formatUrl($url)
    {
        $path = array_key_exists('path', $this->urlComponents) ? $this->urlComponents['path'] : '';

        if (filter_var($url, FILTER_VALIDATE_URL) !== false) {
            return $url;
        }
        if (substr($url, 0, 1) === '/') {
            return 'http://' . $this->urlComponents['host'] . $url;
        }
        return 'http://' . $this->urlComponents['host'] .$path . '/' . $url;
    }
}