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