[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / IFile.class.php

<?php
namespace wcf\data;

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