Merge branch 'b-3.6.1' of ../kivitendo-erp_20220811

[kivitendo-erp.git] / SL / Presenter / FileObject.pm

diff --git a/SL/Presenter/FileObject.pm b/SL/Presenter/FileObject.pm
new file mode 100644 (file)
index 0000000..a339f94
--- /dev/null
+++ b/SL/Presenter/FileObject.pm
@@ -0,0 +1,78 @@
+package SL::Presenter::FileObject;
+
+use strict;
+
+use SL::Presenter::Tag         qw(link_tag);
+use SL::Presenter::EscapedText qw(escape is_escaped);
+
+use Exporter qw(import);
+our @EXPORT_OK = qw(file_object);
+
+use Carp;
+
+sub file_object {
+  my ($file_object, %params) = @_;
+
+
+  my $text = escape($file_object->file_name);
+  if (! delete $params{no_link}) {
+    my $href  = 'controller.pl?action=File/download&id=' . $file_object->id;
+    $href    .= '&version=' . $file_object->version if $file_object->version;
+    $text     = link_tag($href, $text, %params);
+  }
+
+  is_escaped($text);
+}
+
+1;
+
+
+__END__
+
+=pod
+
+=encoding utf8
+
+=head1 NAME
+
+SL::Presenter::FileObject - Presenter module for SL::File::Object(s), the
+file objects of the filemanagement. (Note, that this are not instances of
+SL::DB::File)
+
+=head1 SYNOPSIS
+
+  my $file_object = SL::File->get(id => 1);
+  my $html        = SL::Presenter::FileObject::file_object($file_object, no_link => 1);
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C<file_object $file_object, %params>
+
+Returns a rendered version (actually an instance of
+L<SL::Presenter::EscapedText>) of the file object
+C<$file_object>.
+
+C<%params> can include:
+
+=over 2
+
+=item * no_link
+
+If falsish (the default) then the file name of the object will be linked
+to the "download action" for that file.
+
+=back
+
+=back
+
+=head1 BUGS
+
+Nothing here yet.
+
+=head1 AUTHOR
+
+Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>
+
+=cut