zikula / core

src/system/RoutesModule/Controller/Base/AbstractConfigController.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
      *
      * @param Request $request Current request instance
      *
-     * @return string Output
+     * @return \Symfony\Component\HttpFoundation\Response Output
      *
      * @throws AccessDeniedException Thrown if the user doesn't have required permissions
      */

src/system/RoutesModule/Controller/Base/AbstractRouteController.php

Doc Comments +10 added lines, -6 removed lines

@@ -122,6 +122,10 @@ 
 
     /**
      * This method includes the common implementation code for adminView() and view().
+     * @param string $sort
+     * @param string $sortdir
+     * @param integer $pos
+     * @param integer $num
      */
     protected function viewInternal(Request $request, $sort, $sortdir, $pos, $num, $isAdmin = false)
     {
@@ -444,7 +448,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return Response Output
+     * @return \Symfony\Component\HttpFoundation\Response Output
      *
      * @throws AccessDeniedException Thrown if the user doesn't have required permissions
      */
@@ -458,7 +462,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return Response Output
+     * @return \Symfony\Component\HttpFoundation\Response Output
      *
      * @throws AccessDeniedException Thrown if the user doesn't have required permissions
      */
@@ -494,7 +498,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return Response Output
+     * @return \Symfony\Component\HttpFoundation\Response Output
      *
      * @throws AccessDeniedException Thrown if the user doesn't have required permissions
      */
@@ -508,7 +512,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return Response Output
+     * @return \Symfony\Component\HttpFoundation\Response Output
      *
      * @throws AccessDeniedException Thrown if the user doesn't have required permissions
      */
@@ -548,7 +552,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return bool true on sucess, false on failure
+     * @return RedirectResponse true on sucess, false on failure
      *
      * @throws RuntimeException Thrown if executing the workflow action fails
      */
@@ -564,7 +568,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return bool true on sucess, false on failure
+     * @return RedirectResponse true on sucess, false on failure
      *
      * @throws RuntimeException Thrown if executing the workflow action fails
      */

src/system/RoutesModule/Controller/RouteController.php

Doc Comments +6 added lines, -6 removed lines

@@ -256,7 +256,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return Response Output
+     * @return \Symfony\Component\HttpFoundation\RedirectResponse Output
      *
      * @throws AccessDeniedException Thrown if the user doesn't have required permissions
      */
@@ -315,7 +315,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return Response Output
+     * @return \Symfony\Component\HttpFoundation\RedirectResponse Output
      *
      * @throws AccessDeniedException Thrown if the user doesn't have required permissions
      */
@@ -343,7 +343,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return Response Output
+     * @return \Symfony\Component\HttpFoundation\Response Output
      *
      * @throws AccessDeniedException Thrown if the user doesn't have required permissions
      */
@@ -365,7 +365,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return bool true on sucess, false on failure
+     * @return \Symfony\Component\HttpFoundation\RedirectResponse true on sucess, false on failure
      *
      * @throws RuntimeException Thrown if executing the workflow action fails
      */
@@ -385,7 +385,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return bool true on sucess, false on failure
+     * @return \Symfony\Component\HttpFoundation\RedirectResponse true on sucess, false on failure
      *
      * @throws RuntimeException Thrown if executing the workflow action fails
      */
@@ -405,7 +405,7 @@ 
      *
      * @param Request $request Current request instance
      *
-     * @return Response Output
+     * @return \Symfony\Component\HttpFoundation\RedirectResponse Output
      *
      * @throws AccessDeniedException Thrown if the user doesn't have required permissions
      */

src/system/RoutesModule/Entity/Repository/Base/AbstractRouteRepository.php

Doc Comments +2 added lines, -3 removed lines

@@ -51,7 +51,7 @@ 
     /**
      * Retrieves an array with all fields which can be used for sorting instances.
      *
-     * @return array Sorting fields array
+     * @return string[] Sorting fields array
      */
     public function getAllowedSortingFields()
     {
@@ -176,7 +176,6 @@ 
     /**
      * Returns an array of additional template variables which are specific to the object type treated by this repository.
      *
-     * @param ImageHelper $imageHelper ImageHelper service instance
      * @param string      $context     Usage context (allowed values: controllerAction, api, actionHandler, block, contentType)
      * @param array       $args        Additional arguments
      *
@@ -422,7 +421,7 @@ 
     /**
      * Selects an object from the database.
      *
-     * @param mixed   $id       The id (or array of ids) to use to retrieve the object (optional) (default=0)
+     * @param integer   $id       The id (or array of ids) to use to retrieve the object (optional) (default=0)
      * @param boolean $useJoins Whether to include joining related objects (optional) (default=true)
      * @param boolean $slimMode If activated only some basic fields are selected without using any joins (optional) (default=false)
      *

Indentation +22 added lines, -22 removed lines

@@ -280,9 +280,9 @@ 
     
         $qb = $this->getEntityManager()->createQueryBuilder();
         $qb->update('Zikula\RoutesModule\Entity\RouteEntity', 'tbl')
-           ->set('tbl.createdBy', $newUserId)
-           ->where('tbl.createdBy= :creator')
-           ->setParameter('creator', $userId);
+            ->set('tbl.createdBy', $newUserId)
+            ->where('tbl.createdBy= :creator')
+            ->setParameter('creator', $userId);
         $query = $qb->getQuery();
         $query->execute();
     
@@ -313,9 +313,9 @@ 
     
         $qb = $this->getEntityManager()->createQueryBuilder();
         $qb->update('Zikula\RoutesModule\Entity\RouteEntity', 'tbl')
-           ->set('tbl.updatedBy', $newUserId)
-           ->where('tbl.updatedBy = :editor')
-           ->setParameter('editor', $userId);
+            ->set('tbl.updatedBy', $newUserId)
+            ->where('tbl.updatedBy = :editor')
+            ->setParameter('editor', $userId);
         $query = $qb->getQuery();
         $query->execute();
     
@@ -344,8 +344,8 @@ 
     
         $qb = $this->getEntityManager()->createQueryBuilder();
         $qb->delete('Zikula\RoutesModule\Entity\RouteEntity', 'tbl')
-           ->where('tbl.createdBy = :creator')
-           ->setParameter('creator', $userId);
+            ->where('tbl.createdBy = :creator')
+            ->setParameter('creator', $userId);
         $query = $qb->getQuery();
     
         $query->execute();
@@ -375,8 +375,8 @@ 
     
         $qb = $this->getEntityManager()->createQueryBuilder();
         $qb->delete('Zikula\RoutesModule\Entity\RouteEntity', 'tbl')
-           ->where('tbl.updatedBy = :editor')
-           ->setParameter('editor', $userId);
+            ->where('tbl.updatedBy = :editor')
+            ->setParameter('editor', $userId);
         $query = $qb->getQuery();
     
         $query->execute();
@@ -472,7 +472,7 @@ 
     {
         if ($excludeId > 0) {
             $qb->andWhere('tbl.id != :excludeId')
-               ->setParameter('excludeId', $excludeId);
+                ->setParameter('excludeId', $excludeId);
         }
     
         return $qb;
@@ -534,7 +534,7 @@ 
         $offset = ($currentPage-1) * $resultsPerPage;
     
         $query->setFirstResult($offset)
-              ->setMaxResults($resultsPerPage);
+                ->setMaxResults($resultsPerPage);
     
         return $query;
     }
@@ -600,14 +600,14 @@ 
                 if ((!is_numeric($v) && $v != '') || (is_numeric($v) && $v > 0)) {
                     if ($k == 'workflowState' && substr($v, 0, 1) == '!') {
                         $qb->andWhere('tbl.' . $k . ' != :' . $k)
-                           ->setParameter($k, substr($v, 1, strlen($v)-1));
+                            ->setParameter($k, substr($v, 1, strlen($v)-1));
                     } elseif (substr($v, 0, 1) == '%') {
                         $qb->andWhere('tbl.' . $k . ' LIKE :' . $k)
-                           ->setParameter($k, '%' . $v . '%');
+                            ->setParameter($k, '%' . $v . '%');
                     } else {
                         $qb->andWhere('tbl.' . $k . ' = :' . $k)
-                           ->setParameter($k, $v);
-                   }
+                            ->setParameter($k, $v);
+                    }
                 }
             }
         }
@@ -647,7 +647,7 @@ 
     {
         $qb = $this->genericBaseQuery('', $orderBy, $useJoins);
         if (count($exclude) > 0) {
-        	$qb = $this->addExclusion($qb, $exclude);
+            $qb = $this->addExclusion($qb, $exclude);
         }
     
         $qb = $this->addSearchFilter($qb, $fragment);
@@ -787,7 +787,7 @@ 
     
         $qb = $this->getEntityManager()->createQueryBuilder();
         $qb->select($selection)
-           ->from('Zikula\RoutesModule\Entity\RouteEntity', 'tbl');
+            ->from('Zikula\RoutesModule\Entity\RouteEntity', 'tbl');
     
         if (true === $useJoins) {
             $this->addJoinsToFrom($qb);
@@ -832,7 +832,7 @@ 
     {
         $qb = $this->getCountQuery('', false);
         $qb->andWhere('tbl.' . $fieldName . ' = :' . $fieldName)
-           ->setParameter($fieldName, $fieldValue);
+            ->setParameter($fieldName, $fieldValue);
     
         $qb = $this->addExclusion($qb, $excludeId);
     
@@ -878,7 +878,7 @@ 
     
         $qb = $this->getEntityManager()->createQueryBuilder();
         $qb->select($selection)
-           ->from('Zikula\RoutesModule\Entity\RouteEntity', 'tbl');
+            ->from('Zikula\RoutesModule\Entity\RouteEntity', 'tbl');
     
         if (true === $useJoins) {
             $this->addJoinsToFrom($qb);
@@ -956,7 +956,7 @@ 
             
             $userId = $this->getRequest()->getSession()->get('uid');
             $qb->andWhere('tbl.createdBy = :creator')
-               ->setParameter('creator', $userId);
+                ->setParameter('creator', $userId);
         }
     
         return $qb;
@@ -975,7 +975,7 @@ 
         if ($orderBy == 'RAND()') {
             // random selection
             $qb->addSelect('MOD(tbl.id, ' . mt_rand(2, 15) . ') AS HIDDEN randomIdentifiers')
-               ->add('orderBy', 'randomIdentifiers');
+                ->add('orderBy', 'randomIdentifiers');
             $orderBy = '';
         } elseif (empty($orderBy)) {
             $orderBy = $this->defaultSortingField;

src/system/RoutesModule/Helper/Base/AbstractViewHelper.php

Doc Comments +3 added lines, -3 removed lines

@@ -110,7 +110,7 @@ 
      * @param array   $templateParameters Template data
      * @param string  $template           Optional assignment of precalculated template file
      *
-     * @return mixed Output
+     * @return Response Output
      */
     public function processTemplate($type, $func, array $templateParameters = [], $template = '')
     {
@@ -160,7 +160,7 @@ 
      * @param string $type Current controller (name of currently treated entity)
      * @param string $func Current function (index, view, ...)
      *
-     * @return array List of allowed template extensions
+     * @return string List of allowed template extensions
      */
     protected function determineExtension($type, $func)
     {
@@ -213,7 +213,7 @@ 
      * @param array  $templateParameters Template data
      * @param string $template           Name of template to use
      *
-     * @return mixed Output
+     * @return Response Output
      */
     protected function processPdf(array $templateParameters = [], $template)
     {

Indentation +3 added lines, -3 removed lines

@@ -233,9 +233,9 @@
     
         // create name of the pdf output file
         $fileTitle = $this->controllerHelper->formatPermalink($siteName)
-                   . '-'
-                   . $this->controllerHelper->formatPermalink(\PageUtil::getVar('title'))
-                   . '-' . date('Ymd') . '.pdf';
+                    . '-'
+                    . $this->controllerHelper->formatPermalink(\PageUtil::getVar('title'))
+                    . '-' . date('Ymd') . '.pdf';
     
         /*
         if (true === $this->request->query->getBoolean('dbg', false)) {

src/system/RoutesModule/Form/Type/Base/AbstractRouteType.php

Spacing +17 added lines, -17 removed lines

@@ -100,7 +100,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Choose the route type')
-            ],'choices' => $choices,
+            ], 'choices' => $choices,
             'choice_attr' => $choiceAttributes,
             'multiple' => false,
             'expanded' => false
@@ -111,7 +111,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the replaced route name of the route')
-            ],'required' => false,
+            ], 'required' => false,
             'max_length' => 255,
         ]);
         $builder->add('bundle', TextType::class, [
@@ -120,7 +120,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the bundle of the route')
-            ],'required' => true,
+            ], 'required' => true,
             'max_length' => 255,
         ]);
         $builder->add('controller', TextType::class, [
@@ -129,7 +129,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the controller of the route')
-            ],'required' => true,
+            ], 'required' => true,
             'max_length' => 255,
         ]);
         $builder->add('action', TextType::class, [
@@ -138,7 +138,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the action of the route')
-            ],'required' => true,
+            ], 'required' => true,
             'max_length' => 255,
         ]);
         $builder->add('path', TextType::class, [
@@ -147,7 +147,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the path of the route')
-            ],'required' => true,
+            ], 'required' => true,
             'max_length' => 255,
         ]);
         $builder->add('host', TextType::class, [
@@ -156,7 +156,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the host of the route')
-            ],'required' => false,
+            ], 'required' => false,
             'max_length' => 255,
         ]);
         
@@ -173,7 +173,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Choose the schemes')
-            ],'choices' => $choices,
+            ], 'choices' => $choices,
             'choice_attr' => $choiceAttributes,
             'multiple' => true,
             'expanded' => false
@@ -192,7 +192,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Choose the methods')
-            ],'choices' => $choices,
+            ], 'choices' => $choices,
             'choice_attr' => $choiceAttributes,
             'multiple' => true,
             'expanded' => false
@@ -202,14 +202,14 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('prepend bundle prefix ?')
-            ],'required' => true,
+            ], 'required' => true,
         ]);
         $builder->add('translatable', CheckboxType::class, [
             'label' => $this->__('Translatable') . ':',
             'attr' => [
                 'class' => '',
                 'title' => $this->__('translatable ?')
-            ],'required' => true,
+            ], 'required' => true,
         ]);
         $builder->add('translationPrefix', TextType::class, [
             'label' => $this->__('Translation prefix') . ':',
@@ -217,7 +217,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the translation prefix of the route')
-            ],'required' => false,
+            ], 'required' => false,
             'max_length' => 255,
         ]);
         $builder->add('condition', TextType::class, [
@@ -226,7 +226,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the condition of the route')
-            ],'required' => false,
+            ], 'required' => false,
             'max_length' => 255,
         ]);
         $builder->add('description', TextType::class, [
@@ -235,7 +235,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the description of the route')
-            ],'required' => false,
+            ], 'required' => false,
             'max_length' => 255,
         ]);
         $builder->add('sort', IntegerType::class, [
@@ -244,7 +244,7 @@ 
             'attr' => [
                 'class' => ' validate-digits',
                 'title' => $this->__('Enter the sort of the route. Only digits are allowed.')
-            ],'required' => false,
+            ], 'required' => false,
             'max_length' => 11,
             'scale' => 0
         ]);
@@ -254,7 +254,7 @@ 
             'attr' => [
                 'class' => '',
                 'title' => $this->__('Enter the group of the route')
-            ],'required' => false,
+            ], 'required' => false,
             'max_length' => 255,
         ]);
     }
@@ -330,7 +330,7 @@ 
             ->setDefaults([
                 // define class for underlying data (required for embedding forms)
                 'data_class' => 'Zikula\RoutesModule\Entity\RouteEntity',
-                'empty_data' => function (FormInterface $form) {
+                'empty_data' => function(FormInterface $form) {
                     return $this->entityFactory->createRoute();
                 },
                 'error_mapping' => [

src/system/RoutesModule/Form/Base/AbstractAppSettingsType.php

Spacing +1 added lines, -1 removed lines

@@ -105,7 +105,7 @@
                 'empty_data' => intval('10'),
                 'attr' => [
                     'title' => $this->__('Enter the route entries per page. Only digits are allowed.')
-                ],'max_length' => 255,
+                ], 'max_length' => 255,
                 'scale' => 0
             ])
         ;