mirror of https://github.com/nextcloud/server.git
extend the reference API for the new link picker
- add 2 interfaces for discoverable and searchable reference providers - new OCS route to get info on discoverable/searchable reference providers - new abstract ADiscoverableReferenceProvider that only implements jsonSerialize - listen to RenderReferenceEvent to inject provider list with initial state Signed-off-by: Julien Veyssier <julien-nc@posteo.net>pull/35557/head
parent
aee6b37f3f
commit
6431c5a559
@ -0,0 +1,62 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2022 Julien Veyssier <eneiluj@posteo.net>
|
||||
*
|
||||
* @author Julien Veyssier <eneiluj@posteo.net>
|
||||
*
|
||||
* @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 OC\Collaboration\Reference;
|
||||
|
||||
use OCP\Collaboration\Reference\IDiscoverableReferenceProvider;
|
||||
use OCP\Collaboration\Reference\IReferenceManager;
|
||||
use OCP\Collaboration\Reference\RenderReferenceEvent;
|
||||
use OCP\EventDispatcher\Event;
|
||||
use OCP\EventDispatcher\IEventDispatcher;
|
||||
use OCP\EventDispatcher\IEventListener;
|
||||
use OCP\IInitialStateService;
|
||||
|
||||
class RenderReferenceEventListener implements IEventListener {
|
||||
private IReferenceManager $manager;
|
||||
private IInitialStateService $initialStateService;
|
||||
|
||||
public function __construct(IReferenceManager $manager, IInitialStateService $initialStateService) {
|
||||
$this->manager = $manager;
|
||||
$this->initialStateService = $initialStateService;
|
||||
}
|
||||
|
||||
public static function register(IEventDispatcher $eventDispatcher): void {
|
||||
$eventDispatcher->addServiceListener(RenderReferenceEvent::class, RenderReferenceEventListener::class);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function handle(Event $event): void {
|
||||
if (!($event instanceof RenderReferenceEvent)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$providers = $this->manager->getDiscoverableProviders();
|
||||
$jsonProviders = array_map(static function (IDiscoverableReferenceProvider $provider) {
|
||||
return $provider->jsonSerialize();
|
||||
}, $providers);
|
||||
$this->initialStateService->provideInitialState('core', 'reference-provider-list', $jsonProviders);
|
||||
}
|
||||
}
|
@ -0,0 +1,47 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2022 Julien Veyssier <eneiluj@posteo.net>
|
||||
*
|
||||
* @author Julien Veyssier <eneiluj@posteo.net>
|
||||
*
|
||||
* @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 OCP\Collaboration\Reference;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
abstract class ADiscoverableReferenceProvider implements IDiscoverableReferenceProvider {
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function jsonSerialize(): array {
|
||||
$json = [
|
||||
'id' => $this->getId(),
|
||||
'title' => $this->getTitle(),
|
||||
'icon_url' => $this->getIconUrl(),
|
||||
'order' => $this->getOrder(),
|
||||
];
|
||||
if ($this instanceof ISearchableReferenceProvider) {
|
||||
$json['search_providers_ids'] = $this->getSupportedSearchProviderIds();
|
||||
}
|
||||
return $json;
|
||||
}
|
||||
}
|
@ -0,0 +1,60 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2022 Julien Veyssier <eneiluj@posteo.net>
|
||||
*
|
||||
* @author Julien Veyssier <eneiluj@posteo.net>
|
||||
*
|
||||
* @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 OCP\Collaboration\Reference;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
interface IDiscoverableReferenceProvider extends IReferenceProvider {
|
||||
/**
|
||||
* @return string Unique id that identifies the reference provider
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function getId(): string;
|
||||
|
||||
/**
|
||||
* @return string User facing title of the widget
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function getTitle(): string;
|
||||
|
||||
/**
|
||||
* @return int Initial order for reference provider sorting
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function getOrder(): int;
|
||||
|
||||
/**
|
||||
* @return string url to an icon that can be displayed next to the reference provider title
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function getIconUrl(): string;
|
||||
|
||||
/**
|
||||
* @return array representation of the provider
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function jsonSerialize(): array;
|
||||
}
|
@ -0,0 +1,36 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2022 Julien Veyssier <eneiluj@posteo.net>
|
||||
*
|
||||
* @author Julien Veyssier <eneiluj@posteo.net>
|
||||
*
|
||||
* @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 OCP\Collaboration\Reference;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
interface ISearchableReferenceProvider extends IDiscoverableReferenceProvider {
|
||||
/**
|
||||
* @return string[] list of search provider IDs that can be used by the vue-richtext picker
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function getSupportedSearchProviderIds(): array;
|
||||
}
|
Loading…
Reference in New Issue