Logi-CE / fmup

src/Bootstrap.php

<?php
namespace FMUP;

class Bootstrap implements Environment\OptionalInterface, Sapi\OptionalInterface, Logger\LoggerInterface
{
    use Environment\OptionalTrait {
        getEnvironment as getEnvironmentTrait;
        setEnvironment as setEnvironmentTrait;
    }
    use Sapi\OptionalTrait;
    use Config\RequiredTrait;
    use Logger\LoggerTrait {
        getLogger as getLoggerTrait;
        setLogger as setLoggerTrait;
    }

    private $isErrorHandlerRegistered = false;
    private $request;
    private $session;
    private $flashMessenger;
    private $isWarmed;
    /**
     * @var Cookie
     */
    private $cookie;

    /**
     * Prepare needed configuration in bootstrap.
     *
     * There is no need to warm up DB connection but it could be configured
     *
     * @return $this
     */
    public function warmUp()
    {
        if (!$this->isWarmed()) {
            $this->defineTimezone();
            $this->getLogger();
            $this->initHelperDb();
            $this->getEnvironment();
            //$this->registerErrorHandler(); //@todo activation of this might be very useful

72% of this comment could be valid code. Did you maybe forget this after debugging?

            $this->setIsWarmed();
        }
        return $this;
    }

    /**
     * Define default timezone
     * @return $this
     * @codeCoverageIgnore
     */
    protected function defineTimezone()
    {
        date_default_timezone_set("Europe/Paris");
        return $this;
    }

    /**
     * Initialize Config in helper db
     * @return $this
     */
    private function initHelperDb()
    {
        Db\Manager::getInstance()
            ->setConfig($this->getConfig())//@todo find a better solution
            ->setLogger($this->getLogger());
        return $this;
    }

    /**
     * @return Session
     */
    public function getSession()
    {
        if (!$this->session) {
            $this->session = Session::getInstance();
        }
        return $this->session;
    }

    /**
     * Define session component
     * @param Session $session
     * @return $this
     */
    public function setSession(Session $session)
    {
        $this->session = $session;
        return $this;
    }

    /**
     * Return logger
     * @return Logger
     */
    public function getLogger()
    {
        if (!$this->hasLogger()) {
            $this->setLogger(
                (new Logger())
                    ->setRequest($this->getRequest())
                    ->setConfig($this->getConfig())
                    ->setEnvironment($this->getEnvironment())
            );
        }
        return $this->getLoggerTrait();
    }

    /**
     * Define logger
     * @param Logger $logger
     * @return $this
     */
    public function setLogger(Logger $logger)
    {
        if (!$logger->hasEnvironment()) {
            $logger->setEnvironment($this->getEnvironment());
        }
        $this->setLoggerTrait($logger);
        return $this;
    }

    public function registerErrorHandler()
    {
        if (!$this->isErrorHandlerRegistered) {
            \Monolog\ErrorHandler::register($this->getLogger()->get(\FMUP\Logger\Channel\System::NAME)->getLogger());
            $this->isErrorHandlerRegistered = true;
        }
        return $this;
    }

    /**
     * Define HTTP request object
     * @param Request $request
     * @return $this
     */
    public function setRequest(Request $request)
    {
        $this->request = $request;
        return $this;
    }

    /**
     * Retrieve defined HTTP request object
     * @return Request
     * @throws \LogicException if no request has been set
     */
    public function getRequest()
    {
        if (!$this->hasRequest()) {
            throw new \LogicException('Request is not defined');
        }
        return $this->request;
    }

    /**
     * Check if request is defined
     * @return bool
     */
    public function hasRequest()
    {
        return !is_null($this->request);
    }

    /**
     * Get flashMessenger
     * @return \FMUP\FlashMessenger
     */
    public function getFlashMessenger()
    {
        if ($this->flashMessenger === null) {
            $this->flashMessenger = FlashMessenger::getInstance();
        }
        return $this->flashMessenger;
    }

    /**
     * @param FlashMessenger $flashMessenger
     * @return $this
     */
    public function setFlashMessenger(FlashMessenger $flashMessenger)
    {
        $this->flashMessenger = $flashMessenger;
        return $this;
    }

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

    /**
     * @return $this
     */
    public function setIsWarmed()
    {
        $this->isWarmed = true;
        return $this;
    }

    /**
     * @return Environment
     */
    public function getEnvironment()
    {
        if (!$this->hasEnvironment()) {
            $environment = Environment::getInstance();
            $environment->setConfig($this->getConfig());
            $this->setEnvironmentTrait($environment);
        }
        return $this->getEnvironmentTrait();
    }

    /**
     * @param Environment $environment
     * @return $this
     */
    public function setEnvironment(Environment $environment = null)
    {
        if (!$environment->hasConfig()) {
            $environment->setConfig($this->getConfig());
        }
        $this->setEnvironmentTrait($environment);
        return $this;
    }

    /**
     * Retriever Cookie component
     * @return Cookie
     */
    public function getCookie()
    {
        if (!$this->cookie) {
            $this->cookie = Cookie::getInstance();
        }
        return $this->cookie;
    }

    /**
     * Define cookie component
     * @param Cookie $cookie
     * @return $this
     */
    public function setCookie(Cookie $cookie)
    {
        $this->cookie = $cookie;
        return $this;
    }
}