vis/articles_l5

Articles handler package for L5

Articles

Пакет для Laravel 5.2+ предназначенный работы с материалами, которые можно предоставить в виде "Каталог статей - Статья"., _(*1)

Разделы 1. Установка 2. Спецификация нефильтруемых статей 3. Спецификация фильтруемых статей, _(*2)

Установка

Выполняем, _(*3)

    composer require "vis/articles_l5":"1.*"

Спецификация нефильтруемых статей

Для использования функционала нефильтруемых статей необходимо:, _(*4)

1. Создать модель, которая наследует Vis\Articles\Models\AbstractArticle, которая в свою очередь наследует BaseModel

    use Vis\Articles\Models\AbstractArticle;

    class PackageArticle extends AbstractArticle
    {    
        protected $table = 'package_articles';

        protected $viewFolder = 'package_articles';

        protected $sortOrder = "created_at:desc";

        protected $perPage = 25;
        protected $perPageSettingName = 'kol_statei-v-kataloge-novostei';

        protected $relationsInCatalog = [];
        protected $relationsInArticle = [];

        public function getUrl()
        {
            return route("package_article", [$this->getSlug(), $this->id]);
        }
    }

Описание свойств:, _(*5)

Путь к папке с view templates Если значение 'sub_folder.package_articles', тогда view должны лежать в папке /resources/views/pages/sub_folder/package_articles Значение: путь к папке через точки, _(*6)

    protected $viewFolder = 'package_articles';

Путь к папке с view templates Значение: название_поля:порядок, по умолчанию: created_at:desc, _(*7)

    protected $sortOrder = "created_at:desc";

Количество статей на странице каталога Значение: целое число, по умолчанию: 12, _(*8)

    protected $perPage = 25;

Название опции в CMS, которая содержит количество статей на странице каталога. Если указано, то параметр $perPage игнорируется Значение: строка с названием опции в CMS, _(*9)

    protected $perPageSettingName = 'kol_statei-v-kataloge-novostei';

Массив названий дополнительных Eloquent связей, которые необходимо загрузить в каталоге Необходим для реализации Lazy Eager loading на страницах каталогов Значение: массив $relationsInCatalog['', ...], _(*10)

    protected $relationsInCatalog = [];

Массив названий дополнительных Eloquent связей, которые необходимо загрузить в статье Необходим для реализации Lazy Eager loading на страницах статей Значение: массив $relationsInArticle['', ...], _(*11)

    protected $relationsInArticle = [];

Описание методов:, _(*12)

Метод получения свойства $viewFolder, _(*13)

    public function getViewFolder(): string;

Метод получения свойства $sortOrder, _(*14)

    public function getSortOrder(): string;

Метод получения свойства $perPage, _(*15)

    public function getPerPage(): int;

Метод получения свойства $relationsInCatalog, _(*16)

    public function getRelationsInCatalog(): array;

Метод получения свойства $RelationsInArticle, _(*17)

    public function getRelationsInArticle(): array;

Метод-фильтр выведения статей по признаку is_main = 1, _(*18)

    public function scopeIsMain($query);

Метод-фильтр сортировки статей Значение: строка $order = 'created_at:desc', _(*19)

    public function scopeFilterCustomOrder($query, string $order);

1. Создать контроллер, который наследует Vis\Articles\Controllers\AbstractSimpleArticleController

    use Vis\Articles\Controllers\AbstractSimpleArticleController;

    class PackageArticlesController extends AbstractSimpleArticleController
    {
        protected $model = "PackageArticle";
    }

Описание свойств:, _(*20)

Название модели, которая будет использоваться Значение: строка с названием модели , _(*21)

     protected $model = "PackageArticle";

1. Создать шаблон в \config\builder\tree.php

    'articles_catalog' => array(
        'action' => 'PackageArticlesController@showCatalog',
        'node_definition' => 'node',
        'check' => function() {
            return true;
        },
        'title' => 'Каталог статей',
    ),

1. Определить именной роут, по которому будут доступны статьи

    Route::get('/test-articles-catalog/{slug}-{id}', [
        'as' => 'package_article',
        'uses' => 'PackageArticlesController@showArticle'
    ]);

1. Создать два шаблона article.blade.php и catalog.blade.php в соответствующей параметру $viewFolder папке. Пример article.blade.php

@extends('layouts.default')

@section('main')

    <section class="article-section">
        <div class="article-text">
            <h1>
                {{$page->t('title')}}
            </h1>
        </div>
    </section>

@stop

Пример catalog.blade.php, _(*22)

@extends('layouts.default')

@section('main')

    <section class="associations-page">
        <div class="container">

            <div class="associations-list">
                @foreach($articles as $key => $article)
                    <div class="associations-item">
                        <div class="text">
                            <div class="title">
                                <a href="{{$article->getUrl()}}">
                                    {{$article->t('title')}}
                                </a>
                            </div>
                        </div>
                    </div>
                @endforeach
            </div>
        </div>
    </section>
@stop

Спецификация фильтруемых статей

Часть параметров наследуется от нефильтруемой модели, их описание опущено. Для использования функционала фильтруемых статей необходимо:, _(*23)

1. Создать модель, которая наследует Vis\Articles\Models\AbstractFilterableArticle, которая в свою очередь наследует BaseModel

use Vis\Articles\Models\AbstractFilterableArticle;

class PackageFilterableArticle extends AbstractFilterableArticle
{
    protected $table = 'articles_filterable';

    protected $viewFolder = 'package_filterable_articles';

    protected $sortOrder = "created_at:desc";

    protected $perPage = 25;
    protected $perPageSettingName = 'kol_statei-v-kataloge-novostei';

    protected $sortOptions = [
        ['name' => 'title', 'description' => 'По названию','value' => 'title:asc'],
        ['name' => 'new_first', 'description' => 'от новых к старым','value' => 'created_at:desc'],
        ['name' => 'old_first', 'description' => 'от старых к новым','value' => 'created_at:asc'],
    ];

    protected $countOptions = [
        ['name' => '15','description' => 'По 15', 'value' => 15 ],
        ['name' => 'all','description' => 'Все', 'value' => 99999999 ],
    ];

    protected $dateField = 'created_at';

    protected $relationsInCatalog = [];

    protected $relationsInArticle = [];

    public function getUrl()
    {
       return route("package_filterable_article", [$this->filterModel->getSlug(),$this->getSlug(), $this->id]);
    }

    public function filterModel()
    {
        return $this->belongsTo('Tree');
    }

Описание дополнительных свойств:, _(*24)

Фильтры порядка сортировки Значение: массив $sortOptions['name' => '', 'description' => '','value' => ''], _(*25)

    protected $sortOptions = [
        ['name' => 'title', 'description' => 'По названию','value' => 'title:asc'],
        ['name' => 'new_first', 'description' => 'от новых к старым','value' => 'created_at:desc'],
        ['name' => 'old_first', 'description' => 'от старых к новым','value' => 'created_at:asc'],
    ];

Фильтры количества отображения на странице Значение: массив $countOptions['name' => '', 'description' => '','value' => ''], _(*26)

    protected $countOptions = [
        ['name' => '15','description' => 'По 15', 'value' => 15 ],
        ['name' => 'all','description' => 'Все', 'value' => 99999999 ],
    ];

Путь к папке с view templates Значение: название_поля:порядок, по умолчанию: created_at:desc, _(*27)

Название поля используемого для фильтрации по дате Значение: строка с названием_поля, по умолчанию: created_at, _(*28)

    protected $dateField = 'created_at';

Описание дополнительных методов: Метод получения свойства $sortOptions , _(*29)

    public function getSortOptions(): array;

Метод получения свойства $countOptions , _(*30)

    public function getCountOptions(): array;

Метод получения свойства $dateField , _(*31)

    public function getDateField(): string;

Метод-фильтр по связи с другой моделью Значение: строка $relationName = 'filterModel', объект $relationSelected, _(*32)

    public function scopeFilterRelation($query, $relationName, $relationSelected);

Метод-фильтр статей по дню Значение: целое число $year, целое число $month, целое число $day, _(*33)

    public function scopeFilterDateDay($query, int $day = 0);

Метод-фильтр статей по месяцу Значение: целое число $year, целое число $month, целое число $day, _(*34)

    public function scopeFilterDateMonth($query, int $month = 0);

Метод-фильтр статей по году Значение: целое число $year, целое число $month, целое число $day, _(*35)

    public function scopeFilterDateYear($query, int $year = 0);

Метод-фильтр статей по точной дате Y-M-D Значение: целое число $year, целое число $month, целое число $day, _(*36)

    public function scopeFilterDateStrict($query, int $year = 0, int $month = 0, int $day = 0)

Метод-фильтр по промежутку дат Значение: Объект Carbon\Carbon $dateFrom, Объект Carbon\Carbon $dateTo, _(*37)

    public function scopeFilterDateRange($query, Carbon $dateFrom, Carbon $dateTo);

1. Создать контроллер, который наследует Vis\Articles\Controllers\AbstractFilterableArticleController. Определить в нём методы ShowSingle, ShowCatalog

use Vis\Articles\Controllers\AbstractFilterableArticleController;

class PackageFilteredArticlesController extends AbstractFilterableArticleController
{
    protected $model = "PackageFilterableArticle";

    private function handleArticles()
    {
        $page = $this->node;
        $filters = $this->filter;

        $filters->addCount()
            ->addSort()
            ->addRelation('filterModel', $page)
            ->addDateRange()
            ->addDateDay()
            ->addDateMonth()
            ->addDateYear()
            ->addDateStrict()
            ->handle();

        $sortOrder  = $filters->getSort()->getSelected();
        $perPage    = $filters->getCount()->getSelected();
        $filter     = $filters->getRelation('filterModel')->getSelected() ?: $filters->getRelation('filterModel')->setSelectedToFirstOption()->getSelected();
        $dateRange  = $filters->getDateRange()->getSelected();
        $dateDay    = $filters->getDateDay()->getSelected();
        $dateMonth  = $filters->getDateMonth()->getSelected();
        $dateYear   = $filters->getDateYear()->getSelected();
        $dateStrict = $filters->getDateStrict()->getSelected();

        $articles = $this->model->active()->with('filterModel')
            ->filterRelation('filterModel', $filter)
            ->filterDateRange($dateRange['date-from'], $dateRange['date-to'])
            ->filterDateDay($dateDay)
            ->filterDateMonth($dateMonth)
            ->filterDateYear($dateYear)
            ->filterDateStrict($dateStrict['year'], $dateStrict['month'], $dateStrict['day'])
            ->filterCustomOrder($sortOrder)
            ->paginate($perPage);


        $articles->load($this->model->getRelationsInCatalog());

        return view("pages." . $this->model->getViewFolder() . ".catalog", compact('page', 'articles', 'filters'));
    }

    public function showCatalog()
    {
        return $this->handleArticles();
    }

    public function showSubCatalog($catalog)
    {
        if (!$this->node) {
            $this->node = $this->model->filterModel()->where('slug', $catalog)->active()->first();
            if (!$this->node) {
                abort(404);
            }
        }

        return $this->handleArticles();
    }

    public function showArticle($catalog, $slug, $id)
    {
        $page = $this->model->where('id', $id)->active()->with('filterModel')->first();

        if (!$page) {
            abort(404);
        }

        if ($page->filterModel->getSlug() != $catalog) {
            return redirect($page->getUrl(), 302);
        }

        if ($page->getSlug() != $slug) {
            return redirect($page->getUrl(), 302);
        }

        $page->load($this->model->getRelationsInArticle());

        return view("pages." . $this->model->getViewFolder() . ".article", compact('page'));
    } // end showSingle

}

1. Создать шаблон в \config\builder\tree.php

    'filterable_catalog' => array(
        'action' => 'PackageFilteredArticlesController@showCatalog',
        'node_definition' => 'node',
        'check' => function() {
            return true;
        },
        'title' => 'фильтруемый каталог',
    ),

Если модель фильтров является деревом, тогда создаем еще шаблон:, _(*38)

    'filterable_sub_catalog' => array(
        'action' => 'PackageFilteredArticlesController@showSubCatalog',
        'node_definition' => 'node',
        'check' => function() {
            return true;
        },
        'title' => 'фильтруемый подкаталог',
    ),

Если модель фильтров внешняя модель, тогда необходимо создать роут для отслеживания фильтра:, _(*39)

    Route::get('/test-filterable-articles-catalog-foreign/{catalog}', [
        'as' => 'test-filterable-articles-catalog-foreign',
        'uses' => 'PackageFilteredForeignArticlesController@showSubCatalog'
    ]);

Примечание. Для корректной работы у внешней модели-фильтра необходимо наличие поля slug. Для его автоматического заполнения в definition`е этой модели можно определить, _(*40)

handler => 'Vis\Builder\Helpers\SlugHandler' 

1. Определить именной роут, по которому будут доступны статьи

    Route::get('/test-filterable-articles-catalog/{catalog}/{slug}-{id}', [
        'as' => 'package_filterable_article',
        'uses' => 'PackageFilteredArticlesController@showArticle'
    ]);

1. Создать два шаблона article.blade.php и catalog.blade.php в соответствующей параметру $viewFolder папке. Аналогично нефильтруемым статьям, _(*41)

2. Создать шаблон фильтров, который необходимо будет подключить на странице каталога. Желательно разместить его в views/partials, для того чтобы можно было подключать один шаблон фильтров на всех каталогах. Неполный пример такого шаблона:, _(*42)

    
{{__('Фильтры')}}
    

        

            
                {{__('Все')}}
                    @foreach($filters->getRelation('filterModel')->getOptions() as $filterOption)
                        current() == $filterOption->getUrl() ? 'selected' : ''}}>{{$filterOption->t('title')}}
                    @endforeach
            

        
        

            

                

                    
                        @foreach($filters->getSort()->getOptions() as $sortOption)
                            getSort()->getSelected() ?'selected' : ''}}>{{$sortOption['description']}}
                        @endforeach
                    
                
                

                    
                        @foreach($filters->getCount()->getOptions() as $optionValue)
                            getCount()->getSelected() ? 'selected' : ''}}>{{$optionValue['description']}}
                        @endforeach