nextcloud / server

lib/public/Dashboard/Model/WidgetSetup.php

Indentation +231 added lines, -231 removed lines

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

lib/public/Dashboard/Model/WidgetSetting.php

Indentation +193 added lines, -193 removed lines

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

lib/public/IAddressBook.php

Indentation +77 added lines, -77 removed lines

@@ -37,90 +37,90 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 
 namespace OCP {
-	/**
-	 * Interface IAddressBook
-	 *
-	 * @since 5.0.0
-	 */
-	interface IAddressBook {
+    /**
+     * Interface IAddressBook
+     *
+     * @since 5.0.0
+     */
+    interface IAddressBook {
 
-		/**
-		 * @return string defining the technical unique key
-		 * @since 5.0.0
-		 */
-		public function getKey();
+        /**
+         * @return string defining the technical unique key
+         * @since 5.0.0
+         */
+        public function getKey();
 
-		/**
-		 * @return string defining the unique uri
-		 * @since 16.0.0
-		 * @return string
-		 */
-		public function getUri(): string;
+        /**
+         * @return string defining the unique uri
+         * @since 16.0.0
+         * @return string
+         */
+        public function getUri(): string;
 
-		/**
-		 * In comparison to getKey() this function returns a human readable (maybe translated) name
-		 * @return mixed
-		 * @since 5.0.0
-		 */
-		public function getDisplayName();
+        /**
+         * In comparison to getKey() this function returns a human readable (maybe translated) name
+         * @return mixed
+         * @since 5.0.0
+         */
+        public function getDisplayName();
 
-		/**
-		 * @param string $pattern which should match within the $searchProperties
-		 * @param array $searchProperties defines the properties within the query pattern should match
-		 * @param array $options Options to define the output format and search behavior
-		 * 	- 'types' boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array
-		 *    example: ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['type => 'HOME', 'value' => 'g@h.i']]
-		 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
-		 * 	- 'limit' - Set a numeric limit for the search results
-		 * 	- 'offset' - Set the offset for the limited search results
-		 * @return array an array of contacts which are arrays of key-value-pairs
-		 *  example result:
-		 *  [
-		 *		['id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'],
-		 *		['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['d@e.f', 'g@h.i']]
-		 *	]
-		 * @since 5.0.0
-		 */
-		public function search($pattern, $searchProperties, $options);
+        /**
+         * @param string $pattern which should match within the $searchProperties
+         * @param array $searchProperties defines the properties within the query pattern should match
+         * @param array $options Options to define the output format and search behavior
+         * 	- 'types' boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array
+         *    example: ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['type => 'HOME', 'value' => 'g@h.i']]
+         * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
+         * 	- 'limit' - Set a numeric limit for the search results
+         * 	- 'offset' - Set the offset for the limited search results
+         * @return array an array of contacts which are arrays of key-value-pairs
+         *  example result:
+         *  [
+         *		['id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'],
+         *		['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['d@e.f', 'g@h.i']]
+         *	]
+         * @since 5.0.0
+         */
+        public function search($pattern, $searchProperties, $options);
 
-		/**
-		 * @param array $properties this array if key-value-pairs defines a contact
-		 * @return array an array representing the contact just created or updated
-		 * @since 5.0.0
-		 */
-		public function createOrUpdate($properties);
-		//	// dummy
-		//	return array('id'    => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c',
-		//		     'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif',
-		//		     'ADR'   => ';;123 Main Street;Any Town;CA;91921-1234'
-		//	);
+        /**
+         * @param array $properties this array if key-value-pairs defines a contact
+         * @return array an array representing the contact just created or updated
+         * @since 5.0.0
+         */
+        public function createOrUpdate($properties);
+        //	// dummy
+        //	return array('id'    => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c',
+        //		     'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif',
+        //		     'ADR'   => ';;123 Main Street;Any Town;CA;91921-1234'
+        //	);
 
-		/**
-		 * @return mixed
-		 * @since 5.0.0
-		 */
-		public function getPermissions();
+        /**
+         * @return mixed
+         * @since 5.0.0
+         */
+        public function getPermissions();
 
-		/**
-		 * @param object $id the unique identifier to a contact
-		 * @return bool successful or not
-		 * @since 5.0.0
-		 */
-		public function delete($id);
+        /**
+         * @param object $id the unique identifier to a contact
+         * @return bool successful or not
+         * @since 5.0.0
+         */
+        public function delete($id);
 
-		/**
-		 * Returns true if this address-book is not owned by the current user,
-		 * but shared with them.
-		 *
-		 * @return bool
-		 * @since 20.0.0
-		 */
-		public function isShared(): bool;
+        /**
+         * Returns true if this address-book is not owned by the current user,
+         * but shared with them.
+         *
+         * @return bool
+         * @since 20.0.0
+         */
+        public function isShared(): bool;
 
-		/**
-		 * @return bool
-		 * @since 20.0.0
-		 */
-		public function isSystemAddressBook(): bool;
-	}
+        /**
+         * @return bool
+         * @since 20.0.0
+         */
+        public function isSystemAddressBook(): bool;
+    }
 }

lib/public/FullTextSearch/Model/ISearchRequestSimpleQuery.php

Indentation +77 added lines, -77 removed lines

@@ -39,92 +39,92 @@
  *
  */
 interface ISearchRequestSimpleQuery {
-	public const COMPARE_TYPE_TEXT = 1;
-	public const COMPARE_TYPE_KEYWORD = 2;
-	public const COMPARE_TYPE_INT_EQ = 3;
-	public const COMPARE_TYPE_INT_GTE = 4;
-	public const COMPARE_TYPE_INT_GT = 5;
-	public const COMPARE_TYPE_INT_LTE = 6;
-	public const COMPARE_TYPE_INT_LT = 7;
-	public const COMPARE_TYPE_BOOL = 8;
-	public const COMPARE_TYPE_ARRAY = 9;
-	public const COMPARE_TYPE_REGEX = 10;
-	public const COMPARE_TYPE_WILDCARD = 11;
+    public const COMPARE_TYPE_TEXT = 1;
+    public const COMPARE_TYPE_KEYWORD = 2;
+    public const COMPARE_TYPE_INT_EQ = 3;
+    public const COMPARE_TYPE_INT_GTE = 4;
+    public const COMPARE_TYPE_INT_GT = 5;
+    public const COMPARE_TYPE_INT_LTE = 6;
+    public const COMPARE_TYPE_INT_LT = 7;
+    public const COMPARE_TYPE_BOOL = 8;
+    public const COMPARE_TYPE_ARRAY = 9;
+    public const COMPARE_TYPE_REGEX = 10;
+    public const COMPARE_TYPE_WILDCARD = 11;
 
 
-	/**
-	 * Get the compare type of the query
-	 *
-	 * @return int
-	 * @since 17.0.0
-	 */
-	public function getType(): int;
+    /**
+     * Get the compare type of the query
+     *
+     * @return int
+     * @since 17.0.0
+     */
+    public function getType(): int;
 
 
-	/**
-	 * Get the field to apply query
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getField(): string;
+    /**
+     * Get the field to apply query
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getField(): string;
 
-	/**
-	 * Set the field to apply query
-	 *
-	 * @param string $field
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function setField(string $field): ISearchRequestSimpleQuery;
+    /**
+     * Set the field to apply query
+     *
+     * @param string $field
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function setField(string $field): ISearchRequestSimpleQuery;
 
 
-	/**
-	 * Get the all values to compare
-	 *
-	 * @return array
-	 * @since 17.0.0
-	 */
-	public function getValues(): array;
+    /**
+     * Get the all values to compare
+     *
+     * @return array
+     * @since 17.0.0
+     */
+    public function getValues(): array;
 
-	/**
-	 * Add value to compare (string)
-	 *
-	 * @param string $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValue(string $value): ISearchRequestSimpleQuery;
+    /**
+     * Add value to compare (string)
+     *
+     * @param string $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValue(string $value): ISearchRequestSimpleQuery;
 
-	/**
-	 * Add value to compare (int)
-	 *
-	 * @param int $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValueInt(int $value): ISearchRequestSimpleQuery;
+    /**
+     * Add value to compare (int)
+     *
+     * @param int $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValueInt(int $value): ISearchRequestSimpleQuery;
 
-	/**
-	 * Add value to compare (array)
-	 *
-	 * @param array $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValueArray(array $value): ISearchRequestSimpleQuery;
+    /**
+     * Add value to compare (array)
+     *
+     * @param array $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValueArray(array $value): ISearchRequestSimpleQuery;
 
-	/**
-	 * Add value to compare (bool)
-	 *
-	 * @param bool $value
-	 *
-	 * @return ISearchRequestSimpleQuery
-	 * @since 17.0.0
-	 */
-	public function addValueBool(bool $value): ISearchRequestSimpleQuery;
+    /**
+     * Add value to compare (bool)
+     *
+     * @param bool $value
+     *
+     * @return ISearchRequestSimpleQuery
+     * @since 17.0.0
+     */
+    public function addValueBool(bool $value): ISearchRequestSimpleQuery;
 }

lib/public/FullTextSearch/Model/IRunner.php

Indentation +78 added lines, -78 removed lines

@@ -41,92 +41,92 @@
  *
  */
 interface IRunner {
-	public const RESULT_TYPE_SUCCESS = 1;
-	public const RESULT_TYPE_WARNING = 4;
-	public const RESULT_TYPE_FAIL = 9;
+    public const RESULT_TYPE_SUCCESS = 1;
+    public const RESULT_TYPE_WARNING = 4;
+    public const RESULT_TYPE_FAIL = 9;
 
 
-	/**
-	 * Info are displayed in the user interface when an admin execute the
-	 * ./occ fulltextsearch:index command.
-	 *
-	 * quick list of info that can be edited:
-	 *   'documentId', 'info', 'title', 'resultIndex', 'resultStatus',
-	 *   'content', 'documentCurrent', 'documentTotal', 'progressStatus',
-	 *   'errorCurrent', 'errorException', 'errorIndex'.
-	 *
-	 * List of all editable info can be find in the Command\Index.php of the
-	 * FullTextSearch app.
-	 * (look for a comment 'full list of info that can be edited')
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param string $value
-	 */
-	public function setInfo(string $info, string $value);
+    /**
+     * Info are displayed in the user interface when an admin execute the
+     * ./occ fulltextsearch:index command.
+     *
+     * quick list of info that can be edited:
+     *   'documentId', 'info', 'title', 'resultIndex', 'resultStatus',
+     *   'content', 'documentCurrent', 'documentTotal', 'progressStatus',
+     *   'errorCurrent', 'errorException', 'errorIndex'.
+     *
+     * List of all editable info can be find in the Command\Index.php of the
+     * FullTextSearch app.
+     * (look for a comment 'full list of info that can be edited')
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param string $value
+     */
+    public function setInfo(string $info, string $value);
 
 
-	/**
-	 * This method should be used when editing multiple info to avoid too many
-	 * refresh of the interface.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $data
-	 */
-	public function setInfoArray(array $data);
+    /**
+     * This method should be used when editing multiple info to avoid too many
+     * refresh of the interface.
+     *
+     * @since 15.0.0
+     *
+     * @param array $data
+     */
+    public function setInfoArray(array $data);
 
 
-	/**
-	 * Method used to update the current Action when an index is running.
-	 *
-	 * This method should be used instead of manually update the 'action' using
-	 * setInfo()/setInfoArray() as it is also used to keep the process alive,
-	 * manage the input, and some statistics of the load of the process.
-	 *
-	 * $action is a string with no space
-	 * $force should be set to true if the action is heavy while being executed
-	 * multiple times
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $action
-	 * @param bool $force
-	 *
-	 * @return string
-	 * @throws \Exception
-	 */
-	public function updateAction(string $action = '', bool $force = false): string;
+    /**
+     * Method used to update the current Action when an index is running.
+     *
+     * This method should be used instead of manually update the 'action' using
+     * setInfo()/setInfoArray() as it is also used to keep the process alive,
+     * manage the input, and some statistics of the load of the process.
+     *
+     * $action is a string with no space
+     * $force should be set to true if the action is heavy while being executed
+     * multiple times
+     *
+     * @since 15.0.0
+     *
+     * @param string $action
+     * @param bool $force
+     *
+     * @return string
+     * @throws \Exception
+     */
+    public function updateAction(string $action = '', bool $force = false): string;
 
 
-	/**
-	 * Call this method in a Search Platform or Content Provider if there is an
-	 * issue while generating a document or while indexing the current document.
-	 * This is used to store and display errors in the UI during an index to help
-	 * admin to keep track of errors.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex $index
-	 * @param string $message
-	 * @param string $class
-	 * @param int $sev
-	 */
-	public function newIndexError(IIndex $index, string $message, string $class = '', int $sev = 3);
+    /**
+     * Call this method in a Search Platform or Content Provider if there is an
+     * issue while generating a document or while indexing the current document.
+     * This is used to store and display errors in the UI during an index to help
+     * admin to keep track of errors.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex $index
+     * @param string $message
+     * @param string $class
+     * @param int $sev
+     */
+    public function newIndexError(IIndex $index, string $message, string $class = '', int $sev = 3);
 
 
-	/**
-	 * Call this method only in a Search Platform after an index of a document.
-	 * This is used to store and display results (good or bad) in the UI during
-	 * an index to help admin to keep track of fail and successful indexes.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex $index
-	 * @param string $message
-	 * @param string $status
-	 * @param int $type
-	 */
-	public function newIndexResult(IIndex $index, string $message, string $status, int $type);
+    /**
+     * Call this method only in a Search Platform after an index of a document.
+     * This is used to store and display results (good or bad) in the UI during
+     * an index to help admin to keep track of fail and successful indexes.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex $index
+     * @param string $message
+     * @param string $status
+     * @param int $type
+     */
+    public function newIndexResult(IIndex $index, string $message, string $status, int $type);
 }

lib/public/FullTextSearch/Model/IIndexDocument.php

Indentation +581 added lines, -581 removed lines

@@ -42,585 +42,585 @@
  * @since 15.0.0
  */
 interface IIndexDocument {
-	public const NOT_ENCODED = 0;
-	public const ENCODED_BASE64 = 1;
-
-
-
-	/**
-	 * Returns the Id of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getId(): string;
-
-
-	/**
-	 * Returns the Id of the provider.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getProviderId(): string;
-
-
-	/**
-	 * Set the Index related to the IIndexDocument.
-	 *
-	 * @see IIndex
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex $index
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setIndex(IIndex $index): IIndexDocument;
-
-	/**
-	 * Get the Index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndex
-	 */
-	public function getIndex(): IIndex;
-
-	/**
-	 * return if Index is defined.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return bool
-	 */
-	public function hasIndex(): bool;
-
-
-	/**
-	 * Set the modified time of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $modifiedTime
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setModifiedTime(int $modifiedTime): IIndexDocument;
-
-	/**
-	 * Get the modified time of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function getModifiedTime(): int;
-
-	/**
-	 * Check if the original document of the IIndexDocument is older than $time.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $time
-	 *
-	 * @return bool
-	 */
-	public function isOlderThan(int $time): bool;
-
-
-	/**
-	 * Set the read rights of the original document using a IDocumentAccess.
-	 *
-	 * @see IDocumentAccess
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IDocumentAccess $access
-	 *
-	 * @return $this
-	 */
-	public function setAccess(IDocumentAccess $access): IIndexDocument;
-
-	/**
-	 * Get the IDocumentAccess related to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function getAccess(): IDocumentAccess;
-
-
-	/**
-	 * Add a tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	public function addTag(string $tag): IIndexDocument;
-
-	/**
-	 * Set the list of tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setTags(array $tags): IIndexDocument;
-
-	/**
-	 * Get the list of tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getTags(): array;
-
-
-	/**
-	 * Add a meta tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	public function addMetaTag(string $tag): IIndexDocument;
-
-	/**
-	 * Set the list of meta tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setMetaTags(array $tags): IIndexDocument;
-
-	/**
-	 * Get the list of meta tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getMetaTags(): array;
-
-
-	/**
-	 * Add a sub tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $sub
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	public function addSubTag(string $sub, string $tag): IIndexDocument;
-
-	/**
-	 * Set the list of sub tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setSubTags(array $tags): IIndexDocument;
-
-	/**
-	 * 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
-	 */
-	public function getSubTags(bool $formatted = false): array;
-
-
-	/**
-	 * Set the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $source
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setSource(string $source): IIndexDocument;
-
-	/**
-	 * Get the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getSource(): string;
-
-
-	/**
-	 * Set the title of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $title
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setTitle(string $title): IIndexDocument;
-
-	/**
-	 * Get the title of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getTitle(): string;
-
-
-	/**
-	 * 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
-	 */
-	public function setContent(string $content, int $encoded = 0): IIndexDocument;
-
-	/**
-	 * Get the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getContent(): string;
-
-	/**
-	 * Returns the type of the encoding on the content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function isContentEncoded(): int;
-
-	/**
-	 * Return the size of the content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function getContentSize(): int;
-
-
-	/**
-	 * Generate an hash, based on the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndexDocument
-	 */
-	public function initHash(): IIndexDocument;
-
-	/**
-	 * Set the hash of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $hash
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setHash(string $hash): IIndexDocument;
-
-	/**
-	 * Get the hash of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getHash(): string;
-
-
-	/**
-	 * 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
-	 */
-	public function addPart(string $part, string $content): IIndexDocument;
-
-	/**
-	 * Set all parts and their content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $parts
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setParts(array $parts): IIndexDocument;
-
-	/**
-	 * Get all parts of the IIndexDocument.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getParts(): array;
-
-
-	/**
-	 * Add a link, usable by the frontend.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $link
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setLink(string $link): IIndexDocument;
-
-	/**
-	 * Get the link.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getLink(): string;
-
-
-	/**
-	 * Set more information that couldn't be set using other method.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $more
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setMore(array $more): IIndexDocument;
-
-	/**
-	 * Get more information.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getMore(): array;
-
-
-	/**
-	 * 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
-	 */
-	public function addExcerpt(string $source, string $excerpt): IIndexDocument;
-
-	/**
-	 * Set all excerpts of the content of the original document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $excerpts
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setExcerpts(array $excerpts): IIndexDocument;
-
-	/**
-	 * Get all excerpts of the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getExcerpts(): array;
-
-
-	/**
-	 * Set the score to the result assigned to this document during a search
-	 * request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $score
-	 *
-	 * @return IIndexDocument
-	 */
-	public function setScore(string $score): IIndexDocument;
-
-	/**
-	 * Get the score.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getScore(): string;
-
-
-	/**
-	 * 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
-	 */
-	public function setInfo(string $info, string $value): IIndexDocument;
-
-	/**
-	 * Get an information about a document. (string)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param string $default
-	 *
-	 * @return string
-	 */
-	public function getInfo(string $info, string $default = ''): string;
-
-	/**
-	 * 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
-	 */
-	public function setInfoArray(string $info, array $value): IIndexDocument;
-
-	/**
-	 * Get an information about a document. (array)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param array $default
-	 *
-	 * @return array
-	 */
-	public function getInfoArray(string $info, array $default = []): array;
-
-	/**
-	 * 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
-	 */
-	public function setInfoInt(string $info, int $value): IIndexDocument;
-
-	/**
-	 * Get an information about a document. (int)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param int $default
-	 *
-	 * @return int
-	 */
-	public function getInfoInt(string $info, int $default = 0): int;
-
-	/**
-	 * 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
-	 */
-	public function setInfoBool(string $info, bool $value): IIndexDocument;
-
-	/**
-	 * Get an information about a document. (bool)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param bool $default
-	 *
-	 * @return bool
-	 */
-	public function getInfoBool(string $info, bool $default = false): bool;
-
-	/**
-	 * Get all info.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getInfoAll(): array;
+    public const NOT_ENCODED = 0;
+    public const ENCODED_BASE64 = 1;
+
+
+
+    /**
+     * Returns the Id of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getId(): string;
+
+
+    /**
+     * Returns the Id of the provider.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getProviderId(): string;
+
+
+    /**
+     * Set the Index related to the IIndexDocument.
+     *
+     * @see IIndex
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex $index
+     *
+     * @return IIndexDocument
+     */
+    public function setIndex(IIndex $index): IIndexDocument;
+
+    /**
+     * Get the Index.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndex
+     */
+    public function getIndex(): IIndex;
+
+    /**
+     * return if Index is defined.
+     *
+     * @since 16.0.0
+     *
+     * @return bool
+     */
+    public function hasIndex(): bool;
+
+
+    /**
+     * Set the modified time of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param int $modifiedTime
+     *
+     * @return IIndexDocument
+     */
+    public function setModifiedTime(int $modifiedTime): IIndexDocument;
+
+    /**
+     * Get the modified time of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function getModifiedTime(): int;
+
+    /**
+     * Check if the original document of the IIndexDocument is older than $time.
+     *
+     * @since 15.0.0
+     *
+     * @param int $time
+     *
+     * @return bool
+     */
+    public function isOlderThan(int $time): bool;
+
+
+    /**
+     * Set the read rights of the original document using a IDocumentAccess.
+     *
+     * @see IDocumentAccess
+     *
+     * @since 15.0.0
+     *
+     * @param IDocumentAccess $access
+     *
+     * @return $this
+     */
+    public function setAccess(IDocumentAccess $access): IIndexDocument;
+
+    /**
+     * Get the IDocumentAccess related to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return IDocumentAccess
+     */
+    public function getAccess(): IDocumentAccess;
+
+
+    /**
+     * Add a tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    public function addTag(string $tag): IIndexDocument;
+
+    /**
+     * Set the list of tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    public function setTags(array $tags): IIndexDocument;
+
+    /**
+     * Get the list of tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getTags(): array;
+
+
+    /**
+     * Add a meta tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    public function addMetaTag(string $tag): IIndexDocument;
+
+    /**
+     * Set the list of meta tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    public function setMetaTags(array $tags): IIndexDocument;
+
+    /**
+     * Get the list of meta tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getMetaTags(): array;
+
+
+    /**
+     * Add a sub tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $sub
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    public function addSubTag(string $sub, string $tag): IIndexDocument;
+
+    /**
+     * Set the list of sub tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    public function setSubTags(array $tags): IIndexDocument;
+
+    /**
+     * 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
+     */
+    public function getSubTags(bool $formatted = false): array;
+
+
+    /**
+     * Set the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $source
+     *
+     * @return IIndexDocument
+     */
+    public function setSource(string $source): IIndexDocument;
+
+    /**
+     * Get the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getSource(): string;
+
+
+    /**
+     * Set the title of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $title
+     *
+     * @return IIndexDocument
+     */
+    public function setTitle(string $title): IIndexDocument;
+
+    /**
+     * Get the title of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getTitle(): string;
+
+
+    /**
+     * 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
+     */
+    public function setContent(string $content, int $encoded = 0): IIndexDocument;
+
+    /**
+     * Get the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getContent(): string;
+
+    /**
+     * Returns the type of the encoding on the content.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function isContentEncoded(): int;
+
+    /**
+     * Return the size of the content.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function getContentSize(): int;
+
+
+    /**
+     * Generate an hash, based on the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndexDocument
+     */
+    public function initHash(): IIndexDocument;
+
+    /**
+     * Set the hash of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $hash
+     *
+     * @return IIndexDocument
+     */
+    public function setHash(string $hash): IIndexDocument;
+
+    /**
+     * Get the hash of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getHash(): string;
+
+
+    /**
+     * 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
+     */
+    public function addPart(string $part, string $content): IIndexDocument;
+
+    /**
+     * Set all parts and their content.
+     *
+     * @since 15.0.0
+     *
+     * @param array $parts
+     *
+     * @return IIndexDocument
+     */
+    public function setParts(array $parts): IIndexDocument;
+
+    /**
+     * Get all parts of the IIndexDocument.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getParts(): array;
+
+
+    /**
+     * Add a link, usable by the frontend.
+     *
+     * @since 15.0.0
+     *
+     * @param string $link
+     *
+     * @return IIndexDocument
+     */
+    public function setLink(string $link): IIndexDocument;
+
+    /**
+     * Get the link.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getLink(): string;
+
+
+    /**
+     * Set more information that couldn't be set using other method.
+     *
+     * @since 15.0.0
+     *
+     * @param array $more
+     *
+     * @return IIndexDocument
+     */
+    public function setMore(array $more): IIndexDocument;
+
+    /**
+     * Get more information.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getMore(): array;
+
+
+    /**
+     * 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
+     */
+    public function addExcerpt(string $source, string $excerpt): IIndexDocument;
+
+    /**
+     * Set all excerpts of the content of the original document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $excerpts
+     *
+     * @return IIndexDocument
+     */
+    public function setExcerpts(array $excerpts): IIndexDocument;
+
+    /**
+     * Get all excerpts of the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getExcerpts(): array;
+
+
+    /**
+     * Set the score to the result assigned to this document during a search
+     * request.
+     *
+     * @since 15.0.0
+     *
+     * @param string $score
+     *
+     * @return IIndexDocument
+     */
+    public function setScore(string $score): IIndexDocument;
+
+    /**
+     * Get the score.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getScore(): string;
+
+
+    /**
+     * 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
+     */
+    public function setInfo(string $info, string $value): IIndexDocument;
+
+    /**
+     * Get an information about a document. (string)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param string $default
+     *
+     * @return string
+     */
+    public function getInfo(string $info, string $default = ''): string;
+
+    /**
+     * 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
+     */
+    public function setInfoArray(string $info, array $value): IIndexDocument;
+
+    /**
+     * Get an information about a document. (array)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param array $default
+     *
+     * @return array
+     */
+    public function getInfoArray(string $info, array $default = []): array;
+
+    /**
+     * 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
+     */
+    public function setInfoInt(string $info, int $value): IIndexDocument;
+
+    /**
+     * Get an information about a document. (int)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param int $default
+     *
+     * @return int
+     */
+    public function getInfoInt(string $info, int $default = 0): int;
+
+    /**
+     * 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
+     */
+    public function setInfoBool(string $info, bool $value): IIndexDocument;
+
+    /**
+     * Get an information about a document. (bool)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param bool $default
+     *
+     * @return bool
+     */
+    public function getInfoBool(string $info, bool $default = false): bool;
+
+    /**
+     * Get all info.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getInfoAll(): array;
 }

lib/public/FullTextSearch/Model/IIndex.php

Indentation +235 added lines, -235 removed lines

@@ -44,239 +44,239 @@
  *
  */
 interface IIndex {
-	public const INDEX_OK = 1;
-	public const INDEX_IGNORE = 2;
-
-	public const INDEX_META = 4;
-	public const INDEX_CONTENT = 8;
-	public const INDEX_PARTS = 16;
-	public const INDEX_FULL = 28;
-	public const INDEX_REMOVE = 32;
-	public const INDEX_DONE = 64;
-	public const INDEX_FAILED = 128;
-
-	public const ERROR_FAILED = 1;
-	public const ERROR_FAILED2 = 2;
-	public const ERROR_FAILED3 = 4;
-
-	public const ERROR_SEV_1 = 1;
-	public const ERROR_SEV_2 = 2;
-	public const ERROR_SEV_3 = 3;
-	public const ERROR_SEV_4 = 4;
-
-
-	/**
-	 * Get the Id of the Content Provider.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getProviderId(): string;
-
-
-	/**
-	 * Get the Id of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getDocumentId(): string;
-
-
-	/**
-	 * Set the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $source
-	 *
-	 * @return IIndex
-	 */
-	public function setSource(string $source): IIndex;
-
-	/**
-	 * Get the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getSource(): string;
-
-
-	/**
-	 * Set the owner of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $ownerId
-	 *
-	 * @return IIndex
-	 */
-	public function setOwnerId(string $ownerId): IIndex;
-
-	/**
-	 * Get the owner of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getOwnerId(): string;
-
-
-	/**
-	 * Set the current index status (bit flag) of the original document.
-	 * If $reset is true, the status is reset to the defined value.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $status
-	 * @param bool $reset
-	 *
-	 * @return IIndex
-	 */
-	public function setStatus(int $status, bool $reset = false): IIndex;
-
-	/**
-	 * Get the current index status of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function getStatus(): int;
-
-	/**
-	 * Check if the document fit a specific status.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $status
-	 *
-	 * @return bool
-	 */
-	public function isStatus(int $status): bool;
-
-	/**
-	 * Remove a status.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $status
-	 *
-	 * @return IIndex
-	 */
-	public function unsetStatus(int $status): IIndex;
-
-
-	/**
-	 * Add an option related to the original document (as string).
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param string $value
-	 *
-	 * @return IIndex
-	 */
-	public function addOption(string $option, string $value): IIndex;
-
-	/**
-	 * Add an option related to the original document (as integer).
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param int $value
-	 *
-	 * @return IIndex
-	 */
-	public function addOptionInt(string $option, int $value): IIndex;
-
-	/**
-	 * Get the option related to the original document (as string).
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param string $default
-	 *
-	 * @return string
-	 */
-	public function getOption(string $option, string $default = ''): string;
-
-	/**
-	 * Get the option related to the original document (as integer).
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param int $default
-	 *
-	 * @return int
-	 */
-	public function getOptionInt(string $option, int $default = 0): int;
-
-	/**
-	 * Get all options related to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getOptions(): array;
-
-
-	/**
-	 * Add an error log related to the Index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $message
-	 * @param string $exception
-	 * @param int $sev
-	 *
-	 * @return IIndex
-	 */
-	public function addError(string $message, string $exception = '', int $sev = self::ERROR_SEV_3): IIndex;
-
-	/**
-	 * Returns the number of known errors related to the Index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function getErrorCount(): int;
-
-	/**
-	 * Reset all error logs related to the Index.
-	 *
-	 * @since 15.0.0
-	 */
-	public function resetErrors(): IIndex;
-
-
-	/**
-	 * Set the date of the last index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $lastIndex
-	 *
-	 * @return IIndex
-	 */
-	public function setLastIndex(int $lastIndex = -1): IIndex;
-
-	/**
-	 * Get the date of the last index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function getLastIndex(): int;
+    public const INDEX_OK = 1;
+    public const INDEX_IGNORE = 2;
+
+    public const INDEX_META = 4;
+    public const INDEX_CONTENT = 8;
+    public const INDEX_PARTS = 16;
+    public const INDEX_FULL = 28;
+    public const INDEX_REMOVE = 32;
+    public const INDEX_DONE = 64;
+    public const INDEX_FAILED = 128;
+
+    public const ERROR_FAILED = 1;
+    public const ERROR_FAILED2 = 2;
+    public const ERROR_FAILED3 = 4;
+
+    public const ERROR_SEV_1 = 1;
+    public const ERROR_SEV_2 = 2;
+    public const ERROR_SEV_3 = 3;
+    public const ERROR_SEV_4 = 4;
+
+
+    /**
+     * Get the Id of the Content Provider.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getProviderId(): string;
+
+
+    /**
+     * Get the Id of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getDocumentId(): string;
+
+
+    /**
+     * Set the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $source
+     *
+     * @return IIndex
+     */
+    public function setSource(string $source): IIndex;
+
+    /**
+     * Get the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getSource(): string;
+
+
+    /**
+     * Set the owner of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $ownerId
+     *
+     * @return IIndex
+     */
+    public function setOwnerId(string $ownerId): IIndex;
+
+    /**
+     * Get the owner of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getOwnerId(): string;
+
+
+    /**
+     * Set the current index status (bit flag) of the original document.
+     * If $reset is true, the status is reset to the defined value.
+     *
+     * @since 15.0.0
+     *
+     * @param int $status
+     * @param bool $reset
+     *
+     * @return IIndex
+     */
+    public function setStatus(int $status, bool $reset = false): IIndex;
+
+    /**
+     * Get the current index status of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function getStatus(): int;
+
+    /**
+     * Check if the document fit a specific status.
+     *
+     * @since 15.0.0
+     *
+     * @param int $status
+     *
+     * @return bool
+     */
+    public function isStatus(int $status): bool;
+
+    /**
+     * Remove a status.
+     *
+     * @since 15.0.0
+     *
+     * @param int $status
+     *
+     * @return IIndex
+     */
+    public function unsetStatus(int $status): IIndex;
+
+
+    /**
+     * Add an option related to the original document (as string).
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param string $value
+     *
+     * @return IIndex
+     */
+    public function addOption(string $option, string $value): IIndex;
+
+    /**
+     * Add an option related to the original document (as integer).
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param int $value
+     *
+     * @return IIndex
+     */
+    public function addOptionInt(string $option, int $value): IIndex;
+
+    /**
+     * Get the option related to the original document (as string).
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param string $default
+     *
+     * @return string
+     */
+    public function getOption(string $option, string $default = ''): string;
+
+    /**
+     * Get the option related to the original document (as integer).
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param int $default
+     *
+     * @return int
+     */
+    public function getOptionInt(string $option, int $default = 0): int;
+
+    /**
+     * Get all options related to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getOptions(): array;
+
+
+    /**
+     * Add an error log related to the Index.
+     *
+     * @since 15.0.0
+     *
+     * @param string $message
+     * @param string $exception
+     * @param int $sev
+     *
+     * @return IIndex
+     */
+    public function addError(string $message, string $exception = '', int $sev = self::ERROR_SEV_3): IIndex;
+
+    /**
+     * Returns the number of known errors related to the Index.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function getErrorCount(): int;
+
+    /**
+     * Reset all error logs related to the Index.
+     *
+     * @since 15.0.0
+     */
+    public function resetErrors(): IIndex;
+
+
+    /**
+     * Set the date of the last index.
+     *
+     * @since 15.0.0
+     *
+     * @param int $lastIndex
+     *
+     * @return IIndex
+     */
+    public function setLastIndex(int $lastIndex = -1): IIndex;
+
+    /**
+     * Get the date of the last index.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function getLastIndex(): int;
 }