nextcloud / server

lib/private/FullTextSearch/Model/SearchOption.php

Indentation +243 added lines, -243 removed lines

@@ -45,247 +45,247 @@
 final class SearchOption implements ISearchOption, JsonSerializable {
 
 
-	/** @var string */
-	private $name = '';
-
-	/** @var string */
-	private $title = '';
-
-	/** @var string */
-	private $type = '';
-
-	/** @var string */
-	private $size = '';
-
-	/** @var string */
-	private $placeholder = '';
-
-
-	/**
-	 *     *
-	 *
-	 * The array can be empty in case no search options are available.
-	 * The format of the array must be like this:
-	 *
-	 * [
-	 *   'panel' => [
-	 *     'options' => [
-	 *         OPTION1,
-	 *         OPTION2,
-	 *         OPTION3
-	 *     ]
-	 *   ],
-	 *   'navigation' => [
-	 *     'icon'    => 'css-class-of-the-icon',
-	 *     'options' => [
-	 *         OPTION1,
-	 *         OPTION2,
-	 *         OPTION3
-	 *     ]
-	 *   ]
-	 * ]
-	 *
-	 * - PANEL contains entries that will be displayed in the app itself, when
-	 *   a search is initiated.
-	 * - NAVIGATION contains entries that will be available when using the
-	 *   FullTextSearch navigation page
-	 * - OPTION is an element that define each option available to the user.
-	 *
-	 * The format for the options must be like this:
-	 *
-	 * [
-	 *   'name'        => 'name_of_the_option',
-	 *   'title'       => 'Name displayed in the panel',
-	 *   'type'        => '',
-	 *   'size'        => ''   (optional),
-	 *   'placeholder' => ''   (optional)
-	 * ]
-	 *
-	 * - NAME is the variable name that is sent to the IFullTextSearchProvider
-	 *   when a ISearchRequest is requested. (keys in the array returned by the
-	 *   ISearchRequest->getOptions())
-	 * - TYPE can be 'input' or 'checkbox'
-	 * - SIZE is only used in case TYPE='input', default is 'large' but can be
-	 *   'small'
-	 * - PLACEHOLDER is only used in case TYPE='input', default is empty.
-	 */
-
-	/**
-	 * ISearchOption constructor.
-	 *
-	 * Some value can be setduring the creation of the object.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $name
-	 * @param string $title
-	 * @param string $type
-	 * @param string $size
-	 * @param string $placeholder
-	 */
-	public function __construct(string $name = '', string $title = '', string $type = '', string $size = '', string $placeholder = '') {
-		$this->name = $name;
-		$this->title = $title;
-		$this->type = $type;
-		$this->size = $size;
-		$this->placeholder = $placeholder;
-	}
-
-
-	/**
-	 * Set the name/key of the option.
-	 * The string should only contains alphanumerical chars and underscore.
-	 * The key can be retrieve when using ISearchRequest::getOption
-	 *
-	 * @see ISearchRequest::getOption
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $name
-	 *
-	 * @return ISearchOption
-	 */
-	public function setName(string $name): ISearchOption {
-		$this->name = $name;
-
-		return $this;
-	}
-
-	/**
-	 * Get the name/key of the option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getName(): string {
-		return $this->name;
-	}
-
-
-	/**
-	 * Set the title/display name of the option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $title
-	 *
-	 * @return ISearchOption
-	 */
-	public function setTitle(string $title): ISearchOption {
-		$this->title = $title;
-
-		return $this;
-	}
-
-	/**
-	 * Get the title of the option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getTitle(): string {
-		return $this->title;
-	}
-
-
-	/**
-	 * Set the type of the option.
-	 * $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $type
-	 *
-	 * @return ISearchOption
-	 */
-	public function setType(string $type): ISearchOption {
-		$this->type = $type;
-
-		return $this;
-	}
-
-	/**
-	 * Get the type of the option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getType(): string {
-		return $this->type;
-	}
-
-
-	/**
-	 * In case of Type is INPUT, set the size of the input field.
-	 * Value can be ISearchOption::INPUT_SMALL or not defined.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $size
-	 *
-	 * @return ISearchOption
-	 */
-	public function setSize(string $size): ISearchOption {
-		$this->size = $size;
-
-		return $this;
-	}
-
-	/**
-	 * Get the size of the INPUT.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getSize(): string {
-		return $this->size;
-	}
-
-
-	/**
-	 * In case of Type is , set the placeholder to be displayed in the input
-	 * field.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $placeholder
-	 *
-	 * @return ISearchOption
-	 */
-	public function setPlaceholder(string $placeholder): ISearchOption {
-		$this->placeholder = $placeholder;
-
-		return $this;
-	}
-
-	/**
-	 * Get the placeholder.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getPlaceholder(): string {
-		return $this->placeholder;
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'name' => $this->getName(),
-			'title' => $this->getTitle(),
-			'type' => $this->getType(),
-			'size' => $this->getSize(),
-			'placeholder' => $this->getPlaceholder()
-		];
-	}
+    /** @var string */
+    private $name = '';
+
+    /** @var string */
+    private $title = '';
+
+    /** @var string */
+    private $type = '';
+
+    /** @var string */
+    private $size = '';
+
+    /** @var string */
+    private $placeholder = '';
+
+
+    /**
+     *     *
+     *
+     * The array can be empty in case no search options are available.
+     * The format of the array must be like this:
+     *
+     * [
+     *   'panel' => [
+     *     'options' => [
+     *         OPTION1,
+     *         OPTION2,
+     *         OPTION3
+     *     ]
+     *   ],
+     *   'navigation' => [
+     *     'icon'    => 'css-class-of-the-icon',
+     *     'options' => [
+     *         OPTION1,
+     *         OPTION2,
+     *         OPTION3
+     *     ]
+     *   ]
+     * ]
+     *
+     * - PANEL contains entries that will be displayed in the app itself, when
+     *   a search is initiated.
+     * - NAVIGATION contains entries that will be available when using the
+     *   FullTextSearch navigation page
+     * - OPTION is an element that define each option available to the user.
+     *
+     * The format for the options must be like this:
+     *
+     * [
+     *   'name'        => 'name_of_the_option',
+     *   'title'       => 'Name displayed in the panel',
+     *   'type'        => '',
+     *   'size'        => ''   (optional),
+     *   'placeholder' => ''   (optional)
+     * ]
+     *
+     * - NAME is the variable name that is sent to the IFullTextSearchProvider
+     *   when a ISearchRequest is requested. (keys in the array returned by the
+     *   ISearchRequest->getOptions())
+     * - TYPE can be 'input' or 'checkbox'
+     * - SIZE is only used in case TYPE='input', default is 'large' but can be
+     *   'small'
+     * - PLACEHOLDER is only used in case TYPE='input', default is empty.
+     */
+
+    /**
+     * ISearchOption constructor.
+     *
+     * Some value can be setduring the creation of the object.
+     *
+     * @since 15.0.0
+     *
+     * @param string $name
+     * @param string $title
+     * @param string $type
+     * @param string $size
+     * @param string $placeholder
+     */
+    public function __construct(string $name = '', string $title = '', string $type = '', string $size = '', string $placeholder = '') {
+        $this->name = $name;
+        $this->title = $title;
+        $this->type = $type;
+        $this->size = $size;
+        $this->placeholder = $placeholder;
+    }
+
+
+    /**
+     * Set the name/key of the option.
+     * The string should only contains alphanumerical chars and underscore.
+     * The key can be retrieve when using ISearchRequest::getOption
+     *
+     * @see ISearchRequest::getOption
+     *
+     * @since 15.0.0
+     *
+     * @param string $name
+     *
+     * @return ISearchOption
+     */
+    public function setName(string $name): ISearchOption {
+        $this->name = $name;
+
+        return $this;
+    }
+
+    /**
+     * Get the name/key of the option.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getName(): string {
+        return $this->name;
+    }
+
+
+    /**
+     * Set the title/display name of the option.
+     *
+     * @since 15.0.0
+     *
+     * @param string $title
+     *
+     * @return ISearchOption
+     */
+    public function setTitle(string $title): ISearchOption {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    /**
+     * Get the title of the option.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getTitle(): string {
+        return $this->title;
+    }
+
+
+    /**
+     * Set the type of the option.
+     * $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
+     *
+     * @since 15.0.0
+     *
+     * @param string $type
+     *
+     * @return ISearchOption
+     */
+    public function setType(string $type): ISearchOption {
+        $this->type = $type;
+
+        return $this;
+    }
+
+    /**
+     * Get the type of the option.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getType(): string {
+        return $this->type;
+    }
+
+
+    /**
+     * In case of Type is INPUT, set the size of the input field.
+     * Value can be ISearchOption::INPUT_SMALL or not defined.
+     *
+     * @since 15.0.0
+     *
+     * @param string $size
+     *
+     * @return ISearchOption
+     */
+    public function setSize(string $size): ISearchOption {
+        $this->size = $size;
+
+        return $this;
+    }
+
+    /**
+     * Get the size of the INPUT.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getSize(): string {
+        return $this->size;
+    }
+
+
+    /**
+     * In case of Type is , set the placeholder to be displayed in the input
+     * field.
+     *
+     * @since 15.0.0
+     *
+     * @param string $placeholder
+     *
+     * @return ISearchOption
+     */
+    public function setPlaceholder(string $placeholder): ISearchOption {
+        $this->placeholder = $placeholder;
+
+        return $this;
+    }
+
+    /**
+     * Get the placeholder.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getPlaceholder(): string {
+        return $this->placeholder;
+    }
+
+
+    /**
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function jsonSerialize(): array {
+        return [
+            'name' => $this->getName(),
+            'title' => $this->getTitle(),
+            'type' => $this->getType(),
+            'size' => $this->getSize(),
+            'placeholder' => $this->getPlaceholder()
+        ];
+    }
 }

lib/private/FullTextSearch/Model/IndexDocument.php

Spacing +1 added lines, -1 removed lines

@@ -389,7 +389,7 @@
 		foreach ($ak as $source) {
 			$tags = $this->subTags[$source];
 			foreach ($tags as $tag) {
-				$subTags[] = $source . '_' . $tag;
+				$subTags[] = $source.'_'.$tag;
 			}
 		}
 

Indentation +934 added lines, -934 removed lines

@@ -49,940 +49,940 @@
 class IndexDocument implements IIndexDocument, JsonSerializable {
 
 
-	/** @var string */
-	protected $id = '';
+    /** @var string */
+    protected $id = '';
 
-	/** @var string */
-	protected $providerId = '';
+    /** @var string */
+    protected $providerId = '';
 
-	/** @var DocumentAccess */
-	protected $access;
-
-	/** @var IIndex */
-	protected $index;
-
-	/** @var int */
-	protected $modifiedTime = 0;
-
-	/** @var string */
-	protected $source = '';
-
-	/** @var array */
-	protected $tags = [];
-
-	/** @var array */
-	protected $metaTags = [];
-
-	/** @var array */
-	protected $subTags = [];
-
-	/** @var string */
-	protected $title = '';
-
-	/** @var string */
-	protected $content = '';
-
-	/** @var string */
-	protected $hash = '';
-
-	/** @var array */
-	protected $parts = [];
-
-	/** @var string */
-	protected $link = '';
-
-	/** @var array */
-	protected $more = [];
-
-	/** @var array */
-	protected $excerpts = [];
-
-	/** @var string */
-	protected $score = '';
-
-	/** @var array */
-	protected $info = [];
-
-	/** @var int */
-	protected $contentEncoded = 0;
-
-
-	/**
-	 * IIndexDocument constructor.
-	 *
-	 * On creation, we assure the uniqueness of the object using the providerId
-	 * and the Id of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 */
-	public function __construct(string $providerId, string $documentId) {
-		$this->providerId = $providerId;
-		$this->id = $documentId;
-	}
-
-
-	/**
-	 * Returns the Id of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getId(): string {
-		return $this->id;
-	}
-
-
-	/**
-	 * Returns the Id of the provider.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getProviderId(): string {
-		return $this->providerId;
-	}
-
-
-	/**
-	 * Set the Index related to the IIndexDocument.
-	 *
-	 * @see IIndex
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex $index
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setIndex(IIndex $index): IIndexDocument {
-		$this->index = $index;
-
-		return $this;
-	}
-
-	/**
-	 * Get the Index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndex
-	 */
-	final public function getIndex(): IIndex {
-		return $this->index;
-	}
-
-	/**
-	 * return if Index is defined.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return bool
-	 */
-	final public function hasIndex(): bool {
-		return ($this->index !== null);
-	}
-
-
-	/**
-	 * Set the modified time of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $modifiedTime
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setModifiedTime(int $modifiedTime): IIndexDocument {
-		$this->modifiedTime = $modifiedTime;
-
-		return $this;
-	}
-
-	/**
-	 * Get the modified time of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	final public function getModifiedTime(): int {
-		return $this->modifiedTime;
-	}
-
-	/**
-	 * Check if the original document of the IIndexDocument is older than $time.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $time
-	 *
-	 * @return bool
-	 */
-	final public function isOlderThan(int $time): bool {
-		return ($this->modifiedTime < $time);
-	}
-
-
-	/**
-	 * Set the read rights of the original document using a IDocumentAccess.
-	 *
-	 * @see IDocumentAccess
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IDocumentAccess $access
-	 *
-	 * @return $this
-	 */
-	final public function setAccess(IDocumentAccess $access): IIndexDocument {
-		$this->access = $access;
-
-		return $this;
-	}
-
-	/**
-	 * Get the IDocumentAccess related to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IDocumentAccess
-	 */
-	final public function getAccess(): IDocumentAccess {
-		return $this->access;
-	}
-
-
-	/**
-	 * Add a tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addTag(string $tag): IIndexDocument {
-		$this->tags[] = $tag;
-
-		return $this;
-	}
-
-	/**
-	 * Set the list of tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setTags(array $tags): IIndexDocument {
-		$this->tags = $tags;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getTags(): array {
-		return $this->tags;
-	}
-
-
-	/**
-	 * Add a meta tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addMetaTag(string $tag): IIndexDocument {
-		$this->metaTags[] = $tag;
-
-		return $this;
-	}
-
-	/**
-	 * Set the list of meta tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setMetaTags(array $tags): IIndexDocument {
-		$this->metaTags = $tags;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of meta tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getMetaTags(): array {
-		return $this->metaTags;
-	}
-
-
-	/**
-	 * Add a sub tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $sub
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addSubTag(string $sub, string $tag): IIndexDocument {
-		if (!array_key_exists($sub, $this->subTags)) {
-			$this->subTags[$sub] = [];
-		}
-
-		$this->subTags[$sub][] = $tag;
-
-		return $this;
-	}
-
-
-	/**
-	 * Set the list of sub tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setSubTags(array $tags): IIndexDocument {
-		$this->subTags = $tags;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of sub tags assigned to the original document.
-	 * If $formatted is true, the result will be formatted in a one
-	 * dimensional array.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param bool $formatted
-	 *
-	 * @return array
-	 */
-	final public function getSubTags(bool $formatted = false): array {
-		if ($formatted === false) {
-			return $this->subTags;
-		}
-
-		$subTags = [];
-		$ak = array_keys($this->subTags);
-		foreach ($ak as $source) {
-			$tags = $this->subTags[$source];
-			foreach ($tags as $tag) {
-				$subTags[] = $source . '_' . $tag;
-			}
-		}
-
-		return $subTags;
-	}
-
-
-	/**
-	 * Set the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $source
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setSource(string $source): IIndexDocument {
-		$this->source = $source;
-
-		return $this;
-	}
-
-	/**
-	 * Get the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getSource(): string {
-		return $this->source;
-	}
-
-
-	/**
-	 * Set the title of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $title
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setTitle(string $title): IIndexDocument {
-		$this->title = $title;
-
-		return $this;
-	}
-
-	/**
-	 * Get the title of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getTitle(): string {
-		return $this->title;
-	}
-
-
-	/**
-	 * Set the content of the document.
-	 * $encoded can be NOT_ENCODED or ENCODED_BASE64 if the content is raw or
-	 * encoded in base64.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $content
-	 * @param int $encoded
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setContent(string $content, int $encoded = 0): IIndexDocument {
-		$this->content = $content;
-		$this->contentEncoded = $encoded;
-
-		return $this;
-	}
-
-	/**
-	 * Get the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getContent(): string {
-		return $this->content;
-	}
-
-	/**
-	 * Returns the type of the encoding on the content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	final public function isContentEncoded(): int {
-		return $this->contentEncoded;
-	}
-
-	/**
-	 * Return the size of the content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	final public function getContentSize(): int {
-		return strlen($this->getContent());
-	}
-
-
-	/**
-	 * Generate an hash, based on the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function initHash(): IIndexDocument {
-		if ($this->getContent() === '' || is_null($this->getContent())) {
-			return $this;
-		}
-
-		$this->hash = hash("md5", $this->getContent());
-
-		return $this;
-	}
-
-	/**
-	 * Set the hash of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $hash
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setHash(string $hash): IIndexDocument {
-		$this->hash = $hash;
-
-		return $this;
-	}
-
-	/**
-	 * Get the hash of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getHash(): string {
-		return $this->hash;
-	}
-
-
-	/**
-	 * Add a part, identified by a string, and its content.
-	 *
-	 * It is strongly advised to use alphanumerical chars with no space in the
-	 * $part string.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $part
-	 * @param string $content
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addPart(string $part, string $content): IIndexDocument {
-		$this->parts[$part] = $content;
-
-		return $this;
-	}
-
-	/**
-	 * Set all parts and their content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $parts
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setParts(array $parts): IIndexDocument {
-		$this->parts = $parts;
-
-		return $this;
-	}
-
-	/**
-	 * Get all parts of the IIndexDocument.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getParts(): array {
-		return $this->parts;
-	}
-
-
-	/**
-	 * Add a link, usable by the frontend.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $link
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setLink(string $link): IIndexDocument {
-		$this->link = $link;
-
-		return $this;
-	}
-
-	/**
-	 * Get the link.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getLink(): string {
-		return $this->link;
-	}
-
-
-	/**
-	 * Set more information that couldn't be set using other method.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $more
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setMore(array $more): IIndexDocument {
-		$this->more = $more;
-
-		return $this;
-	}
-
-	/**
-	 * Get more information.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getMore(): array {
-		return $this->more;
-	}
-
-
-	/**
-	 * Add some excerpt of the content of the original document, usually based
-	 * on the search request.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $source
-	 * @param string $excerpt
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addExcerpt(string $source, string $excerpt): IIndexDocument {
-		$this->excerpts[] =
-			[
-				'source' => $source,
-				'excerpt' => $this->cleanExcerpt($excerpt)
-			];
-
-		return $this;
-	}
-
-
-	/**
-	 * Set all excerpts of the content of the original document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $excerpts
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setExcerpts(array $excerpts): IIndexDocument {
-		$new = [];
-		foreach ($excerpts as $entry) {
-			$new[] = [
-				'source' => $entry['source'],
-				'excerpt' => $this->cleanExcerpt($entry['excerpt'])
-			];
-		}
-
-		$this->excerpts = $new;
-
-		return $this;
-	}
-
-	/**
-	 * Get all excerpts of the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getExcerpts(): array {
-		return $this->excerpts;
-	}
-
-	/**
-	 * Clean excerpt.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $excerpt
-	 * @return string
-	 */
-	private function cleanExcerpt(string $excerpt): string {
-		$excerpt = str_replace("\\n", ' ', $excerpt);
-		$excerpt = str_replace("\\r", ' ', $excerpt);
-		$excerpt = str_replace("\\t", ' ', $excerpt);
-		$excerpt = str_replace("\n", ' ', $excerpt);
-		$excerpt = str_replace("\r", ' ', $excerpt);
-		$excerpt = str_replace("\t", ' ', $excerpt);
-
-		return $excerpt;
-	}
-
-
-	/**
-	 * Set the score to the result assigned to this document during a search
-	 * request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $score
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setScore(string $score): IIndexDocument {
-		$this->score = $score;
-
-		return $this;
-	}
-
-	/**
-	 * Get the score.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getScore(): string {
-		return $this->score;
-	}
-
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as string)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param string $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfo(string $info, string $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (string)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param string $default
-	 *
-	 * @return string
-	 */
-	final public function getInfo(string $info, string $default = ''): string {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as array)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param array $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfoArray(string $info, array $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (array)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param array $default
-	 *
-	 * @return array
-	 */
-	final public function getInfoArray(string $info, array $default = []): array {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as int)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param int $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfoInt(string $info, int $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (int)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param int $default
-	 *
-	 * @return int
-	 */
-	final public function getInfoInt(string $info, int $default = 0): int {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as bool)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param bool $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfoBool(string $info, bool $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (bool)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param bool $default
-	 *
-	 * @return bool
-	 */
-	final public function getInfoBool(string $info, bool $default = false): bool {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Get all info.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getInfoAll(): array {
-		$info = [];
-		foreach ($this->info as $k => $v) {
-			if (substr($k, 0, 1) === '_') {
-				continue;
-			}
-
-			$info[$k] = $v;
-		}
-
-		return $info;
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * On some version of PHP, it is better to force destruct the object.
-	 * And during the index, the number of generated IIndexDocument can be
-	 * _huge_.
-	 */
-	public function __destruct() {
-		unset($this->id);
-		unset($this->providerId);
-		unset($this->access);
-		unset($this->modifiedTime);
-		unset($this->title);
-		unset($this->content);
-		unset($this->hash);
-		unset($this->link);
-		unset($this->source);
-		unset($this->tags);
-		unset($this->metaTags);
-		unset($this->subTags);
-		unset($this->more);
-		unset($this->excerpts);
-		unset($this->score);
-		unset($this->info);
-		unset($this->contentEncoded);
-	}
-
-	/**
-	 * @since 15.0.0
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'id' => $this->getId(),
-			'providerId' => $this->getProviderId(),
-			'access' => $this->access,
-			'modifiedTime' => $this->getModifiedTime(),
-			'title' => $this->getTitle(),
-			'link' => $this->getLink(),
-			'index' => $this->index,
-			'source' => $this->getSource(),
-			'info' => $this->getInfoAll(),
-			'hash' => $this->getHash(),
-			'contentSize' => $this->getContentSize(),
-			'tags' => $this->getTags(),
-			'metatags' => $this->getMetaTags(),
-			'subtags' => $this->getSubTags(),
-			'more' => $this->getMore(),
-			'excerpts' => $this->getExcerpts(),
-			'score' => $this->getScore()
-		];
-	}
+    /** @var DocumentAccess */
+    protected $access;
+
+    /** @var IIndex */
+    protected $index;
+
+    /** @var int */
+    protected $modifiedTime = 0;
+
+    /** @var string */
+    protected $source = '';
+
+    /** @var array */
+    protected $tags = [];
+
+    /** @var array */
+    protected $metaTags = [];
+
+    /** @var array */
+    protected $subTags = [];
+
+    /** @var string */
+    protected $title = '';
+
+    /** @var string */
+    protected $content = '';
+
+    /** @var string */
+    protected $hash = '';
+
+    /** @var array */
+    protected $parts = [];
+
+    /** @var string */
+    protected $link = '';
+
+    /** @var array */
+    protected $more = [];
+
+    /** @var array */
+    protected $excerpts = [];
+
+    /** @var string */
+    protected $score = '';
+
+    /** @var array */
+    protected $info = [];
+
+    /** @var int */
+    protected $contentEncoded = 0;
+
+
+    /**
+     * IIndexDocument constructor.
+     *
+     * On creation, we assure the uniqueness of the object using the providerId
+     * and the Id of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     */
+    public function __construct(string $providerId, string $documentId) {
+        $this->providerId = $providerId;
+        $this->id = $documentId;
+    }
+
+
+    /**
+     * Returns the Id of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getId(): string {
+        return $this->id;
+    }
+
+
+    /**
+     * Returns the Id of the provider.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getProviderId(): string {
+        return $this->providerId;
+    }
+
+
+    /**
+     * Set the Index related to the IIndexDocument.
+     *
+     * @see IIndex
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex $index
+     *
+     * @return IIndexDocument
+     */
+    final public function setIndex(IIndex $index): IIndexDocument {
+        $this->index = $index;
+
+        return $this;
+    }
+
+    /**
+     * Get the Index.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndex
+     */
+    final public function getIndex(): IIndex {
+        return $this->index;
+    }
+
+    /**
+     * return if Index is defined.
+     *
+     * @since 16.0.0
+     *
+     * @return bool
+     */
+    final public function hasIndex(): bool {
+        return ($this->index !== null);
+    }
+
+
+    /**
+     * Set the modified time of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param int $modifiedTime
+     *
+     * @return IIndexDocument
+     */
+    final public function setModifiedTime(int $modifiedTime): IIndexDocument {
+        $this->modifiedTime = $modifiedTime;
+
+        return $this;
+    }
+
+    /**
+     * Get the modified time of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    final public function getModifiedTime(): int {
+        return $this->modifiedTime;
+    }
+
+    /**
+     * Check if the original document of the IIndexDocument is older than $time.
+     *
+     * @since 15.0.0
+     *
+     * @param int $time
+     *
+     * @return bool
+     */
+    final public function isOlderThan(int $time): bool {
+        return ($this->modifiedTime < $time);
+    }
+
+
+    /**
+     * Set the read rights of the original document using a IDocumentAccess.
+     *
+     * @see IDocumentAccess
+     *
+     * @since 15.0.0
+     *
+     * @param IDocumentAccess $access
+     *
+     * @return $this
+     */
+    final public function setAccess(IDocumentAccess $access): IIndexDocument {
+        $this->access = $access;
+
+        return $this;
+    }
+
+    /**
+     * Get the IDocumentAccess related to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return IDocumentAccess
+     */
+    final public function getAccess(): IDocumentAccess {
+        return $this->access;
+    }
+
+
+    /**
+     * Add a tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    final public function addTag(string $tag): IIndexDocument {
+        $this->tags[] = $tag;
+
+        return $this;
+    }
+
+    /**
+     * Set the list of tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    final public function setTags(array $tags): IIndexDocument {
+        $this->tags = $tags;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getTags(): array {
+        return $this->tags;
+    }
+
+
+    /**
+     * Add a meta tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    final public function addMetaTag(string $tag): IIndexDocument {
+        $this->metaTags[] = $tag;
+
+        return $this;
+    }
+
+    /**
+     * Set the list of meta tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    final public function setMetaTags(array $tags): IIndexDocument {
+        $this->metaTags = $tags;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of meta tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getMetaTags(): array {
+        return $this->metaTags;
+    }
+
+
+    /**
+     * Add a sub tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $sub
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    final public function addSubTag(string $sub, string $tag): IIndexDocument {
+        if (!array_key_exists($sub, $this->subTags)) {
+            $this->subTags[$sub] = [];
+        }
+
+        $this->subTags[$sub][] = $tag;
+
+        return $this;
+    }
+
+
+    /**
+     * Set the list of sub tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    final public function setSubTags(array $tags): IIndexDocument {
+        $this->subTags = $tags;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of sub tags assigned to the original document.
+     * If $formatted is true, the result will be formatted in a one
+     * dimensional array.
+     *
+     * @since 15.0.0
+     *
+     * @param bool $formatted
+     *
+     * @return array
+     */
+    final public function getSubTags(bool $formatted = false): array {
+        if ($formatted === false) {
+            return $this->subTags;
+        }
+
+        $subTags = [];
+        $ak = array_keys($this->subTags);
+        foreach ($ak as $source) {
+            $tags = $this->subTags[$source];
+            foreach ($tags as $tag) {
+                $subTags[] = $source . '_' . $tag;
+            }
+        }
+
+        return $subTags;
+    }
+
+
+    /**
+     * Set the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $source
+     *
+     * @return IIndexDocument
+     */
+    final public function setSource(string $source): IIndexDocument {
+        $this->source = $source;
+
+        return $this;
+    }
+
+    /**
+     * Get the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getSource(): string {
+        return $this->source;
+    }
+
+
+    /**
+     * Set the title of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $title
+     *
+     * @return IIndexDocument
+     */
+    final public function setTitle(string $title): IIndexDocument {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    /**
+     * Get the title of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getTitle(): string {
+        return $this->title;
+    }
+
+
+    /**
+     * Set the content of the document.
+     * $encoded can be NOT_ENCODED or ENCODED_BASE64 if the content is raw or
+     * encoded in base64.
+     *
+     * @since 15.0.0
+     *
+     * @param string $content
+     * @param int $encoded
+     *
+     * @return IIndexDocument
+     */
+    final public function setContent(string $content, int $encoded = 0): IIndexDocument {
+        $this->content = $content;
+        $this->contentEncoded = $encoded;
+
+        return $this;
+    }
+
+    /**
+     * Get the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getContent(): string {
+        return $this->content;
+    }
+
+    /**
+     * Returns the type of the encoding on the content.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    final public function isContentEncoded(): int {
+        return $this->contentEncoded;
+    }
+
+    /**
+     * Return the size of the content.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    final public function getContentSize(): int {
+        return strlen($this->getContent());
+    }
+
+
+    /**
+     * Generate an hash, based on the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndexDocument
+     */
+    final public function initHash(): IIndexDocument {
+        if ($this->getContent() === '' || is_null($this->getContent())) {
+            return $this;
+        }
+
+        $this->hash = hash("md5", $this->getContent());
+
+        return $this;
+    }
+
+    /**
+     * Set the hash of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $hash
+     *
+     * @return IIndexDocument
+     */
+    final public function setHash(string $hash): IIndexDocument {
+        $this->hash = $hash;
+
+        return $this;
+    }
+
+    /**
+     * Get the hash of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getHash(): string {
+        return $this->hash;
+    }
+
+
+    /**
+     * Add a part, identified by a string, and its content.
+     *
+     * It is strongly advised to use alphanumerical chars with no space in the
+     * $part string.
+     *
+     * @since 15.0.0
+     *
+     * @param string $part
+     * @param string $content
+     *
+     * @return IIndexDocument
+     */
+    final public function addPart(string $part, string $content): IIndexDocument {
+        $this->parts[$part] = $content;
+
+        return $this;
+    }
+
+    /**
+     * Set all parts and their content.
+     *
+     * @since 15.0.0
+     *
+     * @param array $parts
+     *
+     * @return IIndexDocument
+     */
+    final public function setParts(array $parts): IIndexDocument {
+        $this->parts = $parts;
+
+        return $this;
+    }
+
+    /**
+     * Get all parts of the IIndexDocument.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getParts(): array {
+        return $this->parts;
+    }
+
+
+    /**
+     * Add a link, usable by the frontend.
+     *
+     * @since 15.0.0
+     *
+     * @param string $link
+     *
+     * @return IIndexDocument
+     */
+    final public function setLink(string $link): IIndexDocument {
+        $this->link = $link;
+
+        return $this;
+    }
+
+    /**
+     * Get the link.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getLink(): string {
+        return $this->link;
+    }
+
+
+    /**
+     * Set more information that couldn't be set using other method.
+     *
+     * @since 15.0.0
+     *
+     * @param array $more
+     *
+     * @return IIndexDocument
+     */
+    final public function setMore(array $more): IIndexDocument {
+        $this->more = $more;
+
+        return $this;
+    }
+
+    /**
+     * Get more information.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getMore(): array {
+        return $this->more;
+    }
+
+
+    /**
+     * Add some excerpt of the content of the original document, usually based
+     * on the search request.
+     *
+     * @since 16.0.0
+     *
+     * @param string $source
+     * @param string $excerpt
+     *
+     * @return IIndexDocument
+     */
+    final public function addExcerpt(string $source, string $excerpt): IIndexDocument {
+        $this->excerpts[] =
+            [
+                'source' => $source,
+                'excerpt' => $this->cleanExcerpt($excerpt)
+            ];
+
+        return $this;
+    }
+
+
+    /**
+     * Set all excerpts of the content of the original document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $excerpts
+     *
+     * @return IIndexDocument
+     */
+    final public function setExcerpts(array $excerpts): IIndexDocument {
+        $new = [];
+        foreach ($excerpts as $entry) {
+            $new[] = [
+                'source' => $entry['source'],
+                'excerpt' => $this->cleanExcerpt($entry['excerpt'])
+            ];
+        }
+
+        $this->excerpts = $new;
+
+        return $this;
+    }
+
+    /**
+     * Get all excerpts of the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getExcerpts(): array {
+        return $this->excerpts;
+    }
+
+    /**
+     * Clean excerpt.
+     *
+     * @since 16.0.0
+     *
+     * @param string $excerpt
+     * @return string
+     */
+    private function cleanExcerpt(string $excerpt): string {
+        $excerpt = str_replace("\\n", ' ', $excerpt);
+        $excerpt = str_replace("\\r", ' ', $excerpt);
+        $excerpt = str_replace("\\t", ' ', $excerpt);
+        $excerpt = str_replace("\n", ' ', $excerpt);
+        $excerpt = str_replace("\r", ' ', $excerpt);
+        $excerpt = str_replace("\t", ' ', $excerpt);
+
+        return $excerpt;
+    }
+
+
+    /**
+     * Set the score to the result assigned to this document during a search
+     * request.
+     *
+     * @since 15.0.0
+     *
+     * @param string $score
+     *
+     * @return IIndexDocument
+     */
+    final public function setScore(string $score): IIndexDocument {
+        $this->score = $score;
+
+        return $this;
+    }
+
+    /**
+     * Get the score.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getScore(): string {
+        return $this->score;
+    }
+
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as string)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param string $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfo(string $info, string $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (string)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param string $default
+     *
+     * @return string
+     */
+    final public function getInfo(string $info, string $default = ''): string {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as array)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param array $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfoArray(string $info, array $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (array)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param array $default
+     *
+     * @return array
+     */
+    final public function getInfoArray(string $info, array $default = []): array {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as int)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param int $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfoInt(string $info, int $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (int)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param int $default
+     *
+     * @return int
+     */
+    final public function getInfoInt(string $info, int $default = 0): int {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as bool)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param bool $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfoBool(string $info, bool $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (bool)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param bool $default
+     *
+     * @return bool
+     */
+    final public function getInfoBool(string $info, bool $default = false): bool {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Get all info.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getInfoAll(): array {
+        $info = [];
+        foreach ($this->info as $k => $v) {
+            if (substr($k, 0, 1) === '_') {
+                continue;
+            }
+
+            $info[$k] = $v;
+        }
+
+        return $info;
+    }
+
+
+    /**
+     * @since 15.0.0
+     *
+     * On some version of PHP, it is better to force destruct the object.
+     * And during the index, the number of generated IIndexDocument can be
+     * _huge_.
+     */
+    public function __destruct() {
+        unset($this->id);
+        unset($this->providerId);
+        unset($this->access);
+        unset($this->modifiedTime);
+        unset($this->title);
+        unset($this->content);
+        unset($this->hash);
+        unset($this->link);
+        unset($this->source);
+        unset($this->tags);
+        unset($this->metaTags);
+        unset($this->subTags);
+        unset($this->more);
+        unset($this->excerpts);
+        unset($this->score);
+        unset($this->info);
+        unset($this->contentEncoded);
+    }
+
+    /**
+     * @since 15.0.0
+     */
+    public function jsonSerialize(): array {
+        return [
+            'id' => $this->getId(),
+            'providerId' => $this->getProviderId(),
+            'access' => $this->access,
+            'modifiedTime' => $this->getModifiedTime(),
+            'title' => $this->getTitle(),
+            'link' => $this->getLink(),
+            'index' => $this->index,
+            'source' => $this->getSource(),
+            'info' => $this->getInfoAll(),
+            'hash' => $this->getHash(),
+            'contentSize' => $this->getContentSize(),
+            'tags' => $this->getTags(),
+            'metatags' => $this->getMetaTags(),
+            'subtags' => $this->getSubTags(),
+            'more' => $this->getMore(),
+            'excerpts' => $this->getExcerpts(),
+            'score' => $this->getScore()
+        ];
+    }
 }

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 '';
+    }
 }