Add attributes and first body transformation

Author: OliverZiegler

config/webfactor/documents.php

@@ -10,7 +10,7 @@
         'sbt'
     ],
 
-    // define the access to the documents (see backpack for mor information)
+    // define the access to the documents (see backpack for more information)
     'access'            => [
         // can users list documents
         'list'   => true,
@@ -31,13 +31,30 @@
     //      -> will present the simplemde markdown editor and store markdown to the database
     'body_type'         => 'md',
 
+    // define additional field options here (see backpack for more information on this)
+    'field_editor_attributes' => [
+        'plaintext' => [],
+        'html' => "",
+        'md' => "'renderingConfig': {'singleLineBreaks': true}"
+    ],
+
     // the model to use with this package
     // keep in mind: when changing the model, you most likely need to change the Transformer also
     'model_class'       => \Webfactor\Laravel\Backpack\Documents\Models\Document::class,
 
     // the transformer class used to transform the model for api responses
     'transformer_class' => \Webfactor\Laravel\Backpack\Documents\Transformers\DocumentTransformer::class,
 
+    // define some options for the transformer
+    // currently supported:
+    //  * md
+    //    -> single_line_breaks
+    'transform_options' => [
+        'md' => [
+            'single_line_breaks'
+        ]
+    ],
+
     // customize your backend parameters
     'backend'           => [
 

src/Controllers/DocumentCrudController.php

@@ -8,6 +8,21 @@
 
 class DocumentCrudController extends CrudController
 {
+    protected $types = [
+        'plaintext' => [
+            'field' => 'textarea',
+            'attrLabel' => 'textareaAttributes'
+        ],
+        'html'      => [
+            'field' => 'summernote',
+            'attrLabel' => 'options'
+        ],
+        'md'        => [
+            'field' => 'simplemde',
+            'attrLabel' => 'simplemdeAttributesRaw'
+        ],
+    ];
+
     public function setup()
     {
         /*
@@ -16,7 +31,7 @@ public function setup()
         |--------------------------------------------------------------------------
         */
         $this->crud->setModel(config('webfactor.documents.model_class'));
-        $this->crud->setRoute(config('webfactor.documents.backend.route_prefix').'/'.config('webfactor.documents.backend.route'));
+        $this->crud->setRoute(config('webfactor.documents.backend.route_prefix') . '/' . config('webfactor.documents.backend.route'));
         $this->crud->setEntityNameStrings(trans('webfactor::documents.entity_name_singular'),
             trans('webfactor::documents.entity_name_plural'));
 
@@ -29,23 +44,24 @@ public function setup()
         // ------ CRUD FIELDS
 
         $this->crud->addField([
-            'name'  => 'type',
-            'label' => 'Dokumentenart',
-            'type'  => 'select_from_array',
-            'options' => $this->getTypeOptions(),
-            'allows_null' => false,
-            'allows_multiple' => false
+            'name'            => 'type',
+            'label'           => 'Dokumentenart',
+            'type'            => 'select_from_array',
+            'options'         => $this->getTypeOptions(),
+            'allows_null'     => false,
+            'allows_multiple' => false,
         ]);
 
         $this->crud->addField([
-            'name' => 'title',
-            'label' => trans('webfactor::documents.title')
+            'name'  => 'title',
+            'label' => trans('webfactor::documents.title'),
         ]);
-        
+
         $this->crud->addField([
-            'name' => 'body',
-            'label' => trans('webfactor::documents.body'),
-            'type' => $this->bodyFieldType()
+            'name'                            => 'body',
+            'label'                           => trans('webfactor::documents.body'),
+            'type'                            => $this->bodyFieldType(),
+            $this->bodyFieldAttributesLabel() => $this->bodyFieldAttributes(),
         ]);
 
         // ------ CRUD COLUMNS
@@ -57,12 +73,12 @@ public function setup()
             ],
             [
                 'name'  => 'title',
-                'label' => trans('webfactor::documents.title')
+                'label' => trans('webfactor::documents.title'),
             ],
             [
                 'name'  => 'body',
-                'label' => trans('webfactor::documents.body')
-            ]
+                'label' => trans('webfactor::documents.body'),
+            ],
         ]);
 
         // ------ CRUD BUTTONS
@@ -95,19 +111,24 @@ public function getTypeOptions()
         $types = collect(config('webfactor.documents.types'));
 
         return $types->mapWithKeys(function ($type) {
-            return [$type => trans('webfactor::documents.types.'.$type)];
+            return [$type => trans('webfactor::documents.types.' . $type)];
         });
     }
 
     public function bodyFieldType()
     {
-        $types = [
-            'plaintext' => 'textarea',
-            'html' => 'summernote',
-            'md' => 'simplemde'
-        ];
+        return $this->types[config('webfactor.documents.body_type', 'plaintext')]['field'];
+    }
+
+    public function bodyFieldAttributesLabel()
+    {
+        return $this->types[config('webfactor.documents.body_type', 'plaintext')]['attrLabel'];
+    }
 
-        return $types[config('webfactor.documents.body_type', 'plaintext')];
+    public function bodyFieldAttributes()
+    {
+        $type = config('webfactor.documents.body_type', 'plaintext');
+        return config('webfactor.documents.field_editor_attributes.'.$type, []);
     }
 
     public function store(StoreRequest $request)

src/DocumentsServiceProvider.php

@@ -27,10 +27,6 @@ public function boot()
 
         $this->loadTranslationsFrom(realpath(__DIR__.'/../resources/lang'), 'webfactor');
 
-        $this->mergeConfigFrom(
-            __DIR__.'/../config/webfactor/documents.php', 'webfactor.documents'
-        );
-
         $this->publishFiles();
     }
 
@@ -41,7 +37,9 @@ public function boot()
      */
     public function register()
     {
-        //
+        $this->mergeConfigFrom(
+            __DIR__.'/../config/webfactor/documents.php', 'webfactor.documents'
+        );
     }
 
     public function publishFiles()

src/Transformers/DocumentTransformer.php

@@ -7,13 +7,33 @@
 
 class DocumentTransformer extends TransformerAbstract
 {
+    protected $defaultIncludes = ['body'];
+
     public function transform(Document $document)
     {
         return [
             'type'      => $document->type,
             'title'     => $document->title,
-            'body'      => $document->body,
             'updatedAt' => $document->updated_at->toIso8601String()
         ];
     }
+
+    public function includeBody(Document $document) {
+        $type = config('webfactor.documents.body_type');
+        $options = config('webfactor.documents.transform_options.'.$type, []);
+        $options = is_array($options)? $options : [$options];
+
+        $body = $document->body;
+
+        foreach($options as $option) {
+            $body = method_exists($this, $option) ? $this->{$option}($body) : $body;
+        }
+
+        return $this->primitive($body);
+    }
+
+    // body transformations
+    protected function single_line_breaks($body) {
+        return str_replace("\r\n", "  \r\n", $body);
+    }
 }