wcfsetup/install/files/lib/data/IFile.class.php

   1 <?php
   2
   3 namespace wcf\data;
   4
   5 /**
   6  * Every database object representing a file should implement this interface.
   7  *
   8  * @author  Matthias Schmidt
   9  * @copyright   2001-2019 WoltLab GmbH
  10  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  11  * @package WoltLabSuite\Core\Data
  12  * @since   3.0
  13  *
  14  * @property-read   string $fileType   type of the physical attachment file
  15  * @property-read   int $isImage    is `1` if the file is an image, otherwise `0`
  16  * @property-read   int $width      width of the file if `$isImage` is `1`, otherwise `0`
  17  * @property-read   int $height     height of the file if `$isImage` is `1`, otherwise `0`
  18  */
  19 interface IFile extends IStorableObject
  20 {
  21     /**
  22      * Returns the physical location of the file.
  23      *
  24      * @return  string
  25      */
  26     public function getLocation();
  27 }