diff options
author | Joas Schilling <coding@schilljs.com> | 2016-05-24 16:44:19 +0300 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2016-07-18 11:26:42 +0300 |
commit | 7c039bcbf67128fa72b66f6553af5f5802ae5ea1 (patch) | |
tree | 19c380dcd2bb8a4ed87b5f15e96cdb36d7edbc2c /lib/public/SystemTag | |
parent | c2b077e185495cf3ac42861fece2ed332ddbeb2e (diff) |
Allow apps to register SystemTags plugins
Diffstat (limited to 'lib/public/SystemTag')
-rw-r--r-- | lib/public/SystemTag/SystemTagsEntityEvent.php | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/lib/public/SystemTag/SystemTagsEntityEvent.php b/lib/public/SystemTag/SystemTagsEntityEvent.php new file mode 100644 index 00000000000..d57b26709d1 --- /dev/null +++ b/lib/public/SystemTag/SystemTagsEntityEvent.php @@ -0,0 +1,76 @@ +<?php +/** + * @author Joas Schilling <nickvergessen@owncloud.com> + * + * @copyright Copyright (c) 2016, 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/> + * + */ + +namespace OCP\SystemTag; + +use Symfony\Component\EventDispatcher\Event; + +/** + * Class SystemTagsEntityEvent + * + * @package OCP\SystemTag + * @since 9.2.0 + */ +class SystemTagsEntityEvent extends Event { + + const EVENT_ENTITY = 'OCP\SystemTag\ISystemTagManager::registerEntity'; + + /** @var string */ + protected $event; + /** @var \Closure[] */ + protected $collections; + + /** + * SystemTagsEntityEvent constructor. + * + * @param string $event + * @since 9.2.0 + */ + public function __construct($event) { + $this->event = $event; + $this->collections = []; + } + + /** + * @param string $name + * @param \Closure $entityExistsFunction The closure should take one + * argument, which is the id of the entity, that tags + * should be handled for. The return should then be bool, + * depending on whether tags are allowed (true) or not. + * @throws \OutOfBoundsException when the entity name is already taken + * @since 9.2.0 + */ + public function addEntityCollection($name, \Closure $entityExistsFunction) { + if (isset($this->collections[$name])) { + throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); + } + + $this->collections[$name] = $entityExistsFunction; + } + + /** + * @return \Closure[] + * @since 9.2.0 + */ + public function getEntityCollections() { + return $this->collections; + } +} |