nextcloud / server

lib/private/FullTextSearch/Model/SearchTemplate.php

Indentation +191 added lines, -191 removed lines

@@ -65,196 +65,196 @@
 final class SearchTemplate implements ISearchTemplate, JsonSerializable {
 
 
-	/** @var string */
-	private $icon = '';
-
-	/** @var string */
-	private $css = '';
-
-	/** @var string */
-	private $template = '';
-
-	/** @var SearchOption[] */
-	private $panelOptions = [];
-
-	/** @var SearchOption[] */
-	private $navigationOptions = [];
-
-
-	/**
-	 * ISearchTemplate constructor.
-	 *
-	 * the class of the icon and the css file to be loaded can be set during the
-	 * creation of the object.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $icon
-	 * @param string $css
-	 */
-	public function __construct(string $icon = '', string $css = '') {
-		$this->icon = $icon;
-		$this->css = $css;
-	}
-
-
-	/**
-	 * Set the class of the icon to be displayed in the left panel of the
-	 * FullTextSearch navigation page, in front of the related Content Provider.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $class
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setIcon(string $class): ISearchTemplate {
-		$this->icon = $class;
-
-		return $this;
-	}
-
-	/**
-	 * Get the class of the icon.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getIcon(): string {
-		return $this->icon;
-	}
-
-
-	/**
-	 * Set the path of a CSS file that will be loaded when needed.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $css
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setCss(string $css): ISearchTemplate {
-		$this->css = $css;
-
-		return $this;
-	}
-
-	/**
-	 * Get the path of the CSS file.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getCss(): string {
-		return $this->css;
-	}
-
-
-	/**
-	 * Set the path of the file of a template that the HTML will be displayed
-	 * below the Options.
-	 * This should only be used if your Content Provider needs to set options in
-	 * a way not generated by FullTextSearch
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $template
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setTemplate(string $template): ISearchTemplate {
-		$this->template = $template;
-
-		return $this;
-	}
-
-	/**
-	 * Get the path of the template file.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getTemplate(): string {
-		return $this->template;
-	}
-
-
-	/**
-	 * Add an option in the Panel that is displayed when the user start a search
-	 * within the app that generate the content.
-	 *
-	 * @see ISearchOption
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchOption $option
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function addPanelOption(ISearchOption $option): ISearchTemplate {
-		$this->panelOptions[] = $option;
-
-		return $this;
-	}
-
-	/**
-	 * Get all options to be displayed in the Panel.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return SearchOption[]
-	 */
-	public function getPanelOptions(): array {
-		return $this->panelOptions;
-	}
-
-
-	/**
-	 * Add an option in the left panel of the FullTextSearch navigation page.
-	 *
-	 * @see ISearchOption
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchOption $option
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function addNavigationOption(ISearchOption $option): ISearchTemplate {
-		$this->navigationOptions[] = $option;
-
-		return $this;
-	}
-
-	/**
-	 * Get all options to be displayed in the FullTextSearch navigation page.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getNavigationOptions(): array {
-		return $this->navigationOptions;
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'icon' => $this->getIcon(),
-			'css' => $this->getCss(),
-			'template' => $this->getTemplate(),
-			'panel' => $this->getPanelOptions(),
-			'navigation' => $this->getNavigationOptions()
-		];
-	}
+    /** @var string */
+    private $icon = '';
+
+    /** @var string */
+    private $css = '';
+
+    /** @var string */
+    private $template = '';
+
+    /** @var SearchOption[] */
+    private $panelOptions = [];
+
+    /** @var SearchOption[] */
+    private $navigationOptions = [];
+
+
+    /**
+     * ISearchTemplate constructor.
+     *
+     * the class of the icon and the css file to be loaded can be set during the
+     * creation of the object.
+     *
+     * @since 15.0.0
+     *
+     * @param string $icon
+     * @param string $css
+     */
+    public function __construct(string $icon = '', string $css = '') {
+        $this->icon = $icon;
+        $this->css = $css;
+    }
+
+
+    /**
+     * Set the class of the icon to be displayed in the left panel of the
+     * FullTextSearch navigation page, in front of the related Content Provider.
+     *
+     * @since 15.0.0
+     *
+     * @param string $class
+     *
+     * @return ISearchTemplate
+     */
+    public function setIcon(string $class): ISearchTemplate {
+        $this->icon = $class;
+
+        return $this;
+    }
+
+    /**
+     * Get the class of the icon.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getIcon(): string {
+        return $this->icon;
+    }
+
+
+    /**
+     * Set the path of a CSS file that will be loaded when needed.
+     *
+     * @since 15.0.0
+     *
+     * @param string $css
+     *
+     * @return ISearchTemplate
+     */
+    public function setCss(string $css): ISearchTemplate {
+        $this->css = $css;
+
+        return $this;
+    }
+
+    /**
+     * Get the path of the CSS file.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getCss(): string {
+        return $this->css;
+    }
+
+
+    /**
+     * Set the path of the file of a template that the HTML will be displayed
+     * below the Options.
+     * This should only be used if your Content Provider needs to set options in
+     * a way not generated by FullTextSearch
+     *
+     * @since 15.0.0
+     *
+     * @param string $template
+     *
+     * @return ISearchTemplate
+     */
+    public function setTemplate(string $template): ISearchTemplate {
+        $this->template = $template;
+
+        return $this;
+    }
+
+    /**
+     * Get the path of the template file.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getTemplate(): string {
+        return $this->template;
+    }
+
+
+    /**
+     * Add an option in the Panel that is displayed when the user start a search
+     * within the app that generate the content.
+     *
+     * @see ISearchOption
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchOption $option
+     *
+     * @return ISearchTemplate
+     */
+    public function addPanelOption(ISearchOption $option): ISearchTemplate {
+        $this->panelOptions[] = $option;
+
+        return $this;
+    }
+
+    /**
+     * Get all options to be displayed in the Panel.
+     *
+     * @since 15.0.0
+     *
+     * @return SearchOption[]
+     */
+    public function getPanelOptions(): array {
+        return $this->panelOptions;
+    }
+
+
+    /**
+     * Add an option in the left panel of the FullTextSearch navigation page.
+     *
+     * @see ISearchOption
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchOption $option
+     *
+     * @return ISearchTemplate
+     */
+    public function addNavigationOption(ISearchOption $option): ISearchTemplate {
+        $this->navigationOptions[] = $option;
+
+        return $this;
+    }
+
+    /**
+     * Get all options to be displayed in the FullTextSearch navigation page.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getNavigationOptions(): array {
+        return $this->navigationOptions;
+    }
+
+
+    /**
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function jsonSerialize(): array {
+        return [
+            'icon' => $this->getIcon(),
+            'css' => $this->getCss(),
+            'template' => $this->getTemplate(),
+            'panel' => $this->getPanelOptions(),
+            'navigation' => $this->getNavigationOptions()
+        ];
+    }
 }
 

lib/private/FullTextSearch/Model/DocumentAccess.php

Indentation +303 added lines, -303 removed lines

@@ -58,308 +58,308 @@
 final class DocumentAccess implements IDocumentAccess, JsonSerializable {
 
 
-	/** @var string */
-	private $ownerId;
-
-	/** @var string */
-	private $viewerId = '';
-
-	/** @var array */
-	private $users = [];
-
-	/** @var array */
-	private $groups = [];
-
-	/** @var array */
-	private $circles = [];
-
-	/** @var array */
-	private $links = [];
-
-
-	/**
-	 * Owner of the document can be set at the init of the object.
-	 *
-	 * @since 16.0.0
-	 *
-	 * IDocumentAccess constructor.
-	 *
-	 * @param string $ownerId
-	 */
-	public function __construct(string $ownerId = '') {
-		$this->setOwnerId($ownerId);
-	}
-
-
-	/**
-	 * Set the Owner of the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $ownerId
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setOwnerId(string $ownerId): IDocumentAccess {
-		$this->ownerId = $ownerId;
-
-		return $this;
-	}
-
-	/**
-	 * Get the Owner of the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getOwnerId(): string {
-		return $this->ownerId;
-	}
-
-
-	/**
-	 * Set the viewer of the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $viewerId
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setViewerId(string $viewerId): IDocumentAccess {
-		$this->viewerId = $viewerId;
-
-		return $this;
-	}
-
-	/**
-	 * Get the viewer of the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getViewerId(): string {
-		return $this->viewerId;
-	}
-
-
-	/**
-	 * Set the list of users that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $users
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setUsers(array $users): IDocumentAccess {
-		$this->users = $users;
-
-		return $this;
-	}
-
-	/**
-	 * Add an entry to the list of users that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $user
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addUser(string $user): IDocumentAccess {
-		$this->users[] = $user;
-
-		return $this;
-	}
-
-	/**
-	 * Add multiple entries to the list of users that have read access to the
-	 * document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $users
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addUsers($users): IDocumentAccess {
-		$this->users = array_merge($this->users, $users);
-
-		return $this;
-	}
-
-	/**
-	 * Get the complete list of users that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getUsers(): array {
-		return $this->users;
-	}
-
-
-	/**
-	 * Set the list of groups that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $groups
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setGroups(array $groups): IDocumentAccess {
-		$this->groups = $groups;
-
-		return $this;
-	}
-
-	/**
-	 * Add an entry to the list of groups that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $group
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addGroup(string $group): IDocumentAccess {
-		$this->groups[] = $group;
-
-		return $this;
-	}
-
-	/**
-	 * Add multiple entries to the list of groups that have read access to the
-	 * document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $groups
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addGroups(array $groups) {
-		$this->groups = array_merge($this->groups, $groups);
-
-		return $this;
-	}
-
-	/**
-	 * Get the complete list of groups that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getGroups(): array {
-		return $this->groups;
-	}
-
-
-	/**
-	 * Set the list of circles that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $circles
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setCircles(array $circles): IDocumentAccess {
-		$this->circles = $circles;
-
-		return $this;
-	}
-
-	/**
-	 * Add an entry to the list of circles that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $circle
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addCircle(string $circle): IDocumentAccess {
-		$this->circles[] = $circle;
-
-		return $this;
-	}
-
-	/**
-	 * Add multiple entries to the list of groups that have read access to the
-	 * document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $circles
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addCircles(array $circles): IDocumentAccess {
-		$this->circles = array_merge($this->circles, $circles);
-
-		return $this;
-	}
-
-	/**
-	 * Get the complete list of circles that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getCircles(): array {
-		return $this->circles;
-	}
-
-
-	/**
-	 * Set the list of links that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $links
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setLinks(array $links): IDocumentAccess {
-		$this->links = $links;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of links that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getLinks(): array {
-		return $this->links;
-	}
-
-
-	/**
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'ownerId' => $this->getOwnerId(),
-			'viewerId' => $this->getViewerId(),
-			'users' => $this->getUsers(),
-			'groups' => $this->getGroups(),
-			'circles' => $this->getCircles(),
-			'links' => $this->getLinks()
-		];
-	}
+    /** @var string */
+    private $ownerId;
+
+    /** @var string */
+    private $viewerId = '';
+
+    /** @var array */
+    private $users = [];
+
+    /** @var array */
+    private $groups = [];
+
+    /** @var array */
+    private $circles = [];
+
+    /** @var array */
+    private $links = [];
+
+
+    /**
+     * Owner of the document can be set at the init of the object.
+     *
+     * @since 16.0.0
+     *
+     * IDocumentAccess constructor.
+     *
+     * @param string $ownerId
+     */
+    public function __construct(string $ownerId = '') {
+        $this->setOwnerId($ownerId);
+    }
+
+
+    /**
+     * Set the Owner of the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $ownerId
+     *
+     * @return IDocumentAccess
+     */
+    public function setOwnerId(string $ownerId): IDocumentAccess {
+        $this->ownerId = $ownerId;
+
+        return $this;
+    }
+
+    /**
+     * Get the Owner of the document.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getOwnerId(): string {
+        return $this->ownerId;
+    }
+
+
+    /**
+     * Set the viewer of the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $viewerId
+     *
+     * @return IDocumentAccess
+     */
+    public function setViewerId(string $viewerId): IDocumentAccess {
+        $this->viewerId = $viewerId;
+
+        return $this;
+    }
+
+    /**
+     * Get the viewer of the document.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getViewerId(): string {
+        return $this->viewerId;
+    }
+
+
+    /**
+     * Set the list of users that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $users
+     *
+     * @return IDocumentAccess
+     */
+    public function setUsers(array $users): IDocumentAccess {
+        $this->users = $users;
+
+        return $this;
+    }
+
+    /**
+     * Add an entry to the list of users that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $user
+     *
+     * @return IDocumentAccess
+     */
+    public function addUser(string $user): IDocumentAccess {
+        $this->users[] = $user;
+
+        return $this;
+    }
+
+    /**
+     * Add multiple entries to the list of users that have read access to the
+     * document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $users
+     *
+     * @return IDocumentAccess
+     */
+    public function addUsers($users): IDocumentAccess {
+        $this->users = array_merge($this->users, $users);
+
+        return $this;
+    }
+
+    /**
+     * Get the complete list of users that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getUsers(): array {
+        return $this->users;
+    }
+
+
+    /**
+     * Set the list of groups that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $groups
+     *
+     * @return IDocumentAccess
+     */
+    public function setGroups(array $groups): IDocumentAccess {
+        $this->groups = $groups;
+
+        return $this;
+    }
+
+    /**
+     * Add an entry to the list of groups that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $group
+     *
+     * @return IDocumentAccess
+     */
+    public function addGroup(string $group): IDocumentAccess {
+        $this->groups[] = $group;
+
+        return $this;
+    }
+
+    /**
+     * Add multiple entries to the list of groups that have read access to the
+     * document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $groups
+     *
+     * @return IDocumentAccess
+     */
+    public function addGroups(array $groups) {
+        $this->groups = array_merge($this->groups, $groups);
+
+        return $this;
+    }
+
+    /**
+     * Get the complete list of groups that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getGroups(): array {
+        return $this->groups;
+    }
+
+
+    /**
+     * Set the list of circles that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $circles
+     *
+     * @return IDocumentAccess
+     */
+    public function setCircles(array $circles): IDocumentAccess {
+        $this->circles = $circles;
+
+        return $this;
+    }
+
+    /**
+     * Add an entry to the list of circles that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $circle
+     *
+     * @return IDocumentAccess
+     */
+    public function addCircle(string $circle): IDocumentAccess {
+        $this->circles[] = $circle;
+
+        return $this;
+    }
+
+    /**
+     * Add multiple entries to the list of groups that have read access to the
+     * document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $circles
+     *
+     * @return IDocumentAccess
+     */
+    public function addCircles(array $circles): IDocumentAccess {
+        $this->circles = array_merge($this->circles, $circles);
+
+        return $this;
+    }
+
+    /**
+     * Get the complete list of circles that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getCircles(): array {
+        return $this->circles;
+    }
+
+
+    /**
+     * Set the list of links that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $links
+     *
+     * @return IDocumentAccess
+     */
+    public function setLinks(array $links): IDocumentAccess {
+        $this->links = $links;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of links that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getLinks(): array {
+        return $this->links;
+    }
+
+
+    /**
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function jsonSerialize(): array {
+        return [
+            'ownerId' => $this->getOwnerId(),
+            'viewerId' => $this->getViewerId(),
+            'users' => $this->getUsers(),
+            'groups' => $this->getGroups(),
+            'circles' => $this->getCircles(),
+            'links' => $this->getLinks()
+        ];
+    }
 }
 

apps/twofactor_backupcodes/lib/Listener/ProviderDisabled.php

Spacing +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
 		$providers = $this->registry->getProviderStates($event->getUser());
 
 		// Loop over all providers. If all are disabled we remove the job
-		$state = array_reduce($providers, function (bool $carry, bool $enabled) {
+		$state = array_reduce($providers, function(bool $carry, bool $enabled) {
 			return $carry || $enabled;
 		}, false);
 

Indentation +22 added lines, -22 removed lines

@@ -35,33 +35,33 @@
 
 class ProviderDisabled implements IEventListener {
 
-	/** @var IRegistry */
-	private $registry;
+    /** @var IRegistry */
+    private $registry;
 
-	/** @var IJobList */
-	private $jobList;
+    /** @var IJobList */
+    private $jobList;
 
-	public function __construct(IRegistry $registry,
-								IJobList $jobList) {
-		$this->registry = $registry;
-		$this->jobList = $jobList;
-	}
+    public function __construct(IRegistry $registry,
+                                IJobList $jobList) {
+        $this->registry = $registry;
+        $this->jobList = $jobList;
+    }
 
-	public function handle(Event $event): void {
-		if (!($event instanceof RegistryEvent)) {
-			return;
-		}
+    public function handle(Event $event): void {
+        if (!($event instanceof RegistryEvent)) {
+            return;
+        }
 
-		$providers = $this->registry->getProviderStates($event->getUser());
+        $providers = $this->registry->getProviderStates($event->getUser());
 
-		// Loop over all providers. If all are disabled we remove the job
-		$state = array_reduce($providers, function (bool $carry, bool $enabled) {
-			return $carry || $enabled;
-		}, false);
+        // Loop over all providers. If all are disabled we remove the job
+        $state = array_reduce($providers, function (bool $carry, bool $enabled) {
+            return $carry || $enabled;
+        }, false);
 
-		if ($state === false) {
-			$this->jobList->remove(RememberBackupCodesJob::class, ['uid' => $event->getUser()->getUID()]);
-		}
-	}
+        if ($state === false) {
+            $this->jobList->remove(RememberBackupCodesJob::class, ['uid' => $event->getUser()->getUID()]);
+        }
+    }
 
 }

lib/private/Collaboration/Resources/Resource.php

Indentation +125 added lines, -125 removed lines

@@ -31,129 +31,129 @@
 
 class Resource implements IResource {
 
-	/** @var IManager */
-	protected $manager;
-
-	/** @var IDBConnection */
-	protected $connection;
-
-	/** @var string */
-	protected $type;
-
-	/** @var string */
-	protected $id;
-
-	/** @var IUser|null */
-	protected $userForAccess;
-
-	/** @var bool|null */
-	protected $access;
-
-	/** @var array|null */
-	protected $data;
-
-	public function __construct(
-		IManager $manager,
-		IDBConnection $connection,
-		string $type,
-		string $id,
-		?IUser $userForAccess = null,
-		?bool $access = null
-	) {
-		$this->manager = $manager;
-		$this->connection = $connection;
-		$this->type = $type;
-		$this->id = $id;
-		$this->userForAccess = $userForAccess;
-		$this->access = $access;
-	}
-
-	/**
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getType(): string {
-		return $this->type;
-	}
-
-	/**
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getId(): string {
-		return $this->id;
-	}
-
-	/**
-	 * @return array
-	 * @since 16.0.0
-	 */
-	public function getRichObject(): array {
-		if ($this->data === null) {
-			$this->data = $this->manager->getResourceRichObject($this);
-		}
-
-		return $this->data;
-	}
-
-	/**
-	 * Can a user/guest access the resource
-	 *
-	 * @param IUser|null $user
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function canAccess(?IUser $user): bool {
-		if ($user instanceof IUser) {
-			return $this->canUserAccess($user);
-		}
-		return $this->canGuestAccess();
-	}
-
-	protected function canUserAccess(IUser $user): bool {
-		if (\is_bool($this->access) && $this->userForAccess instanceof IUser && $user->getUID() === $this->userForAccess->getUID()) {
-			return $this->access;
-		}
-
-		$access = $this->manager->canAccessResource($this, $user);
-		if ($this->userForAccess instanceof IUser && $user->getUID() === $this->userForAccess->getUID()) {
-			$this->access = $access;
-		}
-		return $access;
-	}
-
-	protected function canGuestAccess(): bool {
-		if (\is_bool($this->access) && !$this->userForAccess instanceof IUser) {
-			return $this->access;
-		}
-
-		$access = $this->manager->canAccessResource($this, null);
-		if (!$this->userForAccess instanceof IUser) {
-			$this->access = $access;
-		}
-		return $access;
-	}
-
-	/**
-	 * @return ICollection[]
-	 * @since 16.0.0
-	 */
-	public function getCollections(): array {
-		$collections = [];
-
-		$query = $this->connection->getQueryBuilder();
-
-		$query->select('collection_id')
-			->from('collres_resources')
-			->where($query->expr()->eq('resource_type', $query->createNamedParameter($this->getType())))
-			->andWhere($query->expr()->eq('resource_id', $query->createNamedParameter($this->getId())));
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$collections[] = $this->manager->getCollection((int) $row['collection_id']);
-		}
-		$result->closeCursor();
-
-		return $collections;
-	}
+    /** @var IManager */
+    protected $manager;
+
+    /** @var IDBConnection */
+    protected $connection;
+
+    /** @var string */
+    protected $type;
+
+    /** @var string */
+    protected $id;
+
+    /** @var IUser|null */
+    protected $userForAccess;
+
+    /** @var bool|null */
+    protected $access;
+
+    /** @var array|null */
+    protected $data;
+
+    public function __construct(
+        IManager $manager,
+        IDBConnection $connection,
+        string $type,
+        string $id,
+        ?IUser $userForAccess = null,
+        ?bool $access = null
+    ) {
+        $this->manager = $manager;
+        $this->connection = $connection;
+        $this->type = $type;
+        $this->id = $id;
+        $this->userForAccess = $userForAccess;
+        $this->access = $access;
+    }
+
+    /**
+     * @return string
+     * @since 16.0.0
+     */
+    public function getType(): string {
+        return $this->type;
+    }
+
+    /**
+     * @return string
+     * @since 16.0.0
+     */
+    public function getId(): string {
+        return $this->id;
+    }
+
+    /**
+     * @return array
+     * @since 16.0.0
+     */
+    public function getRichObject(): array {
+        if ($this->data === null) {
+            $this->data = $this->manager->getResourceRichObject($this);
+        }
+
+        return $this->data;
+    }
+
+    /**
+     * Can a user/guest access the resource
+     *
+     * @param IUser|null $user
+     * @return bool
+     * @since 16.0.0
+     */
+    public function canAccess(?IUser $user): bool {
+        if ($user instanceof IUser) {
+            return $this->canUserAccess($user);
+        }
+        return $this->canGuestAccess();
+    }
+
+    protected function canUserAccess(IUser $user): bool {
+        if (\is_bool($this->access) && $this->userForAccess instanceof IUser && $user->getUID() === $this->userForAccess->getUID()) {
+            return $this->access;
+        }
+
+        $access = $this->manager->canAccessResource($this, $user);
+        if ($this->userForAccess instanceof IUser && $user->getUID() === $this->userForAccess->getUID()) {
+            $this->access = $access;
+        }
+        return $access;
+    }
+
+    protected function canGuestAccess(): bool {
+        if (\is_bool($this->access) && !$this->userForAccess instanceof IUser) {
+            return $this->access;
+        }
+
+        $access = $this->manager->canAccessResource($this, null);
+        if (!$this->userForAccess instanceof IUser) {
+            $this->access = $access;
+        }
+        return $access;
+    }
+
+    /**
+     * @return ICollection[]
+     * @since 16.0.0
+     */
+    public function getCollections(): array {
+        $collections = [];
+
+        $query = $this->connection->getQueryBuilder();
+
+        $query->select('collection_id')
+            ->from('collres_resources')
+            ->where($query->expr()->eq('resource_type', $query->createNamedParameter($this->getType())))
+            ->andWhere($query->expr()->eq('resource_id', $query->createNamedParameter($this->getId())));
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $collections[] = $this->manager->getCollection((int) $row['collection_id']);
+        }
+        $result->closeCursor();
+
+        return $collections;
+    }
 }

lib/public/Collaboration/Resources/IResource.php

Indentation +28 added lines, -28 removed lines

@@ -29,36 +29,36 @@
  */
 interface IResource {
 
-	/**
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getType(): string;
+    /**
+     * @return string
+     * @since 16.0.0
+     */
+    public function getType(): string;
 
-	/**
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getId(): string;
+    /**
+     * @return string
+     * @since 16.0.0
+     */
+    public function getId(): string;
 
-	/**
-	 * @return array
-	 * @since 16.0.0
-	 */
-	public function getRichObject(): array;
+    /**
+     * @return array
+     * @since 16.0.0
+     */
+    public function getRichObject(): array;
 
-	/**
-	 * Can a user/guest access the resource
-	 *
-	 * @param IUser|null $user
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function canAccess(?IUser $user): bool;
+    /**
+     * Can a user/guest access the resource
+     *
+     * @param IUser|null $user
+     * @return bool
+     * @since 16.0.0
+     */
+    public function canAccess(?IUser $user): bool;
 
-	/**
-	 * @return ICollection[]
-	 * @since 16.0.0
-	 */
-	public function getCollections(): array;
+    /**
+     * @return ICollection[]
+     * @since 16.0.0
+     */
+    public function getCollections(): array;
 }

lib/public/Collaboration/Resources/IProvider.php

Indentation +24 added lines, -24 removed lines

@@ -29,31 +29,31 @@
  */
 interface IProvider {
 
-	/**
-	 * Get the resource type of the provider
-	 *
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getType(): string;
+    /**
+     * Get the resource type of the provider
+     *
+     * @return string
+     * @since 16.0.0
+     */
+    public function getType(): string;
 
-	/**
-	 * Get the rich object data of a resource
-	 *
-	 * @param IResource $resource
-	 * @return array
-	 * @since 16.0.0
-	 */
-	public function getResourceRichObject(IResource $resource): array;
+    /**
+     * Get the rich object data of a resource
+     *
+     * @param IResource $resource
+     * @return array
+     * @since 16.0.0
+     */
+    public function getResourceRichObject(IResource $resource): array;
 
-	/**
-	 * Can a user/guest access the collection
-	 *
-	 * @param IResource $resource
-	 * @param IUser|null $user
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function canAccessResource(IResource $resource, ?IUser $user): bool;
+    /**
+     * Can a user/guest access the collection
+     *
+     * @param IResource $resource
+     * @param IUser|null $user
+     * @return bool
+     * @since 16.0.0
+     */
+    public function canAccessResource(IResource $resource, ?IUser $user): bool;
 
 }

lib/private/Collaboration/Resources/Manager.php

Spacing +2 added lines, -2 removed lines

@@ -144,7 +144,7 @@ 
 			->setFirstResult($start);
 
 		if ($filter !== '') {
-			$query->where($query->expr()->iLike('c.name', $query->createNamedParameter('%' . $this->connection->escapeLikeParameter($filter) . '%')));
+			$query->where($query->expr()->iLike('c.name', $query->createNamedParameter('%'.$this->connection->escapeLikeParameter($filter).'%')));
 		}
 
 		$result = $query->execute();
@@ -154,7 +154,7 @@ 
 		while ($row = $result->fetch()) {
 			$foundResults++;
 			$access = $row['access'] === null ? null : (bool) $row['access'];
-			$collection = new Collection($this, $this->connection, (int)$row['id'], (string)$row['name'], $user, $access);
+			$collection = new Collection($this, $this->connection, (int) $row['id'], (string) $row['name'], $user, $access);
 			if ($collection->canAccess($user)) {
 				$collections[] = $collection;
 			}

Indentation +481 added lines, -481 removed lines

@@ -41,485 +41,485 @@
 use Psr\Log\LoggerInterface;
 
 class Manager implements IManager {
-	public const TABLE_COLLECTIONS = 'collres_collections';
-	public const TABLE_RESOURCES = 'collres_resources';
-	public const TABLE_ACCESS_CACHE = 'collres_accesscache';
-
-	/** @var IDBConnection */
-	protected $connection;
-	/** @var IProviderManager */
-	protected $providerManager;
-	/** @var LoggerInterface */
-	protected $logger;
-
-	/** @var string[] */
-	protected $providers = [];
-
-
-	public function __construct(IDBConnection $connection, IProviderManager $providerManager, LoggerInterface $logger) {
-		$this->connection = $connection;
-		$this->providerManager = $providerManager;
-		$this->logger = $logger;
-	}
-
-	/**
-	 * @param int $id
-	 * @return ICollection
-	 * @throws CollectionException when the collection could not be found
-	 * @since 16.0.0
-	 */
-	public function getCollection(int $id): ICollection {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from(self::TABLE_COLLECTIONS)
-			->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if (!$row) {
-			throw new CollectionException('Collection not found');
-		}
-
-		return new Collection($this, $this->connection, (int) $row['id'], (string) $row['name']);
-	}
-
-	/**
-	 * @param int $id
-	 * @param IUser|null $user
-	 * @return ICollection
-	 * @throws CollectionException when the collection could not be found
-	 * @since 16.0.0
-	 */
-	public function getCollectionForUser(int $id, ?IUser $user): ICollection {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->select('*')
-			->from(self::TABLE_COLLECTIONS, 'c')
-			->leftJoin(
-				'c', self::TABLE_ACCESS_CACHE, 'a',
-				$query->expr()->andX(
-					$query->expr()->eq('c.id', 'a.collection_id'),
-					$query->expr()->eq('a.user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR))
-				)
-			)
-			->where($query->expr()->eq('c.id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if (!$row) {
-			throw new CollectionException('Collection not found');
-		}
-
-		$access = $row['access'] === null ? null : (bool) $row['access'];
-		if ($user instanceof IUser) {
-			return new Collection($this, $this->connection, (int) $row['id'], (string) $row['name'], $user, $access);
-		}
-
-		return new Collection($this, $this->connection, (int) $row['id'], (string) $row['name'], $user, $access);
-	}
-
-	/**
-	 * @param IUser $user
-	 * @param string $filter
-	 * @param int $limit
-	 * @param int $start
-	 * @return ICollection[]
-	 * @since 16.0.0
-	 */
-	public function searchCollections(IUser $user, string $filter, int $limit = 50, int $start = 0): array {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user->getUID();
-
-		$query->select('c.*', 'a.access')
-			->from(self::TABLE_COLLECTIONS, 'c')
-			->leftJoin(
-				'c', self::TABLE_ACCESS_CACHE, 'a',
-				$query->expr()->andX(
-					$query->expr()->eq('c.id', 'a.collection_id'),
-					$query->expr()->eq('a.user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR))
-				)
-			)
-			->where($query->expr()->eq('a.access', $query->createNamedParameter(1, IQueryBuilder::PARAM_INT)))
-			->orderBy('c.id')
-			->setMaxResults($limit)
-			->setFirstResult($start);
-
-		if ($filter !== '') {
-			$query->where($query->expr()->iLike('c.name', $query->createNamedParameter('%' . $this->connection->escapeLikeParameter($filter) . '%')));
-		}
-
-		$result = $query->execute();
-		$collections = [];
-
-		$foundResults = 0;
-		while ($row = $result->fetch()) {
-			$foundResults++;
-			$access = $row['access'] === null ? null : (bool) $row['access'];
-			$collection = new Collection($this, $this->connection, (int)$row['id'], (string)$row['name'], $user, $access);
-			if ($collection->canAccess($user)) {
-				$collections[] = $collection;
-			}
-		}
-		$result->closeCursor();
-
-		if (empty($collections) && $foundResults === $limit) {
-			return $this->searchCollections($user, $filter, $limit, $start + $limit);
-		}
-
-		return $collections;
-	}
-
-	/**
-	 * @param string $name
-	 * @return ICollection
-	 * @since 16.0.0
-	 */
-	public function newCollection(string $name): ICollection {
-		$query = $this->connection->getQueryBuilder();
-		$query->insert(self::TABLE_COLLECTIONS)
-			->values([
-				'name' => $query->createNamedParameter($name),
-			]);
-		$query->execute();
-
-		return new Collection($this, $this->connection, $query->getLastInsertId(), $name);
-	}
-
-	/**
-	 * @param string $type
-	 * @param string $id
-	 * @return IResource
-	 * @since 16.0.0
-	 */
-	public function createResource(string $type, string $id): IResource {
-		return new Resource($this, $this->connection, $type, $id);
-	}
-
-	/**
-	 * @param string $type
-	 * @param string $id
-	 * @param IUser|null $user
-	 * @return IResource
-	 * @throws ResourceException
-	 * @since 16.0.0
-	 */
-	public function getResourceForUser(string $type, string $id, ?IUser $user): IResource {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->select('r.*', 'a.access')
-			->from(self::TABLE_RESOURCES, 'r')
-			->leftJoin(
-				'r', self::TABLE_ACCESS_CACHE, 'a',
-				$query->expr()->andX(
-					$query->expr()->eq('r.resource_id', 'a.resource_id'),
-					$query->expr()->eq('r.resource_type', 'a.resource_type'),
-					$query->expr()->eq('a.user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR))
-				)
-			)
-			->where($query->expr()->eq('r.resource_type', $query->createNamedParameter($type, IQueryBuilder::PARAM_STR)))
-			->andWhere($query->expr()->eq('r.resource_id', $query->createNamedParameter($id, IQueryBuilder::PARAM_STR)));
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if (!$row) {
-			throw new ResourceException('Resource not found');
-		}
-
-		$access = $row['access'] === null ? null : (bool) $row['access'];
-		if ($user instanceof IUser) {
-			return new Resource($this, $this->connection, $type, $id, $user, $access);
-		}
-
-		return new Resource($this, $this->connection, $type, $id, null, $access);
-	}
-
-	/**
-	 * @param ICollection $collection
-	 * @param IUser|null $user
-	 * @return IResource[]
-	 * @since 16.0.0
-	 */
-	public function getResourcesByCollectionForUser(ICollection $collection, ?IUser $user): array {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->select('r.*', 'a.access')
-			->from(self::TABLE_RESOURCES, 'r')
-			->leftJoin(
-				'r', self::TABLE_ACCESS_CACHE, 'a',
-				$query->expr()->andX(
-					$query->expr()->eq('r.resource_id', 'a.resource_id'),
-					$query->expr()->eq('r.resource_type', 'a.resource_type'),
-					$query->expr()->eq('a.user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR))
-				)
-			)
-			->where($query->expr()->eq('r.collection_id', $query->createNamedParameter($collection->getId(), IQueryBuilder::PARAM_INT)));
-
-		$resources = [];
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$access = $row['access'] === null ? null : (bool) $row['access'];
-			$resources[] = new Resource($this, $this->connection, $row['resource_type'], $row['resource_id'], $user, $access);
-		}
-		$result->closeCursor();
-
-		return $resources;
-	}
-
-	/**
-	 * Get the rich object data of a resource
-	 *
-	 * @param IResource $resource
-	 * @return array
-	 * @since 16.0.0
-	 */
-	public function getResourceRichObject(IResource $resource): array {
-		foreach ($this->providerManager->getResourceProviders() as $provider) {
-			if ($provider->getType() === $resource->getType()) {
-				try {
-					return $provider->getResourceRichObject($resource);
-				} catch (ResourceException $e) {
-				}
-			}
-		}
-
-		return [];
-	}
-
-	/**
-	 * Can a user/guest access the collection
-	 *
-	 * @param IResource $resource
-	 * @param IUser|null $user
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function canAccessResource(IResource $resource, ?IUser $user): bool {
-		$access = $this->checkAccessCacheForUserByResource($resource, $user);
-		if (\is_bool($access)) {
-			return $access;
-		}
-
-		$access = false;
-		foreach ($this->providerManager->getResourceProviders() as $provider) {
-			if ($provider->getType() === $resource->getType()) {
-				try {
-					if ($provider->canAccessResource($resource, $user)) {
-						$access = true;
-						break;
-					}
-				} catch (ResourceException $e) {
-				}
-			}
-		}
-
-		$this->cacheAccessForResource($resource, $user, $access);
-		return $access;
-	}
-
-	/**
-	 * Can a user/guest access the collection
-	 *
-	 * @param ICollection $collection
-	 * @param IUser|null $user
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function canAccessCollection(ICollection $collection, ?IUser $user): bool {
-		$access = $this->checkAccessCacheForUserByCollection($collection, $user);
-		if (\is_bool($access)) {
-			return $access;
-		}
-
-		$access = null;
-		// Access is granted when a user can access all resources
-		foreach ($collection->getResources() as $resource) {
-			if (!$resource->canAccess($user)) {
-				$access = false;
-				break;
-			}
-
-			$access = true;
-		}
-
-		$this->cacheAccessForCollection($collection, $user, $access);
-		return $access;
-	}
-
-	protected function checkAccessCacheForUserByResource(IResource $resource, ?IUser $user): ?bool {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->select('access')
-			->from(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->eq('resource_id', $query->createNamedParameter($resource->getId(), IQueryBuilder::PARAM_STR)))
-			->andWhere($query->expr()->eq('resource_type', $query->createNamedParameter($resource->getType(), IQueryBuilder::PARAM_STR)))
-			->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR)))
-			->setMaxResults(1);
-
-		$hasAccess = null;
-		$result = $query->execute();
-		if ($row = $result->fetch()) {
-			$hasAccess = (bool) $row['access'];
-		}
-		$result->closeCursor();
-
-		return $hasAccess;
-	}
-
-	protected function checkAccessCacheForUserByCollection(ICollection $collection, ?IUser $user): ?bool {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->select('access')
-			->from(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->eq('collection_id', $query->createNamedParameter($collection->getId(), IQueryBuilder::PARAM_INT)))
-			->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR)))
-			->setMaxResults(1);
-
-		$hasAccess = null;
-		$result = $query->execute();
-		if ($row = $result->fetch()) {
-			$hasAccess = (bool) $row['access'];
-		}
-		$result->closeCursor();
-
-		return $hasAccess;
-	}
-
-	public function cacheAccessForResource(IResource $resource, ?IUser $user, bool $access): void {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->insert(self::TABLE_ACCESS_CACHE)
-			->values([
-				'user_id' => $query->createNamedParameter($userId),
-				'resource_id' => $query->createNamedParameter($resource->getId()),
-				'resource_type' => $query->createNamedParameter($resource->getType()),
-				'access' => $query->createNamedParameter($access, IQueryBuilder::PARAM_BOOL),
-			]);
-		try {
-			$query->execute();
-		} catch (UniqueConstraintViolationException $e) {
-		}
-	}
-
-	public function cacheAccessForCollection(ICollection $collection, ?IUser $user, bool $access): void {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->insert(self::TABLE_ACCESS_CACHE)
-			->values([
-				'user_id' => $query->createNamedParameter($userId),
-				'collection_id' => $query->createNamedParameter($collection->getId()),
-				'access' => $query->createNamedParameter($access, IQueryBuilder::PARAM_BOOL),
-			]);
-		try {
-			$query->execute();
-		} catch (UniqueConstraintViolationException $e) {
-		}
-	}
-
-	public function invalidateAccessCacheForUser(?IUser $user): void {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->delete(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->eq('user_id', $query->createNamedParameter($userId)));
-		$query->execute();
-	}
-
-	public function invalidateAccessCacheForResource(IResource $resource): void {
-		$query = $this->connection->getQueryBuilder();
-
-		$query->delete(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->eq('resource_id', $query->createNamedParameter($resource->getId())))
-			->andWhere($query->expr()->eq('resource_type', $query->createNamedParameter($resource->getType(), IQueryBuilder::PARAM_STR)));
-		$query->execute();
-
-		foreach ($resource->getCollections() as $collection) {
-			$this->invalidateAccessCacheForCollection($collection);
-		}
-	}
-
-	public function invalidateAccessCacheForAllCollections(): void {
-		$query = $this->connection->getQueryBuilder();
-
-		$query->delete(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->neq('collection_id', $query->createNamedParameter(0)));
-		$query->execute();
-	}
-
-	public function invalidateAccessCacheForCollection(ICollection $collection): void {
-		$query = $this->connection->getQueryBuilder();
-
-		$query->delete(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->eq('collection_id', $query->createNamedParameter($collection->getId())));
-		$query->execute();
-	}
-
-	public function invalidateAccessCacheForProvider(IProvider $provider): void {
-		$query = $this->connection->getQueryBuilder();
-
-		$query->delete(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->eq('resource_type', $query->createNamedParameter($provider->getType(), IQueryBuilder::PARAM_STR)));
-		$query->execute();
-	}
-
-	public function invalidateAccessCacheForResourceByUser(IResource $resource, ?IUser $user): void {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->delete(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->eq('resource_id', $query->createNamedParameter($resource->getId())))
-			->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId)));
-		$query->execute();
-
-		foreach ($resource->getCollections() as $collection) {
-			$this->invalidateAccessCacheForCollectionByUser($collection, $user);
-		}
-	}
-
-	protected function invalidateAccessCacheForCollectionByUser(ICollection $collection, ?IUser $user): void {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->delete(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->eq('collection_id', $query->createNamedParameter($collection->getId())))
-			->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId)));
-		$query->execute();
-	}
-
-	public function invalidateAccessCacheForProviderByUser(IProvider $provider, ?IUser $user): void {
-		$query = $this->connection->getQueryBuilder();
-		$userId = $user instanceof IUser ? $user->getUID() : '';
-
-		$query->delete(self::TABLE_ACCESS_CACHE)
-			->where($query->expr()->eq('resource_type', $query->createNamedParameter($provider->getType(), IQueryBuilder::PARAM_STR)))
-			->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId)));
-		$query->execute();
-	}
-
-	/**
-	 * @param string $provider
-	 */
-	public function registerResourceProvider(string $provider): void {
-		$this->logger->debug('\OC\Collaboration\Resources\Manager::registerResourceProvider is deprecated', ['provider' => $provider]);
-		$this->providerManager->registerResourceProvider($provider);
-	}
-
-	/**
-	 * Get the resource type of the provider
-	 *
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getType(): string {
-		return '';
-	}
+    public const TABLE_COLLECTIONS = 'collres_collections';
+    public const TABLE_RESOURCES = 'collres_resources';
+    public const TABLE_ACCESS_CACHE = 'collres_accesscache';
+
+    /** @var IDBConnection */
+    protected $connection;
+    /** @var IProviderManager */
+    protected $providerManager;
+    /** @var LoggerInterface */
+    protected $logger;
+
+    /** @var string[] */
+    protected $providers = [];
+
+
+    public function __construct(IDBConnection $connection, IProviderManager $providerManager, LoggerInterface $logger) {
+        $this->connection = $connection;
+        $this->providerManager = $providerManager;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @param int $id
+     * @return ICollection
+     * @throws CollectionException when the collection could not be found
+     * @since 16.0.0
+     */
+    public function getCollection(int $id): ICollection {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from(self::TABLE_COLLECTIONS)
+            ->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+        $result = $query->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if (!$row) {
+            throw new CollectionException('Collection not found');
+        }
+
+        return new Collection($this, $this->connection, (int) $row['id'], (string) $row['name']);
+    }
+
+    /**
+     * @param int $id
+     * @param IUser|null $user
+     * @return ICollection
+     * @throws CollectionException when the collection could not be found
+     * @since 16.0.0
+     */
+    public function getCollectionForUser(int $id, ?IUser $user): ICollection {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->select('*')
+            ->from(self::TABLE_COLLECTIONS, 'c')
+            ->leftJoin(
+                'c', self::TABLE_ACCESS_CACHE, 'a',
+                $query->expr()->andX(
+                    $query->expr()->eq('c.id', 'a.collection_id'),
+                    $query->expr()->eq('a.user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR))
+                )
+            )
+            ->where($query->expr()->eq('c.id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+        $result = $query->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if (!$row) {
+            throw new CollectionException('Collection not found');
+        }
+
+        $access = $row['access'] === null ? null : (bool) $row['access'];
+        if ($user instanceof IUser) {
+            return new Collection($this, $this->connection, (int) $row['id'], (string) $row['name'], $user, $access);
+        }
+
+        return new Collection($this, $this->connection, (int) $row['id'], (string) $row['name'], $user, $access);
+    }
+
+    /**
+     * @param IUser $user
+     * @param string $filter
+     * @param int $limit
+     * @param int $start
+     * @return ICollection[]
+     * @since 16.0.0
+     */
+    public function searchCollections(IUser $user, string $filter, int $limit = 50, int $start = 0): array {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user->getUID();
+
+        $query->select('c.*', 'a.access')
+            ->from(self::TABLE_COLLECTIONS, 'c')
+            ->leftJoin(
+                'c', self::TABLE_ACCESS_CACHE, 'a',
+                $query->expr()->andX(
+                    $query->expr()->eq('c.id', 'a.collection_id'),
+                    $query->expr()->eq('a.user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR))
+                )
+            )
+            ->where($query->expr()->eq('a.access', $query->createNamedParameter(1, IQueryBuilder::PARAM_INT)))
+            ->orderBy('c.id')
+            ->setMaxResults($limit)
+            ->setFirstResult($start);
+
+        if ($filter !== '') {
+            $query->where($query->expr()->iLike('c.name', $query->createNamedParameter('%' . $this->connection->escapeLikeParameter($filter) . '%')));
+        }
+
+        $result = $query->execute();
+        $collections = [];
+
+        $foundResults = 0;
+        while ($row = $result->fetch()) {
+            $foundResults++;
+            $access = $row['access'] === null ? null : (bool) $row['access'];
+            $collection = new Collection($this, $this->connection, (int)$row['id'], (string)$row['name'], $user, $access);
+            if ($collection->canAccess($user)) {
+                $collections[] = $collection;
+            }
+        }
+        $result->closeCursor();
+
+        if (empty($collections) && $foundResults === $limit) {
+            return $this->searchCollections($user, $filter, $limit, $start + $limit);
+        }
+
+        return $collections;
+    }
+
+    /**
+     * @param string $name
+     * @return ICollection
+     * @since 16.0.0
+     */
+    public function newCollection(string $name): ICollection {
+        $query = $this->connection->getQueryBuilder();
+        $query->insert(self::TABLE_COLLECTIONS)
+            ->values([
+                'name' => $query->createNamedParameter($name),
+            ]);
+        $query->execute();
+
+        return new Collection($this, $this->connection, $query->getLastInsertId(), $name);
+    }
+
+    /**
+     * @param string $type
+     * @param string $id
+     * @return IResource
+     * @since 16.0.0
+     */
+    public function createResource(string $type, string $id): IResource {
+        return new Resource($this, $this->connection, $type, $id);
+    }
+
+    /**
+     * @param string $type
+     * @param string $id
+     * @param IUser|null $user
+     * @return IResource
+     * @throws ResourceException
+     * @since 16.0.0
+     */
+    public function getResourceForUser(string $type, string $id, ?IUser $user): IResource {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->select('r.*', 'a.access')
+            ->from(self::TABLE_RESOURCES, 'r')
+            ->leftJoin(
+                'r', self::TABLE_ACCESS_CACHE, 'a',
+                $query->expr()->andX(
+                    $query->expr()->eq('r.resource_id', 'a.resource_id'),
+                    $query->expr()->eq('r.resource_type', 'a.resource_type'),
+                    $query->expr()->eq('a.user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR))
+                )
+            )
+            ->where($query->expr()->eq('r.resource_type', $query->createNamedParameter($type, IQueryBuilder::PARAM_STR)))
+            ->andWhere($query->expr()->eq('r.resource_id', $query->createNamedParameter($id, IQueryBuilder::PARAM_STR)));
+        $result = $query->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if (!$row) {
+            throw new ResourceException('Resource not found');
+        }
+
+        $access = $row['access'] === null ? null : (bool) $row['access'];
+        if ($user instanceof IUser) {
+            return new Resource($this, $this->connection, $type, $id, $user, $access);
+        }
+
+        return new Resource($this, $this->connection, $type, $id, null, $access);
+    }
+
+    /**
+     * @param ICollection $collection
+     * @param IUser|null $user
+     * @return IResource[]
+     * @since 16.0.0
+     */
+    public function getResourcesByCollectionForUser(ICollection $collection, ?IUser $user): array {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->select('r.*', 'a.access')
+            ->from(self::TABLE_RESOURCES, 'r')
+            ->leftJoin(
+                'r', self::TABLE_ACCESS_CACHE, 'a',
+                $query->expr()->andX(
+                    $query->expr()->eq('r.resource_id', 'a.resource_id'),
+                    $query->expr()->eq('r.resource_type', 'a.resource_type'),
+                    $query->expr()->eq('a.user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR))
+                )
+            )
+            ->where($query->expr()->eq('r.collection_id', $query->createNamedParameter($collection->getId(), IQueryBuilder::PARAM_INT)));
+
+        $resources = [];
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $access = $row['access'] === null ? null : (bool) $row['access'];
+            $resources[] = new Resource($this, $this->connection, $row['resource_type'], $row['resource_id'], $user, $access);
+        }
+        $result->closeCursor();
+
+        return $resources;
+    }
+
+    /**
+     * Get the rich object data of a resource
+     *
+     * @param IResource $resource
+     * @return array
+     * @since 16.0.0
+     */
+    public function getResourceRichObject(IResource $resource): array {
+        foreach ($this->providerManager->getResourceProviders() as $provider) {
+            if ($provider->getType() === $resource->getType()) {
+                try {
+                    return $provider->getResourceRichObject($resource);
+                } catch (ResourceException $e) {
+                }
+            }
+        }
+
+        return [];
+    }
+
+    /**
+     * Can a user/guest access the collection
+     *
+     * @param IResource $resource
+     * @param IUser|null $user
+     * @return bool
+     * @since 16.0.0
+     */
+    public function canAccessResource(IResource $resource, ?IUser $user): bool {
+        $access = $this->checkAccessCacheForUserByResource($resource, $user);
+        if (\is_bool($access)) {
+            return $access;
+        }
+
+        $access = false;
+        foreach ($this->providerManager->getResourceProviders() as $provider) {
+            if ($provider->getType() === $resource->getType()) {
+                try {
+                    if ($provider->canAccessResource($resource, $user)) {
+                        $access = true;
+                        break;
+                    }
+                } catch (ResourceException $e) {
+                }
+            }
+        }
+
+        $this->cacheAccessForResource($resource, $user, $access);
+        return $access;
+    }
+
+    /**
+     * Can a user/guest access the collection
+     *
+     * @param ICollection $collection
+     * @param IUser|null $user
+     * @return bool
+     * @since 16.0.0
+     */
+    public function canAccessCollection(ICollection $collection, ?IUser $user): bool {
+        $access = $this->checkAccessCacheForUserByCollection($collection, $user);
+        if (\is_bool($access)) {
+            return $access;
+        }
+
+        $access = null;
+        // Access is granted when a user can access all resources
+        foreach ($collection->getResources() as $resource) {
+            if (!$resource->canAccess($user)) {
+                $access = false;
+                break;
+            }
+
+            $access = true;
+        }
+
+        $this->cacheAccessForCollection($collection, $user, $access);
+        return $access;
+    }
+
+    protected function checkAccessCacheForUserByResource(IResource $resource, ?IUser $user): ?bool {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->select('access')
+            ->from(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->eq('resource_id', $query->createNamedParameter($resource->getId(), IQueryBuilder::PARAM_STR)))
+            ->andWhere($query->expr()->eq('resource_type', $query->createNamedParameter($resource->getType(), IQueryBuilder::PARAM_STR)))
+            ->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR)))
+            ->setMaxResults(1);
+
+        $hasAccess = null;
+        $result = $query->execute();
+        if ($row = $result->fetch()) {
+            $hasAccess = (bool) $row['access'];
+        }
+        $result->closeCursor();
+
+        return $hasAccess;
+    }
+
+    protected function checkAccessCacheForUserByCollection(ICollection $collection, ?IUser $user): ?bool {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->select('access')
+            ->from(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->eq('collection_id', $query->createNamedParameter($collection->getId(), IQueryBuilder::PARAM_INT)))
+            ->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId, IQueryBuilder::PARAM_STR)))
+            ->setMaxResults(1);
+
+        $hasAccess = null;
+        $result = $query->execute();
+        if ($row = $result->fetch()) {
+            $hasAccess = (bool) $row['access'];
+        }
+        $result->closeCursor();
+
+        return $hasAccess;
+    }
+
+    public function cacheAccessForResource(IResource $resource, ?IUser $user, bool $access): void {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->insert(self::TABLE_ACCESS_CACHE)
+            ->values([
+                'user_id' => $query->createNamedParameter($userId),
+                'resource_id' => $query->createNamedParameter($resource->getId()),
+                'resource_type' => $query->createNamedParameter($resource->getType()),
+                'access' => $query->createNamedParameter($access, IQueryBuilder::PARAM_BOOL),
+            ]);
+        try {
+            $query->execute();
+        } catch (UniqueConstraintViolationException $e) {
+        }
+    }
+
+    public function cacheAccessForCollection(ICollection $collection, ?IUser $user, bool $access): void {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->insert(self::TABLE_ACCESS_CACHE)
+            ->values([
+                'user_id' => $query->createNamedParameter($userId),
+                'collection_id' => $query->createNamedParameter($collection->getId()),
+                'access' => $query->createNamedParameter($access, IQueryBuilder::PARAM_BOOL),
+            ]);
+        try {
+            $query->execute();
+        } catch (UniqueConstraintViolationException $e) {
+        }
+    }
+
+    public function invalidateAccessCacheForUser(?IUser $user): void {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->delete(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->eq('user_id', $query->createNamedParameter($userId)));
+        $query->execute();
+    }
+
+    public function invalidateAccessCacheForResource(IResource $resource): void {
+        $query = $this->connection->getQueryBuilder();
+
+        $query->delete(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->eq('resource_id', $query->createNamedParameter($resource->getId())))
+            ->andWhere($query->expr()->eq('resource_type', $query->createNamedParameter($resource->getType(), IQueryBuilder::PARAM_STR)));
+        $query->execute();
+
+        foreach ($resource->getCollections() as $collection) {
+            $this->invalidateAccessCacheForCollection($collection);
+        }
+    }
+
+    public function invalidateAccessCacheForAllCollections(): void {
+        $query = $this->connection->getQueryBuilder();
+
+        $query->delete(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->neq('collection_id', $query->createNamedParameter(0)));
+        $query->execute();
+    }
+
+    public function invalidateAccessCacheForCollection(ICollection $collection): void {
+        $query = $this->connection->getQueryBuilder();
+
+        $query->delete(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->eq('collection_id', $query->createNamedParameter($collection->getId())));
+        $query->execute();
+    }
+
+    public function invalidateAccessCacheForProvider(IProvider $provider): void {
+        $query = $this->connection->getQueryBuilder();
+
+        $query->delete(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->eq('resource_type', $query->createNamedParameter($provider->getType(), IQueryBuilder::PARAM_STR)));
+        $query->execute();
+    }
+
+    public function invalidateAccessCacheForResourceByUser(IResource $resource, ?IUser $user): void {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->delete(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->eq('resource_id', $query->createNamedParameter($resource->getId())))
+            ->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId)));
+        $query->execute();
+
+        foreach ($resource->getCollections() as $collection) {
+            $this->invalidateAccessCacheForCollectionByUser($collection, $user);
+        }
+    }
+
+    protected function invalidateAccessCacheForCollectionByUser(ICollection $collection, ?IUser $user): void {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->delete(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->eq('collection_id', $query->createNamedParameter($collection->getId())))
+            ->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId)));
+        $query->execute();
+    }
+
+    public function invalidateAccessCacheForProviderByUser(IProvider $provider, ?IUser $user): void {
+        $query = $this->connection->getQueryBuilder();
+        $userId = $user instanceof IUser ? $user->getUID() : '';
+
+        $query->delete(self::TABLE_ACCESS_CACHE)
+            ->where($query->expr()->eq('resource_type', $query->createNamedParameter($provider->getType(), IQueryBuilder::PARAM_STR)))
+            ->andWhere($query->expr()->eq('user_id', $query->createNamedParameter($userId)));
+        $query->execute();
+    }
+
+    /**
+     * @param string $provider
+     */
+    public function registerResourceProvider(string $provider): void {
+        $this->logger->debug('\OC\Collaboration\Resources\Manager::registerResourceProvider is deprecated', ['provider' => $provider]);
+        $this->providerManager->registerResourceProvider($provider);
+    }
+
+    /**
+     * Get the resource type of the provider
+     *
+     * @return string
+     * @since 16.0.0
+     */
+    public function getType(): string {
+        return '';
+    }
 }

lib/public/FullTextSearch/IFullTextSearchManager.php

Indentation +139 added lines, -139 removed lines

@@ -51,145 +51,145 @@
 interface IFullTextSearchManager {
 
 
-	/**
-	 * Register a IProviderService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IProviderService $providerService
-	 */
-	public function registerProviderService(IProviderService $providerService);
-
-	/**
-	 * Register a IIndexService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexService $indexService
-	 */
-	public function registerIndexService(IIndexService $indexService);
-
-	/**
-	 * Register a ISearchService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchService $searchService
-	 */
-	public function registerSearchService(ISearchService $searchService);
-
-	/**
-	 * returns true is Full Text Search is available (app is present and Service
-	 * are registered)
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return bool
-	 */
-	public function isAvailable(): bool;
-
-
-	/**
-	 * Add the Javascript API in the navigation page of an app.
-	 * Needed to replace the default search.
-	 *
-	 * @since 15.0.0
-	 */
-	public function addJavascriptAPI();
-
-
-	/**
-	 * Check if the provider $providerId is already indexed.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 *
-	 * @return bool
-	 */
-	public function isProviderIndexed(string $providerId): bool;
-
-
-	/**
-	 * Retrieve an Index from the database, based on the Id of the Provider
-	 * and the Id of the Document
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 *
-	 * @return IIndex
-	 */
-	public function getIndex(string $providerId, string $documentId): IIndex;
-
-
-	/**
-	 * Create a new Index.
-	 *
-	 * This method must be called when a new document is created.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param string $userId
-	 * @param int $status
-	 *
-	 * @return IIndex
-	 */
-	public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex;
-
-
-	/**
-	 * Update the status of an Index. status is a bitflag, setting $reset to
-	 * true will reset the status to the value defined in the parameter.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param int $status
-	 * @param bool $reset
-	 */
-	public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false);
-
-
-	/**
-	 * Update the status of an array of Index. status is a bit flag, setting $reset to
-	 * true will reset the status to the value defined in the parameter.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param array $documentIds
-	 * @param int $status
-	 * @param bool $reset
-	 */
-	public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false);
-
-	/**
-	 * Update an array of Index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex[] $indexes
-	 */
-	public function updateIndexes(array $indexes);
-
-	/**
-	 * Search using an array as request. If $userId is empty, will use the
-	 * current session.
-	 *
-	 * @see ISearchService::generateSearchRequest
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $request
-	 * @param string $userId
-	 * @return ISearchResult[]
-	 */
-	public function search(array $request, string $userId = ''): array;
+    /**
+     * Register a IProviderService.
+     *
+     * @since 15.0.0
+     *
+     * @param IProviderService $providerService
+     */
+    public function registerProviderService(IProviderService $providerService);
+
+    /**
+     * Register a IIndexService.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexService $indexService
+     */
+    public function registerIndexService(IIndexService $indexService);
+
+    /**
+     * Register a ISearchService.
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchService $searchService
+     */
+    public function registerSearchService(ISearchService $searchService);
+
+    /**
+     * returns true is Full Text Search is available (app is present and Service
+     * are registered)
+     *
+     * @since 16.0.0
+     *
+     * @return bool
+     */
+    public function isAvailable(): bool;
+
+
+    /**
+     * Add the Javascript API in the navigation page of an app.
+     * Needed to replace the default search.
+     *
+     * @since 15.0.0
+     */
+    public function addJavascriptAPI();
+
+
+    /**
+     * Check if the provider $providerId is already indexed.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     *
+     * @return bool
+     */
+    public function isProviderIndexed(string $providerId): bool;
+
+
+    /**
+     * Retrieve an Index from the database, based on the Id of the Provider
+     * and the Id of the Document
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     *
+     * @return IIndex
+     */
+    public function getIndex(string $providerId, string $documentId): IIndex;
+
+
+    /**
+     * Create a new Index.
+     *
+     * This method must be called when a new document is created.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     * @param string $userId
+     * @param int $status
+     *
+     * @return IIndex
+     */
+    public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex;
+
+
+    /**
+     * Update the status of an Index. status is a bitflag, setting $reset to
+     * true will reset the status to the value defined in the parameter.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     * @param int $status
+     * @param bool $reset
+     */
+    public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false);
+
+
+    /**
+     * Update the status of an array of Index. status is a bit flag, setting $reset to
+     * true will reset the status to the value defined in the parameter.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param array $documentIds
+     * @param int $status
+     * @param bool $reset
+     */
+    public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false);
+
+    /**
+     * Update an array of Index.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex[] $indexes
+     */
+    public function updateIndexes(array $indexes);
+
+    /**
+     * Search using an array as request. If $userId is empty, will use the
+     * current session.
+     *
+     * @see ISearchService::generateSearchRequest
+     *
+     * @since 15.0.0
+     *
+     * @param array $request
+     * @param string $userId
+     * @return ISearchResult[]
+     */
+    public function search(array $request, string $userId = ''): array;
 
 
 }

lib/private/FullTextSearch/FullTextSearchManager.php

Indentation +188 added lines, -188 removed lines

@@ -48,194 +48,194 @@
 class FullTextSearchManager implements IFullTextSearchManager {
 
 
-	/** @var IProviderService */
-	private $providerService;
-
-	/** @var IIndexService */
-	private $indexService;
-
-	/** @var ISearchService */
-	private $searchService;
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @param IProviderService $providerService
-	 */
-	public function registerProviderService(IProviderService $providerService) {
-		$this->providerService = $providerService;
-	}
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @param IIndexService $indexService
-	 */
-	public function registerIndexService(IIndexService $indexService) {
-		$this->indexService = $indexService;
-	}
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @param ISearchService $searchService
-	 */
-	public function registerSearchService(ISearchService $searchService) {
-		$this->searchService = $searchService;
-	}
-
-	/**
-	 * @since 16.0.0
-	 *
-	 * @return bool
-	 */
-	public function isAvailable(): bool {
-		if ($this->indexService === null ||
-			$this->providerService === null ||
-			$this->searchService === null) {
-			return false;
-		}
-
-		return true;
-	}
-
-
-	/**
-	 * @return IProviderService
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	private function getProviderService(): IProviderService {
-		if ($this->providerService === null) {
-			throw new FullTextSearchAppNotAvailableException('No IProviderService registered');
-		}
-
-		return $this->providerService;
-	}
-
-
-	/**
-	 * @return IIndexService
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	private function getIndexService(): IIndexService {
-		if ($this->indexService === null) {
-			throw new FullTextSearchAppNotAvailableException('No IIndexService registered');
-		}
-
-		return $this->indexService;
-	}
-
-
-	/**
-	 * @return ISearchService
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	private function getSearchService(): ISearchService {
-		if ($this->searchService === null) {
-			throw new FullTextSearchAppNotAvailableException('No ISearchService registered');
-		}
-
-		return $this->searchService;
-	}
-
-
-	/**
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function addJavascriptAPI() {
-		$this->getProviderService()->addJavascriptAPI();
-	}
-
-
-	/**
-	 * @param string $providerId
-	 *
-	 * @return bool
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function isProviderIndexed(string $providerId): bool {
-		return $this->getProviderService()->isProviderIndexed($providerId);
-	}
-
-
-	/**
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @return IIndex
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function getIndex(string $providerId, string $documentId): IIndex {
-		return $this->getIndexService()->getIndex($providerId, $documentId);
-	}
-
-	/**
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param string $userId
-	 * @param int $status
-	 *
-	 * @see IIndex for available value for $status.
-	 *
-	 * @return IIndex
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex {
-		return $this->getIndexService()->createIndex($providerId, $documentId, $userId, $status);
-	}
-
-
-	/**
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param int $status
-	 * @param bool $reset
-	 *
-	 * @see IIndex for available value for $status.
-	 *
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false) {
-		$this->getIndexService()->updateIndexStatus($providerId, $documentId, $status, $reset);
-	}
-
-	/**
-	 * @param string $providerId
-	 * @param array $documentIds
-	 * @param int $status
-	 * @param bool $reset
-	 *
-	 * @see IIndex for available value for $status.
-	 *
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false) {
-		$this->getIndexService()->updateIndexesStatus($providerId, $documentIds, $status, $reset);
-	}
-
-
-	/**
-	 * @param IIndex[] $indexes
-	 *
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function updateIndexes(array $indexes) {
-		$this->getIndexService()->updateIndexes($indexes);
-	}
-
-
-	/**
-	 * @param array $request
-	 * @param string $userId
-	 *
-	 * @return ISearchResult[]
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function search(array $request, string $userId = ''): array {
-		$searchRequest = $this->getSearchService()->generateSearchRequest($request);
-
-		return $this->getSearchService()->search($userId, $searchRequest);
-	}
+    /** @var IProviderService */
+    private $providerService;
+
+    /** @var IIndexService */
+    private $indexService;
+
+    /** @var ISearchService */
+    private $searchService;
+
+
+    /**
+     * @since 15.0.0
+     *
+     * @param IProviderService $providerService
+     */
+    public function registerProviderService(IProviderService $providerService) {
+        $this->providerService = $providerService;
+    }
+
+    /**
+     * @since 15.0.0
+     *
+     * @param IIndexService $indexService
+     */
+    public function registerIndexService(IIndexService $indexService) {
+        $this->indexService = $indexService;
+    }
+
+    /**
+     * @since 15.0.0
+     *
+     * @param ISearchService $searchService
+     */
+    public function registerSearchService(ISearchService $searchService) {
+        $this->searchService = $searchService;
+    }
+
+    /**
+     * @since 16.0.0
+     *
+     * @return bool
+     */
+    public function isAvailable(): bool {
+        if ($this->indexService === null ||
+            $this->providerService === null ||
+            $this->searchService === null) {
+            return false;
+        }
+
+        return true;
+    }
+
+
+    /**
+     * @return IProviderService
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    private function getProviderService(): IProviderService {
+        if ($this->providerService === null) {
+            throw new FullTextSearchAppNotAvailableException('No IProviderService registered');
+        }
+
+        return $this->providerService;
+    }
+
+
+    /**
+     * @return IIndexService
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    private function getIndexService(): IIndexService {
+        if ($this->indexService === null) {
+            throw new FullTextSearchAppNotAvailableException('No IIndexService registered');
+        }
+
+        return $this->indexService;
+    }
+
+
+    /**
+     * @return ISearchService
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    private function getSearchService(): ISearchService {
+        if ($this->searchService === null) {
+            throw new FullTextSearchAppNotAvailableException('No ISearchService registered');
+        }
+
+        return $this->searchService;
+    }
+
+
+    /**
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function addJavascriptAPI() {
+        $this->getProviderService()->addJavascriptAPI();
+    }
+
+
+    /**
+     * @param string $providerId
+     *
+     * @return bool
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function isProviderIndexed(string $providerId): bool {
+        return $this->getProviderService()->isProviderIndexed($providerId);
+    }
+
+
+    /**
+     * @param string $providerId
+     * @param string $documentId
+     * @return IIndex
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function getIndex(string $providerId, string $documentId): IIndex {
+        return $this->getIndexService()->getIndex($providerId, $documentId);
+    }
+
+    /**
+     * @param string $providerId
+     * @param string $documentId
+     * @param string $userId
+     * @param int $status
+     *
+     * @see IIndex for available value for $status.
+     *
+     * @return IIndex
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex {
+        return $this->getIndexService()->createIndex($providerId, $documentId, $userId, $status);
+    }
+
+
+    /**
+     * @param string $providerId
+     * @param string $documentId
+     * @param int $status
+     * @param bool $reset
+     *
+     * @see IIndex for available value for $status.
+     *
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false) {
+        $this->getIndexService()->updateIndexStatus($providerId, $documentId, $status, $reset);
+    }
+
+    /**
+     * @param string $providerId
+     * @param array $documentIds
+     * @param int $status
+     * @param bool $reset
+     *
+     * @see IIndex for available value for $status.
+     *
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false) {
+        $this->getIndexService()->updateIndexesStatus($providerId, $documentIds, $status, $reset);
+    }
+
+
+    /**
+     * @param IIndex[] $indexes
+     *
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function updateIndexes(array $indexes) {
+        $this->getIndexService()->updateIndexes($indexes);
+    }
+
+
+    /**
+     * @param array $request
+     * @param string $userId
+     *
+     * @return ISearchResult[]
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function search(array $request, string $userId = ''): array {
+        $searchRequest = $this->getSearchService()->generateSearchRequest($request);
+
+        return $this->getSearchService()->search($userId, $searchRequest);
+    }
 
 
 }