Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Cleanup public api methods
Signed-off-by: Julius Härtl <[email protected]>
  • Loading branch information
juliusknorr committed Jul 15, 2020
commit b71de68f438e60925d302a5698cf0a0590e96b00
12 changes: 9 additions & 3 deletions apps/dashboard/lib/Controller/DashboardController.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
use OCP\AppFramework\Http\TemplateResponse;
use OCP\Dashboard\IManager;
use OCP\Dashboard\IPanel;
use OCP\Dashboard\IRegisterPanelEvent;
use OCP\Dashboard\RegisterPanelEvent;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IInitialStateService;
use OCP\IRequest;
Expand All @@ -42,7 +42,13 @@ class DashboardController extends Controller {
/** @var IManager */
private $dashboardManager;

public function __construct($appName, IRequest $request, IInitialStateService $initialStateService, IEventDispatcher $eventDispatcher, IManager $dashboardManager) {
public function __construct(
$appName,
IRequest $request,
IInitialStateService $initialStateService,
IEventDispatcher $eventDispatcher,
IManager $dashboardManager
) {
parent::__construct($appName, $request);

$this->inititalStateService = $initialStateService;
Expand All @@ -56,7 +62,7 @@ public function __construct($appName, IRequest $request, IInitialStateService $i
* @return TemplateResponse
*/
public function index(): TemplateResponse {
$this->eventDispatcher->dispatchTyped(new IRegisterPanelEvent($this->dashboardManager));
$this->eventDispatcher->dispatchTyped(new RegisterPanelEvent($this->dashboardManager));

$dashboardManager = $this->dashboardManager;
$panels = array_map(function (IPanel $panel) {
Expand Down
8 changes: 3 additions & 5 deletions lib/private/Dashboard/Manager.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use OCP\AppFramework\QueryException;
use OCP\Dashboard\IManager;
use OCP\Dashboard\IPanel;
use OCP\ILogger;
use OCP\IServerContainer;

class Manager implements IManager {
Expand All @@ -43,10 +44,7 @@ public function __construct(IServerContainer $serverContainer) {
$this->serverContainer = $serverContainer;
}

/**
* @inheritDoc
*/
public function registerPanel(IPanel $panel): void {
private function registerPanel(IPanel $panel): void {
if (array_key_exists($panel->getId(), $this->panels)) {
throw new \InvalidArgumentException('Dashboard panel with this id has already been registered');
}
Expand Down Expand Up @@ -86,7 +84,7 @@ public function loadLazyPanels(): void {
* we can not inject it. Thus the static call.
*/
\OC::$server->getLogger()->logException($e, [
'message' => 'Could not register lazy crash reporter: ' . $e->getMessage(),
'message' => 'Could not register lazy dashboard panel: ' . $e->getMessage(),
'level' => ILogger::FATAL,
]);
}
Expand Down
6 changes: 0 additions & 6 deletions lib/public/Dashboard/IManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,6 @@
*/
interface IManager {

/**
* @param IPanel $panel
* @since 20.0.0
*/
public function registerPanel(IPanel $panel): void;

/**
* @param string $panelClass
* @since 20.0.0
Expand Down
6 changes: 0 additions & 6 deletions lib/public/Dashboard/IPanel.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,6 @@ public function getOrder(): int;
*/
public function getIconClass(): string;

/**
* @return string The absolute path to an icon in SVG
* @since 20.0.0
*/
public function getIconUrl(): string;

/**
* @return string The absolute url to the apps own view
* @since 20.0.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
use OCP\EventDispatcher\Event;

/**
* Class IRegisterPanelEvent
* Class RegisterPanelEvent
*
* This event is dispatched to allow apps supporting older Nextcloud versions to
* still register their dashboard panels so that they are only constructed when
Expand All @@ -37,7 +37,7 @@
* @since 20.0.0
* @deprecated 20.0.0
*/
class IRegisterPanelEvent extends Event {
class RegisterPanelEvent extends Event {
private $manager;

public function __construct(IManager $manager) {
Expand All @@ -47,10 +47,10 @@ public function __construct(IManager $manager) {
}

/**
* @param IPanel $panel
* @param string $panelClass
* @since 20.0.0
*/
public function registerPanel(IPanel $panel) {
$this->manager->registerPanel($panel);
public function registerPanel(string $panelClass) {
$this->manager->lazyRegisterPanel($panelClass);
}
}