BZIon\Twig\AppGlobal

Complexity

Total Complexity

16

Size/Duplication

Total Lines	183
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

71.43%

Importance

Changes	5
Bugs	1	Features	2

16 Methods

Rating	Name	Duplication	Size	Complexity
A	isAlertEnabled()	0	4	1
A	isAlertCollapsible()	0	4	1
A	getAlertHeader()	0	4	1
A	getAlertMessage()	0	4	1
A	__construct()	0	5	1
A	getController()	0	4	1
A	getEnvironment()	0	4	1
A	isDebug()	0	4	1
A	isMaintenance()	0	4	1
A	getSiteTitle()	0	4	1
A	getSiteWelcome()	0	4	1
A	getSiteSlug()	0	4	1
A	getUrlType()	0	4	1
A	getAlertID()	0	4	1
A	getSocket()	0	9	1
A	getPages()	0	6	1

<?php

namespace BZIon\Twig;

use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * A twig global that provides information about the app
 */
class AppGlobal
{
    /**
     * The controller handling the request
     * @var \Controller
     */
    private $controller;

    /**
     * Symfony's container
     * @var ContainerInterface
     */
    private $container;

    /**
     * Create new AppGlobal
     *
     * @param \Controller        $controller The controller handling the request
     * @param ContainerInterface $container  Symfony's service container
     */
    public function __construct(\Controller $controller, ContainerInterface $container)
    {
        $this->controller = $controller;
        $this->container  = $container;
    }

    /**
     * Get the controller handling the request
     *
     * @return \Controller
     */
    public function getController()
    {
        return $this->controller;
    }

    /**
     * Get the environment of the kernel
     *
     * @return string
     */
    public function getEnvironment()
    {
        return $this->container->getParameter('kernel.environment');
    }

    /**
     * Find out whether the kernel has enabled debugging
     *
     * @return bool
     */
    public function isDebug()
    {
        return $this->container->getParameter('kernel.debug');
    }

    /**
     * Find out whether maintenance mode is enabled for users of the website
     *
     * @return bool
     */
    public function isMaintenance()
    {
        return $this->container->getParameter('bzion.miscellaneous.maintenance');
    }

    /**
     * Get the name of the website
     *
     * @return string
     */
    public function getSiteTitle()
    {
        return $this->container->getParameter('bzion.site.name');
    }

    /**
     * Get the name of the website
     *
     * @return string
     */
    public function getSiteWelcome()
    {
        return $this->container->getParameter('bzion.site.welcome');
    }

    /**
     * Get the name of the website
     *
     * @return string
     */
    public function getSiteSlug()
    {
        return $this->container->getParameter('bzion.site.slug');
    }

    /**
     * Whether or not the website wide alert is enabled
     *
     * @return bool
     */
    public function isAlertEnabled()
    {
        return $this->container->getParameter('bzion.site.alert.enabled');
    }

    /**
     * Should the alert be collapsible
     *
     * @return bool
     */
    public function isAlertCollapsible()
    {
        return $this->container->getParameter('bzion.site.alert.collapsible');
    }

    /**
     * The title of the alert
     *
     * @return string
     */
    public function getAlertHeader()
    {
        return $this->container->getParameter('bzion.site.alert.header');
    }

    /**
     * The message of the alert
     *
     * @return string
     */
    public function getAlertMessage()
    {
        return $this->container->getParameter('bzion.site.alert.message');
    }

    /**
     * The type of URLs for Models
     *
     * @return string `vanity` or `permalink`
     */
    public function getUrlType()
    {
        return $this->container->getParameter('bzion.site.url_type');
    }

    /**
     * A unique enough identifier of the alert
     *
     * @return string
     */
    public function getAlertID()
    {
        return substr(md5($this->getAlertHeader() . $this->getAlertMessage()), 0, 7);
    }

    /**
     * Get information about sockets
     *
     * @return array
     */
    public function getSocket()
    {
        return array(
            'websocket' => array(
                'enabled' => $this->container->getParameter('bzion.features.websocket.enabled'),
                'port'    => $this->container->getParameter('bzion.features.websocket.push_port')
            )
        );
    }

    /**
     * Get a list of visible pages
     *
     * @return \Page[]
     */
    public function getPages()
    {
        return \Page::getQueryBuilder()
            ->where('status')->equals('live')
            ->getModels($fast = true);
    }
}