nextcloud / server

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/workflowengine/lib/AppInfo/Application.php

Indentation +73 added lines, -73 removed lines

@@ -43,86 +43,86 @@
 use OCP\WorkflowEngine\IOperationCompat;
 
 class Application extends App implements IBootstrap {
-	public const APP_ID = 'workflowengine';
+    public const APP_ID = 'workflowengine';
 
-	public function __construct() {
-		parent::__construct(self::APP_ID);
-	}
+    public function __construct() {
+        parent::__construct(self::APP_ID);
+    }
 
-	public function register(IRegistrationContext $context): void {
-		$context->registerServiceAlias('RequestTimeController', RequestTime::class);
-		$context->registerEventListener(
-			LoadSettingsScriptsEvent::class,
-			LoadAdditionalSettingsScriptsListener::class,
-			-100
-		);
-	}
+    public function register(IRegistrationContext $context): void {
+        $context->registerServiceAlias('RequestTimeController', RequestTime::class);
+        $context->registerEventListener(
+            LoadSettingsScriptsEvent::class,
+            LoadAdditionalSettingsScriptsListener::class,
+            -100
+        );
+    }
 
-	public function boot(IBootContext $context): void {
-		$context->injectFn(Closure::fromCallable([$this, 'registerRuleListeners']));
-	}
+    public function boot(IBootContext $context): void {
+        $context->injectFn(Closure::fromCallable([$this, 'registerRuleListeners']));
+    }
 
-	private function registerRuleListeners(IEventDispatcher $dispatcher,
-										   IServerContainer $container,
-										   ILogger $logger): void {
-		/** @var Manager $manager */
-		$manager = $container->query(Manager::class);
-		$configuredEvents = $manager->getAllConfiguredEvents();
+    private function registerRuleListeners(IEventDispatcher $dispatcher,
+                                            IServerContainer $container,
+                                            ILogger $logger): void {
+        /** @var Manager $manager */
+        $manager = $container->query(Manager::class);
+        $configuredEvents = $manager->getAllConfiguredEvents();
 
-		foreach ($configuredEvents as $operationClass => $events) {
-			foreach ($events as $entityClass => $eventNames) {
-				array_map(function (string $eventName) use ($manager, $container, $dispatcher, $logger, $operationClass, $entityClass) {
-					$dispatcher->addListener(
-						$eventName,
-						function ($event) use ($manager, $container, $eventName, $logger, $operationClass, $entityClass) {
-							$ruleMatcher = $manager->getRuleMatcher();
-							try {
-								/** @var IEntity $entity */
-								$entity = $container->query($entityClass);
-								/** @var IOperation $operation */
-								$operation = $container->query($operationClass);
+        foreach ($configuredEvents as $operationClass => $events) {
+            foreach ($events as $entityClass => $eventNames) {
+                array_map(function (string $eventName) use ($manager, $container, $dispatcher, $logger, $operationClass, $entityClass) {
+                    $dispatcher->addListener(
+                        $eventName,
+                        function ($event) use ($manager, $container, $eventName, $logger, $operationClass, $entityClass) {
+                            $ruleMatcher = $manager->getRuleMatcher();
+                            try {
+                                /** @var IEntity $entity */
+                                $entity = $container->query($entityClass);
+                                /** @var IOperation $operation */
+                                $operation = $container->query($operationClass);
 
-								$ruleMatcher->setEventName($eventName);
-								$ruleMatcher->setEntity($entity);
-								$ruleMatcher->setOperation($operation);
+                                $ruleMatcher->setEventName($eventName);
+                                $ruleMatcher->setEntity($entity);
+                                $ruleMatcher->setOperation($operation);
 
-								$ctx = new LogContext();
-								$ctx
-									->setOperation($operation)
-									->setEntity($entity)
-									->setEventName($eventName);
+                                $ctx = new LogContext();
+                                $ctx
+                                    ->setOperation($operation)
+                                    ->setEntity($entity)
+                                    ->setEventName($eventName);
 
-								/** @var Logger $flowLogger */
-								$flowLogger = $container->query(Logger::class);
-								$flowLogger->logEventInit($ctx);
+                                /** @var Logger $flowLogger */
+                                $flowLogger = $container->query(Logger::class);
+                                $flowLogger->logEventInit($ctx);
 
-								if ($event instanceof Event) {
-									$entity->prepareRuleMatcher($ruleMatcher, $eventName, $event);
-									$operation->onEvent($eventName, $event, $ruleMatcher);
-								} elseif ($entity instanceof IEntityCompat && $operation instanceof IOperationCompat) {
-									// TODO: Remove this block (and the compat classes) in the first major release in 2023
-									$entity->prepareRuleMatcherCompat($ruleMatcher, $eventName, $event);
-									$operation->onEventCompat($eventName, $event, $ruleMatcher);
-								} else {
-									$logger->debug(
-										'Cannot handle event {name} of {event} against entity {entity} and operation {operation}',
-										[
-											'app' => self::APP_ID,
-											'name' => $eventName,
-											'event' => get_class($event),
-											'entity' => $entityClass,
-											'operation' => $operationClass,
-										]
-									);
-								}
-								$flowLogger->logEventDone($ctx);
-							} catch (QueryException $e) {
-								// Ignore query exceptions since they might occur when an entity/operation were setup before by an app that is disabled now
-							}
-						}
-					);
-				}, $eventNames ?? []);
-			}
-		}
-	}
+                                if ($event instanceof Event) {
+                                    $entity->prepareRuleMatcher($ruleMatcher, $eventName, $event);
+                                    $operation->onEvent($eventName, $event, $ruleMatcher);
+                                } elseif ($entity instanceof IEntityCompat && $operation instanceof IOperationCompat) {
+                                    // TODO: Remove this block (and the compat classes) in the first major release in 2023
+                                    $entity->prepareRuleMatcherCompat($ruleMatcher, $eventName, $event);
+                                    $operation->onEventCompat($eventName, $event, $ruleMatcher);
+                                } else {
+                                    $logger->debug(
+                                        'Cannot handle event {name} of {event} against entity {entity} and operation {operation}',
+                                        [
+                                            'app' => self::APP_ID,
+                                            'name' => $eventName,
+                                            'event' => get_class($event),
+                                            'entity' => $entityClass,
+                                            'operation' => $operationClass,
+                                        ]
+                                    );
+                                }
+                                $flowLogger->logEventDone($ctx);
+                            } catch (QueryException $e) {
+                                // Ignore query exceptions since they might occur when an entity/operation were setup before by an app that is disabled now
+                            }
+                        }
+                    );
+                }, $eventNames ?? []);
+            }
+        }
+    }
 }

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

apps/files/lib/Service/DirectEditingService.php

Indentation +47 added lines, -47 removed lines

@@ -33,57 +33,57 @@
 
 class DirectEditingService {
 
-	/** @var IManager */
-	private $directEditingManager;
-	/** @var IEventDispatcher */
-	private $eventDispatcher;
+    /** @var IManager */
+    private $directEditingManager;
+    /** @var IEventDispatcher */
+    private $eventDispatcher;
 
-	public function __construct(IEventDispatcher $eventDispatcher, IManager $directEditingManager) {
-		$this->directEditingManager = $directEditingManager;
-		$this->eventDispatcher = $eventDispatcher;
-	}
+    public function __construct(IEventDispatcher $eventDispatcher, IManager $directEditingManager) {
+        $this->directEditingManager = $directEditingManager;
+        $this->eventDispatcher = $eventDispatcher;
+    }
 
-	public function getDirectEditingETag(): string {
-		return \md5(\json_encode($this->getDirectEditingCapabilitites()));
-	}
+    public function getDirectEditingETag(): string {
+        return \md5(\json_encode($this->getDirectEditingCapabilitites()));
+    }
 
-	public function getDirectEditingCapabilitites(): array {
-		$this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager));
+    public function getDirectEditingCapabilitites(): array {
+        $this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager));
 
-		$capabilities = [
-			'editors' => [],
-			'creators' => []
-		];
+        $capabilities = [
+            'editors' => [],
+            'creators' => []
+        ];
 
-		if (!$this->directEditingManager->isEnabled()) {
-			return $capabilities;
-		}
+        if (!$this->directEditingManager->isEnabled()) {
+            return $capabilities;
+        }
 
-		/**
-		 * @var string $id
-		 * @var IEditor $editor
-		 */
-		foreach ($this->directEditingManager->getEditors() as $id => $editor) {
-			$capabilities['editors'][$id] = [
-				'id' => $editor->getId(),
-				'name' => $editor->getName(),
-				'mimetypes' => $editor->getMimetypes(),
-				'optionalMimetypes' => $editor->getMimetypesOptional(),
-				'secure' => $editor->isSecure(),
-			];
-			/** @var ACreateEmpty|ACreateFromTemplate $creator */
-			foreach ($editor->getCreators() as $creator) {
-				$id = $creator->getId();
-				$capabilities['creators'][$id] = [
-					'id' => $id,
-					'editor' => $editor->getId(),
-					'name' => $creator->getName(),
-					'extension' => $creator->getExtension(),
-					'templates' => $creator instanceof ACreateFromTemplate,
-					'mimetype' => $creator->getMimetype()
-				];
-			}
-		}
-		return $capabilities;
-	}
+        /**
+         * @var string $id
+         * @var IEditor $editor
+         */
+        foreach ($this->directEditingManager->getEditors() as $id => $editor) {
+            $capabilities['editors'][$id] = [
+                'id' => $editor->getId(),
+                'name' => $editor->getName(),
+                'mimetypes' => $editor->getMimetypes(),
+                'optionalMimetypes' => $editor->getMimetypesOptional(),
+                'secure' => $editor->isSecure(),
+            ];
+            /** @var ACreateEmpty|ACreateFromTemplate $creator */
+            foreach ($editor->getCreators() as $creator) {
+                $id = $creator->getId();
+                $capabilities['creators'][$id] = [
+                    'id' => $id,
+                    'editor' => $editor->getId(),
+                    'name' => $creator->getName(),
+                    'extension' => $creator->getExtension(),
+                    'templates' => $creator instanceof ACreateFromTemplate,
+                    'mimetype' => $creator->getMimetype()
+                ];
+            }
+        }
+        return $capabilities;
+    }
 }

apps/files/lib/Controller/DirectEditingController.php

Indentation +93 added lines, -93 removed lines

@@ -37,97 +37,97 @@
 
 class DirectEditingController extends OCSController {
 
-	/** @var IEventDispatcher */
-	private $eventDispatcher;
-
-	/** @var IManager */
-	private $directEditingManager;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var DirectEditingService */
-	private $directEditingService;
-
-	public function __construct($appName, IRequest $request, $corsMethods, $corsAllowedHeaders, $corsMaxAge,
-								IEventDispatcher $eventDispatcher, IURLGenerator $urlGenerator, IManager $manager, DirectEditingService $directEditingService, ILogger $logger) {
-		parent::__construct($appName, $request, $corsMethods, $corsAllowedHeaders, $corsMaxAge);
-
-		$this->eventDispatcher = $eventDispatcher;
-		$this->directEditingManager = $manager;
-		$this->directEditingService = $directEditingService;
-		$this->logger = $logger;
-		$this->urlGenerator = $urlGenerator;
-	}
-
-	/**
-	 * @NoAdminRequired
-	 */
-	public function info(): DataResponse {
-		$response = new DataResponse($this->directEditingService->getDirectEditingCapabilitites());
-		$response->setETag($this->directEditingService->getDirectEditingETag());
-		return $response;
-	}
-
-	/**
-	 * @NoAdminRequired
-	 */
-	public function create(string $path, string $editorId, string $creatorId, string $templateId = null): DataResponse {
-		if (!$this->directEditingManager->isEnabled()) {
-			return new DataResponse(['message' => 'Direct editing is not enabled'], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-		$this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager));
-
-		try {
-			$token = $this->directEditingManager->create($path, $editorId, $creatorId, $templateId);
-			return new DataResponse([
-				'url' => $this->urlGenerator->linkToRouteAbsolute('files.DirectEditingView.edit', ['token' => $token])
-			]);
-		} catch (Exception $e) {
-			$this->logger->logException($e, ['message' => 'Exception when creating a new file through direct editing']);
-			return new DataResponse(['message' => 'Failed to create file: ' . $e->getMessage()], Http::STATUS_FORBIDDEN);
-		}
-	}
-
-	/**
-	 * @NoAdminRequired
-	 */
-	public function open(string $path, string $editorId = null): DataResponse {
-		if (!$this->directEditingManager->isEnabled()) {
-			return new DataResponse(['message' => 'Direct editing is not enabled'], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-		$this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager));
-
-		try {
-			$token = $this->directEditingManager->open($path, $editorId);
-			return new DataResponse([
-				'url' => $this->urlGenerator->linkToRouteAbsolute('files.DirectEditingView.edit', ['token' => $token])
-			]);
-		} catch (Exception $e) {
-			$this->logger->logException($e, ['message' => 'Exception when opening a file through direct editing']);
-			return new DataResponse(['message' => 'Failed to open file: ' . $e->getMessage()], Http::STATUS_FORBIDDEN);
-		}
-	}
-
-
-
-	/**
-	 * @NoAdminRequired
-	 */
-	public function templates(string $editorId, string $creatorId): DataResponse {
-		if (!$this->directEditingManager->isEnabled()) {
-			return new DataResponse(['message' => 'Direct editing is not enabled'], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-		$this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager));
-
-		try {
-			return new DataResponse($this->directEditingManager->getTemplates($editorId, $creatorId));
-		} catch (Exception $e) {
-			$this->logger->logException($e);
-			return new DataResponse(['message' => 'Failed to obtain template list: ' . $e->getMessage()], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
+    /** @var IEventDispatcher */
+    private $eventDispatcher;
+
+    /** @var IManager */
+    private $directEditingManager;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var DirectEditingService */
+    private $directEditingService;
+
+    public function __construct($appName, IRequest $request, $corsMethods, $corsAllowedHeaders, $corsMaxAge,
+                                IEventDispatcher $eventDispatcher, IURLGenerator $urlGenerator, IManager $manager, DirectEditingService $directEditingService, ILogger $logger) {
+        parent::__construct($appName, $request, $corsMethods, $corsAllowedHeaders, $corsMaxAge);
+
+        $this->eventDispatcher = $eventDispatcher;
+        $this->directEditingManager = $manager;
+        $this->directEditingService = $directEditingService;
+        $this->logger = $logger;
+        $this->urlGenerator = $urlGenerator;
+    }
+
+    /**
+     * @NoAdminRequired
+     */
+    public function info(): DataResponse {
+        $response = new DataResponse($this->directEditingService->getDirectEditingCapabilitites());
+        $response->setETag($this->directEditingService->getDirectEditingETag());
+        return $response;
+    }
+
+    /**
+     * @NoAdminRequired
+     */
+    public function create(string $path, string $editorId, string $creatorId, string $templateId = null): DataResponse {
+        if (!$this->directEditingManager->isEnabled()) {
+            return new DataResponse(['message' => 'Direct editing is not enabled'], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+        $this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager));
+
+        try {
+            $token = $this->directEditingManager->create($path, $editorId, $creatorId, $templateId);
+            return new DataResponse([
+                'url' => $this->urlGenerator->linkToRouteAbsolute('files.DirectEditingView.edit', ['token' => $token])
+            ]);
+        } catch (Exception $e) {
+            $this->logger->logException($e, ['message' => 'Exception when creating a new file through direct editing']);
+            return new DataResponse(['message' => 'Failed to create file: ' . $e->getMessage()], Http::STATUS_FORBIDDEN);
+        }
+    }
+
+    /**
+     * @NoAdminRequired
+     */
+    public function open(string $path, string $editorId = null): DataResponse {
+        if (!$this->directEditingManager->isEnabled()) {
+            return new DataResponse(['message' => 'Direct editing is not enabled'], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+        $this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager));
+
+        try {
+            $token = $this->directEditingManager->open($path, $editorId);
+            return new DataResponse([
+                'url' => $this->urlGenerator->linkToRouteAbsolute('files.DirectEditingView.edit', ['token' => $token])
+            ]);
+        } catch (Exception $e) {
+            $this->logger->logException($e, ['message' => 'Exception when opening a file through direct editing']);
+            return new DataResponse(['message' => 'Failed to open file: ' . $e->getMessage()], Http::STATUS_FORBIDDEN);
+        }
+    }
+
+
+
+    /**
+     * @NoAdminRequired
+     */
+    public function templates(string $editorId, string $creatorId): DataResponse {
+        if (!$this->directEditingManager->isEnabled()) {
+            return new DataResponse(['message' => 'Direct editing is not enabled'], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+        $this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager));
+
+        try {
+            return new DataResponse($this->directEditingManager->getTemplates($editorId, $creatorId));
+        } catch (Exception $e) {
+            $this->logger->logException($e);
+            return new DataResponse(['message' => 'Failed to obtain template list: ' . $e->getMessage()], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
 }