nextcloud/lib/public/IAvatarManager.php

46 lines
1.4 KiB
PHP
Raw Normal View History

2013-09-20 13:46:11 +04:00
<?php
/**
2015-03-26 13:44:34 +03:00
* @author Arthur Schiwon <blizzz@owncloud.com>
* @author Christopher Schäpers <kondou@ts.unde.re>
* @author Morris Jobke <hey@morrisjobke.de>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <rullzer@owncloud.com>
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-09-20 13:46:11 +04:00
*/
2013-09-20 13:46:11 +04:00
namespace OCP;
/**
* This class provides avatar functionality
* @since 6.0.0
2013-09-20 13:46:11 +04:00
*/
interface IAvatarManager {
/**
* return a user specific instance of \OCP\IAvatar
2013-11-22 02:40:25 +04:00
* @see \OCP\IAvatar
* @param string $user the ownCloud user id
2013-11-22 02:40:25 +04:00
* @return \OCP\IAvatar
* @throws \Exception In case the username is potentially dangerous
* @throws \OCP\Files\NotFoundException In case there is no user folder yet
* @since 6.0.0
2013-09-20 13:46:11 +04:00
*/
2015-04-19 01:26:17 +03:00
public function getAvatar($user);
2013-09-20 13:46:11 +04:00
}