nextcloud / server

apps/weather_status/lib/Capabilities.php

Indentation +16 added lines, -16 removed lines

@@ -35,21 +35,21 @@
  */
 class Capabilities implements ICapability {
 
-	/**
-	 * Capabilities constructor.
-	 *
-	 */
-	public function __construct() {
-	}
+    /**
+     * Capabilities constructor.
+     *
+     */
+    public function __construct() {
+    }
 
-	/**
-	 * @inheritDoc
-	 */
-	public function getCapabilities() {
-		return [
-			Application::APP_ID => [
-				'enabled' => true,
-			],
-		];
-	}
+    /**
+     * @inheritDoc
+     */
+    public function getCapabilities() {
+        return [
+            Application::APP_ID => [
+                'enabled' => true,
+            ],
+        ];
+    }
 }

apps/dav/lib/Migration/BuildCalendarSearchIndexBackgroundJob.php

Indentation +87 added lines, -87 removed lines

@@ -34,91 +34,91 @@
 
 class BuildCalendarSearchIndexBackgroundJob extends QueuedJob {
 
-	/** @var IDBConnection */
-	private $db;
-
-	/** @var CalDavBackend */
-	private $calDavBackend;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var IJobList */
-	private $jobList;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/**
-	 * @param IDBConnection $db
-	 * @param CalDavBackend $calDavBackend
-	 * @param ILogger $logger
-	 * @param IJobList $jobList
-	 * @param ITimeFactory $timeFactory
-	 */
-	public function __construct(IDBConnection $db,
-								CalDavBackend $calDavBackend,
-								ILogger $logger,
-								IJobList $jobList,
-								ITimeFactory $timeFactory) {
-		$this->db = $db;
-		$this->calDavBackend = $calDavBackend;
-		$this->logger = $logger;
-		$this->jobList = $jobList;
-		$this->timeFactory = $timeFactory;
-	}
-
-	public function run($arguments) {
-		$offset = (int) $arguments['offset'];
-		$stopAt = (int) $arguments['stopAt'];
-
-		$this->logger->info('Building calendar index (' . $offset .'/' . $stopAt . ')');
-
-		$startTime = $this->timeFactory->getTime();
-		while (($this->timeFactory->getTime() - $startTime) < 15) {
-			$offset = $this->buildIndex($offset, $stopAt);
-			if ($offset >= $stopAt) {
-				break;
-			}
-		}
-
-		if ($offset >= $stopAt) {
-			$this->logger->info('Building calendar index done');
-		} else {
-			$this->jobList->add(self::class, [
-				'offset' => $offset,
-				'stopAt' => $stopAt
-			]);
-			$this->logger->info('New building calendar index job scheduled with offset ' . $offset);
-		}
-	}
-
-	/**
-	 * @param int $offset
-	 * @param int $stopAt
-	 * @return int
-	 */
-	private function buildIndex(int $offset, int $stopAt): int {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'calendarid', 'uri', 'calendardata'])
-			->from('calendarobjects')
-			->where($query->expr()->lte('id', $query->createNamedParameter($stopAt)))
-			->andWhere($query->expr()->gt('id', $query->createNamedParameter($offset)))
-			->orderBy('id', 'ASC')
-			->setMaxResults(500);
-
-		$result = $query->execute();
-		while ($row = $result->fetch(\PDO::FETCH_ASSOC)) {
-			$offset = $row['id'];
-
-			$calendarData = $row['calendardata'];
-			if (is_resource($calendarData)) {
-				$calendarData = stream_get_contents($calendarData);
-			}
-
-			$this->calDavBackend->updateProperties($row['calendarid'], $row['uri'], $calendarData);
-		}
-
-		return $offset;
-	}
+    /** @var IDBConnection */
+    private $db;
+
+    /** @var CalDavBackend */
+    private $calDavBackend;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var IJobList */
+    private $jobList;
+
+    /** @var ITimeFactory */
+    private $timeFactory;
+
+    /**
+     * @param IDBConnection $db
+     * @param CalDavBackend $calDavBackend
+     * @param ILogger $logger
+     * @param IJobList $jobList
+     * @param ITimeFactory $timeFactory
+     */
+    public function __construct(IDBConnection $db,
+                                CalDavBackend $calDavBackend,
+                                ILogger $logger,
+                                IJobList $jobList,
+                                ITimeFactory $timeFactory) {
+        $this->db = $db;
+        $this->calDavBackend = $calDavBackend;
+        $this->logger = $logger;
+        $this->jobList = $jobList;
+        $this->timeFactory = $timeFactory;
+    }
+
+    public function run($arguments) {
+        $offset = (int) $arguments['offset'];
+        $stopAt = (int) $arguments['stopAt'];
+
+        $this->logger->info('Building calendar index (' . $offset .'/' . $stopAt . ')');
+
+        $startTime = $this->timeFactory->getTime();
+        while (($this->timeFactory->getTime() - $startTime) < 15) {
+            $offset = $this->buildIndex($offset, $stopAt);
+            if ($offset >= $stopAt) {
+                break;
+            }
+        }
+
+        if ($offset >= $stopAt) {
+            $this->logger->info('Building calendar index done');
+        } else {
+            $this->jobList->add(self::class, [
+                'offset' => $offset,
+                'stopAt' => $stopAt
+            ]);
+            $this->logger->info('New building calendar index job scheduled with offset ' . $offset);
+        }
+    }
+
+    /**
+     * @param int $offset
+     * @param int $stopAt
+     * @return int
+     */
+    private function buildIndex(int $offset, int $stopAt): int {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'calendarid', 'uri', 'calendardata'])
+            ->from('calendarobjects')
+            ->where($query->expr()->lte('id', $query->createNamedParameter($stopAt)))
+            ->andWhere($query->expr()->gt('id', $query->createNamedParameter($offset)))
+            ->orderBy('id', 'ASC')
+            ->setMaxResults(500);
+
+        $result = $query->execute();
+        while ($row = $result->fetch(\PDO::FETCH_ASSOC)) {
+            $offset = $row['id'];
+
+            $calendarData = $row['calendardata'];
+            if (is_resource($calendarData)) {
+                $calendarData = stream_get_contents($calendarData);
+            }
+
+            $this->calDavBackend->updateProperties($row['calendarid'], $row['uri'], $calendarData);
+        }
+
+        return $offset;
+    }
 }

lib/private/TempManager.php

Indentation +220 added lines, -220 removed lines

@@ -37,244 +37,244 @@
 use Psr\Log\LoggerInterface;
 
 class TempManager implements ITempManager {
-	/** @var string[] Current temporary files and folders, used for cleanup */
-	protected $current = [];
-	/** @var string i.e. /tmp on linux systems */
-	protected $tmpBaseDir;
-	/** @var LoggerInterface */
-	protected $log;
-	/** @var IConfig */
-	protected $config;
-	/** @var IniGetWrapper */
-	protected $iniGetWrapper;
+    /** @var string[] Current temporary files and folders, used for cleanup */
+    protected $current = [];
+    /** @var string i.e. /tmp on linux systems */
+    protected $tmpBaseDir;
+    /** @var LoggerInterface */
+    protected $log;
+    /** @var IConfig */
+    protected $config;
+    /** @var IniGetWrapper */
+    protected $iniGetWrapper;
 
-	/** Prefix */
-	public const TMP_PREFIX = 'oc_tmp_';
+    /** Prefix */
+    public const TMP_PREFIX = 'oc_tmp_';
 
-	public function __construct(LoggerInterface $logger, IConfig $config, IniGetWrapper $iniGetWrapper) {
-		$this->log = $logger;
-		$this->config = $config;
-		$this->iniGetWrapper = $iniGetWrapper;
-		$this->tmpBaseDir = $this->getTempBaseDir();
-	}
+    public function __construct(LoggerInterface $logger, IConfig $config, IniGetWrapper $iniGetWrapper) {
+        $this->log = $logger;
+        $this->config = $config;
+        $this->iniGetWrapper = $iniGetWrapper;
+        $this->tmpBaseDir = $this->getTempBaseDir();
+    }
 
-	/**
-	 * Builds the filename with suffix and removes potential dangerous characters
-	 * such as directory separators.
-	 *
-	 * @param string $absolutePath Absolute path to the file / folder
-	 * @param string $postFix Postfix appended to the temporary file name, may be user controlled
-	 * @return string
-	 */
-	private function buildFileNameWithSuffix($absolutePath, $postFix = '') {
-		if ($postFix !== '') {
-			$postFix = '.' . ltrim($postFix, '.');
-			$postFix = str_replace(['\\', '/'], '', $postFix);
-			$absolutePath .= '-';
-		}
+    /**
+     * Builds the filename with suffix and removes potential dangerous characters
+     * such as directory separators.
+     *
+     * @param string $absolutePath Absolute path to the file / folder
+     * @param string $postFix Postfix appended to the temporary file name, may be user controlled
+     * @return string
+     */
+    private function buildFileNameWithSuffix($absolutePath, $postFix = '') {
+        if ($postFix !== '') {
+            $postFix = '.' . ltrim($postFix, '.');
+            $postFix = str_replace(['\\', '/'], '', $postFix);
+            $absolutePath .= '-';
+        }
 
-		return $absolutePath . $postFix;
-	}
+        return $absolutePath . $postFix;
+    }
 
-	/**
-	 * Create a temporary file and return the path
-	 *
-	 * @param string $postFix Postfix appended to the temporary file name
-	 * @return string
-	 */
-	public function getTemporaryFile($postFix = '') {
-		if (is_writable($this->tmpBaseDir)) {
-			// To create an unique file and prevent the risk of race conditions
-			// or duplicated temporary files by other means such as collisions
-			// we need to create the file using `tempnam` and append a possible
-			// postfix to it later
-			$file = tempnam($this->tmpBaseDir, self::TMP_PREFIX);
-			$this->current[] = $file;
+    /**
+     * Create a temporary file and return the path
+     *
+     * @param string $postFix Postfix appended to the temporary file name
+     * @return string
+     */
+    public function getTemporaryFile($postFix = '') {
+        if (is_writable($this->tmpBaseDir)) {
+            // To create an unique file and prevent the risk of race conditions
+            // or duplicated temporary files by other means such as collisions
+            // we need to create the file using `tempnam` and append a possible
+            // postfix to it later
+            $file = tempnam($this->tmpBaseDir, self::TMP_PREFIX);
+            $this->current[] = $file;
 
-			// If a postfix got specified sanitize it and create a postfixed
-			// temporary file
-			if ($postFix !== '') {
-				$fileNameWithPostfix = $this->buildFileNameWithSuffix($file, $postFix);
-				touch($fileNameWithPostfix);
-				chmod($fileNameWithPostfix, 0600);
-				$this->current[] = $fileNameWithPostfix;
-				return $fileNameWithPostfix;
-			}
+            // If a postfix got specified sanitize it and create a postfixed
+            // temporary file
+            if ($postFix !== '') {
+                $fileNameWithPostfix = $this->buildFileNameWithSuffix($file, $postFix);
+                touch($fileNameWithPostfix);
+                chmod($fileNameWithPostfix, 0600);
+                $this->current[] = $fileNameWithPostfix;
+                return $fileNameWithPostfix;
+            }
 
-			return $file;
-		} else {
-			$this->log->warning(
-				'Can not create a temporary file in directory {dir}. Check it exists and has correct permissions',
-				[
-					'dir' => $this->tmpBaseDir,
-				]
-			);
-			return false;
-		}
-	}
+            return $file;
+        } else {
+            $this->log->warning(
+                'Can not create a temporary file in directory {dir}. Check it exists and has correct permissions',
+                [
+                    'dir' => $this->tmpBaseDir,
+                ]
+            );
+            return false;
+        }
+    }
 
-	/**
-	 * Create a temporary folder and return the path
-	 *
-	 * @param string $postFix Postfix appended to the temporary folder name
-	 * @return string
-	 */
-	public function getTemporaryFolder($postFix = '') {
-		if (is_writable($this->tmpBaseDir)) {
-			// To create an unique directory and prevent the risk of race conditions
-			// or duplicated temporary files by other means such as collisions
-			// we need to create the file using `tempnam` and append a possible
-			// postfix to it later
-			$uniqueFileName = tempnam($this->tmpBaseDir, self::TMP_PREFIX);
-			$this->current[] = $uniqueFileName;
+    /**
+     * Create a temporary folder and return the path
+     *
+     * @param string $postFix Postfix appended to the temporary folder name
+     * @return string
+     */
+    public function getTemporaryFolder($postFix = '') {
+        if (is_writable($this->tmpBaseDir)) {
+            // To create an unique directory and prevent the risk of race conditions
+            // or duplicated temporary files by other means such as collisions
+            // we need to create the file using `tempnam` and append a possible
+            // postfix to it later
+            $uniqueFileName = tempnam($this->tmpBaseDir, self::TMP_PREFIX);
+            $this->current[] = $uniqueFileName;
 
-			// Build a name without postfix
-			$path = $this->buildFileNameWithSuffix($uniqueFileName . '-folder', $postFix);
-			mkdir($path, 0700);
-			$this->current[] = $path;
+            // Build a name without postfix
+            $path = $this->buildFileNameWithSuffix($uniqueFileName . '-folder', $postFix);
+            mkdir($path, 0700);
+            $this->current[] = $path;
 
-			return $path . '/';
-		} else {
-			$this->log->warning(
-				'Can not create a temporary folder in directory {dir}. Check it exists and has correct permissions',
-				[
-					'dir' => $this->tmpBaseDir,
-				]
-			);
-			return false;
-		}
-	}
+            return $path . '/';
+        } else {
+            $this->log->warning(
+                'Can not create a temporary folder in directory {dir}. Check it exists and has correct permissions',
+                [
+                    'dir' => $this->tmpBaseDir,
+                ]
+            );
+            return false;
+        }
+    }
 
-	/**
-	 * Remove the temporary files and folders generated during this request
-	 */
-	public function clean() {
-		$this->cleanFiles($this->current);
-	}
+    /**
+     * Remove the temporary files and folders generated during this request
+     */
+    public function clean() {
+        $this->cleanFiles($this->current);
+    }
 
-	/**
-	 * @param string[] $files
-	 */
-	protected function cleanFiles($files) {
-		foreach ($files as $file) {
-			if (file_exists($file)) {
-				try {
-					\OC_Helper::rmdirr($file);
-				} catch (\UnexpectedValueException $ex) {
-					$this->log->warning(
-						"Error deleting temporary file/folder: {file} - Reason: {error}",
-						[
-							'file' => $file,
-							'error' => $ex->getMessage(),
-						]
-					);
-				}
-			}
-		}
-	}
+    /**
+     * @param string[] $files
+     */
+    protected function cleanFiles($files) {
+        foreach ($files as $file) {
+            if (file_exists($file)) {
+                try {
+                    \OC_Helper::rmdirr($file);
+                } catch (\UnexpectedValueException $ex) {
+                    $this->log->warning(
+                        "Error deleting temporary file/folder: {file} - Reason: {error}",
+                        [
+                            'file' => $file,
+                            'error' => $ex->getMessage(),
+                        ]
+                    );
+                }
+            }
+        }
+    }
 
-	/**
-	 * Remove old temporary files and folders that were failed to be cleaned
-	 */
-	public function cleanOld() {
-		$this->cleanFiles($this->getOldFiles());
-	}
+    /**
+     * Remove old temporary files and folders that were failed to be cleaned
+     */
+    public function cleanOld() {
+        $this->cleanFiles($this->getOldFiles());
+    }
 
-	/**
-	 * Get all temporary files and folders generated by oc older than an hour
-	 *
-	 * @return string[]
-	 */
-	protected function getOldFiles() {
-		$cutOfTime = time() - 3600;
-		$files = [];
-		$dh = opendir($this->tmpBaseDir);
-		if ($dh) {
-			while (($file = readdir($dh)) !== false) {
-				if (substr($file, 0, 7) === self::TMP_PREFIX) {
-					$path = $this->tmpBaseDir . '/' . $file;
-					$mtime = filemtime($path);
-					if ($mtime < $cutOfTime) {
-						$files[] = $path;
-					}
-				}
-			}
-		}
-		return $files;
-	}
+    /**
+     * Get all temporary files and folders generated by oc older than an hour
+     *
+     * @return string[]
+     */
+    protected function getOldFiles() {
+        $cutOfTime = time() - 3600;
+        $files = [];
+        $dh = opendir($this->tmpBaseDir);
+        if ($dh) {
+            while (($file = readdir($dh)) !== false) {
+                if (substr($file, 0, 7) === self::TMP_PREFIX) {
+                    $path = $this->tmpBaseDir . '/' . $file;
+                    $mtime = filemtime($path);
+                    if ($mtime < $cutOfTime) {
+                        $files[] = $path;
+                    }
+                }
+            }
+        }
+        return $files;
+    }
 
-	/**
-	 * Get the temporary base directory configured on the server
-	 *
-	 * @return string Path to the temporary directory or null
-	 * @throws \UnexpectedValueException
-	 */
-	public function getTempBaseDir() {
-		if ($this->tmpBaseDir) {
-			return $this->tmpBaseDir;
-		}
+    /**
+     * Get the temporary base directory configured on the server
+     *
+     * @return string Path to the temporary directory or null
+     * @throws \UnexpectedValueException
+     */
+    public function getTempBaseDir() {
+        if ($this->tmpBaseDir) {
+            return $this->tmpBaseDir;
+        }
 
-		$directories = [];
-		if ($temp = $this->config->getSystemValue('tempdirectory', null)) {
-			$directories[] = $temp;
-		}
-		if ($temp = $this->iniGetWrapper->get('upload_tmp_dir')) {
-			$directories[] = $temp;
-		}
-		if ($temp = getenv('TMP')) {
-			$directories[] = $temp;
-		}
-		if ($temp = getenv('TEMP')) {
-			$directories[] = $temp;
-		}
-		if ($temp = getenv('TMPDIR')) {
-			$directories[] = $temp;
-		}
-		if ($temp = sys_get_temp_dir()) {
-			$directories[] = $temp;
-		}
+        $directories = [];
+        if ($temp = $this->config->getSystemValue('tempdirectory', null)) {
+            $directories[] = $temp;
+        }
+        if ($temp = $this->iniGetWrapper->get('upload_tmp_dir')) {
+            $directories[] = $temp;
+        }
+        if ($temp = getenv('TMP')) {
+            $directories[] = $temp;
+        }
+        if ($temp = getenv('TEMP')) {
+            $directories[] = $temp;
+        }
+        if ($temp = getenv('TMPDIR')) {
+            $directories[] = $temp;
+        }
+        if ($temp = sys_get_temp_dir()) {
+            $directories[] = $temp;
+        }
 
-		foreach ($directories as $dir) {
-			if ($this->checkTemporaryDirectory($dir)) {
-				return $dir;
-			}
-		}
+        foreach ($directories as $dir) {
+            if ($this->checkTemporaryDirectory($dir)) {
+                return $dir;
+            }
+        }
 
-		$temp = tempnam(dirname(__FILE__), '');
-		if (file_exists($temp)) {
-			unlink($temp);
-			return dirname($temp);
-		}
-		throw new \UnexpectedValueException('Unable to detect system temporary directory');
-	}
+        $temp = tempnam(dirname(__FILE__), '');
+        if (file_exists($temp)) {
+            unlink($temp);
+            return dirname($temp);
+        }
+        throw new \UnexpectedValueException('Unable to detect system temporary directory');
+    }
 
-	/**
-	 * Check if a temporary directory is ready for use
-	 *
-	 * @param mixed $directory
-	 * @return bool
-	 */
-	private function checkTemporaryDirectory($directory) {
-		// suppress any possible errors caused by is_writable
-		// checks missing or invalid path or characters, wrong permissions etc
-		try {
-			if (is_writable($directory)) {
-				return true;
-			}
-		} catch (\Exception $e) {
-		}
-		$this->log->warning('Temporary directory {dir} is not present or writable',
-			['dir' => $directory]
-		);
-		return false;
-	}
+    /**
+     * Check if a temporary directory is ready for use
+     *
+     * @param mixed $directory
+     * @return bool
+     */
+    private function checkTemporaryDirectory($directory) {
+        // suppress any possible errors caused by is_writable
+        // checks missing or invalid path or characters, wrong permissions etc
+        try {
+            if (is_writable($directory)) {
+                return true;
+            }
+        } catch (\Exception $e) {
+        }
+        $this->log->warning('Temporary directory {dir} is not present or writable',
+            ['dir' => $directory]
+        );
+        return false;
+    }
 
-	/**
-	 * Override the temporary base directory
-	 *
-	 * @param string $directory
-	 */
-	public function overrideTempBaseDir($directory) {
-		$this->tmpBaseDir = $directory;
-	}
+    /**
+     * Override the temporary base directory
+     *
+     * @param string $directory
+     */
+    public function overrideTempBaseDir($directory) {
+        $this->tmpBaseDir = $directory;
+    }
 }

lib/public/WorkflowEngine/IRuleMatcher.php

Indentation +47 added lines, -47 removed lines

@@ -36,56 +36,56 @@
  * @since 18.0.0
  */
 interface IRuleMatcher extends IFileCheck {
-	/**
-	 * This method is left for backwards compatibility and easier porting of
-	 * apps. Please use 'getFlows' instead (and setOperation if you implement
-	 * an IComplexOperation).
-	 *
-	 * @since 18.0.0
-	 * @deprecated 18.0.0
-	 */
-	public function getMatchingOperations(string $class, bool $returnFirstMatchingOperationOnly = true): array;
+    /**
+     * This method is left for backwards compatibility and easier porting of
+     * apps. Please use 'getFlows' instead (and setOperation if you implement
+     * an IComplexOperation).
+     *
+     * @since 18.0.0
+     * @deprecated 18.0.0
+     */
+    public function getMatchingOperations(string $class, bool $returnFirstMatchingOperationOnly = true): array;
 
-	/**
-	 * @throws RuntimeException
-	 * @since 18.0.0
-	 */
-	public function getFlows(bool $returnFirstMatchingOperationOnly = true): array;
+    /**
+     * @throws RuntimeException
+     * @since 18.0.0
+     */
+    public function getFlows(bool $returnFirstMatchingOperationOnly = true): array;
 
-	/**
-	 * this method can only be called once and is typically called by the
-	 * Flow engine, unless for IComplexOperations.
-	 *
-	 * @throws RuntimeException
-	 * @since 18.0.0
-	 */
-	public function setOperation(IOperation $operation): void;
+    /**
+     * this method can only be called once and is typically called by the
+     * Flow engine, unless for IComplexOperations.
+     *
+     * @throws RuntimeException
+     * @since 18.0.0
+     */
+    public function setOperation(IOperation $operation): void;
 
-	/**
-	 * this method can only be called once and is typically called by the
-	 * Flow engine, unless for IComplexOperations.
-	 *
-	 * @throws RuntimeException
-	 * @since 18.0.0
-	 */
-	public function setEntity(IEntity $entity): void;
+    /**
+     * this method can only be called once and is typically called by the
+     * Flow engine, unless for IComplexOperations.
+     *
+     * @throws RuntimeException
+     * @since 18.0.0
+     */
+    public function setEntity(IEntity $entity): void;
 
-	/**
-	 * returns the entity which might provide more information, depending on
-	 * the interfaces it implements
-	 *
-	 * @return IEntity
-	 * @since 18.0.0
-	 */
-	public function getEntity(): IEntity;
+    /**
+     * returns the entity which might provide more information, depending on
+     * the interfaces it implements
+     *
+     * @return IEntity
+     * @since 18.0.0
+     */
+    public function getEntity(): IEntity;
 
-	/**
-	 * this method can be called once to set the event name that is currently
-	 * being processed. The workflow engine takes care of this usually, only an
-	 * IComplexOperation might want to make use of it.
-	 *
-	 * @throws RuntimeException
-	 * @since 20.0.0
-	 */
-	public function setEventName(string $eventName): void;
+    /**
+     * this method can be called once to set the event name that is currently
+     * being processed. The workflow engine takes care of this usually, only an
+     * IComplexOperation might want to make use of it.
+     *
+     * @throws RuntimeException
+     * @since 20.0.0
+     */
+    public function setEventName(string $eventName): void;
 }

apps/dav/lib/CalDAV/Activity/Setting/Calendar.php

Indentation +51 added lines, -51 removed lines

@@ -24,61 +24,61 @@
 namespace OCA\DAV\CalDAV\Activity\Setting;
 
 class Calendar extends CalDAVSetting {
-	/**
-	 * @return string Lowercase a-z and underscore only identifier
-	 * @since 11.0.0
-	 */
-	public function getIdentifier() {
-		return 'calendar';
-	}
+    /**
+     * @return string Lowercase a-z and underscore only identifier
+     * @since 11.0.0
+     */
+    public function getIdentifier() {
+        return 'calendar';
+    }
 
-	/**
-	 * @return string A translated string
-	 * @since 11.0.0
-	 */
-	public function getName() {
-		return $this->l->t('A <strong>calendar</strong> was modified');
-	}
+    /**
+     * @return string A translated string
+     * @since 11.0.0
+     */
+    public function getName() {
+        return $this->l->t('A <strong>calendar</strong> was modified');
+    }
 
-	/**
-	 * @return int whether the filter should be rather on the top or bottom of
-	 * the admin section. The filters are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 * @since 11.0.0
-	 */
-	public function getPriority() {
-		return 50;
-	}
+    /**
+     * @return int whether the filter should be rather on the top or bottom of
+     * the admin section. The filters are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     * @since 11.0.0
+     */
+    public function getPriority() {
+        return 50;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function canChangeStream() {
-		return true;
-	}
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function canChangeStream() {
+        return true;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function isDefaultEnabledStream() {
-		return true;
-	}
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function isDefaultEnabledStream() {
+        return true;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the mail
-	 * @since 11.0.0
-	 */
-	public function canChangeMail() {
-		return true;
-	}
+    /**
+     * @return bool True when the option can be changed for the mail
+     * @since 11.0.0
+     */
+    public function canChangeMail() {
+        return true;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function isDefaultEnabledMail() {
-		return false;
-	}
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function isDefaultEnabledMail() {
+        return false;
+    }
 }

apps/dav/lib/CalDAV/Activity/Setting/Event.php

Indentation +51 added lines, -51 removed lines

@@ -24,61 +24,61 @@
 namespace OCA\DAV\CalDAV\Activity\Setting;
 
 class Event extends CalDAVSetting {
-	/**
-	 * @return string Lowercase a-z and underscore only identifier
-	 * @since 11.0.0
-	 */
-	public function getIdentifier() {
-		return 'calendar_event';
-	}
+    /**
+     * @return string Lowercase a-z and underscore only identifier
+     * @since 11.0.0
+     */
+    public function getIdentifier() {
+        return 'calendar_event';
+    }
 
-	/**
-	 * @return string A translated string
-	 * @since 11.0.0
-	 */
-	public function getName() {
-		return $this->l->t('A calendar <strong>event</strong> was modified');
-	}
+    /**
+     * @return string A translated string
+     * @since 11.0.0
+     */
+    public function getName() {
+        return $this->l->t('A calendar <strong>event</strong> was modified');
+    }
 
-	/**
-	 * @return int whether the filter should be rather on the top or bottom of
-	 * the admin section. The filters are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 * @since 11.0.0
-	 */
-	public function getPriority() {
-		return 50;
-	}
+    /**
+     * @return int whether the filter should be rather on the top or bottom of
+     * the admin section. The filters are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     * @since 11.0.0
+     */
+    public function getPriority() {
+        return 50;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function canChangeStream() {
-		return true;
-	}
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function canChangeStream() {
+        return true;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function isDefaultEnabledStream() {
-		return true;
-	}
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function isDefaultEnabledStream() {
+        return true;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the mail
-	 * @since 11.0.0
-	 */
-	public function canChangeMail() {
-		return true;
-	}
+    /**
+     * @return bool True when the option can be changed for the mail
+     * @since 11.0.0
+     */
+    public function canChangeMail() {
+        return true;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function isDefaultEnabledMail() {
-		return false;
-	}
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function isDefaultEnabledMail() {
+        return false;
+    }
 }

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