FileAction Klassenreferenz

Klassendiagramm für FileAction:

Aufstellung aller Elemente

Öffentliche Methoden
	FileAction ()
	replace ()
	savevalue ()
	saveprop ()
	show ()
	imageFormat ()
	imageExt ()
	imageFormats ()
	resize ()
	prop ()
	edit ()
	upload ()
	editvalue ()
	size ()
	extract ()
	uncompress ()
	compress ()
	douncompress ()
	doextract ()
	docompress ()
	pub ()
	pubnow ()
	getCompressionTypes ()
	getArchiveTypes ()
	checkMenu ($name)
Öffentliche Attribute
	$file
	$defaultSubAction = 'show'

---

Ausführliche Beschreibung

Definiert in Zeile 29 der Datei FileAction.class.php.

---

Dokumentation der Elementfunktionen

FileAction::checkMenu

(

$

name

)

Ermittelt, ob der Men�punkt aktiv ist. Ob ein Men�punkt als aktiv angezeigt werden soll, steht meist erst zur Laufzeit fest.
Diese Methode kann von den Unterklassen �berschrieben werden. Falls diese Methode nicht �berschrieben wird, sind alle Men�punkte aktiv.

Parameter:

String

$name Logischer Name des Men�punktes

Rückgabe:

boolean TRUE, wenn Men�punkt aktiv ist.

Erneute Implementation von Action.

Definiert in Zeile 615 der Datei FileAction.class.php.

Benutzt getArchiveTypes() und getCompressionTypes().

     {
          $archiveTypes     = $this->getArchiveTypes();
          $compressionTypes = $this->getCompressionTypes();
          
          switch( $name )
          {
               case 'uncompress':
                    return in_array($this->file->extension,$compressionTypes);

               case 'compress':
                    return !in_array($this->file->extension,$compressionTypes);

               case 'extract':
                    return in_array($this->file->extension,$archiveTypes);

               case 'size':
                    return $this->file->isImage();

               case 'editvalue':
                    return substr($this->file->mimeType(),0,5)=='text/';
                    
               default:
                    return true;
          }
     }

FileAction::compress

(

)

Anzeigen des Inhaltes

Definiert in Zeile 373 der Datei FileAction.class.php.

Benutzt getCompressionTypes(), lang() und Action::setTemplateVar().

     {
          $formats = array();
          foreach( $this->getCompressionTypes() as $t )
               $formats[$t] = lang('compression_'.$t);

          $this->setTemplateVar('formats'       ,$formats    );
     }

FileAction::docompress

(

)

Anzeigen des Inhaltes

Definiert in Zeile 518 der Datei FileAction.class.php.

Benutzt Action::callSubAction() und Action::getRequestVar().

     {
          $format = $this->getRequestVar('format');
          
          switch( $format )
          {
               case 'gz':
                    if   ( $this->getRequestVar('replace') )
                    {
                         $this->file->value = gzencode( $this->file->loadValue() );
                         $this->file->parse_filename( $this->file->filename.'.'.$this->file->extension.'.gz' );
                         $this->file->save();
                         $this->file->saveValue();
                         
                    }
                    else
                    {
                         $newFile = new File();
                         $newFile->name     = $this->file->name;
                         $newFile->parentid = $this->file->parentid;
                         $newFile->value    = gzencode( $this->file->loadValue() );
                         $newFile->parse_filename( $this->file->filename.'.'.$this->file->extension.'.gz' );
                         $newFile->add();
                    }
                    
                    break;

               case 'bzip2':
                    if   ( $this->getRequestVar('replace') )
                    {
                         $this->file->value = bzcompress( $this->file->loadValue() );
                         $this->file->parse_filename( $this->file->filename.'.'.$this->file->extension.'.bz2' );
                         $this->file->save();
                         $this->file->saveValue();
                         
                    }
                    else
                    {
                         $newFile = new File();
                         $newFile->name     = $this->file->name;
                         $newFile->parentid = $this->file->parentid;
                         $newFile->value    = bzcompress( $this->file->loadValue() );
                         $newFile->parse_filename( $this->file->filename.'.'.$this->file->extension.'.bz2' );
                         $newFile->add();
                    }
                    
                    break;
               default:
                    die( 'unknown extract type: '.$format );
          }
          
          $this->callSubAction('edit');
     }

FileAction::doextract

(

)

Anzeigen des Inhaltes

Definiert in Zeile 441 der Datei FileAction.class.php.

Benutzt $file, Action::addNotice() und Action::callSubAction().

     {
          switch( $this->file->extension )
          {
               case 'tar':
                    $folder = new Folder();
                    $folder->parentid = $this->file->parentid;
                    $folder->name     = $this->file->name;
                    $folder->filename = $this->file->filename;
                    $folder->add();
                    
                    $tar = new ArchiveTar();
                    $tar->openTAR( $this->file->loadValue() );
                    
                    foreach( $tar->files as $file )
                    {
                         $newFile = new File();
                         $newFile->name     = $file['name'];
                         $newFile->parentid = $folder->objectid;
                         $newFile->value    = $file['file'];
                         $newFile->parse_filename( $file['name'] );
                         $newFile->lastchangeDate = $file['time'];
                         $newFile->add();
                         
                         $this->addNotice('file',$newFile->name,'ADDED');
                    }
                    
                    unset($tar);
                    
                    break;

               case 'zip':
               
                    $folder = new Folder();
                    $folder->parentid    = $this->file->parentid;
                    $folder->name        = $this->file->name;
                    $folder->filename    = $this->file->filename;
                    $folder->description = $this->file->fullFilename;
                    $folder->add();
                    
                    $zip = new ArchiveUnzip();
                    $zip->open( $this->file->loadValue() );

                    $lista = $zip->getList();

                    if(sizeof($lista)) foreach($lista as $fileName=>$trash){
                         

                         $newFile = new File();
                         $newFile->name        = basename($fileName);
                         $newFile->description = 'Extracted: '.$this->file->fullFilename.' -> '.$fileName;
                         $newFile->parentid    = $folder->objectid;
                         $newFile->parse_filename( basename($fileName) );

                         $newFile->value       = $zip->unzip($fileName);
                         $newFile->add();
                         
                         $this->addNotice('file',$newFile->name,'ADDED');
                         unset($newFile);
                    }

                    $zip->close();
                    unset($zip);
                    
                    break;

               default:
                    die( 'cannot extract file with extension: '.$this->file->extension );
          }
          $this->callSubAction('edit');
     }

FileAction::douncompress

(

)

Anzeigen des Inhaltes

Definiert in Zeile 386 der Datei FileAction.class.php.

Benutzt Action::callSubAction() und Action::getRequestVar().

     {
          switch( $this->file->extension )
          {
               case 'gz':
                    if   ( $this->getRequestVar('replace') )
                    {
                         $this->file->value = gzinflate( substr($this->file->loadValue(),10));
                         $this->file->parse_filename( $this->file->filename );
                         $this->file->save();
                         $this->file->saveValue();
                    }
                    else
                    {
                         $newFile = new File();
                         $newFile->name     = $this->file->name;
                         $newFile->parentid = $this->file->parentid;
                         $newFile->value    = gzinflate( substr($this->file->loadValue(),10));
                         $newFile->parse_filename( $this->file->filename );
                         $newFile->add();
                    }
                    
                    break;

               case 'bz2':
                    if   ( $this->getRequestVar('replace') )
                    {
                         $this->file->value = bzdecompress($this->file->loadValue());
                         $this->file->parse_filename( $this->file->filename );
                         $this->file->save();
                         $this->file->saveValue();
                    }
                    else
                    {
                         $newFile = new File();
                         $newFile->name     = $this->file->name;
                         $newFile->parentid = $this->file->parentid;
                         $newFile->value    = bzdecompress( $this->file->loadValue() );
                         $newFile->parse_filename( $this->file->filename );
                         $newFile->add();
                    }
                    
                    break;

               default:
                    die( 'cannot extract file with extension: '.$this->file->extension );
          }
          $this->callSubAction('edit');
     }

FileAction::edit

(

)

Anzeigen des Inhaltes

Definiert in Zeile 288 der Datei FileAction.class.php.

Benutzt $conf und Action::setTemplateVars().

     {
          global $conf;
          // MIME-Types aus Datei lesen
          $this->setTemplateVars( $this->file->getProperties() );
     }

FileAction::editvalue

(

)

Anzeigen des Inhaltes

Definiert in Zeile 307 der Datei FileAction.class.php.

Benutzt $conf, Action::setTemplateVar() und Action::setTemplateVars().

     {
          global $conf;
          // MIME-Types aus Datei lesen
          $this->setTemplateVars( $this->file->getProperties() );
          $this->setTemplateVar('value',$this->file->loadValue());
     }

FileAction::extract

(

)

Anzeigen des Inhaltes

Definiert in Zeile 354 der Datei FileAction.class.php.

Benutzt imageFormat() und Action::setTemplateVars().

     {
          $this->setTemplateVars( $this->file->getProperties() );
          
          $imageFormat = $this->imageFormat();
     }

FileAction::FileAction

(

)

Konstruktor

Definiert in Zeile 37 der Datei FileAction.class.php.

Benutzt Session::getObject(), Action::getRequestId(), Action::lastModified() und Session::setObject().

     {
          if   ( $this->getRequestId() != 0  )
          {
               $this->file = new File( $this->getRequestId() );
               $this->file->load();
               Session::setObject( $this->file );
          }
          else
          {
               $this->file = Session::getObject();
          }

          $this->lastModified( $this->file->lastchangeDate );
     }

FileAction::getArchiveTypes

(

)

Definiert in Zeile 605 der Datei FileAction.class.php.

Wird benutzt von checkMenu().

     {
          $archiveTypes = array();
          $archiveTypes[] = 'tar';
          $archiveTypes[] = 'zip';
          return $archiveTypes;
     }

FileAction::getCompressionTypes

(

)

Definiert in Zeile 596 der Datei FileAction.class.php.

Wird benutzt von checkMenu() und compress().

     {
          $compressionTypes = array();
          if   ( function_exists('gzencode'    ) ) $compressionTypes[] = 'gz';
          if   ( function_exists('gzencode'    ) ) $compressionTypes[] = 'zip';
          if   ( function_exists('bzipcompress') ) $compressionTypes[] = 'bz2';
          return $compressionTypes;
     }

FileAction::imageExt

(

)

Definiert in Zeile 155 der Datei FileAction.class.php.

Benutzt imageFormat().

     {
          switch( $this->imageFormat() )
          {
               case IMG_GIF:
                    return 'GIF';
               case IMG_JPG:
                    return 'JPEG';
               case IMG_PNG:
                    return 'PNG';
          }
     }

FileAction::imageFormat

(

)

Definiert in Zeile 132 der Datei FileAction.class.php.

Wird benutzt von extract(), imageExt(), resize() und size().

     {
          if   ( ! function_exists( 'imagetypes' ) )
               return 0;

          $ext      = strtolower($this->file->extension);
          $types    = imagetypes();
          $formats  = array( 'gif' =>IMG_GIF,
                             'jpg' =>IMG_JPG,
                             'jpeg'=>IMG_JPG,
                             'png' =>IMG_PNG );
          
          if   ( !isset($formats[$ext]) )
               return 0;

          if   ( $types & $formats[$ext] )
               return $formats[$ext];

          return 0;
     }

FileAction::imageFormats

(

)

Definiert in Zeile 170 der Datei FileAction.class.php.

Wird benutzt von size().

     {
          if   ( ! function_exists( 'imagetypes' ) )
               return array();

          $types    = imagetypes();
          $formats  = array( IMG_GIF => 'gif',
                             IMG_JPG => 'jpeg',
                             IMG_PNG => 'png' );
          $formats2 = $formats;         

          foreach( $formats as $b=>$f )
               if   ( !($types & $b) )
                    unset( $formats2[$b] );

          return $formats2;
     }

FileAction::prop

(

)

Definiert in Zeile 247 der Datei FileAction.class.php.

Benutzt $conf, Action::setTemplateVar(), Action::setTemplateVars() und Html::url().

     {
          
                    global $conf;
          
          if   ( $this->file->filename == $this->file->objectid )
               $this->file->filename = '';

          // Eigenschaften der Datei uebertragen
          $this->setTemplateVars( $this->file->getProperties() );

          $this->setTemplateVar('size',number_format($this->file->size/1000,0,',','.').' kB' );
          $this->setTemplateVar('full_filename',$this->file->full_filename());
          
          if   ( is_file($this->file->tmpfile()))
          {
               $this->setTemplateVar('cache_filename' ,$this->file->tmpfile());
               $this->setTemplateVar('cache_filemtime',@filemtime($this->file->tmpfile()));
          }

          // Alle Seiten mit dieser Datei ermitteln
          $pages = $this->file->getDependentObjectIds();
               
          $list = array();
          foreach( $pages as $id )
          {
               $o = new Object( $id );
               $o->load();
               $list[$id] = array();
               $list[$id]['url' ] = Html::url('main','page',$id);
               $list[$id]['name'] = $o->name;
          }
          asort( $list );
          $this->setTemplateVar('pages',$list);
          $this->setTemplateVar('edit_filename',$conf['filename']['edit']);     
     }

FileAction::pub

(

)

Datei ver?ffentlichen

Definiert in Zeile 576 der Datei FileAction.class.php.

Benutzt Action::forward().

     {
          $this->forward('file_pub');
     }

FileAction::pubnow

(

)

Datei ver?ffentlichen

Definiert in Zeile 585 der Datei FileAction.class.php.

Benutzt Action::addNotice().

     {
          $this->file->publish();
          $this->file->publish->close();
          $this->addNotice('file',$this->file->fullFilename,'PUBLISHED'.($this->file->publish->ok?'':'_ERROR'),$this->file->publish->ok,array(),$this->file->publish->log);
          
          $this->callSubaction('pub');
     }

FileAction::replace

(

)

Ersetzt den Inhalt mit einer anderen Datei

Definiert in Zeile 57 der Datei FileAction.class.php.

Benutzt Action::addNotice().

     {
          $upload = new Upload();

          $this->file->filename  = $upload->filename;
          $this->file->extension = $upload->extension;      
          $this->file->size      = $upload->size;
          $this->file->save();
          
          $this->file->value = $upload->value;
          $this->file->saveValue();
          $this->file->setTimestamp();

          //$setTemplateVar('tree_refresh',true);
          $this->addNotice($this->file->getType(),$this->file->name,'VALUE_SAVED','ok');
     }

FileAction::resize

(

)

Bildgroesse eines Bildes aendern

Definiert in Zeile 192 der Datei FileAction.class.php.

Benutzt Action::addNotice(), Action::addValidationError(), Action::callSubAction(), Action::getRequestVar(), Action::hasRequestVar(), imageFormat() und lang().

     {
          $width           = intval($this->getRequestVar('width'           ));
          $height          = intval($this->getRequestVar('height'          ));
          $jpegcompression =        $this->getRequestVar('jpeg_compression') ;
          $format          =        $this->getRequestVar('format'          ) ;
          $factor          =        $this->getRequestVar('factor'          ) ;
          
          if   ( $this->getRequestVar('type') == 'input' &&
                 ! $this->hasRequestVar('width' )      &&
                 ! $this->hasRequestVar('height') )
          {
               $this->addValidationError('width','INPUT_NEW_IMAGE_SIZE' );
               $this->addValidationError('height','');
               $this->callSubAction('size');
               return;
          }
          
          if   ( $this->hasRequestVar('copy') )
          {
               // Datei neu anlegen.
               $imageFile = new File($this->file->objectid);
               $imageFile->load();
               $imageFile->name       = lang('copy_of').' '.$imageFile->name;
               $imageFile->desription = lang('copy_of').' '.$imageFile->description;
               $imageFile->filename   = $imageFile->filename.'_resized_'.time();
               $imageFile->add();
               $imageFile->copyValueFromFile( $this->file->objectid );
          }
          else
          {
               $imageFile = $this->file;
          }
          
          if   ( $this->getRequestVar('type') == 'factor')
          {
               $width  = 0;
               $height = 0;
          }
          else
          {
               $factor = 1;
          }

          $imageFile->write();
          
          $imageFile->imageResize( intval($width),intval($height),$factor,$this->imageFormat(),$format,$jpegcompression );
          $imageFile->setTimestamp();
          $imageFile->save();      // Um z.B. Groesse abzuspeichern
          $imageFile->saveValue();

          $this->addNotice($imageFile->getType(),$imageFile->name,'IMAGE_RESIZED','ok');
     }

FileAction::saveprop

(

)

Abspeichern der Eigenschaften zu dieser Datei.

Definiert in Zeile 89 der Datei FileAction.class.php.

Benutzt Action::addNotice() und Action::getRequestVar().

     {
          // Eigenschaften speichern
          $this->file->filename  = $this->getRequestVar('filename'   );
          $this->file->name      = $this->getRequestVar('name'       );
          $this->file->extension = $this->getRequestVar('extension'  );
          $this->file->desc      = $this->getRequestVar('description');
          
          $this->file->save();
          $this->file->setTimestamp();
          $this->addNotice($this->file->getType(),$this->file->name,'PROP_SAVED','ok');
     }

FileAction::savevalue

(

)

Definiert in Zeile 75 der Datei FileAction.class.php.

Benutzt Action::addNotice() und Action::getRequestVar().

     {
          $this->file->value = $this->getRequestVar('value');
          $this->file->saveValue();
     
          $this->addNotice($this->file->getType(),$this->file->name,'VALUE_SAVED','ok');
          $this->file->setTimestamp();
     }

FileAction::show

(

)

Anzeigen des Inhaltes, der Inhalt wird samt Header direkt auf die Standardausgabe geschrieben

Definiert in Zeile 107 der Datei FileAction.class.php.

     {
          // Angabe Content-Type
          header('Content-Type: '.$this->file->mimeType() );
          header('X-File-Id: '.$this->file->fileid );

          // Angabe Content-Disposition
          // - Bild soll "inline" gezeigt werden
          // - Dateiname wird benutzt, wenn der Browser das Bild speichern moechte
          header('Content-Disposition: inline; filename='.$this->file->filenameWithExtension() );
          header('Content-Transfer-Encoding: binary' );
          header('Content-Description: '.$this->file->name );

          $this->file->write(); // Bild aus Datenbank laden

          // Groesse des Bildes in Bytes
          // Der Browser hat so die Moeglichkeit, einen Fortschrittsbalken zu zeigen
          header('Content-Length: '.filesize($this->file->tmpfile()) );
          
          
          readfile( $this->file->tmpfile() );
          exit;
     }

FileAction::size

(

)

Anzeigen des Inhaltes

Definiert in Zeile 319 der Datei FileAction.class.php.

Benutzt imageFormat(), imageFormats(), Action::setTemplateVar() und Action::setTemplateVars().

     {
          $this->setTemplateVars( $this->file->getProperties() );
          
          $format = $this->imageFormat();

          if   ( $format != 0 )
               $formats = $this->imageFormats();
          else
               $formats = array();

          $sizes = array();
          foreach( array(10,25,50,75,100,125,150,175,200,250,300,350,400,500,600,800) as $s )
               $sizes[strval($s/100)] = $s.'%';
               
          $jpeglist = array();
          for ($i=10; $i<=95; $i+=5)
               $jpeglist[$i]=$i.'%';

          $this->setTemplateVar('factors'       ,$sizes      );
          $this->setTemplateVar('jpeglist'      ,$jpeglist   );
          $this->setTemplateVar('formats'       ,$formats    );
          $this->setTemplateVar('format'        ,$format     );
          $this->setTemplateVar('factor'        ,1           );
          
          $this->file->getImageSize();
          $this->setTemplateVar('width' ,$this->file->width  );
          $this->setTemplateVar('height',$this->file->height );
          $this->setTemplateVar('type'  ,'input'             );
     }

FileAction::uncompress

(

)

Anzeigen des Inhaltes

Definiert in Zeile 365 der Datei FileAction.class.php.

     {
     }

FileAction::upload

(

)

Anzeigen des Inhaltes

Definiert in Zeile 299 der Datei FileAction.class.php.

     {
     }

---

Dokumentation der Datenelemente

FileAction::$defaultSubAction = 'show'

Definiert in Zeile 32 der Datei FileAction.class.php.

FileAction::$file

Definiert in Zeile 31 der Datei FileAction.class.php.

Wird benutzt von doextract().

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• actionClasses/FileAction.class.php