netcore/module-category

Module for category management

v1.1.1 2019-05-24 06:28 UTC

Requires

• php: >=7.0
• cviebrock/eloquent-sluggable: ^4.3
• kalnoy/nestedset: ^4.2

MIT

• Viktors Ņikiforovs

README

This module was made for easy management of categories.

Features

• Everything is translatable
• Each category has slug, manual slugs are allowed
• Drag'n'drop support for reordering

Pre-installation

This module is part of Netcore CMS ecosystem and is only functional in a project that has following packages installed:

1. https://github.com/netcore/netcore
2. https://github.com/netcore/module-admin
3. https://github.com/netcore/module-translate

Installation

• Require this package using composer

    composer require netcore/module-category

• Publish assets/configuration/migrations

    php artisan module:publish Category
    php artisan module:publish-config Category
    php artisan module:publish-migration Category
    php artisan migrate

Configuration

• Configuration file is available at config/netcore/module-category.php

Category groups

• Category groups are not editable from admin control panel. You should seed them.

    // DatabaseSeeder.php:
    
    // For select2 type, you should create presenter first, read below about presenters.
    CategoryGroup::create([
        'key'                   => 'advertisment',
        'title'                 => 'Advertisement categories', 
        'has_icons'             => true,
        'icons_for_only_roots'  => true,
        'icons_type'            => 'select2',
        'icons_presenter_class' => \App\Icons\ClassifiedIconsPresenter::class,
        'levels'                => 3, 
    ]);

    CategoryGroup::create([
        'key'                  => 'forum',
        'title'                => 'Forum categories',
        'has_icons'            => true,
        'icons_for_only_roots' => true,
        'icons_type'           => 'file',
        'levels'               => null, // no limit
    ]);

Icon set

• Create icons presenter. It should implement \Modules\Category\Icons\IconSetInterface

    use Modules\Category\Icons\IconSetInterface;

    class CustomIconSet implements IconSetInterface
    {
        /**
         * Get array of available icons
         *
         * @return array
         */
        public function getIcons(): array {
            return [
                // Class    => Text
                'my-icon-1' => 'My Icon 1',
                'my-icon-2' => 'My Icon 2'
            ];
        }

        /**
         * Get template for select2 render
         *
         * @return string
         */
        public function getSelect2Template(): string {
            return '<i class="::class::"></i><span>::text::</span>';
        }

        /**
         * Get styles to inject
         *
         * @return array
         */
        public function getInjectableStyles(): array {
            return [
                '/link/to/your/css/style.css'
            ];
        }

        /**
         * Get sprite to inject before container
         *
         * @return string
         */
        public function getInjectableSprite(): string {
            return ''; // this is needed when using SVG icons. ex.: return view('svg/sprite')->render();
        }
    }