1 package Maypole::View::Base;
4 use UNIVERSAL::moniker;
6 use Maypole::Constants;
9 sub new { bless {}, shift } # By default, do nothing.
12 my ( $self, $r ) = @_;
13 my $root = $r->config->template_root || $r->get_template_root;
14 if(ref($root) ne 'ARRAY') {
18 foreach my $path (@$root) {
23 && File::Spec->catdir( $path, $r->model_class->table )
26 push(@output, File::Spec->catdir( $path, "custom" ));
27 push(@output, File::Spec->catdir( $path, "factory" ));
37 my ( $self, $r ) = @_;
38 my $class = $r->model_class;
39 my $base = $r->config->uri_base;
43 objects => $r->objects,
48 $args{object} = $r->object if ($r->can('object'));
51 my $classmeta = $r->template_args->{classmetadata} ||= {};
52 $classmeta->{name} ||= $class;
53 $classmeta->{table} ||= $class->table;
54 $classmeta->{columns} ||= [ $class->display_columns ];
55 $classmeta->{list_columns} ||= [ $class->list_columns ];
56 $classmeta->{colnames} ||= { $class->column_names };
57 $classmeta->{related_accessors} ||= [ $class->related($r) ];
58 $classmeta->{moniker} ||= $class->moniker;
59 $classmeta->{plural} ||= $class->plural_moniker;
60 $classmeta->{cgi} ||= { $class->to_cgi } if ($r->build_form_elements);
61 $classmeta->{stringify_column} ||= $class->stringify_column;
63 # User-friendliness facility for custom template writers.
64 if ( @{ $r->objects || [] } > 1 ) {
65 $args{ $r->model_class->plural_moniker } = $r->objects;
68 ( $args{ $r->model_class->moniker } ) = @{ $r->objects || [] };
73 %args = ( %args, %{ $r->template_args || {} } );
78 my ( $self, $r ) = @_;
79 my $status = $self->template($r);
80 return $self->error($r) if $status != OK;
85 my ( $self, $r, $desc ) = @_;
86 $desc = $desc ? "$desc: " : "";
87 if ( $r->{error} =~ /not found$/ ) {
88 warn "template not found error : ", $r->{error};
89 # This is a rough test to see whether or not we're a template or
91 return -1 unless @{ $r->{objects} || [] };
93 my $template_error = $r->{error};
95 <h1> Template not found </h1>
97 A template was not found while processing the following request:
99 <strong>@{[$r->{action}]}</strong> on table
100 <strong>@{[ $r->{table} ]}</strong> with objects:
103 @{[join "\n", @{$r->{objects}}]}
107 The main template is <strong>@{[$r->{template}]}</strong>.
108 The template subsystem's error message was
115 @{[ join "\n", $self->paths($r) ]}
118 $r->{content_type} = "text/html";
119 $r->{output} = $r->{error};
125 sub template { die shift() . " didn't define a decent template method!" }
132 Maypole::View::Base - Base class for view classes
136 This is the base class for Maypole view classes. This is an abstract class
137 that defines the interface, and can't be used directly.
141 This is the entry point for the view. It templates the request and returns a
142 C<Maypole::Constant> indicate success or failure for the view phase.
144 Anyone subclassing this for a different rendering mechanism needs to provide
145 the following methods:
149 In this method you do the actual processing of your template. it should use
150 L<paths> to search for components, and provide the templates with easy access
151 to the contents of L<vars>. It should put the result in C<$r-E<gt>output> and
152 return C<OK> if processing was sucessfull, or populate C<$r-E<gt>error> and
153 return C<ERROR> if it fails.
155 =head1 Other overrides
157 Additionally, individual derived model classes may want to override the
161 The default constructor does nothing. You can override this to perform actions
162 during view initialization.
166 Returns search paths for templates. the default method returns folders for the
167 model class's C<moniker>, factory, custom under the configured template root.
171 returns a hash of data the template should have access to. The default one
172 populates classmetadata if there is a table class, as well as setting the data
173 objects by name if there is one or more objects available.