1 package SL::Controller::Helper::GetModels;
5 use parent 'Rose::Object';
6 use SL::Controller::Helper::GetModels::Filtered;
7 use SL::Controller::Helper::GetModels::Sorted;
8 use SL::Controller::Helper::GetModels::Paginated;
10 use Scalar::Util qw(weaken);
12 use Rose::Object::MakeMethods::Generic (
13 scalar => [ qw(controller model query with_objects filtered sorted paginated finalized final_params) ],
14 'scalar --get_set_init' => [ qw(handlers source) ],
15 array => [ qw(plugins) ],
18 use constant PRIV => '__getmodelshelperpriv';
25 my %params = $self->finalize;
27 return $self->manager->get_all(%params);
31 my ($self, $plugin) = @_;
32 die 'cannot change internal state after finalize was called' if $self->finalized;
33 die 'unsupported plugin' unless $self->can($plugin) && $self->$plugin && $self->$plugin->isa('SL::Controller::Helper::GetModels::Base');
35 $self->$plugin->disabled(1);
39 my ($self, $plugin) = @_;
40 die 'cannot change internal state after finalize was called' if $self->finalized;
41 die 'unsupported plugin' unless $self->can($plugin) && $self->$plugin && $self->$plugin->isa('SL::Controller::Helper::GetModels::Base');
42 $self->$plugin->disabled(0);
45 sub is_enabled_plugin {
46 my ($self, $plugin) = @_;
47 die 'unsupported plugin' unless $self->can($plugin) && $self->$plugin && $self->$plugin->isa('SL::Controller::Helper::GetModels::Base');
48 $self->$plugin->is_enabled;
51 # TODO: get better delegation
52 sub set_report_generator_sort_options {
53 my ($self, %params) = @_;
56 $self->sorted->set_report_generator_sort_options(%params);
59 sub get_paginate_args {
61 my %params = $self->finalize;
63 $self->paginated->get_current_paginate_params(%params);
67 my ($self, %params) = @_;
70 $self->model(delete $params{model});
73 for my $plugin (qw(filtered sorted paginated)) {
74 next unless my $spec = delete $params{$plugin} // {};
75 my $plugin_class = "SL::Controller::Helper::GetModels::" . ucfirst $plugin;
76 push @plugins, $self->$plugin($plugin_class->new(%$spec, get_models => $self));
78 $self->plugins(@plugins);
80 $self->SUPER::init(%params);
82 $_->read_params for $self->plugins;
84 weaken $self->controller if $self->controller;
88 my ($self, %params) = @_;
90 return %{ $self->final_params } if $self->finalized;
92 push @{ $params{query} ||= [] }, @{ $self->query || [] };
93 push @{ $params{with_objects} ||= [] }, @{ $self->with_objects || [] };
95 %params = $_->finalize(%params) for $self->plugins;
98 $self->final_params(\%params);
103 sub register_handlers {
104 my ($self, %additional_handlers) = @_;
106 my $handlers = $self->handlers;
107 map { push @{ $handlers->{$_} }, $additional_handlers{$_} if $additional_handlers{$_} } keys %$handlers;
111 sub get_models_url_params {
112 my ($class, $sub_name_or_code) = @_;
114 my $code = (ref($sub_name_or_code) || '') eq 'CODE' ? $sub_name_or_code : sub { shift->$sub_name_or_code(@_) };
116 my ($self, %params) = @_;
117 my @additional_params = $code->($self);
120 (scalar(@additional_params) == 1) && (ref($additional_params[0]) eq 'HASH') ? %{ $additional_params[0] } : @additional_params,
124 push @{ _registered_handlers($class)->{callback} }, $callback;
128 my ($self, %override_params) = @_;
130 my %default_params = $self->_run_handlers('callback', action => $self->controller->action_name);
132 return $self->controller->url_for(%default_params, %override_params);
136 die "No 'model' to work on" unless $_[0]->model;
137 "SL::DB::Manager::" . $_[0]->model;
141 # private/internal functions
145 my ($self, $handler_type, %params) = @_;
147 foreach my $sub (@{ $self->handlers->{$handler_type} }) {
148 if (ref $sub eq 'CODE') {
149 %params = $sub->($self, %params);
150 } elsif ($self->can($sub)) {
151 %params = $self->$sub(%params);
153 die "SL::Controller::Helper::GetModels::get_callback: Cannot call $sub on " . ref($self) . ")";
179 SL::Controller::Helper::GetModels - Base mixin for controller helpers
180 dealing with semi-automatic handling of sorting and paginating lists
184 For a proper synopsis see L<SL::Controller::Helper::Sorted>.
188 For a generic overview see L<SL::Controller::Helper::Sorted>.
190 This base module is the interface between a controller and specialized
191 helper modules that handle things like sorting and paginating. The
192 specialized helpers register themselves with this module via a call to
193 L<register_get_models_handlers> during compilation time (e.g. in the
194 case of C<Sorted> this happens when the controller calls
195 L<SL::Controller::Helper::Sorted::make_sorted>).
197 A controller will later usually call the L<get_models>
198 function. Templates will call the L<get_callback> function. Both
199 functions run the registered handlers handing over control to the
200 specialized helpers so that they may inject their parameters into the
203 The C<GetModels> helper hooks into the controller call to the action
204 via a C<run_before> hook. This is done so that it can remember the
205 action called by the user. This is used for constructing the callback
208 =head1 PACKAGE FUNCTIONS
212 =item C<get_models_url_params $class, $sub>
214 Register one of the controller's subs to be called whenever an URL has
215 to be generated (e.g. for sort and pagination links). This is a way
216 for the controller to add additional parameters to the URL (e.g. for
219 The C<$sub> parameter can be either a code reference or the name of
220 one of the controller's functions.
222 The value returned by this C<$sub> must be either a single hash
223 reference or a hash of key/value pairs to add to the URL.
225 =item C<register_get_models_handlers $class, %handlers>
227 This function should only be called from other controller helpers like
228 C<Sorted> or C<Paginated>. It is not exported and must therefore be
229 called its full name. The first parameter C<$class> must be the actual
230 controller's class name.
232 If C<%handlers> contains a key C<ONLY> then it is passed to the hook
233 registration in L<SL::Controller::Base::run_before>.
235 The C<%handlers> register callback functions in the specialized
236 controller helpers that are called during invocation of
237 L<get_callback> or L<get_models>. Possible keys are C<callback> and
240 Each handler (the value in the hash) can be either a code reference
241 (in which case it is called directly) or the name of an instance
242 function callable on a controller instance. In both cases the handler
243 receives a hash of parameters built during this very call to
244 L<get_callback> or L<get_models> respectively. The handler's return
245 value must be the new hash to be used in calls to further handlers and
246 to the actual database model functions later on.
250 =head1 INSTANCE FUNCTIONS
254 =item C<get_callback [%params]>
256 Return an URL suitable for use as a callback parameter. It maps to the
257 current controller and action. All registered handlers of type
258 'callback' (e.g. the ones by C<Sorted> and C<Paginated>) can inject
259 the parameters they need so that the same list view as is currently
260 visible can be re-rendered.
262 Optional C<%params> passed to this function may override any parameter
263 set by the registered handlers.
265 =item C<get_models [%params]>
267 Query the model manager via C<get_all> and return its result. The
268 parameters to C<get_all> are constructed by calling all registered
269 handlers of type 'models' (e.g. the ones by C<Sorted> and
272 Optional C<%params> passed to this function may override any parameter
273 set by the registered handlers.
275 The return value is the an array reference of C<Rose> models.
285 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>