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 purge {
 101   SL::File->delete(dbfile => $_[0]->loaded_db_file, all_but_notlast => 1 )
 102 }
 103
 104 sub rename {
 105   SL::File->rename(dbfile => $_[0]->loaded_db_file, to => $_[1])
 106 }
 107
 108 # internals
 109
 110 sub backend_class {
 111   SL::File->get_backend_class($_[0]->backend)
 112 }
 113
 114
 115 sub loaded_db_file {  # so, dass wir die nur einmal laden.
 116   if (!$_[0]->loaded) {
 117     $_[0]->db_file->load;
 118     $_[0]->loaded(1);
 119   }
 120   $_[0]->db_file;
 121 }
 122
 123
 124 sub init_db_file { die 'must always have a db file'; }
 125 sub init_loaded  { 0 }
 126 sub init_id      { 0 }
 127 sub init_version { 0 }
 128 sub init_newest  { 1 }
 129
 130 1;
 131
 132 __END__
 133
 134 =encoding utf-8
 135
 136 =head1 NAME
 137
 138 SL::File::Object - a filemangement object wrapper
 139
 140 =head1 SYNOPSIS
 141
 142   use SL::File;
 143
 144   my ($object) = SL::File->get_all(object_id   => $object_id,
 145                                    object_type => $object_type,
 146                                    file_type   => 'images',  # may be optional
 147                                    source      => 'uploaded' # may be optional
 148                                   );
 149 # read attributes
 150
 151   my $object_id   = $object->object_id,
 152   my $object_type = $object->object_type,
 153   my $file_type   = $object->file_type;
 154   my $file_name   = $object->file_name;
 155   my $mime_type   = $object->mime_type;
 156
 157   my $mtime       = $object->mtime;
 158   my $itime       = $object->itime;
 159   my $id          = $object->id;
 160   my $newest      = $object->newest;
 161
 162   my $versions    = $object->version_count;
 163
 164   my @versionobjs = $object->versions;
 165   foreach ( @versionobjs ) {
 166     my $mtime    = $_->mtime;
 167     my $contents = $_->get_content;
 168   }
 169
 170 # update
 171
 172   $object->rename("image1.png");
 173   $object->save_contents("new text");
 174   $object->save_file("/tmp/empty.png");
 175   $object->purge;
 176   $object->delete_last_version;
 177   $object->delete;
 178
 179 =head1 DESCRIPTION
 180
 181 This is a wrapper around a single object in the filemangement.
 182
 183 =head1 METHODS
 184
 185 Following methods are wrapper to read the attributes of L<SL::DB::File> :
 186
 187 =over 4
 188
 189 =item C<object_id>
 190
 191 =item C<object_type>
 192
 193 =item C<file_type>
 194
 195 =item C<file_name>
 196
 197 =item C<mime_name>
 198
 199 =item C<file_title>
 200
 201 =item C<file_description>
 202
 203 =item C<backend>
 204
 205 =item C<source>
 206
 207 =item C<itime>
 208
 209 =item C<id>
 210
 211 =back
 212
 213 Additional are there special methods. If the Object is created by SL::File::get_all_versions()
 214 or by "$object->versions"
 215 it has a version number. So the different mtime, filepath or content can be retrieved:
 216
 217 =over 4
 218
 219 =item C<mtime>
 220
 221 get the modification time of a (versioned) object
 222
 223 =item C<get_file>
 224
 225 get the full qualified file path of the (versioned) object
 226
 227 =item C<get_content>
 228
 229 get the content of the (versioned) object
 230
 231 =item C<version_count>
 232
 233 Get the available versions of the file
 234
 235 =item C<versions>
 236
 237 Returns an array of SL::File::Object objects with the available versions of the file, starting with the newest version.
 238
 239 =item C<newest>
 240
 241 If set this is the newest version of the file.
 242
 243 =item C<save_contents $contents>
 244
 245 Store a new contents to the file (as a new version).
 246
 247 =item C<save_file $filepath>
 248
 249 Store the content of an (absolute)file path to the file
 250
 251 =item C<delete>
 252
 253 Delete the file with all of his versions
 254
 255 =item C<delete_last_version>
 256
 257 Delete only the last version of the file with implicit decrement of the version_count.
 258
 259 =item C<purge>
 260
 261 Delete all old versions of the file. Only one version exist after purge. The version count is reset to 1.
 262
 263 =item C<rename $newfilename>
 264
 265 Renames the filename
 266
 267 =back
 268
 269 =head1 SEE ALSO
 270
 271 L<SL::File>
 272
 273 =head1 AUTHOR
 274
 275 Martin Helmling E<lt>martin.helmling@opendynamic.deE<gt>
 276
 277 =cut