File Klassenreferenz

Klassendiagramm für File:

Aufstellung aller Elemente

Öffentliche Methoden
	File ($objectid='')
	full_filename ()
	filenameWithExtension ()
	getProperties ()
	getFileObjectIdsByExtension ($extension)
	getObjectIdsByExtension ($extension)
	mimeType ()
	getImageSize ()
	imageResize ($newWidth, $newHeight, $factor, $oldformat, $newformat, $jpegquality)
	load ()
	delete ()
	isImage ()
	extension ()
	parse_filename ($filename)
	save ()
	copyValueFromFile ($otherfileid)
	loadValue ()
	saveValue ($value= '')
	write ()
	add ()
	publish ()
	tmpfile ()
	setTimestamp ()
Öffentliche Attribute
	$fileid
	$size = 0
	$value = ''
	$extension = ''
	$log_filenames = array()
	$fullFilename = ''
	$publish = null
	$mime_type = ''
	$width = null
	$height = null
	$tmpfile
	$storeValueAsBase64 = false

---

Ausführliche Beschreibung

Definiert in Zeile 34 der Datei File.class.php.

---

Dokumentation der Elementfunktionen

File::add

(

)

Definiert in Zeile 588 der Datei File.class.php.

Benutzt $db, db_connection(), extension(), Object::objectAdd() und saveValue().

     {
          $db = db_connection();

          $this->objectAdd();
          
          $sql = new Sql('SELECT MAX(id) FROM {t_file}');
          $this->fileid = intval($db->getOne($sql->query))+1;

          $sql = new Sql('INSERT INTO {t_file}'.
                         ' (id,objectid,extension,size,value)'.
                         " VALUES( {fileid},{objectid},{extension},0,'' )" );
          $sql->setInt   ('fileid'   ,$this->fileid        );
          $sql->setInt   ('objectid' ,$this->objectid      );
          $sql->setString('extension',$this->extension     );

          $db->query( $sql->query );
          
          $this->saveValue();
     }    

File::copyValueFromFile

(

$

otherfileid

)

Kopieren des Inhaltes von einer anderen Datei

Parameter:

ID

der Datei, von der der Inhalt kopiert werden soll

Definiert in Zeile 513 der Datei File.class.php.

Benutzt File() und saveValue().

     {
          $of = new File( $otherfileid );
          $this->value = $of->loadValue();
          $this->saveValue();
     }

File::delete

(

)

Definiert in Zeile 436 der Datei File.class.php.

Benutzt $db, db_connection() und Object::objectDelete().

     {
          $db = db_connection();

          // Datei l?schen
          $sql = new Sql( 'DELETE FROM {t_file} '.
                          '  WHERE objectid={objectid}' );
          $sql->setInt( 'objectid',$this->objectid );
          $db->query( $sql->query );
          
          $this->objectDelete();
     }

File::extension

(

)

Definiert in Zeile 459 der Datei File.class.php.

Benutzt load().

Wird benutzt von add(), filenameWithExtension(), full_filename(), getProperties(), imageResize(), load(), mimeType(), parse_filename() und save().

     {
          if ($this->extension != '')
               return $this->extension;

          $this->load();
          return $this->extension;
     }

File::File

(

$

objectid = ''

)

Konstruktor

Parameter:

Objekt-Id

Definiert in Zeile 66 der Datei File.class.php.

Benutzt $conf, $db, Object::$objectid, $SESS, Session::getDatabase() und Object::Object().

Wird benutzt von copyValueFromFile().

     {
          global $conf,$SESS;
          
          $db = Session::getDatabase();
          $this->storeValueAsBase64 = $db->conf['base64'];

          $this->Object( $objectid );
          $this->isFile = true;
     }

File::filenameWithExtension

(

)

Ermitteln des Dateinamens dieser Datei (ohne Pfadangabe)

Rückgabe:

String Kompletter Dateiname, z.B. '/pfad/datei.jpeg'

Definiert in Zeile 105 der Datei File.class.php.

Benutzt extension() und Object::filename().

     {
          if   ( $this->extension != '' )
               return $this->filename.'.'.$this->extension;
          else return $this->filename;
     }

File::full_filename

(

)

Ermitteln des Dateinamens dieser Datei

Rückgabe:

String Kompletter Dateiname, z.B. '/pfad/datei.jpeg'

Erneute Implementation von Object.

Definiert in Zeile 84 der Datei File.class.php.

Benutzt Object::$filename und extension().

Wird benutzt von publish().

     {
          if   ( !empty($this->fullFilename) )
               return $this->fullFilename;

          $filename = parent::full_filename();

          if   ( !empty($this->extension) )
               $filename .= '.'.$this->extension;

          $this->fullFilename = $filename;
          return $filename;
     }

File::getFileObjectIdsByExtension

(

$

extension

)

Veraltet:

Definiert in Zeile 133 der Datei File.class.php.

Benutzt $db, $extension, $SESS und db_connection().

     {
          global $SESS;
          $db = db_connection();
          
          $sqlquery = 'SELECT * FROM {t_object} ';

          if   ( $extension != '' )
          {
               $sqlquery .= " WHERE extension='";

               $ext = explode(',',$extension);
               $sqlquery .= implode( "' OR extension='",$ext );
               $sqlquery .= "' AND is_file=1 AND projectid={projectid}";
          }
          else
          {
               $sqlquery .= " WHERE is_file=1 AND projectid={projectid}";
          }

          $sql = new Sql( $sqlquery );
          $sql->setInt( 'projectid',$SESS['projectid'] );
          
          return $db->getCol( $sql->query );
     }

File::getImageSize

(

)

Ermittelt Breite und H�he des Bildes.
Die Werte lassen sich anschlie�end �ber die Eigenschaften "width" und "height" ermitteln.

Definiert in Zeile 227 der Datei File.class.php.

Benutzt $size, tmpfile() und write().

     {
          if   ( is_null($this->width) )
          {
               $this->write(); // Datei schreiben
               
               // Bildinformationen ermitteln
               $size = getimagesize( $this->tmpfile() );
     
               // Breite und Hoehe des aktuellen Bildes      
               $this->width  = $size[0]; 
               $this->height = $size[1];
          }
     }

File::getObjectIdsByExtension

(

$

extension

)

Es werden Objekte zu einer Dateierweiterung ermittelt

Parameter:

String

Dateierweiterung ohne fuehrenden Punkt (z.B. 'jpeg')

Rückgabe:

Array Liste der gefundenen Objekt-IDs

Definiert in Zeile 167 der Datei File.class.php.

Benutzt $db, $extension und db_connection().

     {
          $db = db_connection();
          
          $sql = new Sql( 'SELECT {t_file}.objectid FROM {t_file} '.
                          ' LEFT JOIN {t_object} '.
                          '   ON {t_object}.id={t_file}.objectid'.
                          ' WHERE {t_file}.extension={extension}'.
                          '   AND {t_object}.projectid={projectid}' );
          $sql->setInt   ( 'projectid',$this->projectid );
          $sql->setString( 'extension',$extension       );
          
          return $db->getCol( $sql->query );
     }

File::getProperties

(

)

Ermitteln aller Eigenschaften

Rückgabe:

Array

Erneute Implementation von Object.

Definiert in Zeile 119 der Datei File.class.php.

Benutzt extension().

Wird benutzt von publish().

     {
          return array_merge( parent::getProperties(),
                              array('full_filename'=>$this->fullFilename,
                                    'extension'    =>$this->extension,
                                    'size'         =>$this->size,
                                    'mimetype'     =>$this->mimetype()   ) );
     }

File::imageResize	(	$	newWidth,
		$	newHeight,
		$	factor,
		$	oldformat,
		$	newformat,
		$	jpegquality
	)

Veraendert die Bildgroesse eines Bildes

Diese Methode sollte natuerlich nur bei Bildern ausgefuehrt werden.

Parameter:

	Neue	Breite
	Neue	Hoehe
	Bildgr��enfaktor
	Altes	Format als Integer-Konstante IMG_xxx
	Neues	Format als Integer-Konstante IMG_xxx
	Jpeg-Qualitaet	(sofern neues Format = Jpeg)

Definiert in Zeile 256 der Datei File.class.php.

Benutzt $conf, $size, extension(), tmpfile() und write().

     {
          global $conf;

          $this->write(); // Datei schreiben
          
          // Bildinformationen ermitteln
          $size = getimagesize( $this->tmpfile() );

          // Breite und Hoehe des aktuellen Bildes      
          $oldWidth  = $size[0]; 
          $oldHeight = $size[1];
          $aspectRatio = $oldHeight / $oldWidth; // Seitenverhaeltnis

          // Wenn Breite und Hoehe fehlen, dann Bildgroesse beibehalten
          if   ( $newWidth == 0 && $newHeight == 0)
          {
               if   ( $factor != 0 && $factor != 1 )
               {
                    $newWidth  = $oldWidth  * $factor; 
                    $newHeight = $oldHeight * $factor;
                    $resizing = true;
               }
               else
               {
                    $newWidth  = $oldWidth; 
                    $newHeight = $oldHeight;
                    $resizing = false;
               }
          }
          else
          {
               $resizing = true;
          }

          // Wenn nur Breite oder Hoehe angegeben ist, dann
          // das Seitenverhaeltnis beibehalten
          if   ( $newWidth == 0 )
               $newWidth = $newHeight / $aspectRatio; 
          
          if   ( $newHeight == 0 )
               $newHeight = $newWidth * $aspectRatio; 


          switch( $oldformat )
          {
               case IMG_GIF: // GIF

                    $oldImage = ImageCreateFromGIF( $this->tmpfile ); 
                    break;

               case IMG_JPG: // JPEG

                    $oldImage = ImageCreateFromJPEG($this->tmpfile);
                    break;

               case IMG_PNG: // PNG

                    $oldImage = imagecreatefrompng($this->tmpfile);
                    break;

               default:
                    die('unsupported image format "'.$this->extension.'", cannot load image. resize failed');
          }

          // Ab Version 2 der GD-Bibliothek sind TrueColor-Umwandlungen moeglich.
          global $conf;
          $hasTrueColor = $conf['image']['truecolor'];

          switch( $newformat )
          {
               case IMG_GIF: // GIF

                    if   ( $resizing )
                    {
                         $newImage = ImageCreate($newWidth,$newHeight); 
                         ImageCopyResized($newImage,$oldImage,0,0,0,0,$newWidth,
                              $newHeight,$oldWidth,$oldHeight); 
                    }
                    else
                    {
                         $newImage = &$oldImage;
                    } 

                    ImageGIF($newImage, $this->tmpfile() );
                    $this->extension = 'gif';

                    break;

               case IMG_JPG: // JPEG

                    if   ( !$resizing )
                    {
                         $newImage = &$oldImage;
                    } 
                    elseif   ( $hasTrueColor )
                    {
                         // Verwende TrueColor (GD2)
                         $newImage = imageCreateTrueColor( $newWidth,$newHeight );
                         ImageCopyResampled($newImage,$oldImage,0,0,0,0,$newWidth,
                         $newHeight,$oldWidth,$oldHeight);
                    }
                    else
                    {
                         // GD Version 1.x unterstuetzt kein TrueColor
                         $newImage = ImageCreate($newWidth,$newHeight);
     
                         ImageCopyResized($newImage,$oldImage,0,0,0,0,$newWidth,
                         $newHeight,$oldWidth,$oldHeight);
                    }
     
                    ImageJPEG($newImage, $this->tmpfile,$jpegquality ); 
                    $this->extension = 'jpeg';

                    break;

               case IMG_PNG: // PNG

                    if   ( !$resizing )
                    {
                         $newImage = &$oldImage;
                    } 
                    elseif   ( $hasTrueColor )
                    {
                         // Verwende TrueColor (GD2)
                         $newImage = imageCreateTrueColor( $newWidth,$newHeight );
          
                         ImageCopyResampled($newImage,$oldImage,0,0,0,0,$newWidth,
                         $newHeight,$oldWidth,$oldHeight); 
                    }
                    else
                    {
                         // GD Version 1.x unterstuetzt kein TrueColor
                         $newImage = ImageCreate($newWidth,$newHeight);
          
                         ImageCopyResized($newImage,$oldImage,0,0,0,0,$newWidth,
                         $newHeight,$oldWidth,$oldHeight); 
                    }
          
                    imagepng( $newImage,$this->tmpfile() );
                    $this->extension = 'png';
                    
                    break;
                    
               default:
                    die('unsupported image format "'.$newformat.'", cannot resize');
          } 

          $f = fopen( $this->tmpfile(), "r" );
          $this->value = fread( $f,filesize($this->tmpfile()) );
          fclose( $f );

          imagedestroy( $oldImage );
          //imagedestroy( $newImage );
     }

File::isImage

(

)

Stellt anhand der Dateiendung fest, ob es sich bei dieser Datei um ein Bild handelt

Definiert in Zeile 453 der Datei File.class.php.

Benutzt mimeType().

     {
          return substr($this->mimeType(),0,6)=='image/';
     }

File::load

(

)

Laden des Objektes

Veraltet:

bitte objectLoad() benutzen

Erneute Implementation von Object.

Definiert in Zeile 414 der Datei File.class.php.

Benutzt $db, db_connection(), extension() und Object::objectLoad().

Wird benutzt von extension().

     {
          $db = db_connection();

          $sql = new Sql( 'SELECT id,extension,size'.
                          ' FROM {t_file}'.
                          ' WHERE objectid={objectid}' );
          $sql->setInt( 'objectid',$this->objectid );
          $row = $db->getRow( $sql->query );
          
          if   ( count($row)!=0 )
          {
               $this->fileid    = $row['id'       ];
               $this->extension = $row['extension'];
               $this->size      = $row['size'     ];
          }
          
          $this->objectLoad();
     }

File::loadValue

(

)

Lesen der Datei aus der Datenbank.

Definiert in Zeile 524 der Datei File.class.php.

Benutzt $db, db_connection() und tmpfile().

Wird benutzt von write().

     {
          if   ( is_file($this->tmpfile()))
               return implode('',file($this->tmpfile())); // From cache
               
          $db = db_connection();

          $sql = new Sql( 'SELECT size,value'.
                          ' FROM {t_file}'.
                          ' WHERE objectid={objectid}' );
          $sql->setInt( 'objectid',$this->objectid );
          $row = $db->getRow( $sql->query );
          
          if   ( count($row) != 0 )
          {
               $this->value = $row['value'];
               $this->size  = $row['size' ];
          }

          if   ( $this->storeValueAsBase64 )
               $this->value = base64_decode( $this->value );

          // Store in cache.
          $f = fopen( $this->tmpfile(),'w' );
          fwrite( $f,$this->value );
          fclose( $f );
               
          return $this->value;
     }

File::mimeType

(

)

Ermittelt den Mime-Type zu dieser Datei

Rückgabe:

String Mime-Type

Definiert in Zeile 189 der Datei File.class.php.

Benutzt $conf, extension() und Object::filename().

Wird benutzt von isImage().

     {
          if   ( !empty( $this->mime_type ) )
               return $this->mime_type;

          global $conf;
          $mime_types = $conf['mime-types'];
          
          if   ( !empty($this->extension))
          {
               $ext = $this->extension;
          }
          else
          {
               $pos = strrpos($this->filename,'.');
               if   ( $pos === false )
                    $ext = '';
               else
                    $ext = substr($this->filename,$pos+1);
          }
          
          $ext = strtolower($ext);

          if   ( !empty($mime_types[$ext]) )
               $this->mime_type = $mime_types[$ext];
          else
               // Wenn kein Mime-Type gefunden, dann Standartwert setzen
               $this->mime_type = OR_FILE_DEFAULT_MIMETYPE;
               
          return( $this->mime_type );
     }

File::parse_filename

(

$

filename

)

Definiert in Zeile 470 der Datei File.class.php.

Benutzt Object::$filename, extension() und Object::filename().

     {
          $filename = basename($filename);

          $p = strrpos($filename, '.');
          if ($p !== false)
          {
               $this->extension = substr($filename, $p +1);
               $this->filename = substr($filename, 0, $p);
          }
          else
          {
               $this->extension = '';
               $this->filename = $filename;
          }
     }

File::publish

(

)

Definiert in Zeile 610 der Datei File.class.php.

Benutzt full_filename(), getProperties(), tmpfile() und write().

     {
          if   ( ! is_object($this->publish) )
               $this->publish = new Publish();

          $this->write();
          $this->publish->copy( $this->tmpfile(),$this->full_filename() );
          
          $this->publish->publishedObjects[] = $this->getProperties();
     }

File::save

(

)

Definiert in Zeile 488 der Datei File.class.php.

Benutzt $db, $SESS, db_connection(), extension() und Object::objectSave().

     {
          global $SESS;
          $db = db_connection();
          
          $sql = new Sql( <<<EOF
UPDATE {t_file} SET
  size      = {size},
  extension = {extension}
  WHERE objectid={objectid}
EOF
);
          $sql->setString('size'     ,$this->size      );
          $sql->setString('extension',$this->extension );
          $sql->setString('objectid' ,$this->objectid  );
          $db->query( $sql->query );
          
          $this->objectSave();
     }

File::saveValue

(

$

value = ''

)

Speichert den Inhalt in der Datenbank.

Definiert in Zeile 558 der Datei File.class.php.

Benutzt $db und db_connection().

Wird benutzt von add() und copyValueFromFile().

     {
          $db = db_connection();

          $sql = new Sql( 'UPDATE {t_file}'.
                          ' SET value={value}, '.
                          '      size={size}   '.
                          ' WHERE objectid={objectid}' );
          $sql->setString( 'objectid' ,$this->objectid      );
          $sql->setInt   ( 'size'     ,strlen($this->value) );
          
          if   ( $this->storeValueAsBase64 )
               $sql->setString( 'value',base64_encode($this->value) );
          else
               $sql->setString( 'value',$this->value );

          $db->query( $sql->query );
     }

File::setTimestamp

(

)

Aenderungsdatum auf Systemzeit setzen

Erneute Implementation von Object.

Definiert in Zeile 636 der Datei File.class.php.

Benutzt tmpfile().

     {
          @unlink( $this->tmpfile() );
          
          parent::setTimestamp();
     }

File::tmpfile

(

)

Ermittelt einen tempor�ren Dateinamen f�r diese Datei.

Definiert in Zeile 625 der Datei File.class.php.

Benutzt $db, db_connection() und Object::getTempDir().

Wird benutzt von getImageSize(), imageResize(), loadValue(), publish(), setTimestamp() und write().

     {
          if   ( $this->tmpfile == '' )
          {
               $db = db_connection();
               $this->tmpfile = $this->getTempDir().'/openrat_db'.$db->id.'_'.$this->objectid.'.tmp';
          }
          return $this->tmpfile;
     }

File::write

(

)

Lesen der Datei aus der Datenbank und schreiben in temporaere Datei

Definiert in Zeile 581 der Datei File.class.php.

Benutzt loadValue() und tmpfile().

Wird benutzt von getImageSize(), imageResize() und publish().

     {
          if   ( !is_file($this->tmpfile()) )
               $this->loadValue();
     }

---

Dokumentation der Datenelemente

File::$extension = ''

Definiert in Zeile 40 der Datei File.class.php.

Wird benutzt von getFileObjectIdsByExtension() und getObjectIdsByExtension().

File::$fileid

Definiert in Zeile 36 der Datei File.class.php.

File::$fullFilename = ''

Definiert in Zeile 42 der Datei File.class.php.

File::$height = null

Definiert in Zeile 46 der Datei File.class.php.

File::$log_filenames = array()

Definiert in Zeile 41 der Datei File.class.php.

File::$mime_type = ''

Definiert in Zeile 44 der Datei File.class.php.

File::$publish = null

Definiert in Zeile 43 der Datei File.class.php.

File::$size = 0

Definiert in Zeile 38 der Datei File.class.php.

Wird benutzt von getImageSize() und imageResize().

File::$storeValueAsBase64 = false

Um Probleme mit BLOB-Feldern und Datenbank-Besonderheiten zu vermeiden, kann der Binaerinhalt BASE64-kodiert gespeichert werden. Boolean

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

File::$tmpfile

Dateiname der temporaeren Datei String

Erneute Implementation von Object.

Definiert in Zeile 48 der Datei File.class.php.

File::$value = ''

Definiert in Zeile 39 der Datei File.class.php.

File::$width = null

Definiert in Zeile 45 der Datei File.class.php.

---

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

• objectClasses/File.class.php