All POD::Coverage tests now succeed.

[maypole.git] / lib / Maypole / View / Base.pm

diff --git a/lib/Maypole/View/Base.pm b/lib/Maypole/View/Base.pm
index e7bf29953e4c27a4bffd56464a89ed1c79408767..95c8d9dd09f9e3b6bf6270304d4c6995b7f7d38a 100644 (file)
--- a/lib/Maypole/View/Base.pm
+++ b/lib/Maypole/View/Base.pm
@@ -109,3 +109,53 @@ EOF
 sub template { die shift() . " didn't define a decent template method!" }
 
 1;
+
+
+=head1 NAME
+
+Maypole::View::Base - Base cl
+
+=head1 DESCRIPTION
+
+This is the base class for Maypole view classes. This is an abstract class
+meant to define the interface, and can't be used directly.
+
+=head2 process
+
+This is the engine of this module. It populates all the relevant variables
+and calls the requested action.
+
+Anyone subclassing this for a different database abstraction mechanism
+needs to provide the following methods:
+
+=head2 template 
+
+In this method you do the actual processing of your template. it should use L<paths> 
+to search for components, and provide the templates with easy access to the contents
+of L<vars>. It should put the result in $r->{output} and return OK if processing was
+sucessfull, or populate $r->{error} and return ERROR if it fails.
+
+=head1 Other overrides
+
+Additionally, individual derived model classes may want to override the
+
+=head2 new
+
+The default constructor does nothing. You can override this to perform actions
+during view initialization.
+
+=head2 paths
+
+Returns search paths for templates. the default method returns factory, custom and
+<tablename> under the configured template root.
+
+=head2 vars
+
+returns a hash of data the template should have access to. The default one populates
+classmetadata if there is a class, as well as setting the data objects by name if 
+there is one or more objects available.
+
+=head2 error
+
+
+=cut