nextcloud / server

lib/public/AppFramework/Bootstrap/IRegistrationContext.php

Indentation +95 added lines, -95 removed lines

@@ -37,106 +37,106 @@
  */
 interface IRegistrationContext {
 
-	/**
-	 * @param string $capability
-	 * @see IAppContainer::registerCapability
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerCapability(string $capability): void;
+    /**
+     * @param string $capability
+     * @see IAppContainer::registerCapability
+     *
+     * @since 20.0.0
+     */
+    public function registerCapability(string $capability): void;
 
-	/**
-	 * Register an implementation of \OCP\Support\CrashReport\IReporter that
-	 * will receive unhandled exceptions and throwables
-	 *
-	 * @param string $reporterClass
-	 * @return void
-	 * @since 20.0.0
-	 */
-	public function registerCrashReporter(string $reporterClass): void;
+    /**
+     * Register an implementation of \OCP\Support\CrashReport\IReporter that
+     * will receive unhandled exceptions and throwables
+     *
+     * @param string $reporterClass
+     * @return void
+     * @since 20.0.0
+     */
+    public function registerCrashReporter(string $reporterClass): void;
 
-	/**
-	 * Register an implementation of \OCP\Dashboard\IPanel that
-	 * will handle the implementation of a dashboard panel
-	 *
-	 * @param string $panelClass
-	 * @return void
-	 * @since 20.0.0
-	 */
-	public function registerDashboardPanel(string $panelClass): void;
-	/**
-	 * Register a service
-	 *
-	 * @param string $name
-	 * @param callable $factory
-	 * @param bool $shared
-	 *
-	 * @return void
-	 * @see IContainer::registerService()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerService(string $name, callable $factory, bool $shared = true): void;
+    /**
+     * Register an implementation of \OCP\Dashboard\IPanel that
+     * will handle the implementation of a dashboard panel
+     *
+     * @param string $panelClass
+     * @return void
+     * @since 20.0.0
+     */
+    public function registerDashboardPanel(string $panelClass): void;
+    /**
+     * Register a service
+     *
+     * @param string $name
+     * @param callable $factory
+     * @param bool $shared
+     *
+     * @return void
+     * @see IContainer::registerService()
+     *
+     * @since 20.0.0
+     */
+    public function registerService(string $name, callable $factory, bool $shared = true): void;
 
-	/**
-	 * @param string $alias
-	 * @param string $target
-	 *
-	 * @return void
-	 * @see IContainer::registerAlias()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerServiceAlias(string $alias, string $target): void;
+    /**
+     * @param string $alias
+     * @param string $target
+     *
+     * @return void
+     * @see IContainer::registerAlias()
+     *
+     * @since 20.0.0
+     */
+    public function registerServiceAlias(string $alias, string $target): void;
 
-	/**
-	 * @param string $name
-	 * @param mixed $value
-	 *
-	 * @return void
-	 * @see IContainer::registerParameter()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerParameter(string $name, $value): void;
+    /**
+     * @param string $name
+     * @param mixed $value
+     *
+     * @return void
+     * @see IContainer::registerParameter()
+     *
+     * @since 20.0.0
+     */
+    public function registerParameter(string $name, $value): void;
 
-	/**
-	 * Register a service listener
-	 *
-	 * This is equivalent to calling IEventDispatcher::addServiceListener
-	 *
-	 * @param string $event preferably the fully-qualified class name of the Event sub class to listen for
-	 * @param string $listener fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container
-	 * @param int $priority
-	 *
-	 * @see IEventDispatcher::addServiceListener()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerEventListener(string $event, string $listener, int $priority = 0): void;
+    /**
+     * Register a service listener
+     *
+     * This is equivalent to calling IEventDispatcher::addServiceListener
+     *
+     * @param string $event preferably the fully-qualified class name of the Event sub class to listen for
+     * @param string $listener fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container
+     * @param int $priority
+     *
+     * @see IEventDispatcher::addServiceListener()
+     *
+     * @since 20.0.0
+     */
+    public function registerEventListener(string $event, string $listener, int $priority = 0): void;
 
-	/**
-	 * @param string $class
-	 *
-	 * @return void
-	 * @see IAppContainer::registerMiddleWare()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerMiddleware(string $class): void;
+    /**
+     * @param string $class
+     *
+     * @return void
+     * @see IAppContainer::registerMiddleWare()
+     *
+     * @since 20.0.0
+     */
+    public function registerMiddleware(string $class): void;
 
-	/**
-	 * Register a search provider for the unified search
-	 *
-	 * It is allowed to register more than one provider per app as the search
-	 * results can go into distinct sections, e.g. "Files" and "Files shared
-	 * with you" in the Files app.
-	 *
-	 * @param string $class
-	 *
-	 * @return void
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerSearchProvider(string $class): void;
+    /**
+     * Register a search provider for the unified search
+     *
+     * It is allowed to register more than one provider per app as the search
+     * results can go into distinct sections, e.g. "Files" and "Files shared
+     * with you" in the Files app.
+     *
+     * @param string $class
+     *
+     * @return void
+     *
+     * @since 20.0.0
+     */
+    public function registerSearchProvider(string $class): void;
 }

lib/public/Dashboard/IDashboardWidget.php

Indentation +95 added lines, -95 removed lines

@@ -51,99 +51,99 @@
  */
 interface IDashboardWidget {
 
-	/**
-	 * Should returns the (unique) Id of the widget.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getId(): string;
-
-
-	/**
-	 * Should returns the [display] name of the widget.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.0.0
-	 *
-	 * @param IWidgetRequest $request
-	 */
-	public function requestWidget(IWidgetRequest $request);
+    /**
+     * Should returns the (unique) Id of the widget.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getId(): string;
+
+
+    /**
+     * Should returns the [display] name of the widget.
+     *
+     * @since 15.0.0
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.0.0
+     *
+     * @param IWidgetRequest $request
+     */
+    public function requestWidget(IWidgetRequest $request);
 }

lib/public/Dashboard/IManager.php

Indentation +11 added lines, -11 removed lines

@@ -34,16 +34,16 @@
  */
 interface IManager {
 
-	/**
-	 * @param string $panelClass
-	 * @since 20.0.0
-	 */
-	public function lazyRegisterPanel(string $panelClass): void;
+    /**
+     * @param string $panelClass
+     * @since 20.0.0
+     */
+    public function lazyRegisterPanel(string $panelClass): void;
 
-	/**
-	 * @since 20.0.0
-	 *
-	 * @return IPanel[]
-	 */
-	public function getPanels(): array;
+    /**
+     * @since 20.0.0
+     *
+     * @return IPanel[]
+     */
+    public function getPanels(): array;
 }

lib/public/Dashboard/IPanel.php

Indentation +30 added lines, -30 removed lines

@@ -34,39 +34,39 @@
  */
 interface IPanel {
 
-	/**
-	 * @return string Unique id that identifies the panel, e.g. the app id
-	 * @since 20.0.0
-	 */
-	public function getId(): string;
+    /**
+     * @return string Unique id that identifies the panel, e.g. the app id
+     * @since 20.0.0
+     */
+    public function getId(): string;
 
-	/**
-	 * @return string User facing title of the panel
-	 * @since 20.0.0
-	 */
-	public function getTitle(): string;
+    /**
+     * @return string User facing title of the panel
+     * @since 20.0.0
+     */
+    public function getTitle(): string;
 
-	/**
-	 * @return int Initial order for panel sorting
-	 * @since 20.0.0
-	 */
-	public function getOrder(): int;
+    /**
+     * @return int Initial order for panel sorting
+     * @since 20.0.0
+     */
+    public function getOrder(): int;
 
-	/**
-	 * @return string css class that displays an icon next to the panel title
-	 * @since 20.0.0
-	 */
-	public function getIconClass(): string;
+    /**
+     * @return string css class that displays an icon next to the panel title
+     * @since 20.0.0
+     */
+    public function getIconClass(): string;
 
-	/**
-	 * @return string|null The absolute url to the apps own view
-	 * @since 20.0.0
-	 */
-	public function getUrl(): ?string;
+    /**
+     * @return string|null The absolute url to the apps own view
+     * @since 20.0.0
+     */
+    public function getUrl(): ?string;
 
-	/**
-	 * Execute panel bootstrap code like loading scripts and providing initial state
-	 * @since 20.0.0
-	 */
-	public function load(): void;
+    /**
+     * Execute panel bootstrap code like loading scripts and providing initial state
+     * @since 20.0.0
+     */
+    public function load(): void;
 }

lib/public/Dashboard/Model/IWidgetConfig.php

Indentation +74 added lines, -74 removed lines

@@ -43,86 +43,86 @@
 interface IWidgetConfig {
 
 
-	/**
-	 * Returns the userId
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getUserId(): string;
+    /**
+     * Returns the userId
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getUserId(): string;
 
 
-	/**
-	 * Returns the widgetId
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getWidgetId(): string;
+    /**
+     * Returns the widgetId
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getWidgetId(): string;
 
 
-	/**
-	 * Returns the current position and the current size of the widget as
-	 * displayed on the user's dashboard
-	 *
-	 * The returned value is an array:
-	 * [
-	 *   'x'      => (int) position on the X axis,
-	 *   'y'      => (int) position on the Y axis,
-	 *   'width'  => (int) width of the widget,
-	 *   'height' => (int) height of the widget
-	 * ]
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function getPosition(): array;
+    /**
+     * Returns the current position and the current size of the widget as
+     * displayed on the user's dashboard
+     *
+     * The returned value is an array:
+     * [
+     *   'x'      => (int) position on the X axis,
+     *   'y'      => (int) position on the Y axis,
+     *   'width'  => (int) width of the widget,
+     *   'height' => (int) height of the widget
+     * ]
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function getPosition(): array;
 
 
-	/**
-	 * Returns an array with the settings defined by the user for the widget.
-	 * The returned value is an array, with setting used as keys:
-	 *
-	 * [
-	 *   'setting1'  => 'any value',
-	 *   'setting2'  => 'other value'
-	 * ]
-	 *
-	 * Each setting that can be edited by a user should be defined in a
-	 * WidgetSetting.
-	 *
-	 * @see WidgetSetting
-	 *
-	 * Those WidgetSetting are in the WidgetTemplate defined during the setup
-	 * of the widget in the IDashboardWidget.
-	 *
-	 * @see IDashboardWidget::getWidgetTemplate
-	 * @see WidgetTemplate
-	 *
-	 * When using this framework, the settings interface is generated by the
-	 * Dashboard app.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function getSettings(): array;
+    /**
+     * Returns an array with the settings defined by the user for the widget.
+     * The returned value is an array, with setting used as keys:
+     *
+     * [
+     *   'setting1'  => 'any value',
+     *   'setting2'  => 'other value'
+     * ]
+     *
+     * Each setting that can be edited by a user should be defined in a
+     * WidgetSetting.
+     *
+     * @see WidgetSetting
+     *
+     * Those WidgetSetting are in the WidgetTemplate defined during the setup
+     * of the widget in the IDashboardWidget.
+     *
+     * @see IDashboardWidget::getWidgetTemplate
+     * @see WidgetTemplate
+     *
+     * When using this framework, the settings interface is generated by the
+     * Dashboard app.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function getSettings(): array;
 
 
-	/**
-	 * Returns if the widget is enabled/displayed in this user's dashboard.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return bool
-	 */
-	public function isEnabled(): bool;
+    /**
+     * Returns if the widget is enabled/displayed in this user's dashboard.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return bool
+     */
+    public function isEnabled(): bool;
 }

lib/public/Dashboard/Model/WidgetSetup.php

Indentation +231 added lines, -231 removed lines

@@ -43,235 +43,235 @@
  * @package OCP\Dashboard\Model
  */
 final class WidgetSetup implements JsonSerializable {
-	public const SIZE_TYPE_MIN = 'min';
-	public const SIZE_TYPE_MAX = 'max';
-	public const SIZE_TYPE_DEFAULT = 'default';
-
-
-	/** @var array */
-	private $sizes = [];
-
-	/** @var array */
-	private $menus = [];
-
-	/** @var array */
-	private $jobs = [];
-
-	/** @var string */
-	private $push = '';
-
-	/** @var array */
-	private $settings = [];
-
-
-	/**
-	 * Get the defined size for a specific type (min, max, default)
-	 * Returns an array:
-	 * [
-	 *   'width' => width,
-	 *   'height' => height
-	 * ]
-	 *
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $type
-	 *
-	 * @return array
-	 */
-	public function getSize(string $type): array {
-		if (array_key_exists($type, $this->sizes)) {
-			return $this->sizes[$type];
-		}
-
-		return [];
-	}
-
-	/**
-	 * Returns all sizes defined for the widget.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function getSizes(): array {
-		return $this->sizes;
-	}
-
-	/**
-	 * Add a new size to the setup.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $type
-	 * @param int $width
-	 * @param int $height
-	 *
-	 * @return WidgetSetup
-	 */
-	public function addSize(string $type, int $width, int $height): WidgetSetup {
-		$this->sizes[$type] = [
-			'width' => $width,
-			'height' => $height
-		];
-
-		return $this;
-	}
-
-	/**
-	 * Returns menu entries.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function getMenuEntries(): array {
-		return $this->menus;
-	}
-
-	/**
-	 * Add a menu entry to the widget.
-	 * $function is the Javascript function to be called when clicking the
-	 *           menu entry.
-	 * $icon is the css class of the icon.
-	 * $text is the display name of the menu entry.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $function
-	 * @param string $icon
-	 * @param string $text
-	 *
-	 * @return WidgetSetup
-	 */
-	public function addMenuEntry(string $function, string $icon, string $text): WidgetSetup {
-		$this->menus[] = [
-			'function' => $function,
-			'icon' => $icon,
-			'text' => $text
-		];
-
-		return $this;
-	}
-
-
-	/**
-	 * Add a delayed job to the widget.
-	 *
-	 * $function is the Javascript function to be called.
-	 * $delay is the time in seconds between each call.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $function
-	 * @param int $delay
-	 *
-	 * @return WidgetSetup
-	 */
-	public function addDelayedJob(string $function, int $delay): WidgetSetup {
-		$this->jobs[] = [
-			'function' => $function,
-			'delay' => $delay
-		];
-
-		return $this;
-	}
-
-	/**
-	 * Get delayed jobs.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function getDelayedJobs(): array {
-		return $this->jobs;
-	}
-
-
-	/**
-	 * Get the push function, called when an event is send to the front-end
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getPush(): string {
-		return $this->push;
-	}
-
-	/**
-	 * Set the Javascript function to be called when an event is pushed to the
-	 * frontend.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $function
-	 *
-	 * @return WidgetSetup
-	 */
-	public function setPush(string $function): WidgetSetup {
-		$this->push = $function;
-
-		return $this;
-	}
-
-
-	/**
-	 * Returns the default settings for a widget.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function getDefaultSettings(): array {
-		return $this->settings;
-	}
-
-	/**
-	 * Set the default settings for a widget.
-	 * This method is used by the Dashboard app, using the settings created
-	 * using WidgetSetting
-	 *
-	 * @see WidgetSetting
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param array $settings
-	 *
-	 * @return WidgetSetup
-	 */
-	public function setDefaultSettings(array $settings): WidgetSetup {
-		$this->settings = $settings;
-
-		return $this;
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize() {
-		return [
-			'size' => $this->getSizes(),
-			'menu' => $this->getMenuEntries(),
-			'jobs' => $this->getDelayedJobs(),
-			'push' => $this->getPush(),
-			'settings' => $this->getDefaultSettings()
-		];
-	}
+    public const SIZE_TYPE_MIN = 'min';
+    public const SIZE_TYPE_MAX = 'max';
+    public const SIZE_TYPE_DEFAULT = 'default';
+
+
+    /** @var array */
+    private $sizes = [];
+
+    /** @var array */
+    private $menus = [];
+
+    /** @var array */
+    private $jobs = [];
+
+    /** @var string */
+    private $push = '';
+
+    /** @var array */
+    private $settings = [];
+
+
+    /**
+     * Get the defined size for a specific type (min, max, default)
+     * Returns an array:
+     * [
+     *   'width' => width,
+     *   'height' => height
+     * ]
+     *
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $type
+     *
+     * @return array
+     */
+    public function getSize(string $type): array {
+        if (array_key_exists($type, $this->sizes)) {
+            return $this->sizes[$type];
+        }
+
+        return [];
+    }
+
+    /**
+     * Returns all sizes defined for the widget.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function getSizes(): array {
+        return $this->sizes;
+    }
+
+    /**
+     * Add a new size to the setup.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $type
+     * @param int $width
+     * @param int $height
+     *
+     * @return WidgetSetup
+     */
+    public function addSize(string $type, int $width, int $height): WidgetSetup {
+        $this->sizes[$type] = [
+            'width' => $width,
+            'height' => $height
+        ];
+
+        return $this;
+    }
+
+    /**
+     * Returns menu entries.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function getMenuEntries(): array {
+        return $this->menus;
+    }
+
+    /**
+     * Add a menu entry to the widget.
+     * $function is the Javascript function to be called when clicking the
+     *           menu entry.
+     * $icon is the css class of the icon.
+     * $text is the display name of the menu entry.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $function
+     * @param string $icon
+     * @param string $text
+     *
+     * @return WidgetSetup
+     */
+    public function addMenuEntry(string $function, string $icon, string $text): WidgetSetup {
+        $this->menus[] = [
+            'function' => $function,
+            'icon' => $icon,
+            'text' => $text
+        ];
+
+        return $this;
+    }
+
+
+    /**
+     * Add a delayed job to the widget.
+     *
+     * $function is the Javascript function to be called.
+     * $delay is the time in seconds between each call.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $function
+     * @param int $delay
+     *
+     * @return WidgetSetup
+     */
+    public function addDelayedJob(string $function, int $delay): WidgetSetup {
+        $this->jobs[] = [
+            'function' => $function,
+            'delay' => $delay
+        ];
+
+        return $this;
+    }
+
+    /**
+     * Get delayed jobs.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function getDelayedJobs(): array {
+        return $this->jobs;
+    }
+
+
+    /**
+     * Get the push function, called when an event is send to the front-end
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getPush(): string {
+        return $this->push;
+    }
+
+    /**
+     * Set the Javascript function to be called when an event is pushed to the
+     * frontend.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $function
+     *
+     * @return WidgetSetup
+     */
+    public function setPush(string $function): WidgetSetup {
+        $this->push = $function;
+
+        return $this;
+    }
+
+
+    /**
+     * Returns the default settings for a widget.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function getDefaultSettings(): array {
+        return $this->settings;
+    }
+
+    /**
+     * Set the default settings for a widget.
+     * This method is used by the Dashboard app, using the settings created
+     * using WidgetSetting
+     *
+     * @see WidgetSetting
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param array $settings
+     *
+     * @return WidgetSetup
+     */
+    public function setDefaultSettings(array $settings): WidgetSetup {
+        $this->settings = $settings;
+
+        return $this;
+    }
+
+
+    /**
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function jsonSerialize() {
+        return [
+            'size' => $this->getSizes(),
+            'menu' => $this->getMenuEntries(),
+            'jobs' => $this->getDelayedJobs(),
+            'push' => $this->getPush(),
+            'settings' => $this->getDefaultSettings()
+        ];
+    }
 }

lib/public/Dashboard/Model/WidgetSetting.php

Indentation +193 added lines, -193 removed lines

@@ -50,197 +50,197 @@
  * @package OCP\Dashboard\Model
  */
 final class WidgetSetting implements JsonSerializable {
-	public const TYPE_INPUT = 'input';
-	public const TYPE_CHECKBOX = 'checkbox';
-
-
-	/** @var string */
-	private $name = '';
-
-	/** @var string */
-	private $title = '';
-
-	/** @var string */
-	private $type = '';
-
-	/** @var string */
-	private $placeholder = '';
-
-	/** @var string */
-	private $default = '';
-
-
-	/**
-	 * WidgetSetting constructor.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $type
-	 */
-	public function __construct(string $type = '') {
-		$this->type = $type;
-	}
-
-
-	/**
-	 * Set the name of the setting (full string, no space)
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $name
-	 *
-	 * @return WidgetSetting
-	 */
-	public function setName(string $name): WidgetSetting {
-		$this->name = $name;
-
-		return $this;
-	}
-
-	/**
-	 * Get the name of the setting
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getName(): string {
-		return $this->name;
-	}
-
-
-	/**
-	 * Set the title/display name of the setting.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $title
-	 *
-	 * @return WidgetSetting
-	 */
-	public function setTitle(string $title): WidgetSetting {
-		$this->title = $title;
-
-		return $this;
-	}
-
-	/**
-	 * Get the title of the setting
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getTitle(): string {
-		return $this->title;
-	}
-
-
-	/**
-	 * Set the type of the setting (input, checkbox, ...)
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $type
-	 *
-	 * @return WidgetSetting
-	 */
-	public function setType(string $type): WidgetSetting {
-		$this->type = $type;
-
-		return $this;
-	}
-
-	/**
-	 * Get the type of the setting.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getType(): string {
-		return $this->type;
-	}
-
-
-	/**
-	 * Set the placeholder (in case of type=input)
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $text
-	 *
-	 * @return WidgetSetting
-	 */
-	public function setPlaceholder(string $text): WidgetSetting {
-		$this->placeholder = $text;
-
-		return $this;
-	}
-
-	/**
-	 * Get the placeholder.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getPlaceholder(): string {
-		return $this->placeholder;
-	}
-
-
-	/**
-	 * Set the default value of the setting.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @param string $value
-	 *
-	 * @return WidgetSetting
-	 */
-	public function setDefault(string $value): WidgetSetting {
-		$this->default = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get the default value.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getDefault(): string {
-		return $this->default;
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize() {
-		return [
-			'name' => $this->getName(),
-			'title' => $this->getTitle(),
-			'type' => $this->getTitle(),
-			'default' => $this->getDefault(),
-			'placeholder' => $this->getPlaceholder()
-		];
-	}
+    public const TYPE_INPUT = 'input';
+    public const TYPE_CHECKBOX = 'checkbox';
+
+
+    /** @var string */
+    private $name = '';
+
+    /** @var string */
+    private $title = '';
+
+    /** @var string */
+    private $type = '';
+
+    /** @var string */
+    private $placeholder = '';
+
+    /** @var string */
+    private $default = '';
+
+
+    /**
+     * WidgetSetting constructor.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $type
+     */
+    public function __construct(string $type = '') {
+        $this->type = $type;
+    }
+
+
+    /**
+     * Set the name of the setting (full string, no space)
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $name
+     *
+     * @return WidgetSetting
+     */
+    public function setName(string $name): WidgetSetting {
+        $this->name = $name;
+
+        return $this;
+    }
+
+    /**
+     * Get the name of the setting
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getName(): string {
+        return $this->name;
+    }
+
+
+    /**
+     * Set the title/display name of the setting.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $title
+     *
+     * @return WidgetSetting
+     */
+    public function setTitle(string $title): WidgetSetting {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    /**
+     * Get the title of the setting
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getTitle(): string {
+        return $this->title;
+    }
+
+
+    /**
+     * Set the type of the setting (input, checkbox, ...)
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $type
+     *
+     * @return WidgetSetting
+     */
+    public function setType(string $type): WidgetSetting {
+        $this->type = $type;
+
+        return $this;
+    }
+
+    /**
+     * Get the type of the setting.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getType(): string {
+        return $this->type;
+    }
+
+
+    /**
+     * Set the placeholder (in case of type=input)
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $text
+     *
+     * @return WidgetSetting
+     */
+    public function setPlaceholder(string $text): WidgetSetting {
+        $this->placeholder = $text;
+
+        return $this;
+    }
+
+    /**
+     * Get the placeholder.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getPlaceholder(): string {
+        return $this->placeholder;
+    }
+
+
+    /**
+     * Set the default value of the setting.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @param string $value
+     *
+     * @return WidgetSetting
+     */
+    public function setDefault(string $value): WidgetSetting {
+        $this->default = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get the default value.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getDefault(): string {
+        return $this->default;
+    }
+
+
+    /**
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function jsonSerialize() {
+        return [
+            'name' => $this->getName(),
+            'title' => $this->getTitle(),
+            'type' => $this->getTitle(),
+            'default' => $this->getDefault(),
+            'placeholder' => $this->getPlaceholder()
+        ];
+    }
 }

lib/public/Dashboard/Model/IWidgetRequest.php

Indentation +91 added lines, -91 removed lines

@@ -44,95 +44,95 @@
  */
 interface IWidgetRequest {
 
-	/**
-	 * Get the widgetId.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getWidgetId(): string;
-
-
-	/**
-	 * Get the WidgetClass.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.0.0
-	 *
-	 * @return string
-	 */
-	public function getValue(): string;
-
-
-	/**
-	 * Returns the result.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function getResult(): array;
-
-
-	/**
-	 * add a result (as string)
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.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
-	 * @deprecated 20.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
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getWidgetId(): string;
+
+
+    /**
+     * Get the WidgetClass.
+     *
+     * @since 15.0.0
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.0.0
+     *
+     * @return string
+     */
+    public function getValue(): string;
+
+
+    /**
+     * Returns the result.
+     *
+     * @since 15.0.0
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function getResult(): array;
+
+
+    /**
+     * add a result (as string)
+     *
+     * @since 15.0.0
+     * @deprecated 20.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
+     * @deprecated 20.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 +282 added lines, -282 removed lines

@@ -44,286 +44,286 @@
 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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.0.0
-	 *
-	 * @return array
-	 */
-	public function getCss(): array {
-		return $this->css;
-	}
-
-	/**
-	 * path and name of CSS files
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.0.0
-	 *
-	 * @return WidgetSetting[]
-	 */
-	public function getSettings(): array {
-		return $this->settings;
-	}
-
-	/**
-	 * Define all WidgetSetting for the widget.
-	 *
-	 * @since 15.0.0
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
-	 * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.0.0
+     *
+     * @return array
+     */
+    public function getCss(): array {
+        return $this->css;
+    }
+
+    /**
+     * path and name of CSS files
+     *
+     * @since 15.0.0
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.0.0
+     *
+     * @return WidgetSetting[]
+     */
+    public function getSettings(): array {
+        return $this->settings;
+    }
+
+    /**
+     * Define all WidgetSetting for the widget.
+     *
+     * @since 15.0.0
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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
+     * @deprecated 20.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()
+        ];
+    }
 }