X-Git-Url: http://wagnertech.de/gitweb/gitweb.cgi/kivitendo-erp.git/blobdiff_plain/d5cb059bfa6c56fb74bf2a89c5625cb0b442e48e..ae278b58747710a8c843a6bee9375186eafa17f7:/SL/Controller/Helper/GetModels/Base.pm

diff --git a/SL/Controller/Helper/GetModels/Base.pm b/SL/Controller/Helper/GetModels/Base.pm
index 6a9a9cda7..ee69c8316 100644
--- a/SL/Controller/Helper/GetModels/Base.pm
+++ b/SL/Controller/Helper/GetModels/Base.pm
@@ -43,3 +43,56 @@ sub is_enabled {
 }
 
 1;
+
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+SL::Controller::Helper::GetModels::Base - base class for GetModels plugins
+
+=head1 SYNOPSIS
+
+  package SL::Controller::Helper::Getmodels::...;
+  use parent 'SL::Controller::Helper::Getmodels::Base'
+
+  sub read_params { ... }
+
+  sub finalize { ... }
+
+=head1 DESCRIPTION
+
+This is a base class for plugins of the GetModels framework for controllers. It
+provides some common ground.
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item read_params
+
+This will be called when GetModels transitions to C<Init> phase.
+Make sure that you don't need anything from source after that.
+
+=item finalize
+
+This will be called when GetModels transitions to C<finalized> phase. Make sure
+that no internal state or configuration gets changed after this.
+
+=item merge_args
+
+Common function to merge the output of various callbacks.
+
+=back
+
+=head1 BUGS AND CAVEATS
+
+None yet :)
+
+=head1 AUTHOR
+
+Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
+
+=cut
+