X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FView%2FBase.pm;h=6c6b63c5a8886dc47e85e0452e8ca79c1d5a44c2;hb=2d1409f7dd94e2292690eb03d7d62e464c1714db;hp=b577364ada5c80511ecb8e7bda4a3b6ca47de072;hpb=bd977b8f654533448f37b0dca135003d997c0190;p=maypole.git diff --git a/lib/Maypole/View/Base.pm b/lib/Maypole/View/Base.pm index b577364..6c6b63c 100644 --- a/lib/Maypole/View/Base.pm +++ b/lib/Maypole/View/Base.pm @@ -3,6 +3,7 @@ use File::Spec; use UNIVERSAL::moniker; use strict; use Maypole::Constants; +use Carp; sub new { bless {}, shift } # By default, do nothing. @@ -34,16 +35,17 @@ 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 = $args{classmetadata} ||= {}; + $classmeta->{name} ||= $class; + $classmeta->{description} ||= $class->description; + $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,6 +57,8 @@ sub vars { } # Overrides + local $r->{template_args} = $r->{template_args}; + delete $r->{template_args}{classmetadata}; # already overrides %args = ( %args, %{ $r->{template_args} || {} } ); %args; } @@ -69,8 +73,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 +113,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 +to search for components, and provide the templates with easy access to the contents +of L. 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 + 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