nextcloud / server

apps/admin_audit/lib/Actions/AppManagement.php

Indentation +28 added lines, -28 removed lines

@@ -26,34 +26,34 @@
 
 class AppManagement extends Action {
 
-	/**
-	 * @param string $appName
-	 */
-	public function enableApp(string $appName) {
-		$this->log('App "%s" enabled',
-			['app' => $appName],
-			['app']
-		);
-	}
+    /**
+     * @param string $appName
+     */
+    public function enableApp(string $appName) {
+        $this->log('App "%s" enabled',
+            ['app' => $appName],
+            ['app']
+        );
+    }
 
-	/**
-	 * @param string $appName
-	 * @param string[] $groups
-	 */
-	public function enableAppForGroups(string $appName, array $groups) {
-		$this->log('App "%1$s" enabled for groups: %2$s',
-			['app' => $appName, 'groups' => implode(', ', $groups)],
-			['app', 'groups']
-		);
-	}
+    /**
+     * @param string $appName
+     * @param string[] $groups
+     */
+    public function enableAppForGroups(string $appName, array $groups) {
+        $this->log('App "%1$s" enabled for groups: %2$s',
+            ['app' => $appName, 'groups' => implode(', ', $groups)],
+            ['app', 'groups']
+        );
+    }
 
-	/**
-	 * @param string $appName
-	 */
-	public function disableApp(string $appName) {
-		$this->log('App "%s" disabled',
-			['app' => $appName],
-			['app']
-		);
-	}
+    /**
+     * @param string $appName
+     */
+    public function disableApp(string $appName) {
+        $this->log('App "%s" disabled',
+            ['app' => $appName],
+            ['app']
+        );
+    }
 }

lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php

Indentation +14 added lines, -14 removed lines

@@ -32,19 +32,19 @@
  */
 class ProviderAlreadyExistsException extends HintException {
 
-	/**
-	 * ProviderAlreadyExistsException constructor.
-	 *
-	 * @since 14.0.0
-	 *
-	 * @param string $newProviderId cloud federation provider ID of the new provider
-	 * @param string $existingProviderName name of cloud federation provider which already use the same ID
-	 */
-	public function __construct($newProviderId, $existingProviderName) {
-		$l = \OC::$server->getL10N('federation');
-		$message = 'ID "' . $newProviderId . '" already used by cloud federation provider "' . $existingProviderName . '"';
-		$hint = $l->t('ID "%1$s" already used by cloud federation provider "%2$s"', [$newProviderId, $existingProviderName]);
-		parent::__construct($message, $hint);
-	}
+    /**
+     * ProviderAlreadyExistsException constructor.
+     *
+     * @since 14.0.0
+     *
+     * @param string $newProviderId cloud federation provider ID of the new provider
+     * @param string $existingProviderName name of cloud federation provider which already use the same ID
+     */
+    public function __construct($newProviderId, $existingProviderName) {
+        $l = \OC::$server->getL10N('federation');
+        $message = 'ID "' . $newProviderId . '" already used by cloud federation provider "' . $existingProviderName . '"';
+        $hint = $l->t('ID "%1$s" already used by cloud federation provider "%2$s"', [$newProviderId, $existingProviderName]);
+        parent::__construct($message, $hint);
+    }
 
 }

lib/public/AppFramework/Utility/ITimeFactory.php

Indentation +12 added lines, -12 removed lines

@@ -31,18 +31,18 @@
  */
 interface ITimeFactory {
 
-	/**
-	 * @return int the result of a call to time()
-	 * @since 8.0.0
-	 */
-	public function getTime(): int;
+    /**
+     * @return int the result of a call to time()
+     * @since 8.0.0
+     */
+    public function getTime(): int;
 
-	/**
-	 * @param string $time
-	 * @param \DateTimeZone $timezone
-	 * @return \DateTime
-	 * @since 15.0.0
-	 */
-	public function getDateTime(string $time = 'now', \DateTimeZone $timezone = null): \DateTime;
+    /**
+     * @param string $time
+     * @param \DateTimeZone $timezone
+     * @return \DateTime
+     * @since 15.0.0
+     */
+    public function getDateTime(string $time = 'now', \DateTimeZone $timezone = null): \DateTime;
 
 }

lib/private/AppFramework/Utility/TimeFactory.php

Indentation +16 added lines, -16 removed lines

@@ -34,21 +34,21 @@
 class TimeFactory implements ITimeFactory {
 
 
-	/**
-	 * @return int the result of a call to time()
-	 */
-	public function getTime(): int {
-		return time();
-	}
-
-	/**
-	 * @param string $time
-	 * @param \DateTimeZone $timezone
-	 * @return \DateTime
-	 * @since 15.0.0
-	 */
-	public function getDateTime(string $time = 'now', \DateTimeZone $timezone = null): \DateTime {
-		return new \DateTime($time, $timezone);
-	}
+    /**
+     * @return int the result of a call to time()
+     */
+    public function getTime(): int {
+        return time();
+    }
+
+    /**
+     * @param string $time
+     * @param \DateTimeZone $timezone
+     * @return \DateTime
+     * @since 15.0.0
+     */
+    public function getDateTime(string $time = 'now', \DateTimeZone $timezone = null): \DateTime {
+        return new \DateTime($time, $timezone);
+    }
 
 }

lib/private/Dashboard/DashboardManager.php

Indentation +97 added lines, -97 removed lines

@@ -46,103 +46,103 @@
 class DashboardManager implements IDashboardManager {
 
 
-	/** @var IWidgetsService */
-	private $widgetsService;
-
-	/** @var IEventsService */
-	private $eventsService;
-
-
-	/**
-	 * @param IEventsService $eventsService
-	 */
-	public function registerEventsService(IEventsService $eventsService) {
-		$this->eventsService = $eventsService;
-	}
-
-
-	/**
-	 * @param IWidgetsService $widgetsService
-	 */
-	public function registerWidgetsService(IWidgetsService $widgetsService) {
-		$this->widgetsService = $widgetsService;
-	}
-
-
-	/**
-	 * @param string $widgetId
-	 * @param string $userId
-	 *
-	 * @return IWidgetConfig
-	 * @throws DashboardAppNotAvailableException
-	 */
-	public function getWidgetConfig(string $widgetId, string $userId): IWidgetConfig {
-		return $this->getWidgetsService()->getWidgetConfig($widgetId, $userId);
-	}
-
-
-	/**
-	 * @param string $widgetId
-	 * @param array $users
-	 * @param array $payload
-	 * @param string $uniqueId
-	 *
-	 * @throws DashboardAppNotAvailableException
-	 */
-	public function createUsersEvent(string $widgetId, array $users, array $payload, string $uniqueId = '') {
-		$this->getEventsService()->createUsersEvent($widgetId, $users, $payload, $uniqueId);
-	}
-
-
-	/**
-	 * @param string $widgetId
-	 * @param array $groups
-	 * @param array $payload
-	 * @param string $uniqueId
-	 *
-	 * @throws DashboardAppNotAvailableException
-	 */
-	public function createGroupsEvent(string $widgetId, array $groups, array $payload, string $uniqueId = '') {
-		$this->getEventsService()->createGroupsEvent($widgetId, $groups, $payload, $uniqueId);
-	}
-
-
-	/**
-	 * @param string $widgetId
-	 * @param array $payload
-	 * @param string $uniqueId
-	 *
-	 * @throws DashboardAppNotAvailableException
-	 */
-	public function createGlobalEvent(string $widgetId, array $payload, string $uniqueId = '') {
-		$this->getEventsService()->createGlobalEvent($widgetId, $payload, $uniqueId);
-	}
-
-
-	/**
-	 * @return IWidgetsService
-	 * @throws DashboardAppNotAvailableException
-	 */
-	private function getWidgetsService() {
-		if ($this->widgetsService === null) {
-			throw new DashboardAppNotAvailableException('No IWidgetsService registered');
-		}
-
-		return $this->widgetsService;
-	}
-
-
-	/**
-	 * @return IEventsService
-	 * @throws DashboardAppNotAvailableException
-	 */
-	private function getEventsService() {
-		if ($this->eventsService === null) {
-			throw new DashboardAppNotAvailableException('No IEventsService registered');
-		}
-
-		return $this->eventsService;
-	}
+    /** @var IWidgetsService */
+    private $widgetsService;
+
+    /** @var IEventsService */
+    private $eventsService;
+
+
+    /**
+     * @param IEventsService $eventsService
+     */
+    public function registerEventsService(IEventsService $eventsService) {
+        $this->eventsService = $eventsService;
+    }
+
+
+    /**
+     * @param IWidgetsService $widgetsService
+     */
+    public function registerWidgetsService(IWidgetsService $widgetsService) {
+        $this->widgetsService = $widgetsService;
+    }
+
+
+    /**
+     * @param string $widgetId
+     * @param string $userId
+     *
+     * @return IWidgetConfig
+     * @throws DashboardAppNotAvailableException
+     */
+    public function getWidgetConfig(string $widgetId, string $userId): IWidgetConfig {
+        return $this->getWidgetsService()->getWidgetConfig($widgetId, $userId);
+    }
+
+
+    /**
+     * @param string $widgetId
+     * @param array $users
+     * @param array $payload
+     * @param string $uniqueId
+     *
+     * @throws DashboardAppNotAvailableException
+     */
+    public function createUsersEvent(string $widgetId, array $users, array $payload, string $uniqueId = '') {
+        $this->getEventsService()->createUsersEvent($widgetId, $users, $payload, $uniqueId);
+    }
+
+
+    /**
+     * @param string $widgetId
+     * @param array $groups
+     * @param array $payload
+     * @param string $uniqueId
+     *
+     * @throws DashboardAppNotAvailableException
+     */
+    public function createGroupsEvent(string $widgetId, array $groups, array $payload, string $uniqueId = '') {
+        $this->getEventsService()->createGroupsEvent($widgetId, $groups, $payload, $uniqueId);
+    }
+
+
+    /**
+     * @param string $widgetId
+     * @param array $payload
+     * @param string $uniqueId
+     *
+     * @throws DashboardAppNotAvailableException
+     */
+    public function createGlobalEvent(string $widgetId, array $payload, string $uniqueId = '') {
+        $this->getEventsService()->createGlobalEvent($widgetId, $payload, $uniqueId);
+    }
+
+
+    /**
+     * @return IWidgetsService
+     * @throws DashboardAppNotAvailableException
+     */
+    private function getWidgetsService() {
+        if ($this->widgetsService === null) {
+            throw new DashboardAppNotAvailableException('No IWidgetsService registered');
+        }
+
+        return $this->widgetsService;
+    }
+
+
+    /**
+     * @return IEventsService
+     * @throws DashboardAppNotAvailableException
+     */
+    private function getEventsService() {
+        if ($this->eventsService === null) {
+            throw new DashboardAppNotAvailableException('No IEventsService registered');
+        }
+
+        return $this->eventsService;
+    }
 
 }
 

lib/public/Dashboard/IDashboardWidget.php

Indentation +88 added lines, -88 removed lines

@@ -54,94 +54,94 @@
  */
 interface IDashboardWidget {
 
-	/**
-	 * Should returns the (unique) Id of the widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getId(): string;
-
-
-	/**
-	 * Should returns the [display] name of the widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getName(): string;
-
-
-	/**
-	 * Should returns some text describing the widget.
-	 * This description is displayed in the listing of the available widgets.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getDescription(): string;
-
-
-	/**
-	 * Must generate and return a WidgetTemplate that define important stuff
-	 * about the Widget: icon, content, css or javascript.
-	 *
-	 * @see WidgetTemplate
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function getWidgetTemplate(): WidgetTemplate;
-
-
-	/**
-	 * Must create and return a WidgetSetup containing the general setup of
-	 * the widget
-	 *
-	 * @see WidgetSetup
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return WidgetSetup
-	 */
-	public function getWidgetSetup(): WidgetSetup;
-
-
-	/**
-	 * This method is called when a widget is loaded on the dashboard.
-	 * A widget is 'loaded on the dashboard' when one of these conditions
-	 * occurs:
-	 *
-	 * - the user is adding the widget on his dashboard,
-	 * - the user already added the widget on his dashboard and he is opening
-	 *   the dashboard app.
-	 *
-	 * @see IWidgetConfig
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IWidgetConfig $settings
-	 */
-	public function loadWidget(IWidgetConfig $settings);
-
-
-	/**
-	 * This method s executed when the widget call the net.requestWidget()
-	 * from the Javascript API.
-	 *
-	 * This is used by the frontend to communicate with the backend.
-	 *
-	 * @see IWidgetRequest
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IWidgetRequest $request
-	 */
-	public function requestWidget(IWidgetRequest $request);
+    /**
+     * Should returns the (unique) Id of the widget.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getId(): string;
+
+
+    /**
+     * Should returns the [display] name of the widget.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getName(): string;
+
+
+    /**
+     * Should returns some text describing the widget.
+     * This description is displayed in the listing of the available widgets.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getDescription(): string;
+
+
+    /**
+     * Must generate and return a WidgetTemplate that define important stuff
+     * about the Widget: icon, content, css or javascript.
+     *
+     * @see WidgetTemplate
+     *
+     * @since 15.0.0
+     *
+     * @return WidgetTemplate
+     */
+    public function getWidgetTemplate(): WidgetTemplate;
+
+
+    /**
+     * Must create and return a WidgetSetup containing the general setup of
+     * the widget
+     *
+     * @see WidgetSetup
+     *
+     * @since 15.0.0
+     *
+     * @return WidgetSetup
+     */
+    public function getWidgetSetup(): WidgetSetup;
+
+
+    /**
+     * This method is called when a widget is loaded on the dashboard.
+     * A widget is 'loaded on the dashboard' when one of these conditions
+     * occurs:
+     *
+     * - the user is adding the widget on his dashboard,
+     * - the user already added the widget on his dashboard and he is opening
+     *   the dashboard app.
+     *
+     * @see IWidgetConfig
+     *
+     * @since 15.0.0
+     *
+     * @param IWidgetConfig $settings
+     */
+    public function loadWidget(IWidgetConfig $settings);
+
+
+    /**
+     * This method s executed when the widget call the net.requestWidget()
+     * from the Javascript API.
+     *
+     * This is used by the frontend to communicate with the backend.
+     *
+     * @see IWidgetRequest
+     *
+     * @since 15.0.0
+     *
+     * @param IWidgetRequest $request
+     */
+    public function requestWidget(IWidgetRequest $request);
 
 }
 

lib/public/Dashboard/Model/IWidgetRequest.php

Indentation +84 added lines, -84 removed lines

@@ -48,90 +48,90 @@
  */
 interface IWidgetRequest {
 
-	/**
-	 * Get the widgetId.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getWidgetId(): string;
-
-
-	/**
-	 * Get the WidgetClass.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IDashboardWidget
-	 */
-	public function getWidget(): IDashboardWidget;
-
-
-	/**
-	 * Get the 'request' string sent by the request from the front-end with
-	 * the format:
-	 *
-	 *  net.requestWidget(
-	 *    {
-	 *     widget: widgetId,
-	 *     request: request,
-	 *     value: value
-	 *    },
-	 *    callback);
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getRequest(): string;
-
-
-	/**
-	 * Get the 'value' string sent by the request from the front-end.
-	 *
-	 * @see getRequest
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getValue(): string;
-
-
-	/**
-	 * Returns the result.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getResult(): array;
-
-
-	/**
-	 * add a result (as string)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $key
-	 * @param string $result
-	 *
-	 * @return $this
-	 */
-	public function addResult(string $key, string $result): IWidgetRequest;
-
-	/**
-	 * add a result (as array)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $key
-	 * @param array $result
-	 *
-	 * @return $this
-	 */
-	public function addResultArray(string $key, array $result): IWidgetRequest;
+    /**
+     * Get the widgetId.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getWidgetId(): string;
+
+
+    /**
+     * Get the WidgetClass.
+     *
+     * @since 15.0.0
+     *
+     * @return IDashboardWidget
+     */
+    public function getWidget(): IDashboardWidget;
+
+
+    /**
+     * Get the 'request' string sent by the request from the front-end with
+     * the format:
+     *
+     *  net.requestWidget(
+     *    {
+     *     widget: widgetId,
+     *     request: request,
+     *     value: value
+     *    },
+     *    callback);
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getRequest(): string;
+
+
+    /**
+     * Get the 'value' string sent by the request from the front-end.
+     *
+     * @see getRequest
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getValue(): string;
+
+
+    /**
+     * Returns the result.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getResult(): array;
+
+
+    /**
+     * add a result (as string)
+     *
+     * @since 15.0.0
+     *
+     * @param string $key
+     * @param string $result
+     *
+     * @return $this
+     */
+    public function addResult(string $key, string $result): IWidgetRequest;
+
+    /**
+     * add a result (as array)
+     *
+     * @since 15.0.0
+     *
+     * @param string $key
+     * @param array $result
+     *
+     * @return $this
+     */
+    public function addResultArray(string $key, array $result): IWidgetRequest;
 
 }
 

lib/public/Dashboard/Model/WidgetTemplate.php

Indentation +265 added lines, -265 removed lines

@@ -48,271 +48,271 @@
 final class WidgetTemplate implements JsonSerializable {
 
 
-	/** @var string */
-	private $icon = '';
-
-	/** @var array */
-	private $css = [];
-
-	/** @var array */
-	private $js = [];
-
-	/** @var string */
-	private $content = '';
-
-	/** @var string */
-	private $function = '';
-
-	/** @var WidgetSetting[] */
-	private $settings = [];
-
-
-	/**
-	 * Get the icon class of the widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getIcon(): string {
-		return $this->icon;
-	}
-
-	/**
-	 * Set the icon class of the widget.
-	 * This class must be defined in one of the CSS file used by the widget.
-	 *
-	 * @see addCss
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $icon
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function setIcon(string $icon): WidgetTemplate {
-		$this->icon = $icon;
-
-		return $this;
-	}
-
-	/**
-	 * Get CSS files to be included when displaying a widget
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getCss(): array {
-		return $this->css;
-	}
-
-	/**
-	 * path and name of CSS files
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $css
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function setCss(array $css): WidgetTemplate {
-		$this->css = $css;
-
-		return $this;
-	}
-
-	/**
-	 * Add a CSS file to be included when displaying a widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $css
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function addCss(string $css): WidgetTemplate {
-		$this->css[] = $css;
-
-		return $this;
-	}
-
-	/**
-	 * Get JS files to be included when loading a widget
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getJs(): array {
-		return $this->js;
-	}
-
-	/**
-	 * Set an array of JS files to be included when loading a widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $js
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function setJs(array $js): WidgetTemplate {
-		$this->js = $js;
-
-		return $this;
-	}
-
-	/**
-	 * Add a JS file to be included when loading a widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $js
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function addJs(string $js): WidgetTemplate {
-		$this->js[] = $js;
-
-		return $this;
-	}
-
-	/**
-	 * Get the HTML file that contains the content of the widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getContent(): string {
-		return $this->content;
-	}
-
-	/**
-	 * Set the HTML file that contains the content of the widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $content
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function setContent(string $content): WidgetTemplate {
-		$this->content = $content;
-
-		return $this;
-	}
-
-	/**
-	 * Get the JS function to be called when loading the widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getInitFunction(): string {
-		return $this->function;
-	}
-
-	/**
-	 * JavaScript function to be called when loading the widget on the
-	 * dashboard
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $function
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function setInitFunction(string $function): WidgetTemplate {
-		$this->function = $function;
-
-		return $this;
-	}
-
-	/**
-	 * Get all WidgetSetting defined for the widget.
-	 *
-	 * @see WidgetSetting
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return WidgetSetting[]
-	 */
-	public function getSettings(): array {
-		return $this->settings;
-	}
-
-	/**
-	 * Define all WidgetSetting for the widget.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @see WidgetSetting
-	 *
-	 * @param WidgetSetting[] $settings
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function setSettings(array $settings): WidgetTemplate {
-		$this->settings = $settings;
-
-		return $this;
-	}
-
-	/**
-	 * Add a WidgetSetting.
-	 *
-	 * @see WidgetSetting
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param WidgetSetting $setting
-	 *
-	 * @return WidgetTemplate
-	 */
-	public function addSetting(WidgetSetting $setting): WidgetTemplate {
-		$this->settings[] = $setting;
-
-		return $this;
-	}
-
-	/**
-	 * Get a WidgetSetting by its name
-	 *
-	 * @see WidgetSetting::setName
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $key
-	 *
-	 * @return WidgetSetting
-	 */
-	public function getSetting(string $key): WidgetSetting {
-		if (!array_key_exists($key, $this->settings)) {
-			return null;
-		}
-
-		return $this->settings[$key];
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize() {
-		return [
-			'icon' => $this->getIcon(),
-			'css' => $this->getCss(),
-			'js' => $this->getJs(),
-			'content' => $this->getContent(),
-			'function' => $this->getInitFunction(),
-			'settings' => $this->getSettings()
-		];
-	}
+    /** @var string */
+    private $icon = '';
+
+    /** @var array */
+    private $css = [];
+
+    /** @var array */
+    private $js = [];
+
+    /** @var string */
+    private $content = '';
+
+    /** @var string */
+    private $function = '';
+
+    /** @var WidgetSetting[] */
+    private $settings = [];
+
+
+    /**
+     * Get the icon class of the widget.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getIcon(): string {
+        return $this->icon;
+    }
+
+    /**
+     * Set the icon class of the widget.
+     * This class must be defined in one of the CSS file used by the widget.
+     *
+     * @see addCss
+     *
+     * @since 15.0.0
+     *
+     * @param string $icon
+     *
+     * @return WidgetTemplate
+     */
+    public function setIcon(string $icon): WidgetTemplate {
+        $this->icon = $icon;
+
+        return $this;
+    }
+
+    /**
+     * Get CSS files to be included when displaying a widget
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getCss(): array {
+        return $this->css;
+    }
+
+    /**
+     * path and name of CSS files
+     *
+     * @since 15.0.0
+     *
+     * @param array $css
+     *
+     * @return WidgetTemplate
+     */
+    public function setCss(array $css): WidgetTemplate {
+        $this->css = $css;
+
+        return $this;
+    }
+
+    /**
+     * Add a CSS file to be included when displaying a widget.
+     *
+     * @since 15.0.0
+     *
+     * @param string $css
+     *
+     * @return WidgetTemplate
+     */
+    public function addCss(string $css): WidgetTemplate {
+        $this->css[] = $css;
+
+        return $this;
+    }
+
+    /**
+     * Get JS files to be included when loading a widget
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getJs(): array {
+        return $this->js;
+    }
+
+    /**
+     * Set an array of JS files to be included when loading a widget.
+     *
+     * @since 15.0.0
+     *
+     * @param array $js
+     *
+     * @return WidgetTemplate
+     */
+    public function setJs(array $js): WidgetTemplate {
+        $this->js = $js;
+
+        return $this;
+    }
+
+    /**
+     * Add a JS file to be included when loading a widget.
+     *
+     * @since 15.0.0
+     *
+     * @param string $js
+     *
+     * @return WidgetTemplate
+     */
+    public function addJs(string $js): WidgetTemplate {
+        $this->js[] = $js;
+
+        return $this;
+    }
+
+    /**
+     * Get the HTML file that contains the content of the widget.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getContent(): string {
+        return $this->content;
+    }
+
+    /**
+     * Set the HTML file that contains the content of the widget.
+     *
+     * @since 15.0.0
+     *
+     * @param string $content
+     *
+     * @return WidgetTemplate
+     */
+    public function setContent(string $content): WidgetTemplate {
+        $this->content = $content;
+
+        return $this;
+    }
+
+    /**
+     * Get the JS function to be called when loading the widget.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getInitFunction(): string {
+        return $this->function;
+    }
+
+    /**
+     * JavaScript function to be called when loading the widget on the
+     * dashboard
+     *
+     * @since 15.0.0
+     *
+     * @param string $function
+     *
+     * @return WidgetTemplate
+     */
+    public function setInitFunction(string $function): WidgetTemplate {
+        $this->function = $function;
+
+        return $this;
+    }
+
+    /**
+     * Get all WidgetSetting defined for the widget.
+     *
+     * @see WidgetSetting
+     *
+     * @since 15.0.0
+     *
+     * @return WidgetSetting[]
+     */
+    public function getSettings(): array {
+        return $this->settings;
+    }
+
+    /**
+     * Define all WidgetSetting for the widget.
+     *
+     * @since 15.0.0
+     *
+     * @see WidgetSetting
+     *
+     * @param WidgetSetting[] $settings
+     *
+     * @return WidgetTemplate
+     */
+    public function setSettings(array $settings): WidgetTemplate {
+        $this->settings = $settings;
+
+        return $this;
+    }
+
+    /**
+     * Add a WidgetSetting.
+     *
+     * @see WidgetSetting
+     *
+     * @since 15.0.0
+     *
+     * @param WidgetSetting $setting
+     *
+     * @return WidgetTemplate
+     */
+    public function addSetting(WidgetSetting $setting): WidgetTemplate {
+        $this->settings[] = $setting;
+
+        return $this;
+    }
+
+    /**
+     * Get a WidgetSetting by its name
+     *
+     * @see WidgetSetting::setName
+     *
+     * @since 15.0.0
+     *
+     * @param string $key
+     *
+     * @return WidgetSetting
+     */
+    public function getSetting(string $key): WidgetSetting {
+        if (!array_key_exists($key, $this->settings)) {
+            return null;
+        }
+
+        return $this->settings[$key];
+    }
+
+
+    /**
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function jsonSerialize() {
+        return [
+            'icon' => $this->getIcon(),
+            'css' => $this->getCss(),
+            'js' => $this->getJs(),
+            'content' => $this->getContent(),
+            'function' => $this->getInitFunction(),
+            'settings' => $this->getSettings()
+        ];
+    }
 
 
 }

lib/public/Dashboard/IDashboardManager.php

Indentation +83 added lines, -83 removed lines

@@ -49,89 +49,89 @@
 interface IDashboardManager {
 
 
-	/**
-	 * Register a IWidgetsService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IWidgetsService $widgetsService
-	 */
-	public function registerWidgetsService(IWidgetsService $widgetsService);
-
-
-	/**
-	 * Register a IEventsService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IEventsService $eventsService
-	 */
-	public function registerEventsService(IEventsService $eventsService);
-
-
-	/**
-	 * returns the OCP\Dashboard\Model\IWidgetConfig for a widgetId and userId.
-	 *
-	 * @see IWidgetConfig
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $widgetId
-	 * @param string $userId
-	 *
-	 * @throws DashboardAppNotAvailableException
-	 * @return IWidgetConfig
-	 */
-	public function getWidgetConfig(string $widgetId, string $userId): IWidgetConfig;
-
-
-	/**
-	 * Create push notifications for users.
-	 * $payload is an array that will be send to the Javascript method
-	 * called on push.
-	 * $uniqueId needs to be used if you send the push to multiples users
-	 * and multiples groups so that one user does not have duplicate
-	 * notifications.
-	 *
-	 * Push notifications are created in database and broadcast to user
-	 * that are running dashboard.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $widgetId
-	 * @param array $users
-	 * @param array $payload
-	 * @param string $uniqueId
-	 * @throws DashboardAppNotAvailableException
-	 */
-	public function createUsersEvent(string $widgetId, array $users, array $payload, string $uniqueId = '');
-
-
-	/**
-	 * Create push notifications for groups. (ie. createUsersEvent())
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $widgetId
-	 * @param array $groups
-	 * @param array $payload
-	 * @param string $uniqueId
-	 * @throws DashboardAppNotAvailableException
-	 */
-	public function createGroupsEvent(string $widgetId, array $groups, array $payload, string $uniqueId = '');
-
-
-	/**
-	 * Create push notifications for everyone. (ie. createUsersEvent())
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $widgetId
-	 * @param array $payload
-	 * @param string $uniqueId
-	 * @throws DashboardAppNotAvailableException
-	 */
-	public function createGlobalEvent(string $widgetId, array $payload, string $uniqueId = '');
+    /**
+     * Register a IWidgetsService.
+     *
+     * @since 15.0.0
+     *
+     * @param IWidgetsService $widgetsService
+     */
+    public function registerWidgetsService(IWidgetsService $widgetsService);
+
+
+    /**
+     * Register a IEventsService.
+     *
+     * @since 15.0.0
+     *
+     * @param IEventsService $eventsService
+     */
+    public function registerEventsService(IEventsService $eventsService);
+
+
+    /**
+     * returns the OCP\Dashboard\Model\IWidgetConfig for a widgetId and userId.
+     *
+     * @see IWidgetConfig
+     *
+     * @since 15.0.0
+     *
+     * @param string $widgetId
+     * @param string $userId
+     *
+     * @throws DashboardAppNotAvailableException
+     * @return IWidgetConfig
+     */
+    public function getWidgetConfig(string $widgetId, string $userId): IWidgetConfig;
+
+
+    /**
+     * Create push notifications for users.
+     * $payload is an array that will be send to the Javascript method
+     * called on push.
+     * $uniqueId needs to be used if you send the push to multiples users
+     * and multiples groups so that one user does not have duplicate
+     * notifications.
+     *
+     * Push notifications are created in database and broadcast to user
+     * that are running dashboard.
+     *
+     * @since 15.0.0
+     *
+     * @param string $widgetId
+     * @param array $users
+     * @param array $payload
+     * @param string $uniqueId
+     * @throws DashboardAppNotAvailableException
+     */
+    public function createUsersEvent(string $widgetId, array $users, array $payload, string $uniqueId = '');
+
+
+    /**
+     * Create push notifications for groups. (ie. createUsersEvent())
+     *
+     * @since 15.0.0
+     *
+     * @param string $widgetId
+     * @param array $groups
+     * @param array $payload
+     * @param string $uniqueId
+     * @throws DashboardAppNotAvailableException
+     */
+    public function createGroupsEvent(string $widgetId, array $groups, array $payload, string $uniqueId = '');
+
+
+    /**
+     * Create push notifications for everyone. (ie. createUsersEvent())
+     *
+     * @since 15.0.0
+     *
+     * @param string $widgetId
+     * @param array $payload
+     * @param string $uniqueId
+     * @throws DashboardAppNotAvailableException
+     */
+    public function createGlobalEvent(string $widgetId, array $payload, string $uniqueId = '');
 
 }