2013-09-24 15:10:01 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Bernhard Reiter <ockham@raz.or.at>
|
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
* @author Thomas Tanghus <thomas@tanghus.net>
|
|
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
|
|
|
*
|
|
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
|
|
* @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/>
|
|
|
|
*
|
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Factory class creating instances of \OCP\ITags
|
2013-09-24 15:10:01 +00:00
|
|
|
*
|
2015-02-26 10:37:37 +00:00
|
|
|
* A tag can be e.g. 'Family', 'Work', 'Chore', 'Special Occation' or
|
|
|
|
* anything else that is either parsed from a vobject or that the user chooses
|
|
|
|
* to add.
|
|
|
|
* Tag names are not case-sensitive, but will be saved with the case they
|
|
|
|
* are entered in. If a user already has a tag 'family' for a type, and
|
|
|
|
* tries to add a tag named 'Family' it will be silently ignored.
|
2013-09-24 15:10:01 +00:00
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2013-09-24 15:10:01 +00:00
|
|
|
namespace OC;
|
|
|
|
|
2014-09-08 17:58:43 +00:00
|
|
|
use OC\Tagging\TagMapper;
|
|
|
|
|
2013-09-24 15:10:01 +00:00
|
|
|
class TagManager implements \OCP\ITagManager {
|
|
|
|
|
|
|
|
/**
|
2014-12-10 14:59:41 +00:00
|
|
|
* User session
|
2013-09-24 15:10:01 +00:00
|
|
|
*
|
2014-12-10 14:59:41 +00:00
|
|
|
* @var \OCP\IUserSession
|
2013-09-24 15:10:01 +00:00
|
|
|
*/
|
2014-12-10 14:59:41 +00:00
|
|
|
private $userSession;
|
2013-09-24 15:10:01 +00:00
|
|
|
|
2014-09-08 17:58:43 +00:00
|
|
|
/**
|
|
|
|
* TagMapper
|
|
|
|
*
|
|
|
|
* @var TagMapper
|
|
|
|
*/
|
|
|
|
private $mapper;
|
|
|
|
|
2013-09-24 15:10:01 +00:00
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
2014-09-08 17:58:43 +00:00
|
|
|
* @param TagMapper $mapper Instance of the TagMapper abstraction layer.
|
2014-12-10 14:59:41 +00:00
|
|
|
* @param \OCP\IUserSession $userSession the user session
|
2013-09-24 15:10:01 +00:00
|
|
|
*/
|
2014-12-10 14:59:41 +00:00
|
|
|
public function __construct(TagMapper $mapper, \OCP\IUserSession $userSession) {
|
2014-09-08 17:58:43 +00:00
|
|
|
$this->mapper = $mapper;
|
2014-12-10 14:59:41 +00:00
|
|
|
$this->userSession = $userSession;
|
2013-09-24 15:10:01 +00:00
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a new \OCP\ITags instance and load tags from db.
|
|
|
|
*
|
|
|
|
* @see \OCP\ITags
|
|
|
|
* @param string $type The type identifier e.g. 'contact' or 'event'.
|
|
|
|
* @param array $defaultTags An array of default tags to be used if none are stored.
|
2014-09-15 22:20:52 +00:00
|
|
|
* @param boolean $includeShared Whether to include tags for items shared with this user by others.
|
2014-12-10 14:59:41 +00:00
|
|
|
* @param string $userId user for which to retrieve the tags, defaults to the currently
|
|
|
|
* logged in user
|
2013-09-24 15:10:01 +00:00
|
|
|
* @return \OCP\ITags
|
|
|
|
*/
|
2014-12-10 14:59:41 +00:00
|
|
|
public function load($type, $defaultTags = array(), $includeShared = false, $userId = null) {
|
|
|
|
if (is_null($userId)) {
|
2015-02-25 16:20:26 +00:00
|
|
|
$user = $this->userSession->getUser();
|
|
|
|
if ($user === null) {
|
|
|
|
// nothing we can do without a user
|
|
|
|
return null;
|
|
|
|
}
|
2014-12-10 14:59:41 +00:00
|
|
|
$userId = $this->userSession->getUser()->getUId();
|
|
|
|
}
|
|
|
|
return new Tags($this->mapper, $userId, $type, $defaultTags, $includeShared);
|
2013-09-24 15:10:01 +00:00
|
|
|
}
|
|
|
|
|
2014-10-02 14:08:24 +00:00
|
|
|
}
|