1 package Maypole::View::Base;
3 use UNIVERSAL::moniker;
5 use Maypole::Constants;
7 sub new { bless {}, shift } # By default, do nothing.
10 my ( $self, $r ) = @_;
11 my $root = $r->config->template_root || $r->get_template_root;
16 && File::Spec->catdir( $root, $r->model_class->moniker )
18 File::Spec->catdir( $root, "custom" ),
19 File::Spec->catdir( $root, "factory" )
24 my ( $self, $r ) = @_;
25 my $class = $r->model_class;
26 my $base = $r->config->uri_base;
30 objects => $r->objects,
37 my $classmeta = $args{classmetadata} ||= {};
38 $classmeta->{name} ||= $class;
39 $classmeta->{description} ||= $class->description;
40 $classmeta->{table} ||= $class->table;
41 $classmeta->{columns} ||= [ $class->display_columns ];
42 $classmeta->{list_columns} ||= [ $class->list_columns ];
43 $classmeta->{colnames} ||= { $class->column_names };
44 $classmeta->{related_accessors} ||= [ $class->related($r) ];
45 $classmeta->{moniker} ||= $class->moniker;
46 $classmeta->{plural} ||= $class->plural_moniker;
47 $classmeta->{cgi} ||= { $class->to_cgi };
49 # User-friendliness facility for custom template writers.
50 if ( @{ $r->objects || [] } > 1 ) {
51 $args{ $r->model_class->plural_moniker } = $r->objects;
54 ( $args{ $r->model_class->moniker } ) = @{ $r->objects || [] };
59 local $r->{template_args} = $r->{template_args};
60 delete $r->{template_args}{classmetadata}; # already overrides
61 %args = ( %args, %{ $r->{template_args} || {} } );
66 my ( $self, $r ) = @_;
67 $r->{content_type} ||= "text/html";
68 $r->{document_encoding} ||= "utf-8";
69 my $status = $self->template($r);
70 return $self->error($r) if $status != OK;
75 my ( $self, $r, $desc ) = @_;
76 $desc = $desc ? "$desc: " : "";
77 warn $desc . $r->{error} ."\n";
78 if ( $r->{error} =~ /not found$/ ) {
80 # This is a rough test to see whether or not we're a template or
82 return -1 unless @{ $r->{objects} || [] };
86 <H1> Template not found </H1>
88 This template was not found while processing the following request:
90 <B>@{[$r->{action}]}</B> on table <B>@{[ $r->{table} ]}</B> with objects:
93 @{[join "\n", @{$r->{objects}}]}
96 Looking for template <B>@{[$r->{template}]}</B> in paths:
99 @{[ join "\n", $self->paths($r) ]}
102 $r->{content_type} = "text/html";
103 $r->{output} = $r->{error};
106 $r->{content_type} = "text/plain";
107 $r->{output} = $r->{error};
112 sub template { die shift() . " didn't define a decent template method!" }
119 Maypole::View::Base - Base cl
123 This is the base class for Maypole view classes. This is an abstract class
124 meant to define the interface, and can't be used directly.
128 This is the engine of this module. It populates all the relevant variables
129 and calls the requested action.
131 Anyone subclassing this for a different database abstraction mechanism
132 needs to provide the following methods:
136 In this method you do the actual processing of your template. it should use L<paths>
137 to search for components, and provide the templates with easy access to the contents
138 of L<vars>. It should put the result in $r->{output} and return OK if processing was
139 sucessfull, or populate $r->{error} and return ERROR if it fails.
141 =head1 Other overrides
143 Additionally, individual derived model classes may want to override the
147 The default constructor does nothing. You can override this to perform actions
148 during view initialization.
152 Returns search paths for templates. the default method returns factory, custom and
153 <tablename> under the configured template root.
157 returns a hash of data the template should have access to. The default one populates
158 classmetadata if there is a class, as well as setting the data objects by name if
159 there is one or more objects available.