Mero\Bundle\BaseBundle\Controller\AbstractController

Complexity

Total Complexity

8

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	7

Importance

Changes	3
Bugs	0	Features	3

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getCurrentRequest()	0	4	1
A	getBundleName()	0	10	2
A	getActionName()	0	7	1
A	apiResponse()	0	11	3
A	createInvalidEntityException()	0	4	1

<?php

namespace Mero\Bundle\BaseBundle\Controller;

use Mero\Bundle\BaseBundle\Exception\InvalidEntityException;
use Mero\Bundle\BaseBundle\Exception\UnsupportedFormatException;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
use Symfony\Component\Serializer\Serializer;

class AbstractController extends Controller
{
    /**
     * Gets the current request object.
     *
     * @return Request
     */
    protected function getCurrentRequest()
    {
        return $this->container->get('request_stack')->getCurrentRequest();
    }

    /**
     * Gets the bundle name.
     *
     * <b>Attention! This method returns the bundle name as the conventions of framewok.</b>
     * Example: "Mero/Bundle/BaseBundle" or "Mero/BaseBundle" returns "MeroBaseBundle".
     *
     * @return string
     */
    protected function getBundleName()
    {
        $matches = [];
        $className = str_replace('\Bundle\\', '', get_class($this));
        preg_match('/(.*)\\\Controller/', $className, $matches);

        return count($matches) != 0
            ? $matches[1]
            : null;
    }

    /**
     * Gets the action name.
     *
     * @return string Action name
     */
    protected function getActionName()
    {
        $request = $this->getCurrentRequest();
        $action = explode('::', $request->attributes->get('_controller'));

        return $action[1];
    }

    /**
     * Return JSON response.
     *
     * @param mixed $data    The response data
     * @param int   $status  The response status code
     * @param string $format Response format(json or xml)
     *
     * @throws UnsupportedFormatException When format is not json or xml
     *
     * @return JsonResponse
     */
    protected function apiResponse($data, $status, $format = 'json')
    {
        if (($format != 'json') && ($format != 'xml')) {
            throw new UnsupportedFormatException();
        }

        return new Response(
            $this->container->get('serializer')->serialize($data, $format),
            $status
        );
    }

    /**
     * Returns a InvalidEntityException.
     *
     * This method returns an invalid entity exception. Usage exemple:
     *
     *     throw $this->createInvalidEntityException('Invalid entity');
     *
     * @param string          $message  A message
     * @param \Exception|null $previous The previous exception
     *
     * @return InvalidEntityException
     */
    protected function createInvalidEntityException($message = 'Entity is not object', \Exception $previous = null)
    {
        return new InvalidEntityException($message, $previous);
    }
}