Create Resources Using Stubs (PHP 7.4)

Author: MR-Sharifi

config/repository.php

@@ -25,7 +25,7 @@
         'relative' => [
             'entities' => 'app/Models/Entities/',
             'factories' => 'app/Models/Factories/',
-            'resources' => 'app/Http/Resources/Admin/',
+            'resources' => 'app/Models/Resources/',
             'repositories' => 'app/Models/Repositories/',
         ],
 

src/Commands/MakeResource.php

@@ -2,8 +2,8 @@
 
 namespace Nanvaie\DatabaseRepository\Commands;
 
-use Nanvaie\DatabaseRepository\CustomMySqlQueries;
 use Illuminate\Console\Command;
+use Nanvaie\DatabaseRepository\CustomMySqlQueries;
 
 class MakeResource extends Command
 {
@@ -27,6 +27,20 @@ class MakeResource extends Command
 
     use CustomMySqlQueries;
 
+    public function writeGetter(string $getterStub, string $columnName, string $attributeName)
+    {
+        return str_replace(['{{ ColumnName }}', '{{ GetterName }}'],
+            [$columnName, ucfirst($attributeName)],
+            $getterStub);
+    }
+
+    public function writeForeignGetter(string $foreignGetterStub, string $columnName, string $attributeName)
+    {
+        return str_replace(['{{ AttributeName }}', '{{ GetterName }}', '{{ AttributeType }}'],
+            [$columnName, ucfirst($attributeName), ucfirst($attributeName)],
+            $foreignGetterStub);
+    }
+
     /**
      * Execute the console command.
      *
@@ -38,9 +52,12 @@ public function handle(): int
         $detectForeignKeys = $this->option('foreign-keys');
         $entityName = str_singular(ucfirst(camel_case($tableName)));
         $entityVariableName = camel_case($entityName);
+        $entityNamespace = config('repository.path.namespace.entities');
         $resourceName = $entityName . "Resource";
         $resourceNamespace = config('repository.path.namespace.resources');
         $relativeResourcesPath = config('repository.path.relative.resources');
+        $resourceStubsPath = config('repository.path.stub.resources');
+        $filenameWithPath = $relativeResourcesPath.$resourceName.'.php';
 
         if ($this->option('delete')) {
             unlink("$relativeResourcesPath/$resourceName.php");
@@ -69,38 +86,32 @@ public function handle(): int
             $foreignKeys = $this->extractForeignKeys($tableName);
         }
 
-        // Initialize Class
-        $resourceContent = "<?php\n\nnamespace $resourceNamespace;\n\n";
-        $resourceContent .= "use App\Http\Resources\Resource;\n";
-        $resourceContent .= "use App\Models\Entities\\$entityName;\n\n";
-        $resourceContent .= "class $resourceName extends Resource\n{\n";
+        $baseContent = file_get_contents($resourceStubsPath.'class.stub');
+        $getterStub = file_get_contents($resourceStubsPath.'getter.default.stub');
+        $foreignGetterStub = file_get_contents($resourceStubsPath.'getter.foreign.stub');
 
-        // Create "toArray" Function
-        $resourceContent .= "\t/**\n\t * @param $entityName \$$entityVariableName\n\t * @return array\n\t */\n";
-        $resourceContent .= "\tpublic function toArray($entityName \$$entityVariableName): array\n\t{\n";
-        $resourceContent .= " \t\treturn [";
         foreach ($columns as $_column) {
-            $resourceContent .= "\n\t\t\t'$_column->COLUMN_NAME' => \$$entityVariableName" . "->get" . ucfirst(camel_case($_column->COLUMN_NAME)) . "(),";
+            $baseContent = substr_replace($baseContent,
+                $this->writeGetter($getterStub, $_column->COLUMN_NAME, camel_case($_column->COLUMN_NAME)),
+                -293, 0);
         }
 
-        // Add Additional Resources for Foreign Keys
         if ($detectForeignKeys) {
-            $resourceContent .= "\n";
             foreach ($foreignKeys as $_foreignKey) {
-                $resourceContent .= "\n\t\t\t'" . snake_case($_foreignKey->VARIABLE_NAME) .
-                    "' => \$$entityVariableName" . "->get" . ucfirst($_foreignKey->VARIABLE_NAME) . "()" .
-                    " ? (new " . $_foreignKey->ENTITY_DATA_TYPE . "Resource())->toArray(\$$entityVariableName" .
-                    "->get" . ucfirst($_foreignKey->VARIABLE_NAME) . "()) : null,";
+                $baseContent = substr_replace($baseContent,
+                    $this->writeForeignGetter($foreignGetterStub, $_foreignKey->VARIABLE_NAME, $_foreignKey->ENTITY_DATA_TYPE),
+                    -19, 0);
             }
         }
-        $resourceContent .= "\n\t\t];\n\t}\n";
 
-        $resourceContent .= "}";
+        $baseContent = str_replace(['{{ EntityName }}', '{{ EntityNamespace }}', '{{ EntityVariableName }}', '{{ ResourceName }}', '{{ ResourceNamespace }}'],
+            [$entityName, $entityNamespace, $entityVariableName, $resourceName, $resourceNamespace],
+            $baseContent);
 
-        file_put_contents("$relativeResourcesPath/$resourceName.php", $resourceContent);
+        file_put_contents($filenameWithPath, $baseContent);
 
         if ($this->option('add-to-git')) {
-            shell_exec("git add $relativeResourcesPath/$resourceName.php");
+            shell_exec("git add $filenameWithPath");
         }
 
         $this->info("Resource \"$resourceName\" has been created.");

stubs/Models/PHP7.4/Resource/IResource.stub

@@ -2,6 +2,7 @@
 
 namespace App\Models\Resources;
 
+use App\Models\Entities\Entity;
 use Illuminate\Support\Collection;
 
 interface IResource

stubs/Models/PHP7.4/Resource/Resource.stub

@@ -2,6 +2,7 @@
 
 namespace App\Models\Resources;
 
+use App\Models\Entities\Entity;
 use Illuminate\Support\Collection;
 
 abstract class Resource implements IResource

stubs/PHP7.4/repository.resource.class.stub

@@ -0,0 +1,29 @@
+<?php
+
+namespace {{ ResourceNamespace }};
+
+use {{ EntityNamespace }}\Entity;
+use {{ EntityNamespace }}\{{ EntityName }};
+
+class {{ ResourceName }} extends Resource
+{
+    /**
+     * @param Entity|{{ EntityName }} ${{ EntityVariableName }}
+     * @return array
+     */
+    public function toArray(${{ EntityVariableName }}): array
+    {
+        return [
+        ];
+    }
+
+    /**
+     * @param Entity|{{ EntityName }} ${{ EntityVariableName }}
+     * @return array
+     */
+    public function toArrayWithForeignKeys(${{ EntityVariableName }}): array
+    {
+        return $this->toArray(${{ EntityVariableName }}) + [
+        ];
+    }
+}

stubs/PHP7.4/repository.resource.getter.default.stub

@@ -0,0 +1 @@
+			'{{ ColumnName }}' => ${{ EntityVariableName }}->get{{ GetterName }}(),

stubs/PHP7.4/repository.resource.getter.foreign.stub

@@ -0,0 +1 @@
+            '{{ AttributeName }}' => ${{ EntityVariableName }}->get{{ GetterName }}() ? (new {{ AttributeType }}Resource())->toArray(${{ EntityVariableName }}->get{{ GetterName }}()) : null,