WebinoAppLib\Options\DebuggerOptions

Complexity

Total Complexity

21

Size/Duplication

Total Lines	247
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	isEnabled()	0	4	1
A	isDisabled()	0	4	1
A	getMode()	0	4	1
A	hasBar()	0	4	1
A	isStrict()	0	4	1
A	getLog()	0	7	2
A	getEmail()	0	4	1
A	getMaxDepth()	0	4	1
A	getMaxLen()	0	4	1
A	setEnabled()	0	5	1
A	setMode()	0	5	2
A	setBar()	0	5	1
A	setStrict()	0	5	1
A	setLog()	0	5	1
A	setEmail()	0	5	1
A	setMaxDepth()	0	5	1
A	setMaxLen()	0	5	1
A	setDevMode()	0	5	1
A	setPubMode()	0	5	1

<?php
/**
 * Webino™ (http://webino.sk)
 *
 * @link        https://github.com/webino for the canonical source repository
 * @copyright   Copyright (c) 2015-2017 Webino, s.r.o. (http://webino.sk)
 * @author      Peter Bačinský <peter@bacinsky.sk>
 * @license     BSD-3-Clause
 */

namespace WebinoAppLib\Options;

use Tracy\Debugger as Tracy;
use Zend\Stdlib\AbstractOptions;

/**
 * Class DebuggerOptions
 */
class DebuggerOptions extends AbstractOptions
{
    /**
     * @var bool
     */
    protected $enabled = true;

    /**
     * @var bool|null
     */
    protected $mode = null;

    /**
     * @var bool
     */
    protected $bar = false;

    /**
     * @var bool
     */
    protected $strict = true;

    /**
     * @var string|null
     */
    protected $log;

    /**
     * @var string
     */
    protected $email = '';

    /**
     * @var int
     */
    protected $maxDepth = 10;

    /**
     * @var int
     */
    protected $maxLen = 300;

    /**
     * Is debugger enabled?
     *
     * @return bool
     */
    public function isEnabled()
    {
        return $this->enabled;
    }

    /**
     * Is debugger disabled?
     *
     * @return bool
     */
    public function isDisabled()
    {
        return !$this->enabled;
    }

    /**
     * Debugger mode
     *
     * true  = production|false
     * false = development|null
     * null  = autodetect|IP address(es) csv/array
     *
     * @return bool|null
     */
    public function getMode()
    {
        return $this->mode;
    }

    /**
     * Is debugger bar enabled?
     *
     * @return bool
     */
    public function hasBar()
    {
        return $this->bar;
    }

    /**
     * @return bool
     */
    public function isStrict()
    {
        return $this->strict;
    }

    /**
     * @return string Empty string to disable, null for default
     */
    public function getLog()
    {
        if (null === $this->log) {
            $this->setLog('.');
        }
        return $this->log;
    }

    /**
     * Administrator address
     *
     * @return string
     */
    public function getEmail()
    {
        return $this->email;
    }

    /**
     * @return int
     */
    public function getMaxDepth()
    {
        return $this->maxDepth;
    }

    /**
     * @return int
     */
    public function getMaxLen()
    {
        return $this->maxLen;
    }

    /**
     * Enable debugger
     *
     * @param bool $enabled
     * @return $this
     */
    public function setEnabled($enabled)
    {
        $this->enabled = (bool) $enabled;
        return $this;
    }

    /**
     * Debugger mode, production or development.
     *
     * @param bool|null $mode
     * @return $this
     */
    public function setMode($mode)
    {
        $this->mode = (null === $mode ? null : (bool) $mode);
        return $this;
    }

    /**
     * Force development mode
     *
     * @return $this
     */
    public function setDevMode()
    {
        $this->setMode(Tracy::DEVELOPMENT);
        return $this;
    }

    /**
     * Force production mode
     *
     * @return $this
     */
    public function setPubMode()
    {
        $this->setMode(Tracy::PRODUCTION);
        return $this;
    }

    /**
     * @param bool|true $bar
     * @return $this
     */
    public function setBar($bar = true)
    {
        $this->bar = (bool) $bar;
        return $this;
    }

    /**
     * Strict errors?
     *
     * @param bool|true $strict
     * @return $this
     */
    public function setStrict($strict = true)
    {
        $this->strict = (bool) $strict;
        return $this;
    }

    /**
     * Path to log directory
     *
     * @param string $log
     * @return $this
     */
    public function setLog($log)
    {
        $this->log = realpath($log);
        return $this;
    }

    /**
     * Configure debugger administrator email
     *
     * @param string $email
     * @return $this
     */
    public function setEmail($email)
    {
        $this->email = (string) $email;
        return $this;
    }

    /**
     * Variable dump max depth
     *
     * @param int $maxDepth
     * @return $this
     */
    public function setMaxDepth($maxDepth)
    {
        $this->maxDepth = (int) $maxDepth;
        return $this;
    }

    /**
     * Maximum length of a variable
     *
     * @param int $maxLen
     * @return $this
     */
    public function setMaxLen($maxLen)
    {
        $this->maxLen = (int) $maxLen;
        return $this;
    }
}