Merge remote-tracking branch 'origin/master'

Author: Martin Reitschmied

README.md

@@ -30,7 +30,7 @@ $signed = false
 
 Route::document(
     "invoices/{id}", 
-    "/invoices",
+    "invoices", 
     \App\Printables\Invoice::class, 
     [
         // Middleware for getting the document
@@ -68,6 +68,7 @@ class Invoice extends DocumentAbstract
 
     // Define the blade you want to return as printable document
     public String $blade = "ambersive.documentviewer::printable_default";
+    public bool  $useValidationEndpoint = false; 
 
     public function setData(){
         // Request is available in $this->request
@@ -85,12 +86,24 @@ class Invoice extends DocumentAbstract
 
     }
 
+    public function validateDocumentHandler(Request $request) {
+
+        // Handle the validation
+        // This information is a helper 
+        // Requires a response (preferable json)
+        return ['status' => 200];
+
+    }
+
 }
 ```
 
-### Step 4: Generate a valid blade file
+### Step 4: Modify the blade file
+
+The make command also creates a blade file within the resource folder.
+It will come with some basic scaffold settings so you will be able to create beautiful documents in no time.
 
-Create a blade file. If you want to get our print optimizations you need to use our file document base layout
+But you can also define or resource the files.
 
 ```php
 @extends('ambersive.documentviewer::printable')
@@ -110,6 +123,10 @@ A full example might look like:
 
 ``` 
 
+## Need a way to create PDF files?
+
+We created a [microservice](https://github.com/AMBERSIVE/print-api) which is also open-source to create pdf files. If you need a smooth way to interact with this microservice you can use our [package](https://github.com/AMBERSIVE/laravel-print-api) for that.
+
 ## Security Vulnerabilities
 
 If you discover a security vulnerability within this package, please send an e-mail to Manuel Pirker-Ihl via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

src/Abstracts/DocumentAbstract.php

@@ -11,6 +11,7 @@ abstract class DocumentAbstract implements DocumentInterface
 
     public array $data   = [];
     public array $params = [];
+    public bool  $useValidationEndpoint = false;
 
     public String $blade = "ambersive.documentviewer::printable_default";
 
@@ -47,6 +48,25 @@ public function uploadDocument(Request $request) {
         }
         return $result;
     }
+        
+    /**
+     * Handle the validation request for the document
+     * Should return a json object if document requirement exists.
+     *
+     * @param  mixed $request
+     * @return void
+     */
+    public function validateDocument(Request $request) {
+        $this->params = $request->route()->parameters;
+        if (method_exists($this, 'validateDocumentHandler') === false) {
+            abort(400, 'Document cannot be validated.');
+        }
+        $result = $this->validateDocumentHandler($request);
+        if ($result === null) {
+            abort(400, 'Error while validating the file.');
+        }
+        return $result;
+    }
 
     /**
      * Set the data of this printable

src/Console/Commands/Dev/DocumentAdd.php

@@ -17,7 +17,7 @@ class DocumentAdd extends GeneratorCommand
      *
      * @var string
      */
-    protected $signature = 'make:printable {name}';
+    protected $signature = 'make:printable {name} {--force}';
 
     /**
      * The console command description.
@@ -36,7 +36,8 @@ public function handle()
 
         $name = $this->qualifyClass($this->getNameInput());
 
-        $path = $this->getPath(ucfirst($name));
+        $path        = $this->getPath($name);
+        $pathForView = $this->getPathForView($name);
 
         if ((! $this->hasOption('force') ||
              ! $this->option('force')) &&
@@ -47,10 +48,12 @@ public function handle()
         }
 
         $this->makeDirectory($path);
+        $this->makeDirectory($pathForView);
 
-        $this->files->put($path, $this->sortImports($this->buildClass($name)));
+        $this->files->put($path, $this->sortImports($this->buildClassCustom($name, 'Printable')));
+        $this->files->put($pathForView, $this->sortImports($this->buildClassCustom($name, 'PrintableView')));
 
-        $this->info($this->type.' created successfully.');
+        $this->info($this->type.' created successfully (data class and blade file).');
 
     }
 
@@ -62,9 +65,9 @@ public function handle()
      *
      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
      */
-    protected function buildClass($name)
+    protected function buildClassCustom(String $name, String $stubname)
     {
-        $stub = $this->files->get($this->getStub());
+        $stub = $this->files->get($this->getStubFilePath($stubname));
 
         return $this->replaceNamespace($stub, $name)->replaceClass($stub, $name);
     }
@@ -74,31 +77,61 @@ protected function buildClass($name)
      *
      * @return string
      */
-    protected function rootNamespace()
+    protected function rootNamespace():String
     {
         return $this->laravel->getNamespace()."Printables";
     }
 
+    /**
+     * Returns the path to the stubs folder
+     */
+    protected function getStub(): String {
+        return __DIR__."/../../../Stubs/";
+    }
+
     /**
      * Get the stub file for the generator.
      *
      * @return string
      */
-    protected function getStub():String
+    protected function getStubFilePath(String $stubname):String
     {
-        return __DIR__.'/../../../Stubs/Printable.stub';
+        return $this->getStub()."${stubname}.stub";
     }
 
     /**
-     * Returns the path for the document
+     * Returns the path for the document class
      *
      * @param  mixed $name
      * @return String
      */
-    protected function getPath($name):String
-    {
+    protected function getPath($name):String {
+        $name = Str::replaceFirst($this->rootNamespace(), '', $name);
+        return $this->getPathFolder($name, "app/Printables");
+    }
+    
+    /**
+     * Returns the path for the view (blade) file
+     *
+     * @param  mixed $name
+     * @return String
+     */
+    protected function getPathForView($name):String {
+        $name = Str::replaceFirst($this->rootNamespace(), '', $name).".blade";
+        return strtolower(base_path("resources/views/printables/".str_replace('\\', '/', $name).'.php'));
+    }
+
+        
+    /**
+     * Returns the base path for the file
+     *
+     * @param  mixed $name
+     * @param  mixed $folder
+     * @return String
+     */
+    protected function getPathFolder(String $name, String $folder = ''): String {
         $name = Str::replaceFirst($this->rootNamespace(), '', $name);
-        return $this->laravel['path'].'/Printables/'.str_replace('\\', '/', $name).'.php';
+        return base_path($folder.str_replace('\\', '/', $name).'.php');
     }
 
     /**
@@ -110,10 +143,12 @@ protected function getPath($name):String
      */
     protected function replaceNamespace(&$stub, $name)
     {
+        
+        $bladename = strtolower(str_replace("\\", ".", str_replace($this->rootNamespace()."\\", "printables.", $name)));
 
         $stub = str_replace(
-            ['DummyNamespace', 'DummyRootNamespace', 'NamespacedDummyUserModel'],
-            [$this->getNamespace($name), $this->rootNamespace(), $this->userProviderModel()],
+            ['DummyNamespace', 'DummyRootNamespace', 'NamespacedDummyUserModel', 'DummyBladeName'],
+            [$this->getNamespace($name), $this->rootNamespace(), $this->userProviderModel(), $bladename],
             $stub
         );
 

src/Interfaces/DocumentInterface.php

@@ -10,5 +10,6 @@ public function createDocument(Request $request);
     public function setData();
     public function returnView();
     public function uploadDocument(Request $request);
+    public function validateDocument(Request $request);
 
 }

src/Macros/ResponseDocument.php

@@ -35,6 +35,13 @@ public function register(){
 
             Route::post($route, "\\${documentClassUpload}@uploadDocument")->middleware($middlewareUpload)->name("${name}.upload");
 
+            // Validation endpoint
+            if ($documentClassInstance->useValidationEndpoint === false) {
+              return;
+            }
+
+            Route::get("${route}/validation", "\\${documentClass}@validateDocument")->middleware($middleware)->name($name);
+
       });
 
     }

src/Stubs/Printable.stub

@@ -10,7 +10,8 @@ class DummyClass extends DocumentAbstract
 {
 
     public array $data   = [];
-    public String $blade = "ambersive.documentviewer::printable_default";
+    public String $blade = "DummyBladeName";
+    public bool  $useValidationEndpoint = false; 
 
     /**
      * Set the data of this printable
@@ -28,4 +29,11 @@ class DummyClass extends DocumentAbstract
 
     }
 
+    public function validateDocumentHandler(Request $request) {
+
+        // Handle the validation
+        return ['status' => 200]; 
+
+    }
+
 }

src/Stubs/PrintableView.stub

@@ -0,0 +1,17 @@
+@extends('ambersive.documentviewer::printable')
+
+@section('styles')
+
+    <style>
+        body {
+            background:#efefef;
+        }
+    </style>
+
+@endsection
+
+@section('document')
+
+    <div>Create your printable document here.</div>
+
+@endsection

src/Views/printable_default.blade.php

@@ -1,5 +1,15 @@
 @extends('ambersive.documentviewer::printable')
 
+@section('styles')
+
+    <style>
+        body {
+            background:#efefef;
+        }
+    </style>
+
+@endsection
+
 @section('document')
 
     <div>TODO: Print document</div>