FEATURE #2354 @2h30m: add pipeline for edit and create new content

app/CMS/Contracts/Content/AdvancedContentModifier.php

@@ -5,27 +5,6 @@ use App\Http\Requests\Request;
 use App\Models\Content\Content;
 
 interface AdvancedContentModifier {
-    /**
-     * Save module-specific values into database
-     *
-     * @param Content $content
-     * @param array $inputData
-     *
-     * @return mixed
-     */
-    public static function createNew(Content &$content, array $inputData);
-
-    /**
-     * Method used for editing existing content page.
-     *
-     * Reason why it is separated from createNew() method is simple - we need to save history of changes.
-     *
-     * @param Content $content
-     * @param $request
-     *
-     * @return mixed
-     */
-    public static function edit(Content $content, $request);
     /**
      * Method called right after content page is marked as deleted
      *

app/CMS/Contracts/Content/DisplayPipeline/Pipeline.php

@@ -7,10 +7,9 @@ interface Pipeline {
     /**
      * Add new process into pipeline
      *
-     * @param Process $proces
-     *
-     * @return mixed
+     * @param string $process
      *
+     * @return void
      */
     function add($process);
     function run(Content $page);

app/CMS/Contracts/Content/SavePipeline/Pipeline.php

@@ -0,0 +1,25 @@
+<?php
+namespace App\CMS\Contracts\Content\SavePipeline;
+
+use App\Models\Content\Content;
+
+interface Pipeline {
+    /**
+     * Add new process into pipeline
+     *
+     * @param string $process
+     *
+     * @return void
+     */
+    function add($process);
+
+    /**
+     * Save content page
+     *
+     * @param Content $page
+     * @param array   $input
+     *
+     * @return Content
+     */
+    function run(Content & $page, array $input);
+}

app/CMS/Contracts/Content/SavePipeline/Process.php

@@ -0,0 +1,16 @@
+<?php
+namespace App\CMS\Contracts\Content\SavePipeline;
+
+use App\Models\Content\Content;
+
+interface Process {
+    /**
+     * Process and modify given page
+     *
+     * @param Content $page
+     * @param array   $input
+     *
+     * @return mixed
+     */
+    function handle(Content & $page, array & $input);
+}

app/CMS/Contracts/Modules/AppHandler.php

@@ -6,16 +6,6 @@ use App\Models\Content\Content;
 
 interface AppHandler extends BaseModuleHandler
 {
-    /**
-     * Render given module into visitor area.
-     *
-     * @param Content $content    DB model from table contents
-     * @param array   $parameters parameters used for modifications/custom settings of given model
-     *
-     * @return mixed
-     */
-//    public function render(Content $content, $parameters);
-
     public static function getHistoryHandler();
 
     /**

app/CMS/Contracts/Modules/TemplateHandler.php

@@ -27,21 +27,4 @@ interface TemplateHandler extends BaseModuleHandler
      * @return array
      */
     public static function getPublicTemplatePaths();
-
-    /**
-     * Modify input data into format which can be understood by edit template
-     *
-     * @param Content $content
-     */
-    public static function beforePopulatingEditForm(Content & $content);
-
-    /**
-     * Slightly modify Content object before saving into database.
-     *
-     * This way we can do almost whatever we want - even in template
-     *
-     * @param Content $content
-     * @param  $request
-     */
-    public static function beforeSave(Content & $content, $request);
 }

app/CMS/Helpers/CurrentTemplate.php

@@ -96,37 +96,4 @@ class CurrentTemplate implements TemplateHandler
     {
         return call_user_func([self::handler(), 'getPublicTemplatePaths']);
     }
-
-    /**
-     * Prepare Content object to be rendered using Blade template
-     *
-     * @param Content $content
-     */
-    public static function beforeRender(Content & $content)
-    {
-        call_user_func_array([self::handler(), 'beforeRender'], [&$content]);
-    }
-
-    /**
-     * Modify input data into format which can be understood by edit template
-     *
-     * @param Content $content
-     */
-    public static function beforePopulatingEditForm(Content & $content)
-    {
-        call_user_func_array([self::handler(), 'beforePopulatingEditForm'], [&$content]);
-    }
-
-    /**
-     * Slightly modify Content object before saving into database.
-     *
-     * This way we can do almost whatever we want - even in template
-     *
-     * @param Content $content
-     * @param         $request
-     */
-    public static function beforeSave(Content & $content, $request)
-    {
-        call_user_func_array([self::handler(), 'beforeSave'], [&$content, $request]);
-    }
 }

app/CMS/Interactions/Admin/Content/EditContent.php

@@ -37,32 +37,18 @@ class EditContent implements Interaction
      * @param array $data
      * @param array $parameters
      *
-     * @return mixed|void
+     * @return mixed
      */
     public function handle($data, $parameters)
     {
         /**
          * @var $page Content
          */
-        list($page, $titlePhoto, $relatedFiles) = $parameters;
+        list($page) = $parameters;
 
-        // let template to modify request and content page
-        CurrentTemplate::beforeSave($page, $data);
+        app('saveContentPipeline')->run($page, $data);
 
-        // upload file - if provided
-        $data['titlePhoto'] = isset($data['existingTitlePhoto']) ? $data['existingTitlePhoto'] : null;
-
-        if (!is_null($titlePhoto)) {
-            $file = $this->file->upload($titlePhoto);
-            $data['titlePhoto'] = $file ? $file['filename'] : null;
-        }
-
-        $page->update($data);
-        $this->module->callOnString($page->moduleHandler, 'edit', [$page, $data]);
-
-        // move to interaction
-        $keepAssigned = isset($data['keepAssigned']) ? $data['keepAssigned'] : [];
-        $page->uploadRelatedFiles($relatedFiles, $keepAssigned);
+        return $page;
     }
 
     /**

app/CMS/Interactions/Admin/Content/NewContent.php

@@ -43,29 +43,14 @@ class NewContent implements Interaction
      */
     public function handle($data, $parameters)
     {
-        list($moduleHandler, $titlePhoto, $relatedFiles) = $parameters;
-
-        // upload file - if provided
-        $file = !is_null($titlePhoto) ? $this->file->upload($titlePhoto) : null;
+        list($moduleHandler) = $parameters;
 
         $data['userId'] = \Auth::user()->id;
         $data['language'] = LaravelLocalization::getCurrentLocale();
-        $data['titlePhoto'] = $file ? $file['filename'] : null;
         $data['moduleHandler'] = $moduleHandler;
 
-        $page = Content::create($data);
-
-        // save module-specific stuff
-        $this->module->callOnString($moduleHandler, 'createNew', [&$page, $data]);
-
-        // let template to modify data and content page
-        CurrentTemplate::beforeSave($page, $data);
-
-        // save content of page before (possible) uploading related files
-        $page->save();
-
-        // upload files assigned to content page
-        $page->uploadRelatedFiles($relatedFiles);
+        $page = new Content();
+        app('saveContentPipeline')->run($page, $data);
 
         return $page;
     }

app/CMS/Pipeline/AbstractPipeline.php

@@ -1,17 +1,30 @@
 <?php
 namespace App\CMS\Pipeline;
 
-use App\CMS\Contracts\Content\DisplayPipeline\Pipeline;
-use App\CMS\Contracts\Content\DisplayPipeline\Process;
 use App\CMS\Pipeline\Exceptions\InvalidProcessType;
-use App\Http\Controllers\Controller;
-use App\Models\Content\Content;
 
-class DisplayPipeline implements Pipeline
-{
+abstract class AbstractPipeline {
     protected $processes = [];
     protected $beforeStart = null;
     protected $beforeRender = null;
+    protected $acceptedProcessInterface = null;
+
+    /**
+     * check if given classname implements valid Process interface
+     *
+     * @param $classname
+     *
+     * @throws InvalidProcessType
+     */
+    protected function checkValidProcess($classname)
+    {
+        if (is_null($this->acceptedProcessInterface))
+            return;
+
+        if (!in_array($this->acceptedProcessInterface, class_implements($classname))) {
+            throw new InvalidProcessType($classname);
+        }
+    }
 
     /**
      * Add new process into pipeline
@@ -28,20 +41,6 @@ class DisplayPipeline implements Pipeline
         $this->processes[] = $process;
     }
 
-    /**
-     * check if given classname implements Process interface
-     *
-     * @param $classname
-     *
-     * @throws InvalidProcessType
-     */
-    protected function checkValidProcess($classname)
-    {
-        if (!in_array(Process::class, class_implements($classname))) {
-            throw new InvalidProcessType($classname);
-        }
-    }
-
     /**
      * @param null $beforeStart
      */
@@ -69,44 +68,4 @@ class DisplayPipeline implements Pipeline
 
         $this->beforeRender = $beforeRender;
     }
-
-    /**
-     * Run pipeline
-     *
-     * @param Content $page
-     *
-     * @return Content
-     */
-    function run(Content $page)
-    {
-        $this->runBeforeStart($page);
-
-        foreach ($this->processes as $process) {
-            /**
-             * @var $run Process
-             */
-            $run = new $process;
-            $run->handle($page);
-        }
-
-        $this->runBeforeRender($page);
-
-        return $page;
-    }
-
-    private function runBeforeStart($page)
-    {
-        if (!is_null($this->beforeStart)) {
-            $process = new $this->beforeStart;
-            $process->handle($page);
-        }
-    }
-
-    private function runBeforeRender($page)
-    {
-        if (!is_null($this->beforeRender)) {
-            $process = new $this->beforeRender;
-            $process->handle($page);
-        }
-    }
 }

app/CMS/Pipeline/DisplayPipeline/DisplayPipeline.php

@@ -0,0 +1,58 @@
+<?php
+namespace App\CMS\Pipeline\DisplayPipeline;
+
+use App\CMS\Contracts\Content\DisplayPipeline\Pipeline;
+use App\CMS\Contracts\Content\DisplayPipeline\Process;
+use App\CMS\Pipeline\AbstractPipeline;
+use App\Models\Content\Content;
+
+class DisplayPipeline extends AbstractPipeline implements Pipeline
+{
+    /**
+     * DisplayPipeline constructor.
+     */
+    public function __construct()
+    {
+        $this->acceptedProcessInterface = Process::class;
+    }
+
+    /**
+     * Run pipeline
+     *
+     * @param Content $page
+     *
+     * @return Content
+     */
+    function run(Content $page)
+    {
+        $this->runBeforeStart($page);
+
+        foreach ($this->processes as $process) {
+            /**
+             * @var $run Process
+             */
+            $run = new $process;
+            $run->handle($page);
+        }
+
+        $this->runBeforeRender($page);
+
+        return $page;
+    }
+
+    protected function runBeforeStart($page)
+    {
+        if (!is_null($this->beforeStart)) {
+            $process = new $this->beforeStart;
+            $process->handle($page);
+        }
+    }
+
+    protected  function runBeforeRender($page)
+    {
+        if (!is_null($this->beforeRender)) {
+            $process = new $this->beforeRender;
+            $process->handle($page);
+        }
+    }
+}

app/CMS/Pipeline/DisplayPipeline/Process/AddViewedToPage.php

@@ -1,5 +1,5 @@
 <?php
-namespace App\CMS\Pipeline\Process;
+namespace App\CMS\Pipeline\DisplayPipeline\Process;
 
 use App\CMS\Contracts\Content\DisplayPipeline\Process;
 use App\Models\Content\Content;

app/CMS/Pipeline/DisplayPipeline/Process/CompileShortcodes.php

@@ -1,5 +1,5 @@
 <?php
-namespace App\CMS\Pipeline\Process;
+namespace App\CMS\Pipeline\DisplayPipeline\Process;
 
 use App\CMS\Contracts\Content\DisplayPipeline\Process;
 use App\Models\Content\Content;

app/CMS/Pipeline/SavePipeline/Process/SaveCommonFields.php

@@ -0,0 +1,20 @@
+<?php
+namespace App\CMS\Pipeline\SavePipeline\Process;
+
+use App\CMS\Contracts\Content\SavePipeline\Process;
+use App\Models\Content\Content;
+
+class SaveCommonFields implements Process {
+    /**
+     * Process and modify given page
+     *
+     * @param Content $page
+     * @param array   $input
+     *
+     * @return void
+     */
+    function handle(Content & $page, array &$input)
+    {
+        ($page->exists == false) ? $page = Content::create($input): $page->update($input);
+    }
+}

app/CMS/Pipeline/SavePipeline/Process/UploadRelatedFiles.php

@@ -0,0 +1,75 @@
+<?php
+namespace App\CMS\Pipeline\SavePipeline\Process;
+
+use App\CMS\Contracts\Content\SavePipeline\Process;
+use App\Models\Content\Content;
+use App\Models\Content\ContentHasFile;
+use App\Models\FileManager\Directory;
+use App\Models\FileManager\File;
+
+class UploadRelatedFiles implements Process
+{
+    /**
+     * Process and modify given page
+     *
+     * @param Content $page
+     * @param array   $input
+     *
+     * @return void
+     */
+    function handle(Content & $page, array & $input)
+    {
+        $files = $input['files'];
+        $assignedFiles = isset($input['keepAssigned']) ? $input['keepAssigned'] : [];
+
+        // check if any file was removed
+        $this->removeRelatedFiles($page, $assignedFiles);
+
+        // allow uploading only on created pages
+        if (!$page->id || !$files[0]) {
+            return;
+        }
+
+        // find or create new directory for files assigned to content
+        $directory = Directory::firstOrCreate([
+                                                  'name'   => '.content_files',
+                                                  'hidden' => true
+                                              ]);
+        $data = new \stdClass();
+        $data->directoryId = $directory->id;
+
+        $fileModel = app(File::class);
+
+        foreach ($files as $file) {
+            if (!$file) {
+                continue;
+            }
+            $uploaded = $fileModel->upload($file, $data);
+
+            // add assignement
+            ContentHasFile::create([
+                                       'file_id'    => $uploaded['id'],
+                                       'content_id' => $page->id
+                                   ]);
+        }
+    }
+
+    /**
+     * Delete files from association
+     *
+     * @param Content $page
+     * @param         $assignedFiles
+     */
+    private function removeRelatedFiles(Content $page, $assignedFiles)
+    {
+        $allFiles = $page->files()
+                         ->whereNotIn('id', array_keys($assignedFiles))
+                         ->get();
+
+        foreach ($allFiles as $file) {
+            ContentHasFile::where('content_id', $page->id)
+                          ->where('file_id', $file->id)
+                          ->delete();
+        }
+    }
+}

app/CMS/Pipeline/SavePipeline/Process/UploadTitlePhoto.php

@@ -0,0 +1,33 @@
+<?php
+namespace App\CMS\Pipeline\SavePipeline\Process;
+
+use App\CMS\Contracts\Content\SavePipeline\Process;
+use App\Models\Content\Content;
+use App\Models\FileManager\File;
+
+class UploadTitlePhoto implements Process {
+    /**
+     * Process and modify given page
+     *
+     * @param Content $page
+     * @param array   $input
+     *
+     * @return void
+     */
+    function handle(Content & $page, array & $input)
+    {
+        $fileModel = app(File::class);
+        $titlePhoto = isset($input['titlePhotoFile']) ? $input['titlePhotoFile'] : null;
+
+        // upload file - if provided
+        $page->titlePhoto = isset($input['existingTitlePhoto']) ? $input['existingTitlePhoto'] : null;
+
+        if (!is_null($titlePhoto)) {
+            $file = $fileModel->upload($titlePhoto);
+
+            $page->titlePhoto = $file ? $file['filename'] : null;
+        }
+
+        $page->save();
+    }
+}

app/CMS/Pipeline/SavePipeline/SavePipeline.php

@@ -0,0 +1,69 @@
+<?php
+namespace App\CMS\Pipeline\SavePipeline;
+
+use App\CMS\Contracts\Content\SavePipeline\Pipeline;
+use App\CMS\Contracts\Content\SavePipeline\Process;
+use App\CMS\Pipeline\AbstractPipeline;
+use App\Models\Content\Content;
+
+class SavePipeline extends AbstractPipeline implements Pipeline
+{
+    /**
+     * SavePipeline constructor.
+     */
+    public function __construct()
+    {
+        $this->acceptedProcessInterface = Process::class;
+    }
+
+    /**
+     * Save content page
+     *
+     * @param Content $page
+     * @param array   $input
+     *
+     * @return Content
+     */
+    function run(Content & $page, array $input)
+    {
+        $this->runBeforeStart($page, $input);
+
+        foreach ($this->processes as $process) {
+            /**
+             * @var $run Process
+             */
+            $run = new $process;
+            $run->handle($page, $input);
+        }
+
+        $this->runAfter($page, $input);
+
+        return $page;
+    }
+
+    /**
+     * Run process as first - if specified
+     *
+     * @param Content $page
+     * @param array   $input
+     */
+    protected function runBeforeStart(Content $page, array $input)
+    {
+        if (!is_null($this->beforeStart)) {
+            app($this->beforeStart)->handle($page, $input);
+        }
+    }
+
+    /**
+     * Run some process in the end - if exists
+     *
+     * @param Content $page
+     * @param array   $input
+     */
+    protected function runAfter(Content $page, array $input)
+    {
+        if (!is_null($this->beforeRender)) {
+            app($this->beforeRender)->handle($page, $input);
+        }
+    }
+}