DisposableDomains::getDomains() - Code Metrics - Inspection of "Support Laravel 6.x" - Propaganistas/Laravel-Disposable-Email - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6f0dcd...27eb8a )

by Propa

created 2019-09-04 19:08 UTC

DisposableDomains::getDomains() A

↳ Parent: DisposableDomains

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

namespace Propaganistas\LaravelDisposableEmail;

use ErrorException;
use Illuminate\Contracts\Cache\Repository as Cache;
use Illuminate\Support\Arr;
use Propaganistas\LaravelDisposableEmail\Traits\ParsesJson;

class DisposableDomains
{
    use ParsesJson;

    /**
     * The storage path to retrieve from and save to.
     *
     * @var string
     */
    protected $storagePath;

    /**
     * Array of retrieved disposable domains.
     *
     * @var array
     */
    protected $domains = [];

    /**
     * The cache repository.
     *
     * @var \Illuminate\Contracts\Cache\Repository|null
     */
    protected $cache;

    /**
     * The cache key.
     *
     * @var string
     */
    protected $cacheKey;

    /**
     * Disposable constructor.
     *
     * @param \Illuminate\Contracts\Cache\Repository|null $cache
     */
    public function __construct(Cache $cache = null)
    {
        $this->cache = $cache;
    }

    /**
     * Loads the domains from cache/storage into the class.
     *
     * @return $this
     */
    public function bootstrap()
    {
        if ($this->cache) {
            $data = $inCache = $this->getFromCache();
        }

        if (! isset($data) || ! $data) {
            $data = $this->getFromStorage();
        }

        if ($this->cache && (! isset($inCache) || ! $inCache)) {
            $this->cache->forever($this->getCacheKey(), $data);
        }

        $this->domains = $data;

        return $this;
    }

    /**
     * Get the domains from cache.
     *
     * @return array|null
     */
    protected function getFromCache()
    {
        return $this->cache->get($this->getCacheKey());
        return $this->cache->/** @scrutinizer ignore-call */ get($this->getCacheKey());
    }

    /**
     * Get the domains from storage, or if non-existent, from the package.
     *
     * @return array
     */
    protected function getFromStorage()
    {
        try {
            if ($data = $this->parseJson(file_get_contents($this->getStoragePath()))) {
                return $data;

            }
        } catch (ErrorException $e) {
            // File does not exist or could not be opened.
        }

        // Fall back to the list provided by the package.
        return $this->parseJson(file_get_contents(__DIR__.'/../domains.json'));

    }

    /**
     * Checks whether the given email address' domain matches a disposable email service.
     *
     * @param string $email
     * @return bool
     */
    public function isDisposable($email)
    {
        if ($domain = Arr::get(explode('@', $email, 2), 1)) {
            return in_array($domain, $this->domains);
        }

        // Just ignore this validator if the value doesn't even resemble an email or domain.
        return false;
    }

    /**
     * Checks whether the given email address' domain doesn't match a disposable email service.
     *
     * @param string $email
     * @return bool
     */
    public function isNotDisposable($email)
    {
        return ! $this->isDisposable($email);
    }

    /**
     * Alias of "isNotDisposable".
     *
     * @param string $email
     * @return bool
     */
    public function isIndisposable($email)
    {
        return $this->isNotDisposable($email);
    }

    /**
     * Flushes the cache if applicable.
     */
    public function flushCache()
    {
        if ($this->cache) {
            $this->cache->forget($this->getCacheKey());
        }
    }

    /**
     * Flushes the source's list if applicable.
     */
    public function flushSource()
    {
        if (is_file($this->getStoragePath())) {
            @unlink($this->getStoragePath());
            /** @scrutinizer ignore-unhandled */ @unlink($this->getStoragePath());
        }
    }

    /**
     * Get the list of disposable domains.
     *
     * @return array
     */
    public function getDomains()
    {
        return $this->domains;
    }

    /**
     * Get the storage path.
     *
     * @return string
     */
    public function getStoragePath()
    {
        return $this->storagePath;
    }

    /**
     * Set the storage path.
     *
     * @param string $path
     * @return $this
     */
    public function setStoragePath($path)
    {
        $this->storagePath = $path;

        return $this;
    }

    /**
     * Get the cache key.
     *
     * @return string
     */
    public function getCacheKey()
    {
        return $this->cacheKey;
    }

    /**
     * Set the cache key.
     *
     * @param string $key
     * @return $this
     */
    public function setCacheKey($key)
    {
        $this->cacheKey = $key;

        return $this;
    }
}

Propaganistas / Laravel-Disposable-Email

Push — master ( 6f0dcd...27eb8a )

DisposableDomains::getDomains() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like