WBW\Bundle\CoreBundle\Controller\AbstractController

Complexity

Total Complexity

17

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	dispatchEvent()	0	4	1
A	getContainer()	0	3	1
A	getEventDispatcher()	0	3	1
A	getFormHelper()	0	3	1
A	getKernelEventListener()	0	3	1
A	getLogger()	0	3	1
A	getRepositoryHelper()	0	3	1
A	getRepositoryReportHelper()	0	3	1
A	getRouter()	0	3	1
A	getSession()	0	3	1
A	getTranslator()	0	3	1
A	hasRolesOrRedirect()	0	12	3
A	notify()	0	3	1
A	toast()	0	3	1
A	translate()	0	3	1

<?php

/*
 * This file is part of the core-bundle package.
 *
 * (c) 2018 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Bundle\CoreBundle\Controller;

use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\Session\SessionInterface;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Component\Security\Core\User\User;
use Symfony\Component\Translation\TranslatorInterface;
use WBW\Bundle\CoreBundle\Component\BaseEvent;
use WBW\Bundle\CoreBundle\Event\NotificationEvent;
use WBW\Bundle\CoreBundle\Event\ToastEvent;
use WBW\Bundle\CoreBundle\EventDispatcher\EventDispatcherHelper;
use WBW\Bundle\CoreBundle\EventListener\KernelEventListener;
use WBW\Bundle\CoreBundle\Exception\BadUserRoleException;
use WBW\Bundle\CoreBundle\Helper\FormHelper;
use WBW\Bundle\CoreBundle\Helper\RepositoryReportHelper;
use WBW\Bundle\CoreBundle\Helper\UserHelper;
use WBW\Bundle\CoreBundle\Notification\NotificationInterface;
use WBW\Bundle\CoreBundle\Repository\RepositoryHelper;
use WBW\Bundle\CoreBundle\Toast\ToastInterface;

/**
 * Abstract controller.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\CoreBundle\Controller
 * @abstract
 */
abstract class AbstractController extends BaseController {

    /**
     * Dispatch an event.
     *
     * @param string $eventName The event name.
     * @param BaseEvent $event The event.
     * @return BaseEvent|null Returns the event in case of success, null otherwise.
     */
    protected function dispatchEvent($eventName, BaseEvent $event) {
        $this->getLogger()->debug(sprintf('A controller dispatch an event with name "%s"', $eventName, ["_controller" => get_class($this), "_event" => get_class($event)]));
        return EventDispatcherHelper::dispatch($this->getEventDispatcher(), $eventName, $event);
    }

    /**
     * Get the container.
     *
     * @return Container|null Returns the container in case of success, null otherwise.
     */
    protected function getContainer() {
        return $this->get("service_container");
    }

    /**
     * Get the event dispatcher.
     *
     * @return EventDispatcherInterface|null Returns the event dispatcher in case of success, null otherwise.
     */
    protected function getEventDispatcher() {
        return $this->get("event_dispatcher");
    }

    /**
     * Get the form helper.
     *
     * @return FormHelper|null Returns the form helper in case of success, null otherwise.
     */
    protected function getFormHelper() {
        return $this->get(FormHelper::SERVICE_NAME);
    }

    /**
     * Get the kernel event listener.
     *
     * @return KernelEventListener|null Returns the kernel event listener in case of success, null otherwise.
     */
    protected function getKernelEventListener() {
        return $this->get(KernelEventListener::SERVICE_NAME);
    }

    /**
     * Get the logger.
     *
     * @return LoggerInterface|null Returns the logger in case of success, null otherwise.
     */
    protected function getLogger() {
        return $this->get("logger");
    }

    /**
     * Get the repository helper.
     *
     * @return RepositoryHelper|null Returns the repository helper in case of success, null otherwise.
     */
    protected function getRepositoryHelper() {
        return $this->get(RepositoryHelper::SERVICE_NAME);
    }

    /**
     * Get the repository report helper.
     *
     * @return RepositoryHelper|null Returns the repository helper in case of success, null otherwise.
     * @deprecated since 2.15.0, use {@see WBW\Bundle\CoreBundle\Controller\AbstractController::getRepositoryHelper()} instead.
     */
    protected function getRepositoryReportHelper() {
        return $this->get(RepositoryReportHelper::SERVICE_NAME);
    }

    /**
     * Get the router.
     *
     * @return RouterInterface|null Returns the router in case of success, null otherwise.
     */
    protected function getRouter() {
        return $this->get("router");
    }

    /**
     * Get the session.
     *
     * @return SessionInterface|null Returns the session in case of success, null otherwise.
     */
    protected function getSession() {
        return $this->get("session");
    }

    /**
     * Get the translator.
     *
     * @return TranslatorInterface|null Returns the translator in case of success, null otherwise.
     */
    protected function getTranslator() {
        return $this->get("translator");
    }

    /**
     * Determines if the connected user have roles or redirect.
     *
     * @param array $roles The roles.
     * @param bool $or OR ?
     * @param string $redirectUrl The redirect URL.
     * @param string $originUrl The origin URL.
     * @return bool Returns true.
     * @throws BadUserRoleException Throws a bad user role exception.
     */
    protected function hasRolesOrRedirect(array $roles, $or, $redirectUrl, $originUrl = "") {

        $user = $this->getKernelEventListener()->getUser();
        if (false === UserHelper::hasRoles($user, $roles, $or)) {

            // Throw a bad user role exception with an anonymous user if user is null.
            $user = null !== $user ? $user : new User("anonymous", "");
            throw new BadUserRoleException($user, $roles, $redirectUrl, $originUrl);
        }

        return true;
    }

    /**
     * Notify.
     *
     * @param string $eventName The event name.
     * @param NotificationInterface $notification The notification.
     * @return NotificationEvent|null Returns the event in case of success, null otherwise.
     */
    protected function notify($eventName, NotificationInterface $notification) {
        return $this->dispatchEvent($eventName, new NotificationEvent($eventName, $notification));
    }

    /**
     * Toast.
     *
     * @param string $eventName The event name.
     * @param ToastInterface $toast The toast.
     * @return ToastEvent|null Returns the event in case of success, null otherwise.
     */
    protected function toast($eventName, ToastInterface $toast) {
        return $this->dispatchEvent($eventName, new ToastEvent($eventName, $toast));
    }

    /**
     * Translate.
     *
     * @param string $id The id.
     * @param array $parameters The parameters.
     * @param string|null $domain The domain.
     * @param string|null $locale The locale.
     * @return string Returns the translation in case of success, $id otherwise.
     */
    protected function translate($id, array $parameters = [], $domain = null, $locale = null) {
        return $this->getTranslator()->trans($id, $parameters, $domain, $locale);
    }
}