Generate WebP variants of users' cover photos
[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / user / cover / photo / IUserCoverPhoto.class.php
1 <?php
2
3 namespace wcf\data\user\cover\photo;
4
5 /**
6 * Any displayable cover photo type should implement this class.
7 *
8 * @author Alexander Ebert
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\User\Cover\Photo
12 */
13 interface IUserCoverPhoto
14 {
15 /**
16 * Deletes this cover photo.
17 */
18 public function delete();
19
20 /**
21 * Returns the physical location of this cover photo.
22 */
23 public function getLocation(?bool $forceWebP = null): string;
24
25 /**
26 * Returns the url to this cover photo.
27 */
28 public function getURL(?bool $forceWebP = null): string;
29
30 /**
31 * Returns the file name of this cover photo.
32 */
33 public function getFilename(?bool $forceWebP = null): string;
34 }