diff options
Diffstat (limited to 'apps/dav/lib/Comments/EntityCollection.php')
-rw-r--r-- | apps/dav/lib/Comments/EntityCollection.php | 70 |
1 files changed, 21 insertions, 49 deletions
diff --git a/apps/dav/lib/Comments/EntityCollection.php b/apps/dav/lib/Comments/EntityCollection.php index e84fbb50566..33c58ee44d2 100644 --- a/apps/dav/lib/Comments/EntityCollection.php +++ b/apps/dav/lib/Comments/EntityCollection.php @@ -1,33 +1,17 @@ <?php + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Arthur Schiwon <blizzz@arthur-schiwon.de> - * @author Joas Schilling <coding@schilljs.com> - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * + * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ - namespace OCA\DAV\Comments; use OCP\Comments\ICommentsManager; use OCP\Comments\NotFoundException; -use OCP\ILogger; use OCP\IUserManager; use OCP\IUserSession; +use Psr\Log\LoggerInterface; use Sabre\DAV\Exception\NotFound; use Sabre\DAV\IProperties; use Sabre\DAV\PropPatch; @@ -41,13 +25,7 @@ use Sabre\DAV\PropPatch; * @package OCA\DAV\Comments */ class EntityCollection extends RootCollection implements IProperties { - const PROPERTY_NAME_READ_MARKER = '{http://owncloud.org/ns}readMarker'; - - /** @var string */ - protected $id; - - /** @var ILogger */ - protected $logger; + public const PROPERTY_NAME_READ_MARKER = '{http://owncloud.org/ns}readMarker'; /** * @param string $id @@ -55,26 +33,24 @@ class EntityCollection extends RootCollection implements IProperties { * @param ICommentsManager $commentsManager * @param IUserManager $userManager * @param IUserSession $userSession - * @param ILogger $logger + * @param LoggerInterface $logger */ public function __construct( - $id, + protected $id, $name, ICommentsManager $commentsManager, IUserManager $userManager, IUserSession $userSession, - ILogger $logger + protected LoggerInterface $logger, ) { - foreach(['id', 'name'] as $property) { + foreach (['id', 'name'] as $property) { $$property = trim($$property); - if(empty($$property) || !is_string($$property)) { + if (empty($$property) || !is_string($$property)) { throw new \InvalidArgumentException('"' . $property . '" parameter must be non-empty string'); } } - $this->id = $id; $this->name = $name; $this->commentsManager = $commentsManager; - $this->logger = $logger; $this->userManager = $userManager; $this->userSession = $userSession; } @@ -98,7 +74,7 @@ class EntityCollection extends RootCollection implements IProperties { * @return \Sabre\DAV\INode * @throws NotFound */ - function getChild($name) { + public function getChild($name) { try { $comment = $this->commentsManager->get($name); return new CommentNode( @@ -118,7 +94,7 @@ class EntityCollection extends RootCollection implements IProperties { * * @return \Sabre\DAV\INode[] */ - function getChildren() { + public function getChildren() { return $this->findChildren(); } @@ -131,10 +107,10 @@ class EntityCollection extends RootCollection implements IProperties { * @param \DateTime|null $datetime * @return CommentNode[] */ - function findChildren($limit = 0, $offset = 0, \DateTime $datetime = null) { + public function findChildren($limit = 0, $offset = 0, ?\DateTime $datetime = null) { $comments = $this->commentsManager->getForObject($this->name, $this->id, $limit, $offset, $datetime); $result = []; - foreach($comments as $comment) { + foreach ($comments as $comment) { $result[] = new CommentNode( $this->commentsManager, $comment, @@ -152,7 +128,7 @@ class EntityCollection extends RootCollection implements IProperties { * @param string $name * @return bool */ - function childExists($name) { + public function childExists($name) { try { $this->commentsManager->get($name); return true; @@ -163,12 +139,9 @@ class EntityCollection extends RootCollection implements IProperties { /** * Sets the read marker to the specified date for the logged in user - * - * @param \DateTime $value - * @return bool */ - public function setReadMarker($value) { - $dateTime = new \DateTime($value); + public function setReadMarker(?string $value): bool { + $dateTime = new \DateTime($value ?? 'now'); $user = $this->userSession->getUser(); $this->commentsManager->setReadMark($this->name, $this->id, $dateTime, $user); return true; @@ -177,20 +150,19 @@ class EntityCollection extends RootCollection implements IProperties { /** * @inheritdoc */ - function propPatch(PropPatch $propPatch) { + public function propPatch(PropPatch $propPatch) { $propPatch->handle(self::PROPERTY_NAME_READ_MARKER, [$this, 'setReadMarker']); } /** * @inheritdoc */ - function getProperties($properties) { + public function getProperties($properties) { $marker = null; $user = $this->userSession->getUser(); - if(!is_null($user)) { + if (!is_null($user)) { $marker = $this->commentsManager->getReadMark($this->name, $this->id, $user); } return [self::PROPERTY_NAME_READ_MARKER => $marker]; } } - |