Type in Übersetzung
[kivitendo-erp.git] / SL / File / Object.pm
1 package SL::File::Object;
2
3 use strict;
4 use parent qw(Rose::Object);
5 use DateTime;
6
7 use Rose::Object::MakeMethods::Generic (
8   scalar => [ qw() ],
9   'scalar --get_set_init' => [ qw(db_file loaded id version newest) ],
10 );
11
12 #use SL::DB::Helper::Attr;
13 #__PACKAGE__->_as_timestamp('mtime');
14 # wie wird das mit dem Attr Helper gemacht damit er bei nicht DB Objekten auch geht?
15
16 sub mtime_as_timestamp_s {
17   $::locale->format_date_object($_[0]->mtime, precision => 'second');
18 }
19
20 # wrapper methods
21
22 sub itime {
23   $_[0]->loaded_db_file->itime;
24 }
25
26 sub file_name {
27   $_[0]->loaded_db_file->file_name;
28 }
29
30 sub file_type {
31   $_[0]->loaded_db_file->file_type;
32 }
33
34 sub object_type {
35   $_[0]->loaded_db_file->object_type;
36 }
37
38 sub object_id {
39   $_[0]->loaded_db_file->object_id;
40 }
41
42 sub mime_type {
43   $_[0]->loaded_db_file->mime_type;
44 }
45
46 sub file_title {
47   $_[0]->loaded_db_file->title;
48 }
49
50 sub file_description {
51   $_[0]->loaded_db_file->description;
52 }
53
54 sub backend {
55   $_[0]->loaded_db_file->backend;
56 }
57
58 sub source {
59   $_[0]->loaded_db_file->source;
60 }
61
62 # methods to go directly into the backends
63
64 sub get_file {
65   $_[0]->backend_class->get_filepath(dbfile => $_[0]->loaded_db_file, version => $_[0]->version)
66 }
67
68 sub get_content {
69   $_[0]->backend_class->get_content(dbfile => $_[0]->loaded_db_file,  version => $_[0]->version)
70 }
71
72 sub mtime {
73   $_[0]->backend_class->get_mtime(dbfile => $_[0]->loaded_db_file, version => $_[0]->version)
74 }
75
76 sub version_count {
77   $_[0]->backend_class->get_version_count(dbfile => $_[0]->loaded_db_file)
78 }
79
80 sub versions {
81   SL::File->get_all_versions(dbfile => $_[0]->loaded_db_file)
82 }
83
84 sub save_contents {
85   SL::File->save(dbfile => $_[0]->loaded_db_file, file_contents => $_[1] )
86 }
87
88 sub save_file {
89   SL::File->save(dbfile => $_[0]->loaded_db_file, file_path => $_[1] )
90 }
91
92 sub delete {
93   SL::File->delete(dbfile => $_[0]->loaded_db_file)
94 }
95
96 sub delete_last_version {
97   SL::File->delete(dbfile => $_[0]->loaded_db_file, last => 1 )
98 }
99
100 sub delete_version {
101   SL::File->delete(dbfile => $_[0]->loaded_db_file, version => $_[0]->version )
102 }
103
104 sub purge {
105   SL::File->delete(dbfile => $_[0]->loaded_db_file, all_but_notlast => 1 )
106 }
107
108 sub rename {
109   SL::File->rename(dbfile => $_[0]->loaded_db_file, to => $_[1])
110 }
111
112 # internals
113
114 sub backend_class {
115   SL::File->get_backend_class($_[0]->backend)
116 }
117
118
119 sub loaded_db_file {  # so, dass wir die nur einmal laden.
120   if (!$_[0]->loaded) {
121     $_[0]->db_file->load;
122     $_[0]->loaded(1);
123   }
124   $_[0]->db_file;
125 }
126
127
128 sub init_db_file { die 'must always have a db file'; }
129 sub init_loaded  { 0 }
130 sub init_id      { 0 }
131 sub init_version { 0 }
132 sub init_newest  { 1 }
133
134 1;
135
136 __END__
137
138 =encoding utf-8
139
140 =head1 NAME
141
142 SL::File::Object - a filemangement object wrapper
143
144 =head1 SYNOPSIS
145
146   use SL::File;
147
148   my ($object) = SL::File->get_all(object_id   => $object_id,
149                                    object_type => $object_type,
150                                    file_type   => 'images',  # may be optional
151                                    source      => 'uploaded' # may be optional
152                                   );
153 # read attributes
154
155   my $object_id   = $object->object_id,
156   my $object_type = $object->object_type,
157   my $file_type   = $object->file_type;
158   my $file_name   = $object->file_name;
159   my $mime_type   = $object->mime_type;
160
161   my $mtime       = $object->mtime;
162   my $itime       = $object->itime;
163   my $id          = $object->id;
164   my $newest      = $object->newest;
165
166   my $versions    = $object->version_count;
167
168   my @versionobjs = $object->versions;
169   foreach ( @versionobjs ) {
170     my $mtime    = $_->mtime;
171     my $contents = $_->get_content;
172   }
173
174 # update
175
176   $object->rename("image1.png");
177   $object->save_contents("new text");
178   $object->save_file("/tmp/empty.png");
179   $object->purge;
180   $object->delete_last_version;
181   $object->delete;
182
183 =head1 DESCRIPTION
184
185 This is a wrapper around a single object in the filemangement.
186
187 =head1 METHODS
188
189 Following methods are wrapper to read the attributes of L<SL::DB::File> :
190
191 =over 4
192
193 =item C<object_id>
194
195 =item C<object_type>
196
197 =item C<file_type>
198
199 =item C<file_name>
200
201 =item C<mime_name>
202
203 =item C<file_title>
204
205 =item C<file_description>
206
207 =item C<backend>
208
209 =item C<source>
210
211 =item C<itime>
212
213 =item C<id>
214
215 =back
216
217 Additional are there special methods. If the Object is created by SL::File::get_all_versions()
218 or by "$object->versions"
219 it has a version number. So the different mtime, filepath or content can be retrieved:
220
221 =over 4
222
223 =item C<mtime>
224
225 get the modification time of a (versioned) object
226
227 =item C<get_file>
228
229 get the full qualified file path of the (versioned) object
230
231 =item C<get_content>
232
233 get the content of the (versioned) object
234
235 =item C<version_count>
236
237 Get the available versions of the file
238
239 =item C<versions>
240
241 Returns an array of SL::File::Object objects with the available versions of the file, starting with the newest version.
242
243 =item C<newest>
244
245 If set this is the newest version of the file.
246
247 =item C<save_contents $contents>
248
249 Store a new contents to the file (as a new version).
250
251 =item C<save_file $filepath>
252
253 Store the content of an (absolute)file path to the file
254
255 =item C<delete>
256
257 Delete the file with all of his versions
258
259 =item C<delete_last_version>
260
261 Delete only the last version of the file with implicit decrement of the version_count.
262
263 =item C<purge>
264
265 Delete all old versions of the file. Only one version exist after purge. The version count is reset to 1.
266
267 =item C<rename $newfilename>
268
269 Renames the filename
270
271 =back
272
273 =head1 SEE ALSO
274
275 L<SL::File>
276
277 =head1 AUTHOR
278
279 Martin Helmling E<lt>martin.helmling@opendynamic.deE<gt>
280
281 =cut