Merge pull request #784 from florianv/code-style

Fixed code style

Author: stof

Controller/Annotations/Param.php

@@ -29,11 +29,11 @@ abstract class Param
     public $default = null;
     /** @var string */
     public $description;
-    /** @var boolean */
+    /** @var bool */
     public $strict = false;
-    /** @var boolean */
+    /** @var bool */
     public $array = false;
-    /** @var boolean */
+    /** @var bool */
     public $nullable = false;
 
     /**

Controller/Annotations/RequestParam.php

@@ -21,6 +21,6 @@
  */
 class RequestParam extends Param
 {
-    /** @var boolean */
+    /** @var bool */
     public $strict = true;
 }

Controller/Annotations/View.php

@@ -36,7 +36,7 @@ class View extends Template
     protected $serializerGroups;
 
     /**
-     * @var Boolean
+     * @var bool
      */
     protected $populateDefaultVars = true;
 
@@ -109,15 +109,15 @@ public function getSerializerGroups()
     }
 
     /**
-     * @param Boolean $populateDefaultVars
+     * @param bool $populateDefaultVars
      */
     public function setPopulateDefaultVars($populateDefaultVars)
     {
-        $this->populateDefaultVars = (Boolean) $populateDefaultVars;
+        $this->populateDefaultVars = (bool) $populateDefaultVars;
     }
 
     /**
-     * @return Boolean
+     * @return bool
      */
     public function isPopulateDefaultVars()
     {

Controller/ExceptionController.php

@@ -19,7 +19,6 @@
 use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-
 use FOS\RestBundle\Util\Codes;
 use FOS\RestBundle\View\ViewHandler;
 use FOS\RestBundle\View\View;
@@ -42,18 +41,21 @@ protected function createExceptionWrapper(array $parameters)
     {
         /** @var ExceptionWrapperHandlerInterface $exceptionWrapperHandler */
         $exceptionWrapperHandler = $this->container->get('fos_rest.view.exception_wrapper_handler');
+
         return $exceptionWrapperHandler->wrap($parameters);
     }
 
     /**
      * Converts an Exception to a Response.
      *
-     * @param Request                                       $request   Request
-     * @param HttpFlattenException|DebugFlattenException    $exception A HttpFlattenException|DebugFlattenException instance
-     * @param DebugLoggerInterface                          $logger    A DebugLoggerInterface instance
-     * @param string                                        $format    The format to use for rendering (html, xml, ...)
+     * @param Request                                    $request
+     * @param HttpFlattenException|DebugFlattenException $exception
+     * @param DebugLoggerInterface                       $logger
+     * @param string                                     $format
      *
-     * @return Response Response instance
+     * @return Response
+     *
+     * @throws \InvalidArgumentException
      */
     public function showAction(Request $request, $exception, DebugLoggerInterface $logger = null, $format = 'html')
     {
@@ -109,7 +111,7 @@ public function showAction(Request $request, $exception, DebugLoggerInterface $l
     }
 
     /**
-     * Get and clean any content that was already outputted
+     * Gets and cleans any content that was already outputted.
      *
      * This code comes from Symfony and should be synchronized on a regular basis
      * see src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php
@@ -134,12 +136,12 @@ protected function getAndCleanOutputBuffering()
     }
 
     /**
-     * Extract the exception message
+     * Extracts the exception message.
      *
-     * @param HttpFlattenException|DebugFlattenException $exception    A HttpFlattenException|DebugFlattenException instance
+     * @param HttpFlattenException|DebugFlattenException $exception
      * @param array                                      $exceptionMap
      *
-     * @return string Message
+     * @return int|false
      */
     protected function isSubclassOf($exception, $exceptionMap)
     {
@@ -162,9 +164,9 @@ protected function isSubclassOf($exception, $exceptionMap)
     }
 
     /**
-     * Extract the exception message
+     * Extracts the exception message.
      *
-     * @param HttpFlattenException|DebugFlattenException $exception A HttpFlattenException|DebugFlattenException instance
+     * @param HttpFlattenException|DebugFlattenException $exception
      *
      * @return string Message
      */
@@ -183,27 +185,27 @@ protected function getExceptionMessage($exception)
     }
 
     /**
-     * Determine the status code to use for the response
+     * Determines the status code to use for the response.
      *
-     * @param HttpFlattenException|DebugFlattenException $exception A HttpFlattenException|DebugFlattenException instance
+     * @param HttpFlattenException|DebugFlattenException $exception
      *
-     * @return integer An HTTP response code
+     * @return int
      */
     protected function getStatusCode($exception)
     {
         $exceptionMap = $this->container->getParameter('fos_rest.exception.codes');
         $isExceptionMappedToStatusCode = $this->isSubclassOf($exception, $exceptionMap);
 
-        return ($isExceptionMappedToStatusCode) ? $isExceptionMappedToStatusCode : $exception->getStatusCode();
+        return $isExceptionMappedToStatusCode ?: $exception->getStatusCode();
     }
 
     /**
-     * Determine the format to use for the response
+     * Determines the format to use for the response.
      *
-     * @param Request $request Request instance
-     * @param string  $format  The format to use for rendering (html, xml, ...)
+     * @param Request $request
+     * @param string  $format
      *
-     * @return string Encoding format
+     * @return string
      */
     protected function getFormat(Request $request, $format)
     {
@@ -215,19 +217,19 @@ protected function getFormat(Request $request, $format)
     }
 
     /**
-     * Determine the parameters to pass to the view layer.
+     * Determines the parameters to pass to the view layer.
      *
      * Overwrite it in a custom ExceptionController class to add additionally parameters
      * that should be passed to the view layer.
      *
-     * @param ViewHandler                                       $viewHandler    The view handler instance
-     * @param string                                            $currentContent The current content in the output buffer
-     * @param integer                                           $code           An HTTP response code
-     * @param HttpFlattenException|DebugFlattenException        $exception      A HttpFlattenException|DebugFlattenException instance
-     * @param DebugLoggerInterface                              $logger         A DebugLoggerInterface instance
-     * @param string                                            $format         The format to use for rendering (html, xml, ...)
+     * @param ViewHandler                                $viewHandler
+     * @param string                                     $currentContent
+     * @param int                                        $code
+     * @param HttpFlattenException|DebugFlattenException $exception
+     * @param DebugLoggerInterface                       $logger
+     * @param string                                     $format
      *
-     * @return array Template parameters
+     * @return array
      */
     protected function getParameters(ViewHandler $viewHandler, $currentContent, $code, $exception, DebugLoggerInterface $logger = null, $format = 'html')
     {
@@ -248,7 +250,7 @@ protected function getParameters(ViewHandler $viewHandler, $currentContent, $cod
     }
 
     /**
-     * Find the template for the given format and status code
+     * Finds the template for the given format and status code.
      *
      * Note this method needs to be overridden in case another
      * engine than Twig should be supported;
@@ -258,12 +260,12 @@ protected function getParameters(ViewHandler $viewHandler, $currentContent, $cod
      *
      * @param Request $request
      * @param string  $format
-     * @param integer $code       An HTTP response status code
-     * @param Boolean $debug
+     * @param int     $statusCode
+     * @param bool    $debug
      *
      * @return TemplateReference
      */
-    protected function findTemplate(Request $request, $format, $code, $debug)
+    protected function findTemplate(Request $request, $format, $statusCode, $debug)
     {
         $name = $debug ? 'exception' : 'error';
         if ($debug && 'html' == $format) {
@@ -272,7 +274,7 @@ protected function findTemplate(Request $request, $format, $code, $debug)
 
         // when not in debug, try to find a template for the specific HTTP status code and format
         if (!$debug) {
-            $template = new TemplateReference('TwigBundle', 'Exception', $name.$code, $format, 'twig');
+            $template = new TemplateReference('TwigBundle', 'Exception', $name.$statusCode, $format, 'twig');
             if ($this->container->get('templating')->exists($template)) {
                 return $template;
             }

Controller/FOSRestController.php

@@ -13,7 +13,6 @@
 
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\Response;
-
 use FOS\RestBundle\View\View;
 use FOS\RestBundle\View\RedirectView;
 use FOS\RestBundle\View\RouteRedirectView;
@@ -27,13 +26,13 @@
 abstract class FOSRestController extends Controller
 {
     /**
-     * Create a view
+     * Creates a view.
      *
      * Convenience method to allow for a fluent interface.
      *
-     * @param mixed   $data
-     * @param integer $statusCode
-     * @param array   $headers
+     * @param mixed $data
+     * @param int   $statusCode
+     * @param array $headers
      *
      * @return View
      */
@@ -43,13 +42,13 @@ protected function view($data = null, $statusCode = null, array $headers = array
     }
 
     /**
-     * Create a Redirect view
+     * Creates a Redirect view.
      *
      * Convenience method to allow for a fluent interface.
      *
-     * @param string  $url
-     * @param integer $statusCode
-     * @param array   $headers
+     * @param string $url
+     * @param int    $statusCode
+     * @param array  $headers
      *
      * @return View
      */
@@ -59,14 +58,14 @@ protected function redirectView($url, $statusCode = Codes::HTTP_FOUND, array $he
     }
 
     /**
-     * Create a Route Redirect View
+     * Creates a Route Redirect View.
      *
      * Convenience method to allow for a fluent interface.
      *
-     * @param string  $route
-     * @param mixed   $parameters
-     * @param integer $statusCode
-     * @param array   $headers
+     * @param string $route
+     * @param mixed  $parameters
+     * @param int    $statusCode
+     * @param array  $headers
      *
      * @return View
      */
@@ -76,7 +75,7 @@ protected function routeRedirectView($route, array $parameters = array(), $statu
     }
 
     /**
-     * Convert view into a response object.
+     * Converts view into a response object.
      *
      * Not necessary to use, if you are using the "ViewResponseListener", which
      * does this conversion automatically in kernel event "onKernelView".

Decoder/ContainerDecoderProvider.php

@@ -14,15 +14,12 @@
 use Symfony\Component\DependencyInjection\ContainerAware;
 
 /**
- * Provides encoders through the Symfony2 DIC
+ * Provides encoders through the Symfony2 DIC.
  *
  * @author Igor Wiedler <[email protected]>
  */
 class ContainerDecoderProvider extends ContainerAware implements DecoderProviderInterface
 {
-    /**
-     * @var array
-     */
     private $decoders;
 
     /**
@@ -36,20 +33,15 @@ public function __construct(array $decoders)
     }
 
     /**
-     * @param string $format format
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function supports($format)
     {
         return isset($this->decoders[$format]);
     }
 
     /**
-     * @param string $format format
-     *
-     * @throws \InvalidArgumentException
-     * @return \FOS\RestBundle\Decoder\DecoderInterface
+     * {@inheritdoc}
      */
     public function getDecoder($format)
     {

Decoder/DecoderInterface.php

@@ -19,11 +19,11 @@
 interface DecoderInterface
 {
     /**
-     * Decodes a string into PHP data
+     * Decodes a string into PHP data.
      *
-     * @param string $data data to decode
+     * @param string $data
      *
-     * @return array|Boolean false in case the content could not be decoded, else an array
+     * @return array|bool False in case the content could not be decoded, else an array
      */
     public function decode($data);
 }

Decoder/DecoderProviderInterface.php

@@ -19,18 +19,18 @@
 interface DecoderProviderInterface
 {
     /**
-     * Check if a certain format is supported.
+     * Checks if a certain format is supported.
      *
-     * @param string $format Format for the requested decoder.
+     * @param string $format
      *
-     * @return boolean
+     * @return bool
      */
     public function supports($format);
 
     /**
      * Provides decoders, possibly lazily.
      *
-     * @param string $format Format for the requested decoder.
+     * @param string $format
      *
      * @return \FOS\RestBundle\Decoder\DecoderInterface
      */

Decoder/JsonDecoder.php

@@ -12,7 +12,7 @@
 namespace FOS\RestBundle\Decoder;
 
 /**
- * Decodes JSON data
+ * Decodes JSON data.
  *
  * @author Jordi Boggiano <[email protected]>
  */

Decoder/JsonToFormDecoder.php

@@ -12,7 +12,7 @@
 namespace FOS\RestBundle\Decoder;
 
 /**
- * Decodes JSON data and make it compliant with application/x-www-form-encoded style
+ * Decodes JSON data and make it compliant with application/x-www-form-encoded style.
  *
  * @author Kévin Dunglas <[email protected]>
  */