X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FController%2FHelper%2FGetModels%2FFiltered.pm;h=642d542a00f78f63a4e65c5beababe2c84b2b1c5;hb=5534d9cb025cc4036f6fcce28a24c5e5b164641e;hp=66dd9f6fc9d9b313668f4b44b421933f98e25382;hpb=9e9d719583e142c73486dc7627bc893a55e01311;p=kivitendo-erp.git diff --git a/SL/Controller/Helper/GetModels/Filtered.pm b/SL/Controller/Helper/GetModels/Filtered.pm index 66dd9f6fc..642d542a0 100644 --- a/SL/Controller/Helper/GetModels/Filtered.pm +++ b/SL/Controller/Helper/GetModels/Filtered.pm @@ -8,7 +8,7 @@ use SL::Controller::Helper::ParseFilter (); use List::MoreUtils qw(uniq); use Rose::Object::MakeMethods::Generic ( - scalar => [ qw(filter_args filter_params orig_filter) ], + scalar => [ qw(filter_args filter_params orig_filter filter) ], 'scalar --get_set_init' => [ qw(form_params launder_to) ], ); @@ -31,7 +31,7 @@ sub read_params { return %{ $self->filter_params } if $self->filter_params; my $source = $self->get_models->source; - my $filter = $params{filter} // $source->{ $self->form_params } // {}; + my $filter = $self->filter // $source->{ $self->form_params } // {}; $self->orig_filter($filter); my %filter_args = $self->_get_filter_args; @@ -122,126 +122,77 @@ __END__ =head1 NAME -SL::Controller::Helper::Filtered - A helper for semi-automatic handling -of filtered lists of database models in a controller +SL::Controller::Helper::GetModels::Filtered - Filter handling plugin for GetModels =head1 SYNOPSIS In a controller: - use SL::Controller::Helper::GetModels; - use SL::Controller::Helper::Filtered; - - __PACKAGE__->make_filter( - MODEL => 'Part', - ONLY => [ qw(list) ], - FORM_PARAMS => [ qw(filter) ], - ); + SL::Controller::Helper::GetModels->new( + ... + filtered => { + filter => HASHREF, + launder_to => HASHREF | SUBNAME | '__INPLACE__', + } - sub action_list { - my ($self) = @_; - - my $filtered_models = $self->get_models(%addition_filters); - $self->render('controller/list', ENTRIES => $filtered_models); - } + OR + filtered => 0, + ); =head1 OVERVIEW -This helper module enables use of the L -methods in conjunction with the L style of -plugins. Additional filters can be defined in the database models and filtering -can be reduced to a minimum of work. - -This plugin can be combined with L and -L for filtered, sorted and paginated lists. - -The controller has to provive information where to look for filter information -at compile time. This call is L. +This C plugin enables use of the +L methods. Additional filters can be +defined in the database models and filtering can be reduced to a minimum of +work. The underlying functionality that enables the use of more than just the paginate helper is provided by the controller helper -C. See the documentation for L for +C. See the documentation for L for more information on it. -=head1 PACKAGE FUNCTIONS +=head1 OPTIONS =over 4 -=item C - -This function must be called by a controller at compile time. It is -uesd to set the various parameters required for this helper to do its -magic. - -Careful: If you want to use this in conjunction with -L, you need to call C first, -or the paginating will not get all the relevant information to estimate the -number of pages correctly. To ensure this does not happen, this module will -croak when it detects such a scenario. - -The hash C<%filter_spec> can include the following parameters: - -=over 4 +=item * C -=item * C +Optional. Indicates a key in C to be used as filter. -Optional. A string: the name of the Rose database model that is used -as a default in certain cases. If this parameter is missing then it is -derived from the controller's package (e.g. for the controller -C the C would default to -C). +Defaults to the value C if missing. -=item * C +=item * C -Optional. Indicates a key in C<$::form> to be used as filter. - -Defaults to the values C if missing. - -=item * C - -Option. Indicates a target for laundered filter arguments in the controller. +Optional. Indicates a target for laundered filter arguments in the controller. Can be set to C to disable laundering, and can be set to method named or hash keys of the controller. In the latter case the laundered structure will be put there. -Defaults to inplace laundering which is not normally settable. +Defaults to the controller. Laundered values will end up in C for +template purposes. -=item * C - -Optional. An array reference containing a list of action names for -which the paginate parameters should be saved. If missing or empty then -all actions invoked on the controller are monitored. - -=back +Setting this to the special value C<__INPLACE__> will cause inplace laundering. =back -=head1 INSTANCE FUNCTIONS +=head1 FILTER FORMAT -These functions are called on a controller instance. +See L for a description of the filter format. -=over 4 +=head1 CUSTOM FILTERS -=item C +C will honor custom filters defined in RDBO managers. See +L for an explanation fo those. -Returns a hash to be used in manager C calls or to be passed on to -GetModels. Will only work if the get_models chain has been called at least -once, because only then the full parameters can get parsed and stored. Will -croak otherwise. +=head1 BUGS -=item C +=over 4 -Disable filtering for the duration of the current action. Can be used -when using the attribute C to L does not -cover all cases. +=item * There is currently no easy way to filter for CVars. =back -=head1 BUGS - -Nothing here yet. - =head1 AUTHOR Sven Schöling Es.schoeling@linet-services.deE