nextcloud / server

core/Db/LoginFlowV2Mapper.php

Indentation +57 added lines, -57 removed lines

@@ -30,71 +30,71 @@
 use OCP\IDBConnection;
 
 class LoginFlowV2Mapper extends QBMapper {
-	private const lifetime = 1200;
+    private const lifetime = 1200;
 
-	/** @var ITimeFactory */
-	private $timeFactory;
+    /** @var ITimeFactory */
+    private $timeFactory;
 
-	public function __construct(IDBConnection $db, ITimeFactory $timeFactory) {
-		parent::__construct($db, 'login_flow_v2', LoginFlowV2::class);
-		$this->timeFactory = $timeFactory;
-	}
+    public function __construct(IDBConnection $db, ITimeFactory $timeFactory) {
+        parent::__construct($db, 'login_flow_v2', LoginFlowV2::class);
+        $this->timeFactory = $timeFactory;
+    }
 
-	/**
-	 * @param string $pollToken
-	 * @return LoginFlowV2
-	 * @throws DoesNotExistException
-	 */
-	public function getByPollToken(string $pollToken): LoginFlowV2 {
-		$qb = $this->db->getQueryBuilder();
-		$qb->select('*')
-			->from($this->getTableName())
-			->where(
-				$qb->expr()->eq('poll_token', $qb->createNamedParameter($pollToken))
-			);
+    /**
+     * @param string $pollToken
+     * @return LoginFlowV2
+     * @throws DoesNotExistException
+     */
+    public function getByPollToken(string $pollToken): LoginFlowV2 {
+        $qb = $this->db->getQueryBuilder();
+        $qb->select('*')
+            ->from($this->getTableName())
+            ->where(
+                $qb->expr()->eq('poll_token', $qb->createNamedParameter($pollToken))
+            );
 
-		$entity = $this->findEntity($qb);
-		return $this->validateTimestamp($entity);
-	}
+        $entity = $this->findEntity($qb);
+        return $this->validateTimestamp($entity);
+    }
 
-	/**
-	 * @param string $loginToken
-	 * @return LoginFlowV2
-	 * @throws DoesNotExistException
-	 */
-	public function getByLoginToken(string $loginToken): LoginFlowV2 {
-		$qb = $this->db->getQueryBuilder();
-		$qb->select('*')
-			->from($this->getTableName())
-			->where(
-				$qb->expr()->eq('login_token', $qb->createNamedParameter($loginToken))
-			);
+    /**
+     * @param string $loginToken
+     * @return LoginFlowV2
+     * @throws DoesNotExistException
+     */
+    public function getByLoginToken(string $loginToken): LoginFlowV2 {
+        $qb = $this->db->getQueryBuilder();
+        $qb->select('*')
+            ->from($this->getTableName())
+            ->where(
+                $qb->expr()->eq('login_token', $qb->createNamedParameter($loginToken))
+            );
 
-		$entity = $this->findEntity($qb);
-		return $this->validateTimestamp($entity);
-	}
+        $entity = $this->findEntity($qb);
+        return $this->validateTimestamp($entity);
+    }
 
-	public function cleanup(): void {
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete($this->getTableName())
-			->where(
-				$qb->expr()->lt('timestamp', $qb->createNamedParameter($this->timeFactory->getTime() - self::lifetime))
-			);
+    public function cleanup(): void {
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete($this->getTableName())
+            ->where(
+                $qb->expr()->lt('timestamp', $qb->createNamedParameter($this->timeFactory->getTime() - self::lifetime))
+            );
 
-		$qb->execute();
-	}
+        $qb->execute();
+    }
 
-	/**
-	 * @param LoginFlowV2 $flowV2
-	 * @return LoginFlowV2
-	 * @throws DoesNotExistException
-	 */
-	private function validateTimestamp(LoginFlowV2 $flowV2): LoginFlowV2 {
-		if ($flowV2->getTimestamp() < ($this->timeFactory->getTime() - self::lifetime)) {
-			$this->delete($flowV2);
-			throw new DoesNotExistException('Token expired');
-		}
+    /**
+     * @param LoginFlowV2 $flowV2
+     * @return LoginFlowV2
+     * @throws DoesNotExistException
+     */
+    private function validateTimestamp(LoginFlowV2 $flowV2): LoginFlowV2 {
+        if ($flowV2->getTimestamp() < ($this->timeFactory->getTime() - self::lifetime)) {
+            $this->delete($flowV2);
+            throw new DoesNotExistException('Token expired');
+        }
 
-		return $flowV2;
-	}
+        return $flowV2;
+    }
 }

lib/public/Group/Backend/IHideFromCollaborationBackend.php

Indentation +8 added lines, -8 removed lines

@@ -27,12 +27,12 @@
  * Allow the backend to mark groups to be excluded from being shown in search dialogs
  */
 interface IHideFromCollaborationBackend {
-	/**
-	 * Check if a group should be hidden from search dialogs
-	 *
-	 * @param string $groupId
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function hideGroup(string $groupId): bool;
+    /**
+     * Check if a group should be hidden from search dialogs
+     *
+     * @param string $groupId
+     * @return bool
+     * @since 16.0.0
+     */
+    public function hideGroup(string $groupId): bool;
 }

lib/public/Collaboration/AutoComplete/AutoCompleteEvent.php

Indentation +57 added lines, -57 removed lines

@@ -30,70 +30,70 @@
  */
 class AutoCompleteEvent extends GenericEvent {
 
-	/**
-	 * @param array $arguments
-	 * @since 16.0.0
-	 */
-	public function __construct(array $arguments) {
-		parent::__construct(null, $arguments);
-	}
+    /**
+     * @param array $arguments
+     * @since 16.0.0
+     */
+    public function __construct(array $arguments) {
+        parent::__construct(null, $arguments);
+    }
 
-	/**
-	 * @since 16.0.0
-	 */
-	public function getResults(): array {
-		return $this->getArgument('results');
-	}
+    /**
+     * @since 16.0.0
+     */
+    public function getResults(): array {
+        return $this->getArgument('results');
+    }
 
-	/**
-	 * @param array $results
-	 * @since 16.0.0
-	 */
-	public function setResults(array $results): void {
-		$this->setArgument('results', $results);
-	}
+    /**
+     * @param array $results
+     * @since 16.0.0
+     */
+    public function setResults(array $results): void {
+        $this->setArgument('results', $results);
+    }
 
-	/**
-	 * @since 16.0.0
-	 */
-	public function getSearchTerm(): string {
-		return $this->getArgument('search');
-	}
+    /**
+     * @since 16.0.0
+     */
+    public function getSearchTerm(): string {
+        return $this->getArgument('search');
+    }
 
-	/**
-	 * @return int[]
-	 * @since 16.0.0
-	 */
-	public function getShareTypes(): array {
-		return $this->getArgument('shareTypes');
-	}
+    /**
+     * @return int[]
+     * @since 16.0.0
+     */
+    public function getShareTypes(): array {
+        return $this->getArgument('shareTypes');
+    }
 
-	/**
-	 * @since 16.0.0
-	 */
-	public function getItemType(): string {
-		return $this->getArgument('itemType');
-	}
+    /**
+     * @since 16.0.0
+     */
+    public function getItemType(): string {
+        return $this->getArgument('itemType');
+    }
 
-	/**
-	 * @since 16.0.0
-	 */
-	public function getItemId(): string {
-		return $this->getArgument('itemId');
-	}
+    /**
+     * @since 16.0.0
+     */
+    public function getItemId(): string {
+        return $this->getArgument('itemId');
+    }
 
-	/**
-	 * @since 16.0.0
-	 */
-	public function getSorter(): string {
-		return $this->getArgument('sorter');
-	}
+    /**
+     * @since 16.0.0
+     */
+    public function getSorter(): string {
+        return $this->getArgument('sorter');
+    }
 
-	/**
-	 * @since 16.0.0
-	 */
-	public function getLimit(): int {
-		return $this->getArgument('limit');
-	}
+    /**
+     * @since 16.0.0
+     */
+    public function getLimit(): int {
+        return $this->getArgument('limit');
+    }
 
 }

lib/private/Files/Node/NonExistingFile.php

Indentation +115 added lines, -115 removed lines

@@ -26,119 +26,119 @@
 use OCP\Files\NotFoundException;
 
 class NonExistingFile extends File {
-	/**
-	 * @param string $newPath
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	public function rename($newPath) {
-		throw new NotFoundException();
-	}
-
-	public function delete() {
-		throw new NotFoundException();
-	}
-
-	public function copy($newPath) {
-		throw new NotFoundException();
-	}
-
-	public function touch($mtime = null) {
-		throw new NotFoundException();
-	}
-
-	public function getId() {
-		if ($this->fileInfo) {
-			return parent::getId();
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function stat() {
-		throw new NotFoundException();
-	}
-
-	public function getMTime() {
-		if ($this->fileInfo) {
-			return parent::getMTime();
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function getSize($includeMounts = true) {
-		if ($this->fileInfo) {
-			return parent::getSize($includeMounts);
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function getEtag() {
-		if ($this->fileInfo) {
-			return parent::getEtag();
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function getPermissions() {
-		if ($this->fileInfo) {
-			return parent::getPermissions();
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function isReadable() {
-		if ($this->fileInfo) {
-			return parent::isReadable();
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function isUpdateable() {
-		if ($this->fileInfo) {
-			return parent::isUpdateable();
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function isDeletable() {
-		if ($this->fileInfo) {
-			return parent::isDeletable();
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function isShareable() {
-		if ($this->fileInfo) {
-			return parent::isShareable();
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function getContent() {
-		throw new NotFoundException();
-	}
-
-	public function putContent($data) {
-		throw new NotFoundException();
-	}
-
-	public function getMimeType() {
-		if ($this->fileInfo) {
-			return parent::getMimeType();
-		} else {
-			throw new NotFoundException();
-		}
-	}
-
-	public function fopen($mode) {
-		throw new NotFoundException();
-	}
+    /**
+     * @param string $newPath
+     * @throws \OCP\Files\NotFoundException
+     */
+    public function rename($newPath) {
+        throw new NotFoundException();
+    }
+
+    public function delete() {
+        throw new NotFoundException();
+    }
+
+    public function copy($newPath) {
+        throw new NotFoundException();
+    }
+
+    public function touch($mtime = null) {
+        throw new NotFoundException();
+    }
+
+    public function getId() {
+        if ($this->fileInfo) {
+            return parent::getId();
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function stat() {
+        throw new NotFoundException();
+    }
+
+    public function getMTime() {
+        if ($this->fileInfo) {
+            return parent::getMTime();
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function getSize($includeMounts = true) {
+        if ($this->fileInfo) {
+            return parent::getSize($includeMounts);
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function getEtag() {
+        if ($this->fileInfo) {
+            return parent::getEtag();
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function getPermissions() {
+        if ($this->fileInfo) {
+            return parent::getPermissions();
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function isReadable() {
+        if ($this->fileInfo) {
+            return parent::isReadable();
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function isUpdateable() {
+        if ($this->fileInfo) {
+            return parent::isUpdateable();
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function isDeletable() {
+        if ($this->fileInfo) {
+            return parent::isDeletable();
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function isShareable() {
+        if ($this->fileInfo) {
+            return parent::isShareable();
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function getContent() {
+        throw new NotFoundException();
+    }
+
+    public function putContent($data) {
+        throw new NotFoundException();
+    }
+
+    public function getMimeType() {
+        if ($this->fileInfo) {
+            return parent::getMimeType();
+        } else {
+            throw new NotFoundException();
+        }
+    }
+
+    public function fopen($mode) {
+        throw new NotFoundException();
+    }
 }

apps/files/lib/Collaboration/Resources/Listener.php

Indentation +12 added lines, -12 removed lines

@@ -27,18 +27,18 @@
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 class Listener {
-	public static function register(EventDispatcherInterface $dispatcher): void {
-		$dispatcher->addListener('OCP\Share::postShare', [self::class, 'shareModification']);
-		$dispatcher->addListener('OCP\Share::postUnshare', [self::class, 'shareModification']);
-		$dispatcher->addListener('OCP\Share::postUnshareFromSelf', [self::class, 'shareModification']);
-	}
+    public static function register(EventDispatcherInterface $dispatcher): void {
+        $dispatcher->addListener('OCP\Share::postShare', [self::class, 'shareModification']);
+        $dispatcher->addListener('OCP\Share::postUnshare', [self::class, 'shareModification']);
+        $dispatcher->addListener('OCP\Share::postUnshareFromSelf', [self::class, 'shareModification']);
+    }
 
-	public static function shareModification(): void {
-		/** @var IManager $resourceManager */
-		$resourceManager = \OC::$server->query(IManager::class);
-		/** @var ResourceProvider $resourceProvider */
-		$resourceProvider = \OC::$server->query(ResourceProvider::class);
+    public static function shareModification(): void {
+        /** @var IManager $resourceManager */
+        $resourceManager = \OC::$server->query(IManager::class);
+        /** @var ResourceProvider $resourceProvider */
+        $resourceProvider = \OC::$server->query(ResourceProvider::class);
 
-		$resourceManager->invalidateAccessCacheForProvider($resourceProvider);
-	}
+        $resourceManager->invalidateAccessCacheForProvider($resourceProvider);
+    }
 }

lib/public/Collaboration/Resources/ICollection.php

Indentation +43 added lines, -43 removed lines

@@ -29,53 +29,53 @@
  */
 interface ICollection {
 
-	/**
-	 * @return int
-	 * @since 16.0.0
-	 */
-	public function getId(): int;
+    /**
+     * @return int
+     * @since 16.0.0
+     */
+    public function getId(): int;
 
-	/**
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getName(): string;
+    /**
+     * @return string
+     * @since 16.0.0
+     */
+    public function getName(): string;
 
-	/**
-	 * @param string $name
-	 * @since 16.0.0
-	 */
-	public function setName(string $name): void;
+    /**
+     * @param string $name
+     * @since 16.0.0
+     */
+    public function setName(string $name): void;
 
-	/**
-	 * @return IResource[]
-	 * @since 16.0.0
-	 */
-	public function getResources(): array;
+    /**
+     * @return IResource[]
+     * @since 16.0.0
+     */
+    public function getResources(): array;
 
-	/**
-	 * Adds a resource to a collection
-	 *
-	 * @param IResource $resource
-	 * @throws ResourceException when the resource is already part of the collection
-	 * @since 16.0.0
-	 */
-	public function addResource(IResource $resource): void;
+    /**
+     * Adds a resource to a collection
+     *
+     * @param IResource $resource
+     * @throws ResourceException when the resource is already part of the collection
+     * @since 16.0.0
+     */
+    public function addResource(IResource $resource): void;
 
-	/**
-	 * Removes a resource from a collection
-	 *
-	 * @param IResource $resource
-	 * @since 16.0.0
-	 */
-	public function removeResource(IResource $resource): void;
+    /**
+     * Removes a resource from a collection
+     *
+     * @param IResource $resource
+     * @since 16.0.0
+     */
+    public function removeResource(IResource $resource): void;
 
-	/**
-	 * Can a user/guest access the collection
-	 *
-	 * @param IUser|null $user
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function canAccess(?IUser $user): bool;
+    /**
+     * Can a user/guest access the collection
+     *
+     * @param IUser|null $user
+     * @return bool
+     * @since 16.0.0
+     */
+    public function canAccess(?IUser $user): bool;
 }

lib/public/FullTextSearch/Model/ISearchTemplate.php

Indentation +112 added lines, -112 removed lines

@@ -62,118 +62,118 @@
 interface ISearchTemplate {
 
 
-	/**
-	 * Set the class of the icon to be displayed in the left panel of the
-	 * FullTextSearch navigation page, in front of the related Content Provider.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $class
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setIcon(string $class): ISearchTemplate;
-
-	/**
-	 * Get the class of the icon.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getIcon(): string;
-
-
-	/**
-	 * Set the path of a CSS file that will be loaded when needed.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $css
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setCss(string $css): ISearchTemplate;
-
-	/**
-	 * Get the path of the CSS file.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getCss(): string;
-
-
-	/**
-	 * Set the path of the file of a template that the HTML will be displayed
-	 * below the Options.
-	 * This should only be used if your Content Provider needs to set options in
-	 * a way not generated by FullTextSearch
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $template
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setTemplate(string $template): ISearchTemplate;
-
-	/**
-	 * Get the path of the template file.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getTemplate(): string;
-
-
-	/**
-	 * Add an option in the Panel that is displayed when the user start a search
-	 * within the app that generate the content.
-	 *
-	 * @see ISearchOption
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param ISearchOption $option
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function addPanelOption(ISearchOption $option): ISearchTemplate;
-
-	/**
-	 * Get all options to be displayed in the Panel.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return ISearchOption[]
-	 */
-	public function getPanelOptions(): array;
-
-
-	/**
-	 * Add an option in the left panel of the FullTextSearch navigation page.
-	 *
-	 * @see ISearchOption
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param ISearchOption $option
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function addNavigationOption(ISearchOption $option): ISearchTemplate;
-
-	/**
-	 * Get all options to be displayed in the FullTextSearch navigation page.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getNavigationOptions(): array;
+    /**
+     * Set the class of the icon to be displayed in the left panel of the
+     * FullTextSearch navigation page, in front of the related Content Provider.
+     *
+     * @since 16.0.0
+     *
+     * @param string $class
+     *
+     * @return ISearchTemplate
+     */
+    public function setIcon(string $class): ISearchTemplate;
+
+    /**
+     * Get the class of the icon.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getIcon(): string;
+
+
+    /**
+     * Set the path of a CSS file that will be loaded when needed.
+     *
+     * @since 16.0.0
+     *
+     * @param string $css
+     *
+     * @return ISearchTemplate
+     */
+    public function setCss(string $css): ISearchTemplate;
+
+    /**
+     * Get the path of the CSS file.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getCss(): string;
+
+
+    /**
+     * Set the path of the file of a template that the HTML will be displayed
+     * below the Options.
+     * This should only be used if your Content Provider needs to set options in
+     * a way not generated by FullTextSearch
+     *
+     * @since 16.0.0
+     *
+     * @param string $template
+     *
+     * @return ISearchTemplate
+     */
+    public function setTemplate(string $template): ISearchTemplate;
+
+    /**
+     * Get the path of the template file.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getTemplate(): string;
+
+
+    /**
+     * Add an option in the Panel that is displayed when the user start a search
+     * within the app that generate the content.
+     *
+     * @see ISearchOption
+     *
+     * @since 16.0.0
+     *
+     * @param ISearchOption $option
+     *
+     * @return ISearchTemplate
+     */
+    public function addPanelOption(ISearchOption $option): ISearchTemplate;
+
+    /**
+     * Get all options to be displayed in the Panel.
+     *
+     * @since 16.0.0
+     *
+     * @return ISearchOption[]
+     */
+    public function getPanelOptions(): array;
+
+
+    /**
+     * Add an option in the left panel of the FullTextSearch navigation page.
+     *
+     * @see ISearchOption
+     *
+     * @since 16.0.0
+     *
+     * @param ISearchOption $option
+     *
+     * @return ISearchTemplate
+     */
+    public function addNavigationOption(ISearchOption $option): ISearchTemplate;
+
+    /**
+     * Get all options to be displayed in the FullTextSearch navigation page.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getNavigationOptions(): array;
 
 }
 

lib/public/FullTextSearch/Model/IDocumentAccess.php

Indentation +205 added lines, -205 removed lines

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

lib/public/FullTextSearch/Model/ISearchResult.php

Indentation +137 added lines, -137 removed lines

@@ -56,143 +56,143 @@
 interface ISearchResult {
 
 
-	/**
-	 * Get the original SearchRequest.
-	 *
-	 * @see ISearchRequest
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return ISearchRequest
-	 */
-	public function getRequest(): ISearchRequest;
-
-	/**
-	 * Get the targeted Content Provider.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IFullTextSearchProvider
-	 */
-	public function getProvider(): IFullTextSearchProvider;
-
-
-	/**
-	 * Add an IIndexDocument as one of the result of the search request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexDocument $document
-	 *
-	 * @return ISearchResult
-	 */
-	public function addDocument(IIndexDocument $document): ISearchResult;
-
-	/**
-	 * Returns all result of the search request, in an array of IIndexDocument.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndexDocument[]
-	 */
-	public function getDocuments(): array;
-
-	/**
-	 * Set an array of IIndexDocument as the result of the search request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexDocument[] $documents
-	 *
-	 * @return ISearchResult
-	 */
-	public function setDocuments(array $documents): ISearchResult;
-
-
-	/**
-	 * Add an aggregation to the result.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $category
-	 * @param string $value
-	 * @param int $count
-	 *
-	 * @return ISearchResult
-	 */
-	public function addAggregation(string $category, string $value, int $count): ISearchResult;
-
-	/**
-	 * Get all aggregations.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $category
-	 *
-	 * @return array
-	 */
-	public function getAggregations(string $category): array;
-
-
-	/**
-	 * Set the raw result of the request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $result
-	 *
-	 * @return ISearchResult
-	 */
-	public function setRawResult(string $result): ISearchResult;
-
-
-	/**
-	 * Set the total number of results for the search request.
-	 * Used by pagination.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $total
-	 *
-	 * @return ISearchResult
-	 */
-	public function setTotal(int $total): ISearchResult;
-
-
-	/**
-	 * Set the top score for the search request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $score
-	 *
-	 * @return ISearchResult
-	 */
-	public function setMaxScore(int $score): ISearchResult;
-
-
-	/**
-	 * Set the time spent by the request to perform the search.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $time
-	 *
-	 * @return ISearchResult
-	 */
-	public function setTime(int $time): ISearchResult;
-
-
-	/**
-	 * Set to true if the request timed out.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param bool $timedOut
-	 *
-	 * @return ISearchResult
-	 */
-	public function setTimedOut(bool $timedOut): ISearchResult;
+    /**
+     * Get the original SearchRequest.
+     *
+     * @see ISearchRequest
+     *
+     * @since 15.0.0
+     *
+     * @return ISearchRequest
+     */
+    public function getRequest(): ISearchRequest;
+
+    /**
+     * Get the targeted Content Provider.
+     *
+     * @since 15.0.0
+     *
+     * @return IFullTextSearchProvider
+     */
+    public function getProvider(): IFullTextSearchProvider;
+
+
+    /**
+     * Add an IIndexDocument as one of the result of the search request.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexDocument $document
+     *
+     * @return ISearchResult
+     */
+    public function addDocument(IIndexDocument $document): ISearchResult;
+
+    /**
+     * Returns all result of the search request, in an array of IIndexDocument.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndexDocument[]
+     */
+    public function getDocuments(): array;
+
+    /**
+     * Set an array of IIndexDocument as the result of the search request.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexDocument[] $documents
+     *
+     * @return ISearchResult
+     */
+    public function setDocuments(array $documents): ISearchResult;
+
+
+    /**
+     * Add an aggregation to the result.
+     *
+     * @since 15.0.0
+     *
+     * @param string $category
+     * @param string $value
+     * @param int $count
+     *
+     * @return ISearchResult
+     */
+    public function addAggregation(string $category, string $value, int $count): ISearchResult;
+
+    /**
+     * Get all aggregations.
+     *
+     * @since 15.0.0
+     *
+     * @param string $category
+     *
+     * @return array
+     */
+    public function getAggregations(string $category): array;
+
+
+    /**
+     * Set the raw result of the request.
+     *
+     * @since 15.0.0
+     *
+     * @param string $result
+     *
+     * @return ISearchResult
+     */
+    public function setRawResult(string $result): ISearchResult;
+
+
+    /**
+     * Set the total number of results for the search request.
+     * Used by pagination.
+     *
+     * @since 15.0.0
+     *
+     * @param int $total
+     *
+     * @return ISearchResult
+     */
+    public function setTotal(int $total): ISearchResult;
+
+
+    /**
+     * Set the top score for the search request.
+     *
+     * @since 15.0.0
+     *
+     * @param int $score
+     *
+     * @return ISearchResult
+     */
+    public function setMaxScore(int $score): ISearchResult;
+
+
+    /**
+     * Set the time spent by the request to perform the search.
+     *
+     * @since 15.0.0
+     *
+     * @param int $time
+     *
+     * @return ISearchResult
+     */
+    public function setTime(int $time): ISearchResult;
+
+
+    /**
+     * Set to true if the request timed out.
+     *
+     * @since 15.0.0
+     *
+     * @param bool $timedOut
+     *
+     * @return ISearchResult
+     */
+    public function setTimedOut(bool $timedOut): ISearchResult;
 
 }