diff options
author | Maxence Lange <maxence@nextcloud.com> | 2017-05-30 16:24:01 +0300 |
---|---|---|
committer | Maxence Lange <maxence@nextcloud.com> | 2017-05-31 00:58:25 +0300 |
commit | b8a94bcd93e2c4f2b328d563869f0ec0c84e019b (patch) | |
tree | 71bdbc4d9323db9f37a1f673beef94bad3ac668e /lib | |
parent | 9544aa0fe1d8758f900b85fca4a2b97534d4c995 (diff) |
API v1
Signed-off-by: Maxence Lange <maxence@nextcloud.com>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/Api/Circles.php | 95 | ||||
-rw-r--r-- | lib/Api/v1/Circles.php | 272 | ||||
-rw-r--r-- | lib/Service/CirclesService.php | 2 |
3 files changed, 273 insertions, 96 deletions
diff --git a/lib/Api/Circles.php b/lib/Api/Circles.php deleted file mode 100644 index ef53a0b1..00000000 --- a/lib/Api/Circles.php +++ /dev/null @@ -1,95 +0,0 @@ -<?php -/** - * Circles - Bring cloud-users closer together. - * - * This file is licensed under the Affero General Public License version 3 or - * later. See the COPYING file. - * - * @author Maxence Lange <maxence@pontapreta.net> - * @copyright 2017 - * @license GNU AGPL version 3 or any later version - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * 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 - * along with this program. If not, see <http://www.gnu.org/licenses/>. - * - */ - -namespace OCA\Circles\Api; - - -use OCA\Circles\AppInfo\Application; -use OCA\Circles\Model\SharingFrame; - -class Circles { - - - protected static function getContainer() { - $app = new Application(); - - return $app->getContainer(); - } - - public static function createCircle($type, $name) { - $c = self::getContainer(); - - return $c->query('CirclesService') - ->createCircle($type, $name); - } - - - public static function listCircles($type, $name = '', $level = 0) { - $c = self::getContainer(); - - return $c->query('CirclesService') - ->listCircles($type, $name, $level); - } - - - public static function detailsCircle($circleId) { - $c = self::getContainer(); - - return $c->query('CirclesService') - ->detailsCircle($circleId); - } - - - public static function destroyCircle($circleId) { - $c = self::getContainer(); - - return $c->query('CirclesService') - ->removeCircle($circleId); - } - - - public static function shareToCircle( - $circleId, $source, $type, array $payload, $broadcaster - ) { - $c = self::getContainer(); - - $frame = new SharingFrame((string)$source, (string)$type); - $frame->setCircleId((int)$circleId); - $frame->setPayload($payload); - - return $c->query('SharesService') - ->createFrame($frame, (string)$broadcaster); - } - - - public static function addMember($circleId, $userId) { - $c = self::getContainer(); - - return $c->query('MembersService') - ->addMember($circleId, $userId); - } - -}
\ No newline at end of file diff --git a/lib/Api/v1/Circles.php b/lib/Api/v1/Circles.php new file mode 100644 index 00000000..73dfa67b --- /dev/null +++ b/lib/Api/v1/Circles.php @@ -0,0 +1,272 @@ +<?php +/** + * Circles - Bring cloud-users closer together. + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright 2017 + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * 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 + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCA\Circles\Api\v1; + + +use OCA\Circles\AppInfo\Application; +use OCA\Circles\Model\Circle; +use OCA\Circles\Model\FederatedLink; +use OCA\Circles\Model\Member; +use OCA\Circles\Model\SharingFrame; + +class Circles { + + + protected static function getContainer() { + $app = new Application(); + + return $app->getContainer(); + } + + + /** + * Circles::createCircle(); + * + * Create a new circle and make the current user its owner. + * You must specify type and name. type is one of this value: + * + * CIRCLES_PERSONAL is 1 or 'personal' + * CIRCLES_HIDDEN is 2 or 'hidden' + * CIRCLES_PRIVATE is 4 or 'private' + * CIRCLES_PUBLIC is 8 or 'public' + * + * @param $type + * @param $name + * + * @return Circle + */ + public static function createCircle($type, $name) { + $c = self::getContainer(); + + return $c->query('CirclesService') + ->createCircle($type, $name); + } + + + /** + * Circles::joinCircle(); + * + * This function will make the current user joining a circle identified by its Id. + * + * @param $circleId + * + * @return Member + */ + public static function joinCircle($circleId) { + $c = self::getContainer(); + + return $c->query('CirclesService') + ->joinCircle($circleId); + } + + + /** + * Circles::leaveCircle(); + * + * This function will make the current user leaving the circle identified by its Id. Will fail + * if user is the owner of the circle. + * + * @param $circleId + * + * @return Member + */ + public static function leaveCircle($circleId) { + $c = self::getContainer(); + + return $c->query('CirclesService') + ->joinCircle($circleId); + } + + + /** + * Circles::listCircles(); + * + * This function list all circles fitting a search regarding its name and the level and the + * rights from the current user. In case of Hidden circle, name needs to be complete so the + * circle is included in the list (or if the current user is the owner) + * + * example: Circles::listCircles(Circle::CIRCLES_ALL, '', 8, callback); will returns all + * circles when the current user is at least an Admin. + * + * @param $type + * @param string $name + * @param int $level + * + * @return Circle[] + */ + public static function listCircles($type, $name = '', $level = 0) { + $c = self::getContainer(); + + return $c->query('CirclesService') + ->listCircles($type, $name, $level); + } + + + /** + * Circles::detailsCircle(); + * + * Returns details on the circle. If the current user is a member, the members list will be + * return as well. + * + * @param $circleId + * + * @return Circle + */ + public static function detailsCircle($circleId) { + $c = self::getContainer(); + + return $c->query('CirclesService') + ->detailsCircle($circleId); + } + + + /** + * Circles::destroyCircle(); + * + * This function will destroy the circle if the current user is the Owner. + * + * @param $circleId + * + * @return mixed + */ + public static function destroyCircle($circleId) { + $c = self::getContainer(); + + return $c->query('CirclesService') + ->removeCircle($circleId); + } + + + /** + * Circles::addMember(); + * + * This function will add a user as member of the circle. Current user need at least to be + * Moderator. + * + * @param $circleId + * @param $userId + * + * @return Member[] + */ + public static function addMember($circleId, $userId) { + $c = self::getContainer(); + + return $c->query('MembersService') + ->addMember($circleId, $userId); + } + + + /** + * Circles::removeMember(); + * + * This function will remove a member from the circle. Current user needs to be at least + * Moderator and have a higher level that the targeted member. + * + * @param $circleId + * @param $userId + * + * @return Member[] + */ + public static function removeMember($circleId, $userId) { + $c = self::getContainer(); + + return $c->query('MembersService') + ->removeMember($circleId, $userId); + } + + + /** + * Circles::levelMember(); + * + * Edit the level of a member of the circle. The current level of the target needs to be lower + * than the user that initiate the process (ie. the current user). The new level of the target + * cannot be the same than the current level of the user that initiate the process (ie. the + * current user). + * + * @param $circleId + * @param $userId + * @param $level + * + * @return Member[] + */ + public static function levelMember($circleId, $userId, $level) { + $c = self::getContainer(); + + return $c->query('MembersService') + ->levelMember($circleId, $userId, $level); + } + + + /** + * Circles::shareToCircle(); + * + * This function will share an item (array) to the circle identified by its Id. + * Source is the app that is sharing the item and type can be used by the app to identified the + * payload. + * + * @param $circleId + * @param $source + * @param $type + * @param array $payload + * @param $broadcaster + * + * @return mixed + */ + public static function shareToCircle( + $circleId, $source, $type, array $payload, $broadcaster + ) { + $c = self::getContainer(); + + $frame = new SharingFrame((string)$source, (string)$type); + $frame->setCircleId((int)$circleId); + $frame->setPayload($payload); + + return $c->query('SharesService') + ->createFrame($frame, (string)$broadcaster); + } + + + /** + * Circles::linkCircle(); + * + * Initiate a link procedure. Current user must be at least Admin of the circle. + * circleId is the local circle and remote is the target for the link. + * Remote format is: <circle_name>@<remote_host> when remote_host must be a valid HTTPS address. + * + * @param $circleId + * @param $remote + * + * @return FederatedLink + */ + public static function linkCircle($circleId, $remote) { + $c = self::getContainer(); + + return $c->query('FederatedService') + ->linkCircle($circleId, $remote); + } + +}
\ No newline at end of file diff --git a/lib/Service/CirclesService.php b/lib/Service/CirclesService.php index 38c3b272..905b983a 100644 --- a/lib/Service/CirclesService.php +++ b/lib/Service/CirclesService.php @@ -132,7 +132,7 @@ class CirclesService { * @param string $name * @param int $level * - * @return array + * @return Circle[] * @throws CircleTypeDisabledException */ public function listCircles($type, $name = '', $level = 0) { |