nextcloud/lib/public/IAvatar.php

80 lines
2.2 KiB
PHP
Raw Normal View History

2013-11-22 03:43:23 +04:00
<?php
/**
2016-05-26 20:56:05 +03:00
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
2015-03-26 13:44:34 +03:00
* @author Joas Schilling <nickvergessen@owncloud.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
2016-01-12 17:02:16 +03:00
* @author Roeland Jago Douma <rullzer@owncloud.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
2015-03-26 13:44:34 +03:00
*
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
2013-11-22 03:43:23 +04:00
*/
2013-11-22 03:43:23 +04:00
namespace OCP;
use OCP\Files\File;
use OCP\Files\NotFoundException;
2013-11-22 03:43:23 +04:00
/**
* This class provides avatar functionality
* @since 6.0.0
2013-11-22 03:43:23 +04:00
*/
interface IAvatar {
/**
* get the users avatar
* @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image
* @return boolean|\OCP\IImage containing the avatar or false if there's no image
* @since 6.0.0 - size of -1 was added in 9.0.0
2013-11-22 03:43:23 +04:00
*/
2015-04-19 01:26:17 +03:00
public function get($size = 64);
2013-11-22 03:43:23 +04:00
/**
* Check if an avatar exists for the user
*
* @return bool
* @since 8.1.0
*/
public function exists();
2013-11-22 03:43:23 +04:00
/**
* sets the users avatar
* @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar
* @throws \Exception if the provided file is not a jpg or png image
* @throws \Exception if the provided image is not valid
* @throws \OC\NotSquareException if the image is not square
2013-11-22 03:43:23 +04:00
* @return void
* @since 6.0.0
2013-11-22 03:43:23 +04:00
*/
2015-04-19 01:26:17 +03:00
public function set($data);
2013-11-22 03:43:23 +04:00
/**
* remove the users avatar
2013-11-22 03:43:23 +04:00
* @return void
* @since 6.0.0
2013-11-22 03:43:23 +04:00
*/
2015-04-19 01:26:17 +03:00
public function remove();
/**
* Get the file of the avatar
* @param int $size -1 can be used to not scale the image
* @return File
* @throws NotFoundException
* @since 9.0.0
*/
public function getFile($size);
2013-11-22 03:43:23 +04:00
}