Merge pull request #5040 from owncloud/public_api_avatar_master

Add public API for \OC\Avatar

3 files changed, 67 insertions, 0 deletions

diff --git a/lib/public/iavatar.php b/lib/public/iavatar.php
new file mode 100644
index 00000000000..2cbec0d45c3
--- /dev/null
+++ b/lib/public/iavatar.php
@@ -0,0 +1,38 @@
+<?php
+/**
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP;
+
+/**
+ * This class provides avatar functionality
+ */
+
+interface IAvatar {
+
+	/**
+	 * @brief get the users avatar
+	 * @param $size integer size in px of the avatar, avatars are square, defaults to 64
+	 * @return boolean|\OC_Image containing the avatar or false if there's no image
+	 */
+	function get($size = 64);
+
+	/**
+	 * @brief sets the users avatar
+	 * @param $data mixed 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 \OCP\NotSquareException if the image is not square
+	 * @return void
+	 */
+	function set($data);
+
+	/**
+	 * @brief remove the users avatar
+	 * @return void
+	 */
+	function remove();
+}
diff --git a/lib/public/iavatarmanager.php b/lib/public/iavatarmanager.php
new file mode 100644
index 00000000000..9b185ae0467
--- /dev/null
+++ b/lib/public/iavatarmanager.php
@@ -0,0 +1,23 @@
+<?php
+/**
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP;
+
+/**
+ * This class provides avatar functionality
+ */
+
+interface IAvatarManager {
+
+	/**
+	 * @brief return a user specific instance of \OCP\IAvatar
+	 * @see \OCP\IAvatar
+	 * @param $user string the ownCloud user id
+	 * @return \OCP\IAvatar
+	 */
+	function getAvatar($user);
+}
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index 14822817a47..36296a59850 100644
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -154,4 +154,10 @@ interface IServerContainer {
 	 */
 	function getDatabaseConnection();
 
+	/**
+	 * @brief Returns an avatar manager, used for avatar functionality
+	 * @return \OCP\IAvatarManager
+	 */
+	function getAvatarManager();
+
 }