Charcoal\User\AuthTokenMetadata

Complexity

Total Complexity

11

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	defaults()	0	12	1
A	setEnabled()	0	5	1
A	setCookieName()	0	10	2
A	setCookieDuration()	0	10	2
A	setHttpsOnly()	0	5	1
A	getEnabled()	0	4	1
A	getCookieName()	0	4	1
A	getCookieDuration()	0	4	1
A	getHttpsOnly()	0	4	1

<?php

namespace Charcoal\User;

use InvalidArgumentException;

// From 'charcoal-core'
use Charcoal\Model\ModelMetadata;

/**
 * User Auth Token metadata
 */
class AuthTokenMetadata extends ModelMetadata
{
    /**
     * @var boolean $enabled
     */
    private $enabled;

    /**
     * @var string $cookieName
     */
    private $cookieName;

    /**
     * @var string $cookieDuration
     */
    private $cookieDuration;

    /**
     * @var boolean $httpsOnly
     */
    private $httpsOnly;

    /**
     *
     * @return array
     * @see \Charcoal\Config\ConfigInterface::defaults()
     */
    public function defaults()
    {
        $parentDefaults = parent::defaults();

        $defaults = array_replace_recursive($parentDefaults, [
            'enabled'         => true,
            'cookie_name'     => 'charcoal_user_login',
            'cookie_duration' => '15 days',
            'https_only'      => false
        ]);
        return $defaults;
    }

    /**
     * @param boolean $enabled The enabled flag.
     * @return self
     */
    public function setEnabled($enabled)
    {
        $this->enabled = !!$enabled;
        return $this;
    }

    /**
     * @return boolean
     */
    public function getEnabled()
    {
        return $this->enabled;
    }

    /**
     * @param string $name The cookie name.
     * @throws InvalidArgumentException If the cookie name is not a string.
     * @return self
     */
    public function setCookieName($name)
    {
        if (!is_string($name)) {
            throw new InvalidArgumentException(
                'Can not set auth token\'s cookie  name: must be a string'
            );
        }
        $this->cookieName = $name;
        return $this;
    }

    /**
     * @return string
     */
    public function getCookieName()
    {
        return $this->cookieName;
    }

    /**
     * @param string $duration The cookie duration, or duration. Ex: "15 days".
     * @throws InvalidArgumentException If the cookie name is not a string.
     * @return self
     */
    public function setCookieDuration($duration)
    {
        if (!is_string($duration)) {
            throw new InvalidArgumentException(
                'Can not set auth token\'s cookie duration: must be a string'
            );
        }
        $this->cookieDuration = $duration;
        return $this;
    }

    /**
     * @return string
     */
    public function getCookieDuration()
    {
        return $this->cookieDuration;
    }

    /**
     * @param boolean $httpsOnly The "https only" flag.
     * @return self
     */
    public function setHttpsOnly($httpsOnly)
    {
        $this->httpsOnly = !!$httpsOnly;
        return $this;
    }

    /**
     * @return boolean
     */
    public function getHttpsOnly()
    {
        return $this->httpsOnly;
    }
}