Plugin.php

<?php

namespace OFFLINE\SiteSearch;

use Event;
use System\Classes\PluginBase;
use System\Classes\PluginManager;
use OFFLINE\SiteSearch\Models\Settings;

/**
 * SiteSearch Plugin Information File
 */
class Plugin extends PluginBase
{
    /**
     * Returns information about this plugin.
     *
     * @return array
     */
    public function pluginDetails()
    {
        return [
            'name' => 'offline.sitesearch::lang.plugin.name',
            'description' => 'offline.sitesearch::lang.plugin.description',
            'author' => 'offline.sitesearch::lang.plugin.author',
            'icon' => 'icon-search',
            'homepage' => 'https://github.com/OFFLINE-GmbH/oc-site-search-plugin',
        ];
    }


    public function boot()
    {
        // Remove all tabs for uninstalled plugins
        Event::listen('backend.form.extendFields', function ($widget) {
            if (!$widget->getController() instanceof \System\Controllers\Settings) {
                return;
            }

            if (!$widget->model instanceof \OFFLINE\SiteSearch\Models\Settings) {
                return;
            }

            if ($widget->isNested) {
                return;
            }

            $providersTabs = collect($widget->getTab('primary')->getAllFields())
                ->filter(function ($formField) {
                    return array_get($formField->config, 'native');
                })
                ->keyBy('tab');

            $providersTabs->each(function ($formField, $tabName) use ($widget) {
                if ($tabName === 'Tailor') {
                    return;
                }
                if (! PluginManager::instance()->exists($tabName)) {
                    $widget->removeTab($tabName);
                }
            });
        });
    }

    /**
     * Registers any front-end components implemented in this plugin.
     *
     * @return array
     */
    public function registerComponents()
    {
        return [
            'OFFLINE\SiteSearch\Components\SearchResults' => 'searchResults',
            'OFFLINE\SiteSearch\Components\SearchInput' => 'searchInput',
            'OFFLINE\SiteSearch\Components\SiteSearchInclude' => 'siteSearchInclude',
        ];
    }

    /**
     * Registers any back-end permissions.
     *
     * @return array
     */
    public function registerPermissions()
    {
        return [
            'offline.sitesearch.manage_settings' => [
                'tab' => 'offline.sitesearch::lang.plugin.name',
                'label' => 'offline.sitesearch::lang.plugin.manage_settings_permission',
            ],
            'offline.sitesearch.view_log' => [
                'tab' => 'offline.sitesearch::lang.plugin.name',
                'label' => 'offline.sitesearch::lang.plugin.view_log_permission',
            ],
        ];
    }

    /**
     * Registers any back-end settings.
     *
     * @return array
     */
    public function registerSettings()
    {
        $settings = [
            'config' => [
                'label' => 'offline.sitesearch::lang.plugin.name',
                'description' => 'offline.sitesearch::lang.plugin.manage_settings',
                'category' => 'system::lang.system.categories.cms',
                'icon' => 'icon-search',
                'class' => 'Offline\SiteSearch\Models\Settings',
                'order' => 100,
                'keywords' => 'search',
                'permissions' => ['offline.sitesearch.manage_settings'],
            ],
        ];

        if ((bool)Settings::get('log_queries', false) === false) {
            return $settings;
        }

        $settings['querylogs'] = [
            'label' => 'offline.sitesearch::lang.log.title',
            'description' => 'offline.sitesearch::lang.log.description',
            'category' => 'system::lang.system.categories.cms',
            'url' => \Backend::url('offline/sitesearch/querylogs'),
            'keywords' => 'search log query queries',
            'icon' => 'icon-search',
            'permissions' => ['offline.sitesearch.*'],
            'order' => 99,
        ];

        return $settings;
    }
}