FEATURE: add another repositories

This commit is contained in:
Michal Kváček
2016-10-18 22:35:06 +02:00
parent 662700b4f2
commit 4f6a006ad9
47 changed files with 410 additions and 400 deletions
@@ -0,0 +1,40 @@
<?php
namespace App\CMS\Contracts\Content;
use App\Http\Requests\Request;
use App\Models\Content\Content;
interface AdvancedContentModifier {
/**
* Save module-specific values into database
*
* @param Content $content
* @param Request $request
*
* @return mixed
*/
public static function createNew(Content &$content, Request $request);
/**
* 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 $request
* @param string $revisionId
*
* @return mixed
*/
public static function edit(Content &$content, Request $request, $revisionId);
/**
* Method called right after content page is marked as deleted
*
* This method is supposed to clean after "deleted" page.
*
* @param Content $content
*
* @return mixed
*/
public static function delete(Content $content);
}
@@ -1,5 +1,5 @@
<?php
namespace App\CMS\Handlers\Contracts;
namespace App\CMS\Contracts\Modules;
use App\Http\Requests\Request;
use App\Models\Content\Content;
@@ -18,51 +18,6 @@ interface AppHandler extends BaseModuleHandler
public static function getHistoryHandler();
/**
* Load some extra data for content management form?
*
* @param Content $content
*
* @return mixed
*/
public static function loadExtraData(Content $content);
/**
* Save module-specific values into database
*
* @param Content $content
* @param Request $request
*
* @return mixed
* @internal param Widget $widget
*/
public static function createNew(Content &$content, Request $request);
/**
* 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 $request
*
* @param $revisionID string ID of revision used
*
* @return int number of edited fields
*/
public static function edit(Content &$content, Request $request, $revisionID);
/**
* Method called right after content page is marked as deleted
*
* This method is supposed to clean after "deleted" page.
*
* @param Content $content
*
* @return mixed
*/
public static function delete(Content $content);
/**
* Getter for section names in creating/editing content resource
*
@@ -1,5 +1,5 @@
<?php
namespace App\CMS\Handlers\Contracts;
namespace App\CMS\Contracts\Modules;
use App\Models\User;
@@ -15,11 +15,4 @@ interface BaseModuleHandler
*/
public static function registerAdminMenu(User $user);
/**
* Install module.
*
* This method is called after inserting info about module into database. It can be called only using Artisan in
* CLI.
*/
public static function install();
}
@@ -0,0 +1,23 @@
<?php
namespace App\CMS\Contracts\Modules;
use App\Models\Module;
interface InstallableModule {
/**
* Install module.
*
* This method is called after inserting info about module into database. It can be called only using Artisan in
* CLI.
*/
public static function install();
/**
* Uninstalls module
*
* @param Module $module
*
* @return mixed
*/
public static function uninstall(Module $module);
}
@@ -1,9 +1,8 @@
<?php
namespace App\CMS\Handlers\Contracts;
namespace App\CMS\Contracts\Modules;
use App\Http\Requests\Request;
use App\Models\Content\Content;
use App\Models\Module;
/**
* Interface TemplateHandler
@@ -14,15 +13,6 @@ use App\Models\Module;
*/
interface TemplateHandler extends BaseModuleHandler
{
/**
* Uninstall template
*
* Delete some items in database, delete files etc.
*
* @param Module $template
*/
public static function uninstall(Module $template);
/**
* Get list of registered templates and supported modules.
*
+2 -4
View File
@@ -3,11 +3,9 @@ namespace App\CMS\Contracts\Repositories;
interface Module extends BaseRepository {
public function supportsCategories();
public function getCreateContentTitle(\App\Models\Module $module);
public function getCreateContentTitle();
public function getUpdateContentTitle();
public function getUpdateContentTitle(\App\Models\Module $module);
public function getOverviewTitle(\App\Models\Module $module);
}
@@ -0,0 +1,18 @@
<?php
namespace App\CMS\Contracts\Repositories;
use App\Models\Module as ModuleModel;
interface Template
{
const EDITED_TEMPLATES_DIRECTORY = 'custom';
const ASSETS_DIRECTORY = 'assets';
const MODULES_DIRECTORY = 'modules';
const TEMPLATE_SUFFIX = '.blade.php';
const CUSTOM_EDIT_DIRECTORY = 1;
const ORIGINAL_DIRECTORY = 2;
public function getPathToTemplate();
public function getForModule(ModuleModel $module);
}
+1 -6
View File
@@ -1,10 +1,9 @@
<?php
namespace App\CMS\Handlers;
use App\CMS\Contracts\Modules\BaseModuleHandler;
use App\CMS\Enumerations\TemplatePathsHumanReadableRootOnly;
use App\CMS\Enumerations\WidgetTypes;
use App\CMS\Handlers\Contracts\AppHandler;
use App\CMS\Handlers\Contracts\BaseModuleHandler;
use App\Models\User;
abstract class BaseHandler implements BaseModuleHandler
@@ -97,8 +96,6 @@ abstract class BaseHandler implements BaseModuleHandler
}, 60, ['icon' => 'fa fa-fw fa-file-code-o']);
}
// $menu->dropdown(trans('admin/mainMenu.customFields'), function ($sub) {
// $sub->route('customfields.new', trans('admin/mainMenu.customFieldsNew'), [], 10, ['icon' => 'fa fa-fw fa-code']);
// $sub->route('customfields.overview', trans('admin/mainMenu.customFieldsOverview'), [], 50, ['icon' => 'fa fa-fw fa-code-fork']);
@@ -107,8 +104,6 @@ abstract class BaseHandler implements BaseModuleHandler
$sub->route('log.overview', trans('admin/mainMenu.actionLog'), [], 70, ['icon' => 'fa fa-fw fa-history']);
$sub->route('settings.overview', trans('admin/mainMenu.settings'), [], 80, ['icon' => 'fa fa-fw fa-gear']);
}, 10000, ['icon' => 'fa fa-fw fa-gears']);
});
// order
+2 -21
View File
@@ -1,7 +1,7 @@
<?php
namespace App\CMS\Handlers;
use App\CMS\Handlers\Contracts\AppHandler;
use App\CMS\Contracts\Modules\AppHandler;
use App\Http\Controllers\Controller;
use App\Models\Content\Content;
@@ -15,16 +15,6 @@ use App\Models\Content\Content;
*/
abstract class Handler extends BaseHandler implements AppHandler
{
/**
* todo: Temporary method, will be implemented for each Handler
*
* @return bool
*/
public static function supportCategories()
{
return true;
}
public static function getHistoryHandler()
{
return History::class;
@@ -64,16 +54,7 @@ abstract class Handler extends BaseHandler implements AppHandler
'files' => 'admin.content.formParts.files'
];
}
public static function delete(Content $content)
{
// temporarily nothing to do
}
public static function loadExtraData(Content $content) {
// temporarily nothing to do
}
public static function getExtendedFormInputsEdit()
{
return self::getExtendedFormInputsCreate();
@@ -3,7 +3,7 @@ namespace App\CMS\Handlers\Registrators;
use App\CMS\Enumerations\TemplatePaths;
use App\CMS\Enumerations\Templates;
use App\Models\Templates\Template;
use App\CMS\Contracts\Repositories\Template;
use App\Models\Templates\TemplatePath;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Str;
+3 -1
View File
@@ -9,7 +9,9 @@ class Template
/**
* Getter for real template name
*
* @param $template
* @param $template
*
* @param bool $throwExceptions
*
* @return null|string
*/
@@ -16,6 +16,7 @@ class EditContent implements Interaction
$page = $parameters[0];
// upload file - if provided
// todo use interaction
$file = $page->uploadTitlePhoto($request);
// let template to modify request and content page
@@ -52,13 +53,17 @@ class EditContent implements Interaction
// todo move this method out of the controller!
$data = \App\Http\Controllers\Admin\Contents\EditContent::getFields($request, array_values($fields));
// todo use Model Observer and model::original attributes
list($revision, $changedColumns) = $page->updateWithHistory($fields, $data);
$changedColumns += call_user_func_array([$page->module_handler, 'edit'], [&$page, $request, $revision]);
// move to interaction
$changedColumns += $page->uploadRelatedFiles($request, $revision);
if ($changedColumns > 0) // fire event with
{
if ($changedColumns > 0) {
Event::fire(new EditContentEvent($page, $revision));
}
+9 -2
View File
@@ -14,7 +14,7 @@ class Content extends Repository implements IContent
/**
* @var ContentModel
*/
private $model;
protected $model;
public function __construct(ContentModel $model)
{
@@ -54,9 +54,16 @@ class Content extends Repository implements IContent
$page = new ContentModel();
$page->user_id = \Auth::user()->id;
$page->language = LaravelLocalization::getCurrentLocale();
$page->status = IContent::STATUS_DRAFT;
$page->module_settings = [];
} else {
$page = $this->model->find($id);
if (is_numeric($id)) {
$page = $this->model->findOrFail($id);
} else {
$page = $this->model->where('language', LaravelLocalization::getCurrentLocale())
->where('url', $id)
->firstOrFail();
}
$page->module_settings = json_decode($page->module_settings);
}
+27 -10
View File
@@ -6,25 +6,42 @@ use App\Models\Module as ModuleModel;
class Module extends Repository implements IModule
{
public function getOne($id = null) {
/**
* @var ModuleModel
*/
private $module;
public function __construct(ModuleModel $module)
{
$this->module = $module;
}
public function getOne($id = null)
{
if (!is_null($id)) {
return ModuleModel::find($id);
if (is_numeric($id)) {
return ModuleModel::findOrFail($id);
} else {
return ModuleModel::where('alias', $id)
->firstOrFail();
}
} else {
return new ModuleModel();
}
}
public function supportsCategories()
public function getCreateContentTitle(ModuleModel $module)
{
// TODO: Implement supportsCategories() method.
$pageHeading = trans('admin/contents.new', ['name' => trans($module->name)]);
if (is_callable([$module->handler, 'getCreateNewTitle'])) {
$pageHeading = call_user_func([$module->handler, 'getCreateNewTitle']);
}
return $pageHeading;
}
public function getCreateContentTitle()
{
// TODO: Implement getCreateContentTitle() method.
}
public function getUpdateContentTitle()
public function getUpdateContentTitle(ModuleModel $module)
{
// TODO: Implement getUpdateContentTitle() method.
}
@@ -1,26 +1,16 @@
<?php
namespace App\Cms\Repositories\Templates;
namespace App\Models\Templates\ModelTraits;
use App\Models\Templates\TemplatePath;
use App\CMS\Contracts\Repositories\Template as ITemplate;
use App\CMS\Repositories\Repository;
use App\Models\Module;
use App\Models\Templates\Template as TemplateModel;
trait Template {
protected $pathModel = null;
/**
* In one path may be many templates
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function getPath()
class Template extends Repository implements ITemplate
{
public function __construct(TemplateModel $model)
{
if (!$this->pathModel) {
$this->pathModel = TemplatePath::where('id', $this->path)
->first();
}
return $this->pathModel;
$this->model = $model;
}
/**
@@ -32,11 +22,11 @@ trait Template {
*/
public function getPathToTemplate($mode = null)
{
$templateName = $this->template_name;
$path = $this->getPath();
$templateName = $this->model->template_name;
$path = $this->model->path()->get();
// delete namespace if given
if (strpos($this->template_name, '::')) {
if (strpos($this->model->template_name, '::')) {
list(, $templateName) = explode('::', $templateName);
}
@@ -50,24 +40,24 @@ trait Template {
// path parts
$absolutePath = base_path($path->path);
$templatePath = str_replace('.', $_, $templateName);
$file = $templatePath . TemplateModel::TEMPLATE_SUFFIX;
$file = $templatePath . ITemplate::TEMPLATE_SUFFIX;
// compose two versions of path - original and with "custom" directory
$original = $absolutePath . $_ . $file;
$edited = $absolutePath . $_ . TemplateModel::EDITED_TEMPLATES_DIRECTORY . $_ . $file;
$edited = $absolutePath . $_ . ITemplate::EDITED_TEMPLATES_DIRECTORY . $_ . $file;
// decide which path will be returned
switch ($mode) {
case TemplateModel::CUSTOM_EDIT_DIRECTORY:
case ITemplate::CUSTOM_EDIT_DIRECTORY:
return $edited;
break;
case TemplateModel::ORIGINAL_DIRECTORY:
case ITemplate::ORIGINAL_DIRECTORY:
return $original;
break;
default:
if (file_exists($absolutePath . $_ . TemplateModel::EDITED_TEMPLATES_DIRECTORY . $_ . $file)) {
if (file_exists($absolutePath . $_ . ITemplate::EDITED_TEMPLATES_DIRECTORY . $_ . $file)) {
return $edited;
}
@@ -75,4 +65,10 @@ trait Template {
break;
}
}
public function getForModule(Module $module) {
return Template::where('module_id', $module->id)
->select(['template_name', 'name', 'description'])
->get();
}
}
@@ -3,17 +3,14 @@ namespace App\Http\Controllers\Admin\Contents;
use App\CMS\Contracts\Repositories\Content as IContent;
use App\CMS\Contracts\Repositories\Module as IModuleRepository;
use App\CMS\Contracts\Repositories\Template as ITemplate;
use Modules\Categories\Contracts\Repositories\Category as ICategory;
use App\CMS\Enumerations\ContentStatuses;
use App\Cms\Handlers\Interactions\Interaction;
use App\Cms\Interactions\Admin\Content\NewContent;
use App\Http\Controllers\Admin\Controller;
use App\Http\Requests\CreateNewContentRequest;
use App\Http\Requests\Request;
use App\Models\FileManager\File;
use App\Models\Module;
use App\Models\Templates\Template;
use Modules\Categories\Entities\Category;
use Pingpong\Modules\Facades\Module as ModuleInstance;
/**
* Class CreateNewContent
@@ -24,10 +21,6 @@ use Pingpong\Modules\Facades\Module as ModuleInstance;
*/
class CreateNewContent extends Controller
{
/**
* @var File
*/
private $file;
/**
* @var IContent
*/
@@ -36,71 +29,63 @@ class CreateNewContent extends Controller
* @var IModuleRepository
*/
private $module;
/**
* @var ICategory
*/
private $category;
/**
* @var ITemplate
*/
private $template;
/**
* CreateNewContent constructor.
*
* Sets File and Content models into class variables
*
* @param File $file
* @param Content $content
* @param IContent|Content $content
* @param IModuleRepository $module
* @param ICategory $category
*
* @param ITemplate $template
*
* @internal param File $file
*/
public function __construct(File $file, IContent $content, IModuleRepository $module)
public function __construct(IContent $content, IModuleRepository $module, ICategory $category, ITemplate $template)
{
parent::__construct();
$this->file = $file;
$this->content = $content;
$this->module = $module;
$this->category = $category;
$this->template = $template;
}
/**
* Display form for new content page
*
* @param $moduleId
* @param $module
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function create($moduleId)
public function create($module)
{
$module = Module::findOrFail($moduleId);
$module = $this->module->getOne($module);
$statuses = ContentStatuses::getWithTranslations();
$pageHeading = $this->module->getCreateContentTitle($module);
$templates = $this->template->getForModule($module);
$categories = $this->category->getForModule($module);
// set default page title
$pageHeading = trans('admin/contents.new', ['name' => trans($module->name)]);
if (is_callable([$module->handler, 'getCreateNewTitle'])) {
$pageHeading = call_user_func([$module->handler, 'getCreateNewTitle']);
}
// get list of usable templates
$templates = Template::where('module_id', $moduleId)
->select(['template_name', 'name', 'description'])
->get();
// add categories, if supported
$categoryModule = ModuleInstance::get('categories');
$categories = [];
if ($module->support_categories && !is_null($categoryModule) && $categoryModule->enabled()) {
$categories = Category::where('module_id', $moduleId)
->get();
}
// create default content object
$this->content->status = IContent::STATUS_DRAFT;
$page = $this->content->getOne();
// render view
return view('admin.content.new', [
'pageHeading' => $pageHeading,
'contentStatuses' => $statuses,
'templates' => $templates,
'moduleId' => $moduleId,
'module' => $module,
'categories' => $categories,
'page' => $this->content,
'rootPages' => $this->content->getOverview()
->get(),
'moduleName' => trans($module->name),
'extraData' => call_user_func([$module->handler, 'loadExtraData'], $this->content),
'page' => $page,
'rootPages' => $this->content->getOverview(),
'formSectionNames' => call_user_func([$module->handler, 'getExtendedFormSections']),
'formSections' => call_user_func([$module->handler, 'getExtendedFormInputsCreate']),
]);
@@ -116,7 +101,7 @@ class CreateNewContent extends Controller
*/
public function store(Request $request, $moduleId)
{
$module = Module::findOrFail($moduleId);
$module = $this->module->getOne($moduleId);
// create new page
Interaction::handle($request, new NewContent(), $module->handler);
@@ -18,6 +18,10 @@ use Illuminate\Support\Facades\Event;
use Modules\Categories\Entities\Category;
use Pingpong\Modules\Facades\Module as ModuleInstance;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use App\CMS\Contracts\Repositories\Content as IContent;
use App\CMS\Contracts\Repositories\Module as IModuleRepository;
use App\CMS\Contracts\Repositories\Template as ITemplate;
use Modules\Categories\Contracts\Repositories\Category as ICategory;
class EditContent extends Controller
{
@@ -29,66 +33,70 @@ class EditContent extends Controller
* @var File
*/
private $file;
/**
* @var IContent
*/
private $content;
/**
* @var IModuleRepository
*/
private $module;
/**
* @var ICategory
*/
private $category;
/**
* @var ITemplate
*/
private $template;
/**
* EditContent constructor.
*
* Load ContentHistory and File into this controller
*
* @param ContentHistory $history
* @param File $file
* @param ContentHistory $history
* @param File $file
* @param IContent $content
* @param IModuleRepository $module
* @param ICategory $category
* @param ITemplate $template
*/
public function __construct(ContentHistory $history, File $file)
public function __construct(ContentHistory $history, File $file, IContent $content, IModuleRepository $module, ICategory $category, ITemplate $template)
{
$this->history = $history;
$this->file = $file;
$this->content = $content;
$this->module = $module;
$this->category = $category;
$this->template = $template;
}
/**
* Display form for editing static page
*
* @param $id
* @param $url
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function edit($id)
public function edit($url)
{
// select all content statuses
$statuses = ContentStatuses::getWithTranslations();
// try to find requested page
$page = Content::findOrFail($id);
$page->module_settings = json_decode($page->module_settings);
$page = $this->content->getOne($url);
// get module ID
$module = Module::where('handler', $page->module_handler)
->firstOrFail();
$pageHeading = trans('admin/contents.edit', ['name' => e($page->title)]);
if (is_callable([$module->handler, 'getEditTitle'])) {
$pageHeading = call_user_func([$module->handler, 'getEditTitle'], $page);
}
$pageHeading = $this->module->getUpdateContentTitle($module);
$templates = $this->template->getForModule($module);
$categories = $this->category->getForModule($module);
$history = $this->history->getStructuredHistoryOf($page);
// get all Blade templates for rendering page
$templates = Template::where('module_id', $module->id)
->select(['template_name', 'name', 'description'])
->get();
// get module for Categories - PingPong module
$categoryModule = ModuleInstance::get('categories');
// add categories, if supported
$categories = [];
if ($module->support_categories && !is_null($categoryModule) && $categoryModule->enabled()) {
$categories = Category::where('module_id', $module->id)
->get();
}
// modify data for edit form according to installed template
call_user_func_array([CurrentTemplate::handler(), 'beforePopulatingEditForm'], [&$page]);
$history = $this->history->getStructuredHistoryOf($page);
// render view
return view('admin.content.edit', [
'pageHeading' => $pageHeading,
@@ -96,11 +104,8 @@ class EditContent extends Controller
'page' => $page,
'module' => $module,
'categories' => $categories,
'rootPages' => $page->getOverview()
->where('contents.id', '!=', $page->id)
->get(),
'rootPages' => $this->content->getOverview(),
'templates' => $templates,
'extraData' => call_user_func([$page->module_handler, 'loadExtraData'], $page),
'formSectionNames' => call_user_func([$page->module_handler, 'getExtendedFormSections']),
'formSections' => call_user_func([$page->module_handler, 'getExtendedFormInputsEdit']),
'historySize' => count($history['changesets'])
+3 -3
View File
@@ -1,15 +1,15 @@
<?php
Route::group(['namespace' => 'Contents'], function () {
// list of all static pages
Route::get('content/overview/{moduleId?}/{status?}', 'ContentOverview@index')
Route::get('content/overview/{module?}', 'ContentOverview@index')
->name('content.overview');
// form for creating new static page
Route::get('content/new/{moduleId}', 'CreateNewContent@create')
Route::get('content/new/{module}', 'CreateNewContent@create')
->name('content.new');
// form for editing existing static page
Route::get('content/edit/{id}', 'EditContent@edit')
Route::get('content/edit/{url}', 'EditContent@edit')
->name('content.edit');
// post method for creating new static page
+1 -3
View File
@@ -2,8 +2,6 @@
namespace App\Models\Content;
use App\Events\CreateNewContent;
use App\Events\Event;
use App\Models\FileManager\File;
use App\Models\User;
use Illuminate\Database\Eloquent\Model;
@@ -44,7 +42,7 @@ class Content extends Model
*/
public function history()
{
return $this->hasMany(\App\Models\Content\ContentHistory::class);
return $this->hasMany(ContentHistory::class);
}
/**
+9 -7
View File
@@ -6,7 +6,6 @@ use Illuminate\Database\Eloquent\Model;
class Template extends Model
{
use ModelTraits\Template;
public $timestamps = true;
protected $fillable = [
'template_name',
@@ -16,10 +15,13 @@ class Template extends Model
'description',
'editable'
];
const EDITED_TEMPLATES_DIRECTORY = 'custom';
const ASSETS_DIRECTORY = 'assets';
const MODULES_DIRECTORY = 'modules';
const TEMPLATE_SUFFIX = '.blade.php';
const CUSTOM_EDIT_DIRECTORY = 1;
const ORIGINAL_DIRECTORY = 2;
/**
* Template path where this template is stored
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function path() {
return $this->belongsTo(TemplatePath::class, 'path');
}
}
-3
View File
@@ -4,9 +4,6 @@ namespace App\Models\Templates;
use Illuminate\Database\Eloquent\Model;
/**
* Class CustomFieldType
*/
class TemplatePath extends Model
{
public $timestamps = true;
+3
View File
@@ -4,6 +4,7 @@ namespace App\Providers;
use App\CMS\Contracts\Repositories\Content as IContent;
use App\CMS\Contracts\Repositories\Module as IModule;
use App\CMS\Contracts\Repositories\Template as ITemplate;
use App\CMS\Handlers\Registrators\SearchEngineRegistrator;
use App\CMS\Handlers\Registrators\SettingsExtensionRegistrator;
use App\CMS\Handlers\Registrators\TemplateRegistrator;
@@ -14,6 +15,7 @@ use App\CMS\Handlers\Search\Presenters\AdminContent as AdminContentPresenter;
use App\CMS\Handlers\Search\Presenters\AdminFiles;
use App\CMS\Repositories\Content\Content as ContentRepository;
use App\CMS\Repositories\Module as ModuleRepository;
use App\CMS\Repositories\Templates\Template as TemplateRepository;
use App\CMS\Widgets\HtmlCode\HtmlCode;
use App\CMS\Widgets\Menu\Menu;
use Barryvdh\Debugbar\ServiceProvider as DebugBarServiceProvider;
@@ -41,6 +43,7 @@ class AppServiceProvider extends ServiceProvider
$this->app->bind(IContent::class, ContentRepository::class);
$this->app->bind(IModule::class, ModuleRepository::class);
$this->app->bind(ITemplate::class, TemplateRepository::class);
}
/**