Plugin.php

<?php namespace RainLab\Builder;

use Lang;
use Event;
use Backend;
use System\Classes\PluginBase;
use RainLab\Builder\Classes\StandardControlsRegistry;
use RainLab\Builder\Classes\StandardBehaviorsRegistry;
use RainLab\Builder\Classes\StandardBlueprintsRegistry;
use RainLab\Builder\Rules\Reserved;
use Doctrine\DBAL\Types\Type as DoctrineType;

/**
 * Plugin registration file
 */
class Plugin extends PluginBase
{
    /**
     * pluginDetails
     */
    public function pluginDetails()
    {
        return [
            'name' => "Builder",
            'description' => "Provides visual tools for building October plugins.",
            'author' => 'Alexey Bobkov, Samuel Georges',
            'icon' => 'icon-wrench',
            'homepage' => 'https://github.com/rainlab/builder-plugin'
        ];
    }

    /**
     * registerComponents
     */
    public function registerComponents()
    {
        return [
            \RainLab\Builder\Components\RecordList::class => 'builderList',
            \RainLab\Builder\Components\RecordDetails::class => 'builderDetails'
        ];
    }

    /**
     * registerPermissions
     */
    public function registerPermissions()
    {
        return [
            'rainlab.builder.manage_plugins' => [
                'tab' => "Builder",
                'label' => 'rainlab.builder::lang.plugin.manage_plugins'
            ]
        ];
    }

    /**
     * registerNavigation
     */
    public function registerNavigation()
    {
        return [
            'builder' => [
                'label' => "Builder",
                'url' => Backend::url('rainlab/builder'),
                'icon' => 'icon-wrench',
                'iconSvg' => 'plugins/rainlab/builder/assets/images/builder-icon.svg',
                'permissions' => ['rainlab.builder.manage_plugins'],
                'order' => 400,
                'useDropdown' => false,

                'sideMenu' => [
                    'database' => [
                        'label' => 'rainlab.builder::lang.database.menu_label',
                        'icon' => 'icon-hdd-o',
                        'url' => 'javascript:;',
                        'attributes' => ['data-menu-item' => 'database'],
                        'permissions' => ['rainlab.builder.manage_plugins']
                    ],
                    'models' => [
                        'label' => 'rainlab.builder::lang.model.menu_label',
                        'icon' => 'icon-random',
                        'url' => 'javascript:;',
                        'attributes' => ['data-menu-item' => 'models'],
                        'permissions' => ['rainlab.builder.manage_plugins']
                    ],
                    'permissions' => [
                        'label' => 'rainlab.builder::lang.permission.menu_label',
                        'icon' => 'icon-unlock-alt',
                        'url' => 'javascript:;',
                        'attributes' => ['data-no-side-panel' => 'true', 'data-builder-command' => 'permission:cmdOpenPermissions', 'data-menu-item' => 'permissions'],
                        'permissions' => ['rainlab.builder.manage_plugins']
                    ],
                    'menus' => [
                        'label' => 'rainlab.builder::lang.menu.menu_label',
                        'icon' => 'icon-location-arrow',
                        'url' => 'javascript:;',
                        'attributes' => ['data-no-side-panel' => 'true', 'data-builder-command' => 'menus:cmdOpenMenus', 'data-menu-item' => 'menus'],
                        'permissions' => ['rainlab.builder.manage_plugins']
                    ],
                    'controllers' => [
                        'label' => 'rainlab.builder::lang.controller.menu_label',
                        'icon' => 'icon-asterisk',
                        'url' => 'javascript:;',
                        'attributes' => ['data-menu-item' => 'controllers'],
                        'permissions' => ['rainlab.builder.manage_plugins']
                    ],
                    'versions' => [
                        'label' => 'rainlab.builder::lang.version.menu_label',
                        'icon' => 'icon-code-fork',
                        'url' => 'javascript:;',
                        'attributes' => ['data-menu-item' => 'version'],
                        'permissions' => ['rainlab.builder.manage_plugins']
                    ],
                    'localization' => [
                        'label' => 'rainlab.builder::lang.localization.menu_label',
                        'icon' => 'icon-globe',
                        'url' => 'javascript:;',
                        'attributes' => ['data-menu-item' => 'localization'],
                        'permissions' => ['rainlab.builder.manage_plugins']
                    ],
                    'code' => [
                        'label' => 'Code',
                        'icon' => 'icon-file-code-o',
                        'url' => 'javascript:;',
                        'attributes' => ['data-menu-item' => 'code'],
                        'permissions' => ['rainlab.builder.manage_plugins']
                    ],
                    'imports' => [
                        'label' => 'Import',
                        'icon' => 'icon-arrow-circle-down',
                        'url' => 'javascript:;',
                        'attributes' => ['data-no-side-panel' => 'true', 'data-builder-command' => 'imports:cmdOpenImports', 'data-menu-item' => 'imports'],
                        'permissions' => ['rainlab.builder.manage_plugins']
                    ]
                ]

            ]
        ];
    }

    /**
     * registerSettings
     */
    public function registerSettings()
    {
        return [
            'config' => [
                'label' => 'Builder',
                'icon' => 'icon-wrench',
                'description' => 'Set your author name and namespace for plugin creation.',
                'class' => 'RainLab\Builder\Models\Settings',
                'permissions' => ['rainlab.builder.manage_plugins'],
                'order' => 600
            ]
        ];
    }

    /**
     * boot
     */
    public function boot()
    {
        Event::listen('pages.builder.registerControls', function ($controlLibrary) {
            new StandardControlsRegistry($controlLibrary);
        });

        Event::listen('pages.builder.registerControllerBehaviors', function ($behaviorLibrary) {
            new StandardBehaviorsRegistry($behaviorLibrary);
        });

        Event::listen('pages.builder.registerTailorBlueprints', function ($blueprintLibrary) {
            new StandardBlueprintsRegistry($blueprintLibrary);
        });

        // Register reserved keyword validation
        Event::listen('translator.beforeResolve', function ($key, $replaces, $locale) {
            if ($key === 'validation.reserved') {
                return Lang::get('rainlab.builder::lang.validation.reserved');
            }
        });

        $this->callAfterResolving('validator', function ($validator) {
            $validator->extend('reserved', Reserved::class);
            $validator->replacer('reserved', function ($message, $attribute, $rule, $parameters) {
                // Fixes lowercase attribute names in the new plugin modal form
                return ucfirst($message);
            });
        });

        // Register doctrine types
        if (!DoctrineType::hasType('timestamp')) {
            DoctrineType::addType('timestamp', \RainLab\Builder\Classes\Doctrine\TimestampType::class);
        }
    }
}