0a33902af5dc1774aa359a36183b451b47511646
[kivitendo-erp.git] / SL / DB / Helper / Presenter.pm
1 package SL::DB::Helper::Presenter;
2
3 use strict;
4
5 sub new {
6   # lightweight: 0: class, 1: object
7   bless [ $_[1], $_[2] ], $_[0];
8 }
9
10 sub AUTOLOAD {
11   our $AUTOLOAD;
12
13   my ($self, @args) = @_;
14
15   my $method = $AUTOLOAD;
16   $method    =~ s/.*:://;
17
18   return if $method eq 'DESTROY';
19
20   eval "require $self->[0]";
21
22   if (my $sub = $self->[0]->can($method)) {
23     return $sub->($self->[1], @args);
24   }
25 }
26
27 sub can {
28   my ($self, $method) = @_;
29   eval "require $self->[0]";
30   $self->[0]->can($method);
31 }
32
33 1;
34
35 __END__
36
37 =encoding utf-8
38
39 =head1 NAME
40
41 SL::DB::Helper::Presenter - proxy class to allow models to access presenters
42
43 =head1 SYNOPSIS
44
45   # assuming SL::Presenter::Part exists
46   # and contains a sub link_to($class, $object) {}
47   SL::DB::Part->new(%args)->presenter->link_to
48
49 =head1 DESCRIPTION
50
51 When coding controllers one often encounters objects that are not crucial to
52 the current task, but must be presented in some form to the user. Instead of
53 recreating that all the time the C<SL::Presenter> namepace was introduced to
54 hold such code.
55
56 Unfortunately the Presenter code is designed to be stateless and thus acts _on_
57 objects, but can't be instanced or wrapped. The early band-aid to that was to
58 export all sub-presenter calls into the main presenter namespace. Fixing it
59 would have meant accessing presenter functions like this:
60
61   SL::Presenter::Object->method($object, %additional_args)
62
63 which is extremely inconvenient.
64
65 This glue code allows C<SL::DB::Object> instances to access routines in their
66 presenter without additional boilerplate. C<SL::DB::Object> contains a
67 C<presenter> call for all objects, which will return an instance of this proxy
68 class. All calls on this will then be forwarded to the appropriate presenter.
69
70 =head1 INTERNAL STRUCTURE
71
72 The created proxy objects are lightweight blessed arrayrefs instead of the
73 usual blessed hashrefs. They only store two elements:
74
75 =over 4
76
77 =item * The presenter class
78
79 =item * The invocing object
80
81 =back
82
83 Further delegation is done with C<AUTOLOAD>.
84
85 =head1 BUGS
86
87 None yet :)
88
89 =head1 AUTHOR
90
91 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
92
93 =cut