1 package SL::Controller::Helper::GetModels;
5 use Exporter qw(import);
6 our @EXPORT = qw(get_models_url_params get_callback get_models);
8 use constant PRIV => '__getmodelshelperpriv';
10 my $registered_handlers = {};
12 sub register_get_models_handlers {
13 my ($class, %additional_handlers) = @_;
15 my $only = delete($additional_handlers{ONLY}) || [];
16 $only = [ $only ] if !ref $only;
17 my %hook_params = @{ $only } ? ( only => $only ) : ();
19 $class->run_before(sub { $_[0]->{PRIV()} = { current_action => $_[1] }; }, %hook_params);
21 my $handlers = _registered_handlers($class);
22 map { push @{ $handlers->{$_} }, $additional_handlers{$_} if $additional_handlers{$_} } keys %$handlers;
25 sub get_models_url_params {
26 my ($class, $sub_name_or_code) = @_;
28 my $code = (ref($sub_name_or_code) || '') eq 'CODE' ? $sub_name_or_code : sub { shift->$sub_name_or_code(@_) };
30 my ($self, %params) = @_;
31 my @additional_params = $code->($self);
34 (scalar(@additional_params) == 1) && (ref($additional_params[0]) eq 'HASH') ? %{ $additional_params[0] } : @additional_params,
38 push @{ _registered_handlers($class)->{callback} }, $callback;
42 my ($self, %override_params) = @_;
44 my %default_params = _run_handlers($self, 'callback', action => ($self->{PRIV()} || {})->{current_action});
46 return $self->url_for(%default_params, %override_params);
50 my ($self, %override_params) = @_;
52 my %params = _run_handlers($self, 'get_models', %override_params);
54 my $model = delete($params{model}) || die "No 'model' to work on";
56 return "SL::DB::Manager::${model}"->get_all(%params);
60 # private/internal functions
64 my ($self, $handler_type, %params) = @_;
66 foreach my $sub (@{ _registered_handlers(ref $self)->{$handler_type} }) {
67 if (ref $sub eq 'CODE') {
68 %params = $sub->($self, %params);
69 } elsif ($self->can($sub)) {
70 %params = $self->$sub(%params);
72 die "SL::Controller::Helper::GetModels::get_callback: Cannot call $sub on " . ref($self) . ")";
79 sub _registered_handlers {
80 $registered_handlers->{$_[0]} //= { callback => [], get_models => [] }
92 SL::Controller::Helper::GetModels - Base mixin for controller helpers
93 dealing with semi-automatic handling of sorting and paginating lists
97 For a proper synopsis see L<SL::Controller::Helper::Sorted>.
101 For a generic overview see L<SL::Controller::Helper::Sorted>.
103 This base module is the interface between a controller and specialized
104 helper modules that handle things like sorting and paginating. The
105 specialized helpers register themselves with this module via a call to
106 L<register_get_models_handlers> during compilation time (e.g. in the
107 case of C<Sorted> this happens when the controller calls
108 L<SL::Controller::Helper::Sorted::make_sorted>).
110 A controller will later usually call the L<get_models>
111 function. Templates will call the L<get_callback> function. Both
112 functions run the registered handlers handing over control to the
113 specialized helpers so that they may inject their parameters into the
116 The C<GetModels> helper hooks into the controller call to the action
117 via a C<run_before> hook. This is done so that it can remember the
118 action called by the user. This is used for constructing the callback
121 =head1 PACKAGE FUNCTIONS
125 =item C<get_models_url_params $class, $sub>
127 Register one of the controller's subs to be called whenever an URL has
128 to be generated (e.g. for sort and pagination links). This is a way
129 for the controller to add additional parameters to the URL (e.g. for
132 The C<$sub> parameter can be either a code reference or the name of
133 one of the controller's functions.
135 The value returned by this C<$sub> must be either a single hash
136 reference or a hash of key/value pairs to add to the URL.
138 =item C<register_get_models_handlers $class, %handlers>
140 This function should only be called from other controller helpers like
141 C<Sorted> or C<Paginated>. It is not exported and must therefore be
142 called its full name. The first parameter C<$class> must be the actual
143 controller's class name.
145 If C<%handlers> contains a key C<ONLY> then it is passed to the hook
146 registration in L<SL::Controller::Base::run_before>.
148 The C<%handlers> register callback functions in the specialized
149 controller helpers that are called during invocation of
150 L<get_callback> or L<get_models>. Possible keys are C<callback> and
153 Each handler (the value in the hash) can be either a code reference
154 (in which case it is called directly) or the name of an instance
155 function callable on a controller instance. In both cases the handler
156 receives a hash of parameters built during this very call to
157 L<get_callback> or L<get_models> respectively. The handler's return
158 value must be the new hash to be used in calls to further handlers and
159 to the actual database model functions later on.
163 =head1 INSTANCE FUNCTIONS
167 =item C<get_callback [%params]>
169 Return an URL suitable for use as a callback parameter. It maps to the
170 current controller and action. All registered handlers of type
171 'callback' (e.g. the ones by C<Sorted> and C<Paginated>) can inject
172 the parameters they need so that the same list view as is currently
173 visible can be re-rendered.
175 Optional C<%params> passed to this function may override any parameter
176 set by the registered handlers.
178 =item C<get_models [%params]>
180 Query the model manager via C<get_all> and return its result. The
181 parameters to C<get_all> are constructed by calling all registered
182 handlers of type 'models' (e.g. the ones by C<Sorted> and
185 Optional C<%params> passed to this function may override any parameter
186 set by the registered handlers.
188 The return value is the an array reference of C<Rose> models.
198 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>