applied patch for rt 13447

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

diff --git a/lib/Maypole/View/Base.pm b/lib/Maypole/View/Base.pm
index b577364ada5c80511ecb8e7bda4a3b6ca47de072..a3d9466562b574b722bf96d7ee05a044087f3725 100644 (file)
--- a/lib/Maypole/View/Base.pm
+++ b/lib/Maypole/View/Base.pm
@@ -3,23 +3,34 @@ use File::Spec;
 use UNIVERSAL::moniker;
 use strict;
 use Maypole::Constants;
+use Carp;
 
 sub new { bless {}, shift }    # By default, do nothing.
 
 sub paths {
     my ( $self, $r ) = @_;
     my $root = $r->config->template_root || $r->get_template_root;
-    return (
-        $root,
-        (
-            $r->model_class
-              && File::Spec->catdir( $root, $r->model_class->moniker )
-        ),
-        File::Spec->catdir( $root, "custom" ),
-        File::Spec->catdir( $root, "factory" )
-    );
+    if(ref($root) ne 'ARRAY') {
+       $root = [ $root ];
+    }
+    my @output = ();
+    foreach my $path (@$root) {
+       push(@output, $path);
+       push(@output,
+            (
+              $r->model_class
+             && File::Spec->catdir( $path, $r->model_class->moniker )
+             )
+            );
+       push(@output, File::Spec->catdir( $path, "custom" ));
+       push(@output, File::Spec->catdir( $path, "factory" ));
+    }
+    return @output;
 }
 
+
+
+
 sub vars {
     my ( $self, $r ) = @_;
     my $class = $r->model_class;
@@ -34,16 +45,16 @@ sub vars {
           # ...
     );
     if ($class) {
-        $args{classmetadata} = {
-            name              => $class,
-            table             => $class->table,
-            columns           => [ $class->display_columns ],
-            colnames          => { $class->column_names },
-            related_accessors => [ $class->related($r) ],
-            moniker           => $class->moniker,
-            plural            => $class->plural_moniker,
-            cgi               => { $class->to_cgi },
-        };
+        my $classmeta = $r->template_args->{classmetadata} ||= {};
+        $classmeta->{name}              ||= $class;
+        $classmeta->{table}             ||= $class->table;
+        $classmeta->{columns}           ||= [ $class->display_columns ];
+        $classmeta->{list_columns}      ||= [ $class->list_columns ];
+        $classmeta->{colnames}          ||= { $class->column_names };
+        $classmeta->{related_accessors} ||= [ $class->related($r) ];
+        $classmeta->{moniker}           ||= $class->moniker;
+        $classmeta->{plural}            ||= $class->plural_moniker;
+        $classmeta->{cgi}               ||= { $class->to_cgi };
 
         # User-friendliness facility for custom template writers.
         if ( @{ $r->objects || [] } > 1 ) {
@@ -55,7 +66,7 @@ sub vars {
     }
 
     # Overrides
-    %args = ( %args, %{ $r->{template_args} || {} } );
+    %args = ( %args, %{ $r->template_args || {} } );
     %args;
 }
 
@@ -69,8 +80,9 @@ sub process {
 }
 
 sub error {
-    my ( $self, $r ) = @_;
-    warn $r->{error};
+    my ( $self, $r, $desc ) = @_;
+    $desc = $desc ? "$desc: " : "";
+    carp $desc . $r->{error};
     if ( $r->{error} =~ /not found$/ ) {
 
         # This is a rough test to see whether or not we're a template or
@@ -108,3 +120,54 @@ EOF
 sub template { die shift() . " didn't define a decent template method!" }
 
 1;
+
+
+=head1 NAME
+
+Maypole::View::Base - Base class for view classes
+
+=head1 DESCRIPTION
+
+This is the base class for Maypole view classes. This is an abstract class
+that defines the interface, and can't be used directly.
+
+=head2 process
+
+This is the entry point for the view. It templates the request and returns a
+C<Maypole::Constant> indicate success or failure for the view phase.
+
+Anyone subclassing this for a different rendering 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 C<$r-E<gt>output> and
+return C<OK> if processing was sucessfull, or populate C<$r-E<gt>error> and
+return C<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 folders for the
+model class's C<moniker>, factory, custom 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 table class, as well as setting the data
+objects by name if there is one or more objects available.
+
+=head2 error
+
+
+=cut