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::SalesQuotation',
21 'SL::Controller::TopQuickSearch::SalesOrder',
22 'SL::Controller::TopQuickSearch::RequestForQuotation',
23 'SL::Controller::TopQuickSearch::PurchaseOrder',
24 'SL::Controller::TopQuickSearch::GLTransaction',
28 sub action_query_autocomplete {
31 my $hashes = $self->module->query_autocomplete;
33 $self->render(\ SL::JSON::to_json($hashes), { layout => 0, type => 'json', process => 0 });
36 sub action_select_autocomplete {
39 my $redirect_url = $self->module->select_autocomplete;
41 $self->js->redirect_to($redirect_url)->render;
44 sub action_do_search {
47 my $redirect_url = $self->module->do_search;
50 $self->js->redirect_to($redirect_url)
56 sub available_modules {
59 $self->require_modules;
61 map { $_->new } @available_modules;
65 my %enabled_names = map {
67 } @{ $::instance_conf->get_quick_search_modules };
70 $enabled_names{$_->name}
71 } $_[0]->available_modules
76 $::auth->assert($_->auth, 1)
77 } $_[0]->enabled_modules
83 $self->require_modules;
85 die 'Need module' unless $::form->{module};
87 die 'Unknown module ' . $::form->{module} unless my $class = $modules_by_name{$::form->{module}};
89 $::auth->assert($class->auth);
95 SL::ClientJS->new(controller => $_[0])
101 if (!$self->{__modules_required}) {
102 for my $class (@available_modules) {
103 eval "require $class" or die $@;
104 $modules_by_name{ $class->name } = $class;
106 $self->{__modules_required} = 1;
118 SL::Controller::TopQuickSearch - Framework for pluggable quicksearch fields in the layout top header.
122 use SL::Controller::TopQuickSearch;
123 my $search = SL::Controller::TopQuickSearch->new;
124 $::request->layout->add_javascripts('kivi.QuickSearch.js');
127 [%- FOREACH module = search.enabled_modules %]
128 <input type='text' id='top-search-[% module.name %]'>
133 This controller provides abstraction for different search plugins, and ensures
134 that all follow a common useability scheme.
136 Modules should be configurable per user, but currently are not. Disabling
137 modules can be done by removing them from available_modules or in client_config.
139 =head1 BEHAVIOUR REQUIREMENTS
145 A single text input field with the html5 placeholder containing a small
146 description of the target will be rendered from the plugin information.
150 On typing, the autocompletion must be enabled.
154 On C<Enter>, the search should redirect to an appropriate listing of matching
157 If only one item matches the result, the plugin should instead redirect
158 directly to the matched item.
162 Search terms should accept the broadest possible matching, and if possible with
167 In case nothing is found, a visual indicator should be given, but no actual
168 redirect should occur.
172 Each search must check rights and must not present a backdoor into data that
173 the user should not see.
177 By design the search must not try to guess C<exact matches>.
183 The full interface is described in L<SL::Controller::TopQuickSeach::Base>
188 * searches for orders, customers, vendors
196 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>