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) {
22 && File::Spec->catdir( $path, $r->model_class->table )
25 push(@output, File::Spec->catdir( $path, "custom" ));
27 push(@output, File::Spec->catdir( $path, "factory" ));
30 return grep( $_, @output);
34 my ( $self, $r ) = @_;
35 my $class = $r->model_class;
36 my $base = $r->config->uri_base;
40 objects => $r->objects,
45 $args{object} = $r->object if ($r->can('object'));
48 my $classmeta = $r->template_args->{classmetadata} ||= {};
49 $classmeta->{name} ||= $class;
50 $classmeta->{table} ||= $class->table;
51 $classmeta->{columns} ||= [ $class->display_columns ] if ($class->can('display_columns'));
52 $classmeta->{list_columns} ||= [ $class->list_columns ] if ($class->can('list_columns'));
53 $classmeta->{colnames} ||= { $class->column_names } if ($class->can('column_names'));
54 $classmeta->{related_accessors} ||= [ $class->related($r) ];
55 $classmeta->{moniker} ||= $class->moniker;
56 $classmeta->{plural} ||= $class->plural_moniker;
57 $classmeta->{cgi} ||= { $class->to_cgi } if ($r->build_form_elements && $class->can('to_cgi'));
58 $classmeta->{stringify_column} ||= $class->stringify_column if ($class->can('stringify_column'));
60 # User-friendliness facility for custom template writers.
61 if ( @{ $r->objects || [] } > 1 ) {
62 $args{ $r->model_class->plural_moniker } = $r->objects;
65 ( $args{ $r->model_class->moniker } ) = @{ $r->objects || [] };
70 %args = ( %args, %{ $r->template_args || {} } );
75 my ( $self, $r ) = @_;
76 my $status = $self->template($r);
77 return $self->error($r) if $status != OK;
82 my ( $self, $r, $desc ) = @_;
83 $desc = $desc ? "$desc: " : "";
84 if ( $r->{error} =~ /not found$/ ) {
85 warn "template not found error : ", $r->{error};
86 # This is a rough test to see whether or not we're a template or
88 return -1 unless @{ $r->{objects} || [] };
90 my $template_error = $r->{error};
92 <h1> Template not found </h1>
94 A template was not found while processing the following request:
96 <strong>@{[$r->{action}]}</strong> on table
97 <strong>@{[ $r->{table} ]}</strong> with objects:
100 @{[join "\n", @{$r->{objects}}]}
104 The main template is <strong>@{[$r->{template}]}</strong>.
105 The template subsystem's error message was
112 @{[ join "\n", $self->paths($r) ]}
115 $r->{content_type} = "text/html";
116 $r->{output} = $r->{error};
122 sub template { die shift() . " didn't define a decent template method!" }
129 Maypole::View::Base - Base class for view classes
133 This is the base class for Maypole view classes. This is an abstract class
134 that defines the interface, and can't be used directly.
138 This is the entry point for the view. It templates the request and returns a
139 C<Maypole::Constant> indicate success or failure for the view phase.
141 Anyone subclassing this for a different rendering mechanism needs to provide
142 the following methods:
146 In this method you do the actual processing of your template. it should use
147 L<paths> to search for components, and provide the templates with easy access
148 to the contents of L<vars>. It should put the result in C<$r-E<gt>output> and
149 return C<OK> if processing was sucessfull, or populate C<$r-E<gt>error> and
150 return C<ERROR> if it fails.
152 =head1 Other overrides
154 Additionally, individual derived model classes may want to override the
158 The default constructor does nothing. You can override this to perform actions
159 during view initialization.
163 Returns search paths for templates. the default method returns folders for the
164 model class's C<moniker>, factory, custom under the configured template root.
168 returns a hash of data the template should have access to. The default one
169 populates classmetadata if there is a table class, as well as setting the data
170 objects by name if there is one or more objects available.