Http\Message\CookieJar\CookieJarTemplate

Complexity

Total Complexity

29

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

14 Methods

Rating	Name	Duplication	Size	Complexity
A	hasCookie()	0	4	1
B	addCookie()	0	19	6
A	removeCookie()	0	4	1
A	getCookies()	0	8	1
A	getMatchingCookies()	0	8	1
A	findMatchingCookies()	0	12	3
A	hasCookies()	0	4	1
A	setCookies()	0	5	1
A	addCookies()	0	6	2
A	removeCookies()	0	6	2
C	removeMatchingCookies()	0	24	7
A	clear()	0	4	1
A	count()	0	4	1
A	getIterator()	0	4	1

<?php

namespace Http\Message\CookieJar;

use Http\Message\Cookie;

/**
 * Common implementation of a Cookie Jar.
 *
 * @author Márk Sági-Kazár <mark.sagikazar@gmail.com>
 */
trait CookieJarTemplate
{
    /**
     * @var \SplObjectStorage
     */
    protected $cookies;

    /**
     * {@inheritdoc}
     */
    public function hasCookie(Cookie $cookie)
    {
        return $this->cookies->contains($cookie);
    }

    /**
     * {@inheritdoc}
     */
    public function addCookie(Cookie $cookie)
    {
        if (!$this->hasCookie($cookie)) {
            $cookies = $this->getMatchingCookies($cookie);

            foreach ($cookies as $matchingCookie) {
                if ($cookie->getValue() !== $matchingCookie->getValue() || $cookie->getExpires() > $matchingCookie->getExpires()) {
                    $this->removeCookie($matchingCookie);

                    continue;
                }
            }

            if ($cookie->hasValue()) {
                $this->cookies->attach($cookie);
            }

        }
    }

    /**
     * {@inheritdoc}
     */
    public function removeCookie(Cookie $cookie)
    {
        $this->cookies->detach($cookie);
    }

    /**
     * {@inheritdoc}
     */
    public function getCookies()
    {
        $match = function($matchCookie) {

The parameter $matchCookie is not used and could be removed.

            return true;
        };

        return $this->findMatchingCookies($match);
    }

    /**
     * {@inheritdoc}
     */
    public function getMatchingCookies(Cookie $cookie)
    {
        $match = function($matchCookie) use ($cookie) {
            return $matchCookie->match($cookie);
        };

        return $this->findMatchingCookies($match);
    }

    /**
     * Finds matching cookies based on a callable
     *
     * @param callable $match
     *
     * @return Cookie[]
     */
    protected function findMatchingCookies(callable $match)
    {
        $cookies = [];

        foreach ($this->cookies as $cookie) {
            if ($match($cookie)) {
                $cookies[] = $cookie;
            }
        }

        return $cookies;
    }

    /**
     * {@inheritdoc}
     */
    public function hasCookies()
    {
        return $this->cookies->count() > 0;
    }

    /**
     * {@inheritdoc}
     */
    public function setCookies(array $cookies)
    {
        $this->clear();
        $this->addCookies($cookies);
    }

    /**
     * {@inheritdoc}
     */
    public function addCookies(array $cookies)
    {
        foreach ($cookies as $cookie) {
            $this->addCookie($cookie);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removeCookies(array $cookies)
    {
        foreach ($cookies as $cookie) {
            $this->removeCookie($cookie);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removeMatchingCookies($name = null, $domain = null, $path = null)
    {
        $match = function($cookie) use ($name, $domain, $path) {
            $match = true;

            if (isset($name)) {
                $match = $match && ($cookie->getName() === $name);
            }

            if (isset($domain)) {
                $match = $match && $cookie->matchDomain($domain);
            }

            if (isset($path)) {
                $match = $match && $cookie->matchPath($path);
            }

            return $match;
        };

        $cookies = $this->findMatchingCookies($match);

        $this->removeCookies($cookies);
    }

    /**
     * {@inheritdoc}
     */
    public function clear()
    {
        $this->cookies = new \SplObjectStorage();
    }

    /**
     * {@inheritdoc}
     */
    public function count()
    {
        return $this->cookies->count();
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        return clone $this->cookies;
    }
}