use Carp;
use Template;
-use SL::Presenter::CustomerVendor;
-use SL::Presenter::DeliveryOrder;
-use SL::Presenter::EscapedText;
-use SL::Presenter::Invoice;
-use SL::Presenter::Order;
-use SL::Presenter::Project;
-use SL::Presenter::Record;
+use SL::Presenter::EscapedText qw(is_escaped);
+
+use Rose::Object::MakeMethods::Generic (
+ scalar => [ qw(need_reinit_widgets) ],
+);
sub get {
return $::request->presenter;
}
# Only certain types are supported.
- croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json)$/;
+ croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json|text)$/;
# The "template" argument must be a string or a reference to one.
+ $template = ${ $template } if ((ref($template) || '') eq 'REF') && (ref(${ $template }) eq 'SL::Presenter::EscapedText');
croak "Unsupported 'template' reference type: " . ref($template) if ref($template) && (ref($template) !~ m/^(?:SCALAR|SL::Presenter::EscapedText)$/);
# Look for the file given by $template if $template is not a reference.
my $source;
if (!ref $template) {
- $source = "templates/webpages/${template}." . $options->{type};
+ my $webpages_path = $::request->layout->webpages_path;
+
+ my $ext = $options->{type} eq 'text' ? 'txt' : $options->{type};
+ $source = "${webpages_path}/${template}.${ext}";
croak "Template file ${source} not found" unless -f $source;
} elsif (ref($template) eq 'SCALAR') {
# If no processing is requested then return the content.
if (!$options->{process}) {
# If $template is a reference then don't try to read a file.
- return SL::Presenter::EscapedText->new(text => ${ $template }, is_escaped => 1) if ref $template;
+ my $ref = ref $template;
+ return $template if $ref eq 'SL::Presenter::EscapedText';
+ return is_escaped(${ $template }) if $ref eq 'SCALAR';
# Otherwise return the file's content.
my $file = IO::File->new($source, "r") || croak("Template file ${source} could not be read");
my $content = do { local $/ = ''; <$file> };
$file->close;
- return SL::Presenter::EscapedText->new(text => $content, is_escaped => 1);
+ return is_escaped($content);
}
# Processing was requested. Set up all variables.
my $parser = $self->get_template;
$parser->process($source, \%params, \$output) || croak $parser->error;
- return SL::Presenter::EscapedText->new(text => $output, is_escaped => 1);
+ return is_escaped($output);
}
sub get_template {
my ($self) = @_;
+ my $webpages_path = $::request->layout->webpages_path;
+
+ # Make locales.pl parse generic/exception.html, too:
+ # $::form->parse_html_template("generic/exception")
$self->{template} ||=
Template->new({ INTERPOLATE => 0,
EVAL_PERL => 0,
ABSOLUTE => 1,
CACHE_SIZE => 0,
PLUGIN_BASE => 'SL::Template::Plugin',
- INCLUDE_PATH => '.:templates/webpages',
+ INCLUDE_PATH => ".:$webpages_path",
COMPILE_EXT => '.tcc',
COMPILE_DIR => $::lx_office_conf{paths}->{userspath} . '/templates-cache',
- ERROR => 'templates/webpages/generic/exception.html',
+ ERROR => "${webpages_path}/generic/exception.html",
+ ENCODING => 'utf8',
}) || croak;
return $self->{template};
}
-sub escape {
- my ($self, $text) = @_;
-
- return SL::Presenter::EscapedText->new(text => $text);
-}
-
-sub escaped_text {
- my ($self, $text) = @_;
-
- return SL::Presenter::EscapedText->new(text => $text, is_escaped => 1);
-}
-
1;
__END__
# Higher-level rendering of certain objects:
use SL::DB::Customer;
- my $linked_customer_name = $presenter->customer($customer, display => 'table-cell');
+ my $linked_customer_name = $customer->presenter->customer(display => 'table-cell');
# Render a list of links to sales/purchase records:
use SL::DB::Order;
+ use SL::Presenter::Record qw(grouped_record_list);
my $quotation = SL::DB::Manager::Order->get_first(where => { quotation => 1 });
my $records = $quotation->linked_records(direction => 'to');
- my $html = $presenter->grouped_record_list($records);
+ my $html = grouped_record_list($records);
=head1 CLASS FUNCTIONS
scalar's content is used as the content to process. The C<type> option
is not considered in this case.
+C<$template> can also be an instance of L<SL::Presenter::EscapedText>
+or a reference to such an instance. Both of these cases are handled
+the same way as if C<$template> were a reference to a scalar: its
+content is processed, and C<type> is not considered.
+
Other reference types, unknown options and unknown arguments to the
C<type> option cause the function to L<croak>.
=item C<type>
-The template type. Can be C<html> (the default), C<js> for JavaScript
-or C<json> for JSON content. Affects only the extension that's added
-to the file name given with a non-reference C<$template> argument.
+The template type. Can be C<html> (the default), C<js> for JavaScript,
+C<json> for JSON and C<text> for plain text content. Affects only the
+extension that's added to the file name given with a non-reference
+C<$template> argument.
=item C<process>
=item * C<AUTH> -- C<$::auth>
+=item * C<FLASH> -- the flash instance (C<$::form-E<gt>{FLASH}>)
+
=item * C<FORM> -- C<$::form>
+=item * C<INSTANCE_CONF> -- C<$::instance_conf>
+
=item * C<LOCALE> -- C<$::locale>
=item * C<LXCONFIG> -- all parameters from C<config/kivitendo.conf>
with the same name they appear in the file (first level is the
-section, second the actual variable, e.g. C<system.dbcharset>,
+section, second the actual variable, e.g. C<system.language>,
C<features.webdav> etc)
=item * C<LXDEBUG> -- C<$::lxdebug>
=item * C<SELF> -- the controller instance
+=item * C<PRESENTER> -- the presenter instance the template is
+rendered with
+
=item * All items from C<%locals>
=back
{ type => 'json', process => 0 }
);
-=item C<escape $text>
-
-Returns an HTML-escaped version of C<$text>. Instead of a string an
-instance of the thin proxy-object L<SL::Presenter::EscapedText> is
-returned.
-
-It is safe to call C<escape> on an instance of
-L<SL::Presenter::EscapedText>. This is a no-op (the same instance will
-be returned).
-
-=item C<escaped_text $text>
-
-Returns an instance of L<SL::Presenter::EscapedText>. C<$text> is
-assumed to be a string that has already been HTML-escaped.
-
-It is safe to call C<escaped_text> on an instance of
-L<SL::Presenter::EscapedText>. This is a no-op (the same instance will
-be returned).
-
=item C<get_template>
Returns the global instance of L<Template> and creates it if it