AppBundle\Controller\AbstractController

Complexity

Total Complexity

9

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getGlobalContext()	0	21	3
A	setContainer()	0	17	3
A	addErrorMessage()	0	4	1
A	addSuccessMessage()	0	4	1
A	addInfoMessage()	0	4	1

<?php

namespace AppBundle\Controller;

use AppBundle\Legacy\Traits\LegacyTemplateTrait;
use Oc\GlobalContext\GlobalContext;
use RuntimeException;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Class AbstractController
 *
 * @package AppBundle\Controller

Unexpected tag type @package in doc block

 */
abstract class AbstractController extends Controller
{
    use LegacyTemplateTrait;

    /**
     * Fetches the global context from the master request.
     *
     * @return GlobalContext

GlobalContext => \Oc\GlobalContext\GlobalContext

     */
    public function getGlobalContext()
    {
        $requestStack = $this->get('request_stack');

        $masterRequest = $requestStack->getMasterRequest();

        if ($masterRequest === null) {
            throw new RuntimeException('No master request found.');
        }

        /**
         * @var GlobalContext $globalContext

GlobalContext => \Oc\GlobalContext\GlobalContext

         */
        $globalContext = $masterRequest->get('global_context');

        if ($globalContext === null) {
            throw new RuntimeException('Global context not found on master request');
        }

        return $globalContext;
    }

    /**
     * Sets the container.
     *
     * There is no container available in the constructor of a controller, so we override setContainer() and use this
     *
     * @param ContainerInterface|null $container A ContainerInterface instance or null.

ContainerInterface => \Symfony\Component\DependencyInjection\ContainerInterface

     *
     * @return void
     */
    public function setContainer(ContainerInterface $container = null)
    {
        parent::setContainer($container);

        if ($container === null) {
            return;
        }

        $requestStack = $container->get('request_stack');
        /**
         * @var Request $masterRequest

Request => \Symfony\Component\HttpFoundation\Request

         */
        $masterRequest = $requestStack->getMasterRequest();
        if ($masterRequest) {
            $this->setTarget($masterRequest->getUri());
        }
    }

    /**
     * @param string $message
     *
     * @return void
     */
    protected function addErrorMessage($message)
    {
        $this->addFlash('error', $message);
    }

    /**
     * @param string $message
     *
     * @return void
     */
    protected function addSuccessMessage($message)
    {
        $this->addFlash('success', $message);
    }

    /**
     * @param string $message
     *
     * @return void
     */
    protected function addInfoMessage($message)
    {
        $this->addFlash('info', $message);
    }
}