refactor: Some code and documentation updates (#985)

* Some housekeeping and documentation updates

* Code style fixes

* Code style fixes

* Code style fixes

* Code style fixes

* Change in APIRequest Class

Co-authored-by: neelkanthk <[email protected]>

Author: neelkanthk

src/Criteria/LimitOffsetCriteria.php

@@ -27,8 +27,8 @@ public function __construct(Request $request)
      */
     public function apply($model, \Prettus\Repository\Contracts\RepositoryInterface $repository)
     {
-        $limit = $this->request->get('limit', null);
-        $offset = $this->request->get('offset', null);
+        $limit = (int) $this->request->get('limit', null);
+        $offset = (int) $this->request->get('offset', null);
 
         if ($limit) {
             $model = $model->limit($limit);

src/Events/GeneratorFileCreated.php

@@ -11,7 +11,18 @@ class GeneratorFileCreated
 {
     use SerializesModels;
 
+    /**
+     * Type of event.
+     *
+     * @var string
+     */
     public $type;
+
+    /**
+     * Event payload.
+     *
+     * @var array
+     */
     public $data;
 
     /**

src/Events/GeneratorFileCreating.php

@@ -11,7 +11,18 @@ class GeneratorFileCreating
 {
     use SerializesModels;
 
+    /**
+     * Type of event.
+     *
+     * @var string
+     */
     public $type;
+
+    /**
+     * Event payload.
+     *
+     * @var array
+     */
     public $data;
 
     /**

src/Events/GeneratorFileDeleted.php

@@ -11,7 +11,18 @@ class GeneratorFileDeleted
 {
     use SerializesModels;
 
+    /**
+     * Type of event.
+     *
+     * @var string
+     */
     public $type;
+
+    /**
+     * Event payload.
+     *
+     * @var array
+     */
     public $data;
 
     /**

src/Events/GeneratorFileDeleting.php

@@ -11,7 +11,18 @@ class GeneratorFileDeleting
 {
     use SerializesModels;
 
+    /**
+     * Type of event.
+     *
+     * @var string
+     */
     public $type;
+
+    /**
+     * Event payload.
+     *
+     * @var array
+     */
     public $data;
 
     /**

src/Generators/API/APIControllerGenerator.php

@@ -24,6 +24,11 @@ public function __construct(CommandData $commandData)
         $this->fileName = $this->commandData->modelName.'APIController.php';
     }
 
+    /**
+     * Generate API Controller Class.
+     *
+     * @return void
+     */
     public function generate()
     {
         if ($this->commandData->getOption('repositoryPattern')) {
@@ -73,6 +78,11 @@ private function fillDocs($templateData)
         return $templateData;
     }
 
+    /**
+     * Delete API Controller.
+     *
+     * @return void
+     */
     public function rollback()
     {
         if ($this->rollbackFile($this->path, $this->fileName)) {

src/Generators/API/APIRequestGenerator.php

@@ -29,12 +29,22 @@ public function __construct(CommandData $commandData)
         $this->updateFileName = 'Update'.$this->commandData->modelName.'APIRequest.php';
     }
 
+    /**
+     * Generate API Request Class.
+     *
+     * @return void
+     */
     public function generate()
     {
         $this->generateCreateRequest();
         $this->generateUpdateRequest();
     }
 
+    /**
+     * Generate Create Request.
+     *
+     * @return void
+     */
     private function generateCreateRequest()
     {
         $templateData = get_template('api.request.create_request', 'laravel-generator');
@@ -47,6 +57,11 @@ private function generateCreateRequest()
         $this->commandData->commandInfo($this->createFileName);
     }
 
+    /**
+     * Generate Update Request.
+     *
+     * @return void
+     */
     private function generateUpdateRequest()
     {
         $modelGenerator = new ModelGenerator($this->commandData);
@@ -63,6 +78,11 @@ private function generateUpdateRequest()
         $this->commandData->commandInfo($this->updateFileName);
     }
 
+    /**
+     * Delete the generated Request Classes.
+     *
+     * @return void
+     */
     public function rollback()
     {
         if ($this->rollbackFile($this->path, $this->createFileName)) {

src/Generators/API/APIResourceGenerator.php

@@ -24,6 +24,11 @@ public function __construct(CommandData $commandData)
         $this->fileName = $this->commandData->modelName.'Resource.php';
     }
 
+    /**
+     * Generate API Resources.
+     *
+     * @return void
+     */
     public function generate()
     {
         $templateData = get_template('api.resource.api_resource', 'laravel-generator');

src/Generators/API/APIRoutesGenerator.php

@@ -36,6 +36,11 @@ public function __construct(CommandData $commandData)
         $this->routesTemplate = fill_template($this->commandData->dynamicVars, $routesTemplate);
     }
 
+    /**
+     * Generate API Routes.
+     *
+     * @return void
+     */
     public function generate()
     {
         $this->routeContents .= "\n\n".$this->routesTemplate;
@@ -51,6 +56,11 @@ public function generate()
         $this->commandData->commandComment("\n".$this->commandData->config->mCamelPlural.' api routes added.');
     }
 
+    /**
+     * Remove API Routes.
+     *
+     * @return void
+     */
     public function rollback()
     {
         if (Str::contains($this->routeContents, $this->routesTemplate)) {

src/Generators/MigrationGenerator.php

@@ -47,20 +47,22 @@ private function generateFields()
         $createdAtField = null;
         $updatedAtField = null;
 
-        foreach ($this->commandData->fields as $field) {
-            if ($field->name == 'created_at') {
-                $createdAtField = $field;
-                continue;
-            } else {
-                if ($field->name == 'updated_at') {
-                    $updatedAtField = $field;
+        if (isset($this->commandData->fields) && !empty($this->commandData->fields)) {
+            foreach ($this->commandData->fields as $field) {
+                if ($field->name == 'created_at') {
+                    $createdAtField = $field;
                     continue;
+                } else {
+                    if ($field->name == 'updated_at') {
+                        $updatedAtField = $field;
+                        continue;
+                    }
                 }
-            }
 
-            $fields[] = $field->migrationText;
-            if (!empty($field->foreignKeyText)) {
-                $foreignKeys[] = $field->foreignKeyText;
+                $fields[] = $field->migrationText;
+                if (!empty($field->foreignKeyText)) {
+                    $foreignKeys[] = $field->foreignKeyText;
+                }
             }
         }
 
@@ -91,18 +93,20 @@ public function rollback()
 
         $files = [];
 
-        foreach ($allFiles as $file) {
-            $files[] = $file->getFilename();
-        }
+        if (!empty($allFiles)) {
+            foreach ($allFiles as $file) {
+                $files[] = $file->getFilename();
+            }
 
-        $files = array_reverse($files);
+            $files = array_reverse($files);
 
-        foreach ($files as $file) {
-            if (Str::contains($file, $fileName)) {
-                if ($this->rollbackFile($this->path, $file)) {
-                    $this->commandData->commandComment('Migration file deleted: '.$file);
+            foreach ($files as $file) {
+                if (Str::contains($file, $fileName)) {
+                    if ($this->rollbackFile($this->path, $file)) {
+                        $this->commandData->commandComment('Migration file deleted: '.$file);
+                    }
+                    break;
                 }
-                break;
             }
         }
     }