server/lib/private/avatar.php
Morris Jobke dc36d30953 Remove all occurences of @brief and @returns from PHPDoc
* test case added to avoid adding them later
2014-05-19 17:50:53 +02:00

91 lines
2.2 KiB
PHP

<?php
/**
* Copyright (c) 2013 Christopher Schäpers <christopher@schaepers.it>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
/**
* This class gets and sets users avatars.
*/
class OC_Avatar implements \OCP\IAvatar {
private $view;
/**
* constructor
* @param string $user user to do avatar-management with
*/
public function __construct ($user) {
$this->view = new \OC\Files\View('/'.$user);
}
/**
* get the users avatar
* @param int $size 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
*/
public function get ($size = 64) {
if ($this->view->file_exists('avatar.jpg')) {
$ext = 'jpg';
} elseif ($this->view->file_exists('avatar.png')) {
$ext = 'png';
} else {
return false;
}
$avatar = new OC_Image();
$avatar->loadFromData($this->view->file_get_contents('avatar.'.$ext));
$avatar->resize($size);
return $avatar;
}
/**
* sets the users avatar
* @param \OC_Image|resource|string $data OC_Image, 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
* @return void
*/
public function set ($data) {
if($data instanceOf OC_Image) {
$img = $data;
$data = $img->data();
} else {
$img = new OC_Image($data);
}
$type = substr($img->mimeType(), -3);
if ($type === 'peg') {
$type = 'jpg';
}
if ($type !== 'jpg' && $type !== 'png') {
$l = \OC_L10N::get('lib');
throw new \Exception($l->t("Unknown filetype"));
}
if (!$img->valid()) {
$l = \OC_L10N::get('lib');
throw new \Exception($l->t("Invalid image"));
}
if (!($img->height() === $img->width())) {
throw new \OC\NotSquareException();
}
$this->view->unlink('avatar.jpg');
$this->view->unlink('avatar.png');
$this->view->file_put_contents('avatar.'.$type, $data);
}
/**
* remove the users avatar
* @return void
*/
public function remove () {
$this->view->unlink('avatar.jpg');
$this->view->unlink('avatar.png');
}
}