aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/FullTextSearch/Model/DocumentAccess.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/FullTextSearch/Model/DocumentAccess.php')
-rw-r--r--lib/private/FullTextSearch/Model/DocumentAccess.php106
1 files changed, 9 insertions, 97 deletions
diff --git a/lib/private/FullTextSearch/Model/DocumentAccess.php b/lib/private/FullTextSearch/Model/DocumentAccess.php
index cb2b95284f1..9efffeaee88 100644
--- a/lib/private/FullTextSearch/Model/DocumentAccess.php
+++ b/lib/private/FullTextSearch/Model/DocumentAccess.php
@@ -1,27 +1,9 @@
<?php
declare(strict_types=1);
-
/**
- * @copyright 2018
- *
- * @author Maxence Lange <maxence@artificial-owl.com>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\FullTextSearch\Model;
@@ -49,23 +31,17 @@ use OCP\FullTextSearch\Model\IDocumentAccess;
* @package OC\FullTextSearch\Model
*/
final class DocumentAccess implements IDocumentAccess, JsonSerializable {
- /** @var string */
- private $ownerId;
+ private string $ownerId;
- /** @var string */
- private $viewerId = '';
+ private string $viewerId = '';
- /** @var array */
- private $users = [];
+ private array $users = [];
- /** @var array */
- private $groups = [];
+ private array $groups = [];
- /** @var array */
- private $circles = [];
+ private array $circles = [];
- /** @var array */
- private $links = [];
+ private array $links = [];
/**
@@ -74,8 +50,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* @since 16.0.0
*
* IDocumentAccess constructor.
- *
- * @param string $ownerId
*/
public function __construct(string $ownerId = '') {
$this->setOwnerId($ownerId);
@@ -86,10 +60,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Set the Owner of the document.
*
* @since 16.0.0
- *
- * @param string $ownerId
- *
- * @return IDocumentAccess
*/
public function setOwnerId(string $ownerId): IDocumentAccess {
$this->ownerId = $ownerId;
@@ -101,8 +71,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Get the Owner of the document.
*
* @since 16.0.0
- *
- * @return string
*/
public function getOwnerId(): string {
return $this->ownerId;
@@ -113,10 +81,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Set the viewer of the document.
*
* @since 16.0.0
- *
- * @param string $viewerId
- *
- * @return IDocumentAccess
*/
public function setViewerId(string $viewerId): IDocumentAccess {
$this->viewerId = $viewerId;
@@ -128,8 +92,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Get the viewer of the document.
*
* @since 16.0.0
- *
- * @return string
*/
public function getViewerId(): string {
return $this->viewerId;
@@ -140,10 +102,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Set the list of users that have read access to the document.
*
* @since 16.0.0
- *
- * @param array $users
- *
- * @return IDocumentAccess
*/
public function setUsers(array $users): IDocumentAccess {
$this->users = $users;
@@ -155,10 +113,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Add an entry to the list of users that have read access to the document.
*
* @since 16.0.0
- *
- * @param string $user
- *
- * @return IDocumentAccess
*/
public function addUser(string $user): IDocumentAccess {
$this->users[] = $user;
@@ -171,10 +125,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* document.
*
* @since 16.0.0
- *
- * @param array $users
- *
- * @return IDocumentAccess
*/
public function addUsers($users): IDocumentAccess {
$this->users = array_merge($this->users, $users);
@@ -186,8 +136,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Get the complete list of users that have read access to the document.
*
* @since 16.0.0
- *
- * @return array
*/
public function getUsers(): array {
return $this->users;
@@ -198,10 +146,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Set the list of groups that have read access to the document.
*
* @since 16.0.0
- *
- * @param array $groups
- *
- * @return IDocumentAccess
*/
public function setGroups(array $groups): IDocumentAccess {
$this->groups = $groups;
@@ -213,10 +157,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Add an entry to the list of groups that have read access to the document.
*
* @since 16.0.0
- *
- * @param string $group
- *
- * @return IDocumentAccess
*/
public function addGroup(string $group): IDocumentAccess {
$this->groups[] = $group;
@@ -229,12 +169,8 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* document.
*
* @since 16.0.0
- *
- * @param array $groups
- *
- * @return IDocumentAccess
*/
- public function addGroups(array $groups) {
+ public function addGroups(array $groups): IDocumentAccess {
$this->groups = array_merge($this->groups, $groups);
return $this;
@@ -244,8 +180,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Get the complete list of groups that have read access to the document.
*
* @since 16.0.0
- *
- * @return array
*/
public function getGroups(): array {
return $this->groups;
@@ -256,10 +190,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Set the list of circles that have read access to the document.
*
* @since 16.0.0
- *
- * @param array $circles
- *
- * @return IDocumentAccess
*/
public function setCircles(array $circles): IDocumentAccess {
$this->circles = $circles;
@@ -271,10 +201,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Add an entry to the list of circles that have read access to the document.
*
* @since 16.0.0
- *
- * @param string $circle
- *
- * @return IDocumentAccess
*/
public function addCircle(string $circle): IDocumentAccess {
$this->circles[] = $circle;
@@ -287,10 +213,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* document.
*
* @since 16.0.0
- *
- * @param array $circles
- *
- * @return IDocumentAccess
*/
public function addCircles(array $circles): IDocumentAccess {
$this->circles = array_merge($this->circles, $circles);
@@ -302,8 +224,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Get the complete list of circles that have read access to the document.
*
* @since 16.0.0
- *
- * @return array
*/
public function getCircles(): array {
return $this->circles;
@@ -314,10 +234,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Set the list of links that have read access to the document.
*
* @since 16.0.0
- *
- * @param array $links
- *
- * @return IDocumentAccess
*/
public function setLinks(array $links): IDocumentAccess {
$this->links = $links;
@@ -329,8 +245,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Get the list of links that have read access to the document.
*
* @since 16.0.0
- *
- * @return array
*/
public function getLinks(): array {
return $this->links;
@@ -339,8 +253,6 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/**
* @since 16.0.0
- *
- * @return array
*/
public function jsonSerialize(): array {
return [