PGSSoft / PgsRestfonyBundle

Command/GenerateCrudCommand.php

Doc Comments +18 added lines

@@ -221,6 +221,7 @@ 
 
     /**
      * Tries to generate forms if they don't exist yet and if we need write operations on entities.
+     * @param string $entity
      */
     protected function generateSerializationConfig($bundle, $entity, $metadata, $forceOverwrite)
     {
@@ -235,6 +236,7 @@ 
 
     /**
      * Tries to generate forms if they don't exist yet and if we need write operations on entities.
+     * @param string $entity
      */
     protected function generateForm($bundle, $entity, $metadata, $forceOverwrite)
     {
@@ -247,6 +249,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $entity
+     */
     protected function generateManager($bundle, $entity, $forceOverwrite)
     {
         try {
@@ -258,6 +263,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $entity
+     */
     protected function generateRepository($bundle, $entity, $forceOverwrite)
     {
         try {
@@ -269,6 +277,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $entity
+     */
     protected function updateRestRouting(QuestionHelper $questionHelper, InputInterface $input, OutputInterface $output, BundleInterface $bundle, $entity, $metadata)
     {
         $output->write('Importing REST config: ');
@@ -277,6 +288,10 @@ 
         $config->addResource($bundle->getNamespace(), $entity, $metadata);
     }
 
+    /**
+     * @param string $format
+     * @param string $entity
+     */
     protected function updateRouting(QuestionHelper $questionHelper, InputInterface $input, OutputInterface $output, BundleInterface $bundle, $format, $entity, $prefix)
     {
         $auto = true;
@@ -310,6 +325,9 @@ 
         }
     }
 
+    /**
+     * @param string $entity
+     */
     protected function getRoutePrefix(InputInterface $input, $entity)
     {
         $prefix = $input->getOption('route-prefix') ?: strtolower(str_replace(array('\\', '/'), '_', $entity));

Command/GeneratorCommand.php

Doc Comments +3 added lines, -3 removed lines

@@ -24,7 +24,7 @@ 
     /**
      * @param BundleInterface $bundle
      *
-     * @return array
+     * @return string[]
      */
     protected function getSkeletonDirs(BundleInterface $bundle = null)
     {
@@ -57,7 +57,7 @@ 
     /**
      * @param $shortcut
      *
-     * @return array
+     * @return string[]
      */
     protected function parseShortcutNotation($shortcut)
     {
@@ -74,7 +74,7 @@ 
     }
 
     /**
-     * @param $entity
+     * @param string $entity
      *
      * @return array
      */

Controller/RestController.php

Doc Comments +2 added lines, -2 removed lines

@@ -249,7 +249,7 @@ 
      * @param Request $request
      * @param int     $id
      *
-     * @return FormInterface
+     * @return Response
      */
     protected function editForm(Request $request, $id)
     {
@@ -295,7 +295,7 @@ 
      * Apply serialization rules on response object.
      *
      * @param object $result
-     * @param array  $groups
+     * @param string[]  $groups
      * @param int    $statusCode
      *
      * @return Response

EventListener/RequestAwareEventListener.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
  */
 abstract class RequestAwareEventListener
 {
+    /**
+     * @return string
+     */
     protected function getControllerMethod(Request $request)
     {
         $controller = $request->attributes->get('_controller');

Generator/DoctrineRepositoryGenerator.php

Doc Comments +3 added lines

@@ -18,6 +18,9 @@
         $this->helper = new BundleStructureHelper($bundle, $entity);
     }
 
+    /**
+     * @param boolean $forceOverwrite
+     */
     protected function canWriteToFile($forceOverwrite)
     {
         return !file_exists($this->helper->getRepositoryFullFilename()) || $forceOverwrite;

Generator/DoctrineSerializationConfigGenerator.php

Doc Comments +14 added lines, -1 removed lines

@@ -73,11 +73,18 @@ 
         }
     }
 
+    /**
+     * @param string $file
+     * @param boolean $forceOverwrite
+     */
     protected function canWriteToFile($file, $forceOverwrite)
     {
         return !file_exists($file) || $forceOverwrite;
     }
 
+    /**
+     * @param string $filePath
+     */
     protected function writeYamlToFile($filePath, array $data)
     {
         $yaml = Yaml::dump($data, 4);
@@ -110,6 +117,9 @@ 
         }
     }
 
+    /**
+     * @param string $filePath
+     */
     protected function getYamlFileContent($filePath)
     {
         return file_exists($filePath) ? Yaml::parse($filePath) : [];
@@ -119,7 +129,7 @@ 
      * Returns an array of fields. Fields can be both column fields and
      * association fields.
      *
-     * @param $entityName
+     * @param string $entityName
      * @param ClassMetadataInfo $metadata
      *
      * @return array $fields
@@ -172,6 +182,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $entityName
+     */
     private function getRelationsFromMetadata($entityName)
     {
         $result = [];

Handler/FormlyFormHandler.php

Doc Comments +3 added lines

@@ -144,6 +144,9 @@
         }
     }
 
+    /**
+     * @param string $dataclass
+     */
     protected function getAutocompleteUrl($dataclass)
     {
         $entityName = $dataclass;

Model/RestPaginator.php

Doc Comments +1 added lines, -1 removed lines

@@ -118,7 +118,7 @@
     }
 
     /**
-     * @return array
+     * @return integer
      */
     public function getItems()
     {

Generator/DoctrineCrudGenerator.php

Doc Comments +3 added lines

@@ -18,6 +18,9 @@
         $this->helper = new BundleStructureHelper($bundle, $entity);
     }
 
+    /**
+     * @param boolean $forceOverwrite
+     */
     protected function canWriteToFile($forceOverwrite)
     {
         return !file_exists($this->helper->getRepositoryFullFilename()) || $forceOverwrite;