nextcloud / server

lib/public/AppFramework/Bootstrap/IRegistrationContext.php

Indentation +86 added lines, -86 removed lines

@@ -37,97 +37,97 @@
  */
 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 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 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/ISearch.php

Indentation +32 added lines, -32 removed lines

@@ -33,39 +33,39 @@
  */
 interface ISearch {
 
-	/**
-	 * Search all providers for $query
-	 * @param string $query
-	 * @param string[] $inApps optionally limit results to the given apps
-	 * @param int $page pages start at page 1
-	 * @param int $size
-	 * @return array An array of OCP\Search\Result's
-	 * @since 8.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function searchPaged($query, array $inApps = [], $page = 1, $size = 30);
+    /**
+     * Search all providers for $query
+     * @param string $query
+     * @param string[] $inApps optionally limit results to the given apps
+     * @param int $page pages start at page 1
+     * @param int $size
+     * @return array An array of OCP\Search\Result's
+     * @since 8.0.0
+     * @deprecated 20.0.0
+     */
+    public function searchPaged($query, array $inApps = [], $page = 1, $size = 30);
 
-	/**
-	 * Register a new search provider to search with
-	 * @param string $class class name of a OCP\Search\Provider
-	 * @param array $options optional
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function registerProvider($class, array $options = []);
+    /**
+     * Register a new search provider to search with
+     * @param string $class class name of a OCP\Search\Provider
+     * @param array $options optional
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    public function registerProvider($class, array $options = []);
 
-	/**
-	 * Remove one existing search provider
-	 * @param string $provider class name of a OCP\Search\Provider
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function removeProvider($provider);
+    /**
+     * Remove one existing search provider
+     * @param string $provider class name of a OCP\Search\Provider
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    public function removeProvider($provider);
 
-	/**
-	 * Remove all registered search providers
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function clearProviders();
+    /**
+     * Remove all registered search providers
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    public function clearProviders();
 }

lib/public/Search/IProvider.php

Indentation +40 added lines, -40 removed lines

@@ -39,45 +39,45 @@
  */
 interface IProvider {
 
-	/**
-	 * Get the unique ID of this search provider
-	 *
-	 * Ideally this should be the app name or an identifier identified with the
-	 * app name, especially if the app registers more than one provider.
-	 *
-	 * Example: 'mail', 'mail_recipients', 'files_sharing'
-	 *
-	 * @return string
-	 *
-	 * @since 20.0.0
-	 */
-	public function getId(): string;
+    /**
+     * Get the unique ID of this search provider
+     *
+     * Ideally this should be the app name or an identifier identified with the
+     * app name, especially if the app registers more than one provider.
+     *
+     * Example: 'mail', 'mail_recipients', 'files_sharing'
+     *
+     * @return string
+     *
+     * @since 20.0.0
+     */
+    public function getId(): string;
 
-	/**
-	 * Find matching search entries in an app
-	 *
-	 * Search results can either be a complete list of all the matches the app can
-	 * find, or ideally a paginated result set where more data can be fetched on
-	 * demand. To be able to tell where the next offset starts the search uses
-	 * "cursors" which are a property of the last result entry. E.g. search results
-	 * that show most recent entries first can look for entries older than the last
-	 * one of the first result set. This approach was chosen over a numeric limit/
-	 * offset approach as the offset moves as new data comes in. The cursor is
-	 * resistant to these changes and will still show results without overlaps or
-	 * gaps.
-	 *
-	 * See https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89
-	 * for the concept of cursors.
-	 *
-	 * Implementations that return result pages have to adhere to the limit
-	 * property of a search query.
-	 *
-	 * @param IUser $user
-	 * @param ISearchQuery $query
-	 *
-	 * @return SearchResult
-	 *
-	 * @since 20.0.0
-	 */
-	public function search(IUser $user, ISearchQuery $query): SearchResult;
+    /**
+     * Find matching search entries in an app
+     *
+     * Search results can either be a complete list of all the matches the app can
+     * find, or ideally a paginated result set where more data can be fetched on
+     * demand. To be able to tell where the next offset starts the search uses
+     * "cursors" which are a property of the last result entry. E.g. search results
+     * that show most recent entries first can look for entries older than the last
+     * one of the first result set. This approach was chosen over a numeric limit/
+     * offset approach as the offset moves as new data comes in. The cursor is
+     * resistant to these changes and will still show results without overlaps or
+     * gaps.
+     *
+     * See https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89
+     * for the concept of cursors.
+     *
+     * Implementations that return result pages have to adhere to the limit
+     * property of a search query.
+     *
+     * @param IUser $user
+     * @param ISearchQuery $query
+     *
+     * @return SearchResult
+     *
+     * @since 20.0.0
+     */
+    public function search(IUser $user, ISearchQuery $query): SearchResult;
 }

lib/public/Search/ASearchResultEntry.php

Indentation +50 added lines, -50 removed lines

@@ -44,59 +44,59 @@
  */
 abstract class ASearchResultEntry implements JsonSerializable {
 
-	/**
-	 * @var string
-	 * @since 20.0.0
-	 */
-	protected $thumbnailUrl;
+    /**
+     * @var string
+     * @since 20.0.0
+     */
+    protected $thumbnailUrl;
 
-	/**
-	 * @var string
-	 * @since 20.0.0
-	 */
-	protected $title;
+    /**
+     * @var string
+     * @since 20.0.0
+     */
+    protected $title;
 
-	/**
-	 * @var string
-	 * @since 20.0.0
-	 */
-	protected $subline;
+    /**
+     * @var string
+     * @since 20.0.0
+     */
+    protected $subline;
 
-	/**
-	 * @var string
-	 * @since 20.0.0
-	 */
-	protected $resourceUrl;
+    /**
+     * @var string
+     * @since 20.0.0
+     */
+    protected $resourceUrl;
 
-	/**
-	 * @param string $thumbnailUrl a relative or absolute URL to the thumbnail or icon of the entry
-	 * @param string $title a main title of the entry
-	 * @param string $subline the secondary line of the entry
-	 * @param string $resourceUrl the URL where the user can find the detail, like a deep link inside the app
-	 *
-	 * @since 20.0.0
-	 */
-	public function __construct(string $thumbnailUrl,
-								string $title,
-								string $subline,
-								string $resourceUrl) {
-		$this->thumbnailUrl = $thumbnailUrl;
-		$this->title = $title;
-		$this->subline = $subline;
-		$this->resourceUrl = $resourceUrl;
-	}
+    /**
+     * @param string $thumbnailUrl a relative or absolute URL to the thumbnail or icon of the entry
+     * @param string $title a main title of the entry
+     * @param string $subline the secondary line of the entry
+     * @param string $resourceUrl the URL where the user can find the detail, like a deep link inside the app
+     *
+     * @since 20.0.0
+     */
+    public function __construct(string $thumbnailUrl,
+                                string $title,
+                                string $subline,
+                                string $resourceUrl) {
+        $this->thumbnailUrl = $thumbnailUrl;
+        $this->title = $title;
+        $this->subline = $subline;
+        $this->resourceUrl = $resourceUrl;
+    }
 
-	/**
-	 * @return array
-	 *
-	 * @since 20.0.0
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'thumbnailUrl' => $this->thumbnailUrl,
-			'title' => $this->title,
-			'subline' => $this->subline,
-			'resourceUrl' => $this->resourceUrl,
-		];
-	}
+    /**
+     * @return array
+     *
+     * @since 20.0.0
+     */
+    public function jsonSerialize(): array {
+        return [
+            'thumbnailUrl' => $this->thumbnailUrl,
+            'title' => $this->title,
+            'subline' => $this->subline,
+            'resourceUrl' => $this->resourceUrl,
+        ];
+    }
 }

lib/public/Search/Result.php

Indentation +44 added lines, -44 removed lines

@@ -33,52 +33,52 @@
  */
 class Result {
 
-	/**
-	 * A unique identifier for the result, usually given as the item ID in its
-	 * corresponding application.
-	 * @var string
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	public $id;
+    /**
+     * A unique identifier for the result, usually given as the item ID in its
+     * corresponding application.
+     * @var string
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    public $id;
 
-	/**
-	 * The name of the item returned; this will be displayed in the search
-	 * results.
-	 * @var string
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	public $name;
+    /**
+     * The name of the item returned; this will be displayed in the search
+     * results.
+     * @var string
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    public $name;
 
-	/**
-	 * URL to the application item.
-	 * @var string
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	public $link;
+    /**
+     * URL to the application item.
+     * @var string
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    public $link;
 
-	/**
-	 * The type of search result returned; for consistency, name this the same
-	 * as the class name (e.g. \OC\Search\File -> 'file') in lowercase.
-	 * @var string
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	public $type = 'generic';
+    /**
+     * The type of search result returned; for consistency, name this the same
+     * as the class name (e.g. \OC\Search\File -> 'file') in lowercase.
+     * @var string
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    public $type = 'generic';
 
-	/**
-	 * Create a new search result
-	 * @param string $id unique identifier from application: '[app_name]/[item_identifier_in_app]'
-	 * @param string $name displayed text of result
-	 * @param string $link URL to the result within its app
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function __construct($id = null, $name = null, $link = null) {
-		$this->id = $id;
-		$this->name = $name;
-		$this->link = $link;
-	}
+    /**
+     * Create a new search result
+     * @param string $id unique identifier from application: '[app_name]/[item_identifier_in_app]'
+     * @param string $name displayed text of result
+     * @param string $link URL to the result within its app
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    public function __construct($id = null, $name = null, $link = null) {
+        $this->id = $id;
+        $this->name = $name;
+        $this->link = $link;
+    }
 }

lib/public/Search/ISearchQuery.php

Indentation +34 added lines, -34 removed lines

@@ -38,42 +38,42 @@
  */
 interface ISearchQuery {
 
-	/**
-	 * @since 20.0.0
-	 */
-	public const SORT_DATE_DESC = 1;
+    /**
+     * @since 20.0.0
+     */
+    public const SORT_DATE_DESC = 1;
 
-	/**
-	 * Get the user-entered search term to find matches for
-	 *
-	 * @return string the search term
-	 * @since 20.0.0
-	 */
-	public function getTerm(): string;
+    /**
+     * Get the user-entered search term to find matches for
+     *
+     * @return string the search term
+     * @since 20.0.0
+     */
+    public function getTerm(): string;
 
-	/**
-	 * Get the sort order of results as defined as SORT_* constants on this interface
-	 *
-	 * @return int
-	 * @since 20.0.0
-	 */
-	public function getSortOrder(): int;
+    /**
+     * Get the sort order of results as defined as SORT_* constants on this interface
+     *
+     * @return int
+     * @since 20.0.0
+     */
+    public function getSortOrder(): int;
 
-	/**
-	 * Get the number of items to return for a paginated result
-	 *
-	 * @return int
-	 * @see \OCP\Search\IProvider for details
-	 * @since 20.0.0
-	 */
-	public function getLimit(): int;
+    /**
+     * Get the number of items to return for a paginated result
+     *
+     * @return int
+     * @see \OCP\Search\IProvider for details
+     * @since 20.0.0
+     */
+    public function getLimit(): int;
 
-	/**
-	 * Get the app-specific cursor of the tail of the previous result entries
-	 *
-	 * @return int|string|null
-	 * @see \OCP\Search\IProvider for details
-	 * @since 20.0.0
-	 */
-	public function getCursor();
+    /**
+     * Get the app-specific cursor of the tail of the previous result entries
+     *
+     * @return int|string|null
+     * @see \OCP\Search\IProvider for details
+     * @since 20.0.0
+     */
+    public function getCursor();
 }

lib/public/Search/PagedProvider.php

Indentation +36 added lines, -36 removed lines

@@ -34,43 +34,43 @@
  */
 abstract class PagedProvider extends Provider {
 
-	/**
-	 * show all results
-	 * @since 8.0.0
-	 * @deprecated 20.0.0
-	 */
-	public const SIZE_ALL = 0;
+    /**
+     * show all results
+     * @since 8.0.0
+     * @deprecated 20.0.0
+     */
+    public const SIZE_ALL = 0;
 
-	/**
-	 * Constructor
-	 * @param array $options
-	 * @since 8.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function __construct($options) {
-		parent::__construct($options);
-	}
+    /**
+     * Constructor
+     * @param array $options
+     * @since 8.0.0
+     * @deprecated 20.0.0
+     */
+    public function __construct($options) {
+        parent::__construct($options);
+    }
 
-	/**
-	 * Search for $query
-	 * @param string $query
-	 * @return array An array of OCP\Search\Result's
-	 * @since 8.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function search($query) {
-		// old apps might assume they get all results, so we use SIZE_ALL
-		return $this->searchPaged($query, 1, self::SIZE_ALL);
-	}
+    /**
+     * Search for $query
+     * @param string $query
+     * @return array An array of OCP\Search\Result's
+     * @since 8.0.0
+     * @deprecated 20.0.0
+     */
+    public function search($query) {
+        // old apps might assume they get all results, so we use SIZE_ALL
+        return $this->searchPaged($query, 1, self::SIZE_ALL);
+    }
 
-	/**
-	 * Search for $query
-	 * @param string $query
-	 * @param int $page pages start at page 1
-	 * @param int $size 0 = SIZE_ALL
-	 * @return array An array of OCP\Search\Result's
-	 * @since 8.0.0
-	 * @deprecated 20.0.0
-	 */
-	abstract public function searchPaged($query, $page, $size);
+    /**
+     * Search for $query
+     * @param string $query
+     * @param int $page pages start at page 1
+     * @param int $size 0 = SIZE_ALL
+     * @return array An array of OCP\Search\Result's
+     * @since 8.0.0
+     * @deprecated 20.0.0
+     */
+    abstract public function searchPaged($query, $page, $size);
 }

lib/public/Search/Provider.php

Indentation +57 added lines, -57 removed lines

@@ -34,66 +34,66 @@
  */
 abstract class Provider {
 
-	/**
-	 * @since 8.0.0
-	 * @deprecated 20.0.0
-	 */
-	public const OPTION_APPS = 'apps';
+    /**
+     * @since 8.0.0
+     * @deprecated 20.0.0
+     */
+    public const OPTION_APPS = 'apps';
 
-	/**
-	 * List of options
-	 * @var array
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	protected $options;
+    /**
+     * List of options
+     * @var array
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    protected $options;
 
-	/**
-	 * Constructor
-	 * @param array $options as key => value
-	 * @since 7.0.0 - default value for $options was added in 8.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function __construct($options = []) {
-		$this->options = $options;
-	}
+    /**
+     * Constructor
+     * @param array $options as key => value
+     * @since 7.0.0 - default value for $options was added in 8.0.0
+     * @deprecated 20.0.0
+     */
+    public function __construct($options = []) {
+        $this->options = $options;
+    }
 
-	/**
-	 * get a value from the options array or null
-	 * @param string $key
-	 * @return mixed
-	 * @since 8.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function getOption($key) {
-		if (is_array($this->options) && isset($this->options[$key])) {
-			return $this->options[$key];
-		} else {
-			return null;
-		}
-	}
+    /**
+     * get a value from the options array or null
+     * @param string $key
+     * @return mixed
+     * @since 8.0.0
+     * @deprecated 20.0.0
+     */
+    public function getOption($key) {
+        if (is_array($this->options) && isset($this->options[$key])) {
+            return $this->options[$key];
+        } else {
+            return null;
+        }
+    }
 
-	/**
-	 * checks if the given apps and the apps this provider has results for intersect
-	 * returns true if the given array is empty (all apps)
-	 * or if this provider does not have a list of apps it provides results for (legacy search providers)
-	 * or if the two above arrays have elements in common (intersect)
-	 * @param string[] $apps
-	 * @return bool
-	 * @since 8.0.0
-	 * @deprecated 20.0.0
-	 */
-	public function providesResultsFor(array $apps = []) {
-		$forApps = $this->getOption(self::OPTION_APPS);
-		return empty($apps) || empty($forApps) || array_intersect($forApps, $apps);
-	}
+    /**
+     * checks if the given apps and the apps this provider has results for intersect
+     * returns true if the given array is empty (all apps)
+     * or if this provider does not have a list of apps it provides results for (legacy search providers)
+     * or if the two above arrays have elements in common (intersect)
+     * @param string[] $apps
+     * @return bool
+     * @since 8.0.0
+     * @deprecated 20.0.0
+     */
+    public function providesResultsFor(array $apps = []) {
+        $forApps = $this->getOption(self::OPTION_APPS);
+        return empty($apps) || empty($forApps) || array_intersect($forApps, $apps);
+    }
 
-	/**
-	 * Search for $query
-	 * @param string $query
-	 * @return array An array of OCP\Search\Result's
-	 * @since 7.0.0
-	 * @deprecated 20.0.0
-	 */
-	abstract public function search($query);
+    /**
+     * Search for $query
+     * @param string $query
+     * @return array An array of OCP\Search\Result's
+     * @since 7.0.0
+     * @deprecated 20.0.0
+     */
+    abstract public function search($query);
 }

lib/public/Search/SearchResult.php

Indentation +70 added lines, -70 removed lines

@@ -32,81 +32,81 @@
  */
 final class SearchResult implements JsonSerializable {
 
-	/** @var string */
-	private $name;
+    /** @var string */
+    private $name;
 
-	/** @var bool */
-	private $isPaginated;
+    /** @var bool */
+    private $isPaginated;
 
-	/** @var ASearchResultEntry[] */
-	private $entries;
+    /** @var ASearchResultEntry[] */
+    private $entries;
 
-	/** @var int|string|null */
-	private $cursor;
+    /** @var int|string|null */
+    private $cursor;
 
-	/**
-	 * @param string $name the translated name of the result section or group, e.g. "Mail"
-	 * @param bool $isPaginated
-	 * @param ASearchResultEntry[] $entries
-	 * @param null $cursor
-	 *
-	 * @since 20.0.0
-	 */
-	private function __construct(string $name,
-								 bool $isPaginated,
-								 array $entries,
-								 $cursor = null) {
-		$this->name = $name;
-		$this->isPaginated = $isPaginated;
-		$this->entries = $entries;
-		$this->cursor = $cursor;
-	}
+    /**
+     * @param string $name the translated name of the result section or group, e.g. "Mail"
+     * @param bool $isPaginated
+     * @param ASearchResultEntry[] $entries
+     * @param null $cursor
+     *
+     * @since 20.0.0
+     */
+    private function __construct(string $name,
+                                    bool $isPaginated,
+                                    array $entries,
+                                    $cursor = null) {
+        $this->name = $name;
+        $this->isPaginated = $isPaginated;
+        $this->entries = $entries;
+        $this->cursor = $cursor;
+    }
 
-	/**
-	 * @param ASearchResultEntry[] $entries
-	 *
-	 * @return static
-	 *
-	 * @since 20.0.0
-	 */
-	public static function complete(string $name, array $entries): self {
-		return new self(
-			$name,
-			false,
-			$entries
-		);
-	}
+    /**
+     * @param ASearchResultEntry[] $entries
+     *
+     * @return static
+     *
+     * @since 20.0.0
+     */
+    public static function complete(string $name, array $entries): self {
+        return new self(
+            $name,
+            false,
+            $entries
+        );
+    }
 
-	/**
-	 * @param ASearchResultEntry[] $entries
-	 * @param int|string $cursor
-	 *
-	 * @return static
-	 *
-	 * @since 20.0.0
-	 */
-	public static function paginated(string $name,
-									array $entries,
-									 $cursor): self {
-		return new self(
-			$name,
-			true,
-			$entries,
-			$cursor
-		);
-	}
+    /**
+     * @param ASearchResultEntry[] $entries
+     * @param int|string $cursor
+     *
+     * @return static
+     *
+     * @since 20.0.0
+     */
+    public static function paginated(string $name,
+                                    array $entries,
+                                        $cursor): self {
+        return new self(
+            $name,
+            true,
+            $entries,
+            $cursor
+        );
+    }
 
-	/**
-	 * @return array
-	 *
-	 * @since 20.0.0
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'name' => $this->name,
-			'isPaginated' => $this->isPaginated,
-			'entries' => $this->entries,
-			'cursor' => $this->cursor,
-		];
-	}
+    /**
+     * @return array
+     *
+     * @since 20.0.0
+     */
+    public function jsonSerialize(): array {
+        return [
+            'name' => $this->name,
+            'isPaginated' => $this->isPaginated,
+            'entries' => $this->entries,
+            'cursor' => $this->cursor,
+        ];
+    }
 }