1 package SL::Controller::TopQuickSearch;
4 use parent qw(SL::Controller::Base);
8 use SL::Locale::String qw(t8);
10 use Rose::Object::MakeMethods::Generic (
11 'scalar --get_set_init' => [ qw(module js) ],
14 my @available_modules = (
15 'SL::Controller::TopQuickSearch::Article',
16 'SL::Controller::TopQuickSearch::Part',
17 'SL::Controller::TopQuickSearch::Service',
18 'SL::Controller::TopQuickSearch::Assembly',
19 'SL::Controller::TopQuickSearch::Contact',
20 'SL::Controller::TopQuickSearch::GLTransaction',
24 sub action_query_autocomplete {
27 my $hashes = $self->module->query_autocomplete;
29 $self->render(\ SL::JSON::to_json($hashes), { layout => 0, type => 'json', process => 0 });
32 sub action_select_autocomplete {
35 my $redirect_url = $self->module->select_autocomplete;
37 $self->js->redirect_to($redirect_url)->render;
40 sub action_do_search {
43 my $redirect_url = $self->module->do_search;
46 $self->js->redirect_to($redirect_url)
52 sub available_modules {
55 $self->require_modules;
57 map { $_->new } @available_modules;
61 my %enabled_names = map {
63 } @{ $::instance_conf->get_quick_search_modules };
66 $enabled_names{$_->name}
67 } $_[0]->available_modules
72 $::auth->assert($_->auth, 1)
73 } $_[0]->enabled_modules
79 $self->require_modules;
81 die 'Need module' unless $::form->{module};
83 die 'Unknown module ' . $::form->{module} unless my $class = $modules_by_name{$::form->{module}};
85 $::auth->assert($class->auth);
91 SL::ClientJS->new(controller => $_[0])
97 if (!$self->{__modules_required}) {
98 for my $class (@available_modules) {
99 eval "require $class" or die $@;
100 $modules_by_name{ $class->name } = $class;
102 $self->{__modules_required} = 1;
114 SL::Controller::TopQuickSearch - Framework for pluggable quicksearch fields in the layout top header.
118 use SL::Controller::TopQuickSearch;
119 my $search = SL::Controller::TopQuickSearch->new;
120 $::request->layout->add_javascripts('kivi.QuickSearch.js');
123 [%- FOREACH module = search.enabled_modules %]
124 <input type='text' id='top-search-[% module.name %]'>
129 This controller provides abstraction for different search plugins, and ensures
130 that all follow a common useability scheme.
132 Modules should be configurable per user, but currently are not. Disabling
133 modules can be done by removing them from available_modules or in client_config.
135 =head1 BEHAVIOUR REQUIREMENTS
141 A single text input field with the html5 placeholder containing a small
142 description of the target will be rendered from the plugin information.
146 On typing, the autocompletion must be enabled.
150 On C<Enter>, the search should redirect to an appropriate listing of matching
153 If only one item matches the result, the plugin should instead redirect
154 directly to the matched item.
158 Search terms should accept the broadest possible matching, and if possible with
163 In case nothing is found, a visual indicator should be given, but no actual
164 redirect should occur.
168 Each search must check rights and must not present a backdoor into data that
169 the user should not see.
173 By design the search must not try to guess C<exact matches>.
179 The full interface is described in L<SL::Controller::TopQuickSeach::Base>
184 * searches for orders, customers, vendors
192 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>