RichanFongdasen\Varnishable\Concerns\InvalidateVarnishCache

Complexity

Total Complexity

10

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	flush()	0	6	1
A	banByPatterns()	0	13	3
A	banByUrls()	0	13	3
A	getVarnishUrl()	0	4	1
A	sendBanRequest()	0	10	2
	getConfig()	0	1	?
	getGuzzle()	0	1	?

<?php

namespace RichanFongdasen\Varnishable\Concerns;

trait InvalidateVarnishCache
{
    /**
     * Flush entire cache for an application hostname.
     *
     * @param  string $hostname [description]
     * @return void
     */
    public function flush($hostname)
    {
        $this->sendBanRequest([
            'X-Ban-Host' => $hostname
        ], 'FULLBAN');
    }

    /**
     * Generate ban request for an application hostname,
     * specified by a set of regular expression.
     *
     * @param  string       $hostname
     * @param  string|array $patterns
     * @return void
     */
    public function banByPatterns($hostname, $patterns)
    {
        if (!is_array($patterns)) {
            return $this->sendBanRequest([
                'X-Ban-Host' => $hostname,
                'X-Ban-Regex' => $patterns
            ]);
        }

        foreach ($patterns as $pattern) {
            $this->banByPatterns($hostname, $pattern);
        }
    }

    /**
     * Generate ban request for an application hostname,
     * specified by a set of urls.
     *
     * @param  string       $hostname
     * @param  string|array $urls
     * @return void
     */
    public function banByUrls($hostname, $urls)
    {
        if (!is_array($urls)) {
            return $this->sendBanRequest([
                'X-Ban-Host' => $hostname,
                'X-Ban-Url' => $urls
            ]);
        }

        foreach ($urls as $url) {
            $this->banByUrls($hostname, $url);
        }
    }

    /**
     * Get a valid varnish host url to send the 
     * ban request.
     *
     * @param  string $varnishHost
     * @return string
     */
    protected function getVarnishUrl($varnishHost)
    {
        return 'http://' . $varnishHost . ':' . $this->getConfig('varnish_port') . '/';
    }

    /**
     * Send the ban request to every varnish hosts.
     *
     * @param  array  $headers
     * @param  string $method
     * @return void
     */
    protected function sendBanRequest(array $headers, $method = 'BAN')
    {
        $guzzle = $this->getGuzzle();

        foreach ((array) $this->getConfig('varnish_hosts') as $varnishHost) {
            $url = $this->getVarnishUrl($varnishHost);

            $guzzle->request($method, $url, ['headers' => $headers]);
        }
    }

    /**
     * Get configuration value for a specific key.
     *
     * @param  string $key
     * @return mixed
     */
    abstract public function getConfig($key);

    /**
     * Get guzzle client object.
     *
     * @return \GuzzleHttp\Client
     */
    abstract public function getGuzzle();
}