arter/amos-search

There is no license information available for the latest version (1.0.8) of this package.

Amos Search

Installs: 576

Dependents: 0

Suggesters: 0

Security: 0

Type:component

1.0.8 2022-05-04 16:00 UTC

This package is auto-updated.

Last update: 2024-04-04 07:52:01 UTC


README

Plugin to allow global search on several models. Global search can be extended, possibly, to any module. To enable global search for a model:

  • make the model search class implement the arter\amos\core\interfaces\SearchModelInterface;
  • make the model implement the ModelLabelsInterface

Installation

  1. The preferred way to install this extension is through composer.

    Either run

     composer require arter/amos-search
    

    or add

     "arter/amos-search": "~1.0"
    

    to the require section of your composer.json file.

  2. Add module to your modules-amos config in backend:

    <?php
    $config = [
        'modules' => [
            'search' => [
                'class' => 'arter\amos\search\AmosSearch'
            ],
        ],
    ];
    
  3. Enable the search bar add to backend/params-local

search navbar menu

'searchNavbar' => true

Module configurations

  • enableNetworkScope - boolean, default = false
    If true, when the scope is within a network (eg. in a community) only the network contents results are shown