upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-03-25 03:43:45 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 39

Merge pull request #35424 from nextcloud/cleanup/comments

Browse source 
Cleanup comments code
This commit is contained in:
Côme Chilliet 2023-06-20 14:50:04 +02:00 committed by GitHub
commit d9e9d4e123
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 152 additions and 346 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
apps/comments/lib/Activity/Filter.php
View file

@ -27,64 +27,42 @@ use OCP\IL10N;
use OCP\IURLGenerator;
class Filter implements IFilter {
/** @var IL10N */
protected $l;
/** @var IURLGenerator */
protected $url;
protected IL10N $l;
protected IURLGenerator $url;
public function __construct(IL10N $l, IURLGenerator $url) {
$this->l = $l;
$this->url = $url;
}
/**
* @return string Lowercase a-z only identifier
* @since 11.0.0
*/
public function getIdentifier() {
public function getIdentifier(): string {
return 'comments';
}
/**
* @return string A translated string
* @since 11.0.0
*/
public function getName() {
public function getName(): string {
return $this->l->t('Comments');
}
/**
* @return int
* @since 11.0.0
*/
public function getPriority() {
public function getPriority(): int {
return 40;
}
/**
* @return string Full URL to an icon, empty string when none is given
* @since 11.0.0
*/
public function getIcon() {
public function getIcon(): string {
return $this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg'));
}
/**
* @param string[] $types
* @return string[] An array of allowed apps from which activities should be displayed
* @since 11.0.0
*/
public function filterTypes(array $types) {
public function filterTypes(array $types): array {
return $types;
}
/**
* @return string[] An array of allowed apps from which activities should be displayed
* @since 11.0.0
*/
public function allowedApps() {
public function allowedApps(): array {
return ['comments'];
}
}

5
apps/comments/lib/Activity/Listener.php
View file

@ -59,10 +59,7 @@ class Listener {
$this->shareHelper = $shareHelper;
}
/**
* @param CommentsEvent $event
*/
public function commentEvent(CommentsEvent $event) {
public function commentEvent(CommentsEvent $event): void {
if ($event->getComment()->getObjectType() !== 'files'
|| $event->getEvent() !== CommentsEvent::EVENT_ADD
|| !$this->appManager->isInstalled('activity')) {

2
apps/comments/lib/Activity/Provider.php
View file

@ -58,7 +58,7 @@ class Provider implements IProvider {
* @throws \InvalidArgumentException
* @since 11.0.0
*/
public function parse($language, IEvent $event, IEvent $previousEvent = null) {
public function parse($language, IEvent $event, IEvent $previousEvent = null): IEvent {
if ($event->getApp() !== 'comments') {
throw new \InvalidArgumentException();
}

51
apps/comments/lib/Activity/Setting.php
View file

@ -26,72 +26,37 @@ use OCP\Activity\ISetting;
use OCP\IL10N;
class Setting implements ISetting {
protected IL10N $l;
/** @var IL10N */
protected $l;
/**
* @param IL10N $l
*/
public function __construct(IL10N $l) {
$this->l = $l;
}
/**
* @return string Lowercase a-z and underscore only identifier
* @since 11.0.0
*/
public function getIdentifier() {
public function getIdentifier(): string {
return 'comments';
}
/**
* @return string A translated string
* @since 11.0.0
*/
public function getName() {
public function getName(): string {
return $this->l->t('<strong>Comments</strong> for files');
}
/**
* @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() {
public function getPriority(): int {
return 50;
}
/**
* @return bool True when the option can be changed for the stream
* @since 11.0.0
*/
public function canChangeStream() {
public function canChangeStream(): bool {
return true;
}
/**
* @return bool True when the option can be changed for the stream
* @since 11.0.0
*/
public function isDefaultEnabledStream() {
public function isDefaultEnabledStream(): bool {
return true;
}
/**
* @return bool True when the option can be changed for the mail
* @since 11.0.0
*/
public function canChangeMail() {
public function canChangeMail(): bool {
return true;
}
/**
* @return bool True when the option can be changed for the stream
* @since 11.0.0
*/
public function isDefaultEnabledMail() {
public function isDefaultEnabledMail(): bool {
return false;
}
}

10
apps/comments/lib/Collaboration/CommentersSorter.php
View file

@ -27,14 +27,13 @@ use OCP\Collaboration\AutoComplete\ISorter;
use OCP\Comments\ICommentsManager;
class CommentersSorter implements ISorter {
private ICommentsManager $commentsManager;
public function __construct(ICommentsManager $commentsManager) {
$this->commentsManager = $commentsManager;
}
public function getId() {
public function getId(): string {
return 'commenters';
}
@ -42,10 +41,10 @@ class CommentersSorter implements ISorter {
* Sorts people who commented on the given item atop (descelating) of the
* others
*
* @param array $sortArray
* @param array &$sortArray
* @param array $context
*/
public function sort(array &$sortArray, array $context) {
public function sort(array &$sortArray, array $context): void {
$commenters = $this->retrieveCommentsInformation($context['itemType'], $context['itemId']);
if (count($commenters) === 0) {
return;
@ -76,6 +75,9 @@ class CommentersSorter implements ISorter {
}
}
/**
* @return array<string, array<string, int>>
*/
protected function retrieveCommentsInformation(string $type, string $id): array {
$comments = $this->commentsManager->getForObject($type, $id);
if (count($comments) === 0) {

22
apps/comments/lib/EventHandler.php
View file

@ -34,21 +34,15 @@ use OCP\Comments\ICommentsEventHandler;
* @package OCA\Comments
*/
class EventHandler implements ICommentsEventHandler {
/** @var ActivityListener */
private $activityListener;
/** @var NotificationListener */
private $notificationListener;
private ActivityListener $activityListener;
private NotificationListener $notificationListener;
public function __construct(ActivityListener $activityListener, NotificationListener $notificationListener) {
$this->activityListener = $activityListener;
$this->notificationListener = $notificationListener;
}
/**
* @param CommentsEvent $event
*/
public function handle(CommentsEvent $event) {
public function handle(CommentsEvent $event): void {
if ($event->getComment()->getObjectType() !== 'files') {
// this is a 'files'-specific Handler
return;
@ -73,17 +67,11 @@ class EventHandler implements ICommentsEventHandler {
}
}
/**
* @param CommentsEvent $event
*/
private function activityHandler(CommentsEvent $event) {
private function activityHandler(CommentsEvent $event): void {
$this->activityListener->commentEvent($event);
}
/**
* @param CommentsEvent $event
*/
private function notificationHandler(CommentsEvent $event) {
private function notificationHandler(CommentsEvent $event): void {
$this->notificationListener->evaluate($event);
}
}

13
apps/comments/lib/Listener/CommentsEntityEventListener.php
View file

@ -28,16 +28,25 @@ namespace OCA\Comments\Listener;
use OCP\Comments\CommentsEntityEvent;
use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventListener;
use OCP\Files\IRootFolder;
class CommentsEntityEventListener implements IEventListener {
private IRootFolder $rootFolder;
private ?string $userId;
public function __construct(IRootFolder $rootFolder, ?string $userId = null) {
$this->rootFolder = $rootFolder;
$this->userId = $userId;
}
public function handle(Event $event): void {
if (!($event instanceof CommentsEntityEvent)) {
// Unrelated
return;
}
$event->addEntityCollection('files', function ($name) {
$nodes = \OC::$server->getUserFolder()->getById((int)$name);
$event->addEntityCollection('files', function ($name): bool {
$nodes = $this->rootFolder->getUserFolder($this->userId)->getById((int)$name);
return !empty($nodes);
});
}

4
apps/comments/lib/MaxAutoCompleteResultsInitialState.php
View file

@ -31,9 +31,7 @@ use OCP\AppFramework\Services\InitialStateProvider;
use OCP\IConfig;
class MaxAutoCompleteResultsInitialState extends InitialStateProvider {
/** @var IConfig */
private $config;
private IConfig $config;
public function __construct(IConfig $config) {
$this->config = $config;

23
apps/comments/lib/Notification/Listener.php
View file

@ -27,15 +27,12 @@ use OCP\Comments\CommentsEvent;
use OCP\Comments\IComment;
use OCP\IUserManager;
use OCP\Notification\IManager;
use OCP\Notification\INotification;
class Listener {
protected IManager $notificationManager;
protected IUserManager $userManager;
/**
* Listener constructor.
*/
public function __construct(
IManager $notificationManager,
IUserManager $userManager
@ -44,10 +41,7 @@ class Listener {
$this->userManager = $userManager;
}
/**
* @param CommentsEvent $event
*/
public function evaluate(CommentsEvent $event) {
public function evaluate(CommentsEvent $event): void {
$comment = $event->getComment();
$mentions = $this->extractMentions($comment->getMentions());
@ -77,12 +71,9 @@ class Listener {
}
/**
* creates a notification instance and fills it with comment data
*
* @param IComment $comment
* @return \OCP\Notification\INotification
* Creates a notification instance and fills it with comment data
*/
public function instantiateNotification(IComment $comment) {
public function instantiateNotification(IComment $comment): INotification {
$notification = $this->notificationManager->createNotification();
$notification
->setApp('comments')
@ -94,12 +85,12 @@ class Listener {
}
/**
* flattens the mention array returned from comments to a list of user ids.
* Flattens the mention array returned from comments to a list of user ids.
*
* @param array $mentions
* @return string[] containing the mentions, e.g. ['alice', 'bob']
* @return list<string> containing the mentions, e.g. ['alice', 'bob']
*/
public function extractMentions(array $mentions) {
public function extractMentions(array $mentions): array {
if (empty($mentions)) {
return [];
}

13
apps/comments/lib/Search/CommentsSearchProvider.php
View file

@ -39,7 +39,6 @@ use function array_map;
use function pathinfo;
class CommentsSearchProvider implements IProvider {
private IUserManager $userManager;
private IL10N $l10n;
private IURLGenerator $urlGenerator;
@ -55,23 +54,14 @@ class CommentsSearchProvider implements IProvider {
$this->legacyProvider = $legacyProvider;
}
/**
* @inheritDoc
*/
public function getId(): string {
return 'comments';
}
/**
* @inheritDoc
*/
public function getName(): string {
return $this->l10n->t('Comments');
}
/**
* @inheritDoc
*/
public function getOrder(string $route, array $routeParameters): int {
if ($route === 'files.View.index') {
// Files first
@ -80,9 +70,6 @@ class CommentsSearchProvider implements IProvider {
return 10;
}
/**
* @inheritDoc
*/
public function search(IUser $user, ISearchQuery $query): SearchResult {
return SearchResult::complete(
$this->l10n->t('Comments'),

11
apps/comments/lib/Search/Result.php
View file

@ -58,10 +58,6 @@ class Result extends BaseResult {
public $fileName;
/**
* @param string $search
* @param IComment $comment
* @param string $authorName
* @param string $path
* @throws NotFoundException
* @deprecated 20.0.0
*/
@ -70,7 +66,7 @@ class Result extends BaseResult {
string $authorName,
string $path) {
parent::__construct(
(int) $comment->getId(),
$comment->getId(),
$comment->getMessage()
/* @todo , [link to file] */
);
@ -83,8 +79,6 @@ class Result extends BaseResult {
}
/**
* @param string $path
* @return string
* @throws NotFoundException
*/
protected function getVisiblePath(string $path): string {
@ -98,9 +92,6 @@ class Result extends BaseResult {
}
/**
* @param string $message
* @param string $search
* @return string
* @throws NotFoundException
*/
protected function getRelevantMessagePart(string $message, string $search): string {

4
apps/dav/lib/Comments/CommentNode.php
View file

@ -165,10 +165,8 @@ class CommentNode implements \Sabre\DAV\INode, \Sabre\DAV\IProperties {
/**
* Returns the last modification time, as a unix timestamp
*
* @return int
*/
public function getLastModified() {
public function getLastModified(): ?int {
return null;
}

4
apps/dav/lib/Comments/CommentsPlugin.php
View file

@ -176,7 +176,7 @@ class CommentsPlugin extends ServerPlugin {
}
if (!is_null($args['datetime'])) {
$args['datetime'] = new \DateTime($args['datetime']);
$args['datetime'] = new \DateTime((string)$args['datetime']);
}
$results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']);
@ -189,7 +189,7 @@ class CommentsPlugin extends ServerPlugin {
$responses[] = new Response(
$this->server->getBaseUri() . $nodePath,
[200 => $resultSet[0][200]],
200
'200'
);
}
}

17
apps/dav/lib/Comments/EntityTypeCollection.php
View file

@ -42,25 +42,14 @@ use Sabre\DAV\Exception\NotFound;
* @package OCA\DAV\Comments
*/
class EntityTypeCollection extends RootCollection {
protected LoggerInterface $logger;
/** @var IUserManager */
protected $userManager;
protected IUserManager $userManager;
/** @var \Closure */
protected $childExistsFunction;
/**
* @param string $name
* @param ICommentsManager $commentsManager
* @param IUserManager $userManager
* @param IUserSession $userSession
* @param LoggerInterface $logger
* @param \Closure $childExistsFunction
*/
public function __construct(
$name,
string $name,
ICommentsManager $commentsManager,
IUserManager $userManager,
IUserSession $userSession,
@ -68,7 +57,7 @@ class EntityTypeCollection extends RootCollection {
\Closure $childExistsFunction
) {
$name = trim($name);
if (empty($name) || !is_string($name)) {
if (empty($name)) {
throw new \InvalidArgumentException('"name" parameter must be non-empty string');
}
$this->name = $name;

28
apps/dav/lib/Comments/RootCollection.php
View file

@ -36,26 +36,14 @@ use Sabre\DAV\ICollection;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
class RootCollection implements ICollection {
/** @var EntityTypeCollection[]|null */
private $entityTypeCollections;
/** @var ICommentsManager */
protected $commentsManager;
/** @var string */
protected $name = 'comments';
private ?array $entityTypeCollections = null;
protected ICommentsManager $commentsManager;
protected string $name = 'comments';
protected LoggerInterface $logger;
/** @var IUserManager */
protected $userManager;
/** @var IUserSession */
protected $userSession;
/** @var EventDispatcherInterface */
protected $dispatcher;
protected IUserManager $userManager;
protected IUserSession $userSession;
protected EventDispatcherInterface $dispatcher;
public function __construct(
ICommentsManager $commentsManager,
@ -149,6 +137,7 @@ class RootCollection implements ICollection {
*/
public function getChildren() {
$this->initCollections();
assert(!is_null($this->entityTypeCollections));
return $this->entityTypeCollections;
}
@ -160,6 +149,7 @@ class RootCollection implements ICollection {
*/
public function childExists($name) {
$this->initCollections();
assert(!is_null($this->entityTypeCollections));
return isset($this->entityTypeCollections[$name]);
}
@ -196,7 +186,7 @@ class RootCollection implements ICollection {
/**
* Returns the last modification time, as a unix timestamp
*
* @return int
* @return ?int
*/
public function getLastModified() {
return null;

135
lib/private/Comments/Comment.php
View file

@ -30,7 +30,7 @@ use OCP\Comments\IllegalIDChangeException;
use OCP\Comments\MessageTooLongException;
class Comment implements IComment {
protected $data = [
protected array $data = [
'id' => '',
'parentId' => '0',
'topmostParentId' => '0',
@ -61,21 +61,20 @@ class Comment implements IComment {
}
/**
* returns the ID of the comment
* Returns the ID of the comment
*
* It may return an empty string, if the comment was not stored.
* It is expected that the concrete Comment implementation gives an ID
* by itself (e.g. after saving).
*
* @return string
* @since 9.0.0
*/
public function getId() {
public function getId(): string {
return $this->data['id'];
}
/**
* sets the ID of the comment and returns itself
* Sets the ID of the comment and returns itself
*
* It is only allowed to set the ID only, if the current id is an empty
* string (which means it is not stored in a database, storage or whatever
@ -87,7 +86,7 @@ class Comment implements IComment {
* @throws IllegalIDChangeException
* @since 9.0.0
*/
public function setId($id) {
public function setId($id): IComment {
if (!is_string($id)) {
throw new \InvalidArgumentException('String expected.');
}
@ -102,23 +101,21 @@ class Comment implements IComment {
}
/**
* returns the parent ID of the comment
* Returns the parent ID of the comment
*
* @return string
* @since 9.0.0
*/
public function getParentId() {
public function getParentId(): string {
return $this->data['parentId'];
}
/**
* sets the parent ID and returns itself
* Sets the parent ID and returns itself
*
* @param string $parentId
* @return IComment
* @since 9.0.0
*/
public function setParentId($parentId) {
public function setParentId($parentId): IComment {
if (!is_string($parentId)) {
throw new \InvalidArgumentException('String expected.');
}
@ -127,24 +124,22 @@ class Comment implements IComment {
}
/**
* returns the topmost parent ID of the comment
* Returns the topmost parent ID of the comment
*
* @return string
* @since 9.0.0
*/
public function getTopmostParentId() {
public function getTopmostParentId(): string {
return $this->data['topmostParentId'];
}
/**
* sets the topmost parent ID and returns itself
* Sets the topmost parent ID and returns itself
*
* @param string $id
* @return IComment
* @since 9.0.0
*/
public function setTopmostParentId($id) {
public function setTopmostParentId($id): IComment {
if (!is_string($id)) {
throw new \InvalidArgumentException('String expected.');
}
@ -153,23 +148,21 @@ class Comment implements IComment {
}
/**
* returns the number of children
* Returns the number of children
*
* @return int
* @since 9.0.0
*/
public function getChildrenCount() {
public function getChildrenCount(): int {
return $this->data['childrenCount'];
}
/**
* sets the number of children
* Sets the number of children
*
* @param int $count
* @return IComment
* @since 9.0.0
*/
public function setChildrenCount($count) {
public function setChildrenCount($count): IComment {
if (!is_int($count)) {
throw new \InvalidArgumentException('Integer expected.');
}
@ -178,12 +171,10 @@ class Comment implements IComment {
}
/**
* returns the message of the comment
*
* @return string
* Returns the message of the comment
* @since 9.0.0
*/
public function getMessage() {
public function getMessage(): string {
return $this->data['message'];
}
@ -192,11 +183,10 @@ class Comment implements IComment {
*
* @param string $message
* @param int $maxLength
* @return IComment
* @throws MessageTooLongException
* @since 9.0.0
*/
public function setMessage($message, $maxLength = self::MAX_MESSAGE_LENGTH) {
public function setMessage($message, $maxLength = self::MAX_MESSAGE_LENGTH): IComment {
if (!is_string($message)) {
throw new \InvalidArgumentException('String expected.');
}
@ -228,9 +218,9 @@ class Comment implements IComment {
* ]
*
*/
public function getMentions() {
public function getMentions(): array {
$ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"guest\/[a-f0-9]+\"|\"group\/[a-z0-9_\-@\.\' ]+\"|\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
if (!$ok || !isset($mentions[0]) || !is_array($mentions[0])) {
if (!$ok || !isset($mentions[0])) {
return [];
}
$mentionIds = array_unique($mentions[0]);
@ -252,23 +242,21 @@ class Comment implements IComment {
}
/**
* returns the verb of the comment
* Returns the verb of the comment
*
* @return string
* @since 9.0.0
*/
public function getVerb() {
public function getVerb(): string {
return $this->data['verb'];
}
/**
* sets the verb of the comment, e.g. 'comment' or 'like'
* Sets the verb of the comment, e.g. 'comment' or 'like'
*
* @param string $verb
* @return IComment
* @since 9.0.0
*/
public function setVerb($verb) {
public function setVerb($verb): IComment {
if (!is_string($verb) || !trim($verb)) {
throw new \InvalidArgumentException('Non-empty String expected.');
}
@ -277,34 +265,29 @@ class Comment implements IComment {
}
/**
* returns the actor type
*
* @return string
* Returns the actor type
* @since 9.0.0
*/
public function getActorType() {
public function getActorType(): string {
return $this->data['actorType'];
}
/**
* returns the actor ID
*
* @return string
* Returns the actor ID
* @since 9.0.0
*/
public function getActorId() {
public function getActorId(): string {
return $this->data['actorId'];
}
/**
* sets (overwrites) the actor type and id
* Sets (overwrites) the actor type and id
*
* @param string $actorType e.g. 'users'
* @param string $actorId e.g. 'zombie234'
* @return IComment
* @since 9.0.0
*/
public function setActor($actorType, $actorId) {
public function setActor($actorType, $actorId): IComment {
if (
!is_string($actorType) || !trim($actorType)
|| !is_string($actorId) || $actorId === ''
@ -317,76 +300,68 @@ class Comment implements IComment {
}
/**
* returns the creation date of the comment.
* Returns the creation date of the comment.
*
* If not explicitly set, it shall default to the time of initialization.
*
* @return \DateTime
* @since 9.0.0
* @throw \LogicException if creation date time is not set yet
*/
public function getCreationDateTime() {
public function getCreationDateTime(): \DateTime {
if (!isset($this->data['creationDT'])) {
throw new \LogicException('Cannot get creation date before setting one or writting to database');
}
return $this->data['creationDT'];
}
/**
* sets the creation date of the comment and returns itself
*
* @param \DateTime $timestamp
* @return IComment
* Sets the creation date of the comment and returns itself
* @since 9.0.0
*/
public function setCreationDateTime(\DateTime $timestamp) {
$this->data['creationDT'] = $timestamp;
public function setCreationDateTime(\DateTime $dateTime): IComment {
$this->data['creationDT'] = $dateTime;
return $this;
}
/**
* returns the DateTime of the most recent child, if set, otherwise null
*
* @return \DateTime|null
* Returns the DateTime of the most recent child, if set, otherwise null
* @since 9.0.0
*/
public function getLatestChildDateTime() {
public function getLatestChildDateTime(): ?\DateTime {
return $this->data['latestChildDT'];
}
/**
* @inheritDoc
*/
public function setLatestChildDateTime(?\DateTime $dateTime = null) {
public function setLatestChildDateTime(?\DateTime $dateTime = null): IComment {
$this->data['latestChildDT'] = $dateTime;
return $this;
}
/**
* returns the object type the comment is attached to
*
* @return string
* Returns the object type the comment is attached to
* @since 9.0.0
*/
public function getObjectType() {
public function getObjectType(): string {
return $this->data['objectType'];
}
/**
* returns the object id the comment is attached to
*
* @return string
* Returns the object id the comment is attached to
* @since 9.0.0
*/
public function getObjectId() {
public function getObjectId(): string {
return $this->data['objectId'];
}
/**
* sets (overwrites) the object of the comment
* Sets (overwrites) the object of the comment
*
* @param string $objectType e.g. 'files'
* @param string $objectId e.g. '16435'
* @return IComment
* @since 9.0.0
*/
public function setObject($objectType, $objectId) {
public function setObject($objectType, $objectId): IComment {
if (
!is_string($objectType) || !trim($objectType)
|| !is_string($objectId) || trim($objectId) === ''
@ -399,9 +374,7 @@ class Comment implements IComment {
}
/**
* returns the reference id of the comment
*
* @return string|null
* Returns the reference id of the comment
* @since 19.0.0
*/
public function getReferenceId(): ?string {
@ -409,10 +382,9 @@ class Comment implements IComment {
}
/**
* sets (overwrites) the reference id of the comment
* Sets (overwrites) the reference id of the comment
*
* @param string $referenceId e.g. sha256 hash sum
* @return IComment
* @since 19.0.0
*/
public function setReferenceId(?string $referenceId): IComment {
@ -463,9 +435,8 @@ class Comment implements IComment {
* database.
*
* @param array $data
* @return IComment
*/
protected function fromArray($data) {
protected function fromArray($data): IComment {
foreach (array_keys($data) as $key) {
// translate DB keys to internal setter names
$setter = 'set' . implode('', array_map('ucfirst', explode('_', $key)));

106
lib/private/Comments/Manager.php
View file

@ -47,35 +47,23 @@ use OCP\Util;
use Psr\Log\LoggerInterface;
class Manager implements ICommentsManager {
/** @var IDBConnection */
protected $dbConn;
/** @var LoggerInterface */
protected $logger;
/** @var IConfig */
protected $config;
/** @var ITimeFactory */
protected $timeFactory;
/** @var IEmojiHelper */
protected $emojiHelper;
/** @var IInitialStateService */
protected $initialStateService;
protected IDBConnection $dbConn;
protected LoggerInterface $logger;
protected IConfig $config;
protected ITimeFactory $timeFactory;
protected IEmojiHelper $emojiHelper;
protected IInitialStateService $initialStateService;
/** @var IComment[] */
protected $commentsCache = [];
protected array $commentsCache = [];
/** @var \Closure[] */
protected $eventHandlerClosures = [];
protected array $eventHandlerClosures = [];
/** @var ICommentsEventHandler[] */
protected $eventHandlers = [];
protected array $eventHandlers = [];
/** @var \Closure[] */
protected $displayNameResolvers = [];
protected array $displayNameResolvers = [];
public function __construct(IDBConnection $dbConn,
LoggerInterface $logger,
@ -96,9 +84,8 @@ class Manager implements ICommentsManager {
* IComment interface.
*
* @param array $data
* @return array
*/
protected function normalizeDatabaseData(array $data) {
protected function normalizeDatabaseData(array $data): array {
$data['id'] = (string)$data['id'];
$data['parent_id'] = (string)$data['parent_id'];
$data['topmost_parent_id'] = (string)$data['topmost_parent_id'];
@ -134,11 +121,6 @@ class Manager implements ICommentsManager {
return $data;
}
/**
* @param array $data
* @return IComment
*/
public function getCommentFromData(array $data): IComment {
return new Comment($this->normalizeDatabaseData($data));
}
@ -152,7 +134,7 @@ class Manager implements ICommentsManager {
* by parameter for convenience
* @throws \UnexpectedValueException
*/
protected function prepareCommentForDatabaseWrite(IComment $comment) {
protected function prepareCommentForDatabaseWrite(IComment $comment): IComment {
if (!$comment->getActorType()
|| $comment->getActorId() === ''
|| !$comment->getObjectType()
@ -172,7 +154,9 @@ class Manager implements ICommentsManager {
$comment->setLatestChildDateTime(null);
}
if (is_null($comment->getCreationDateTime())) {
try {
$comment->getCreationDateTime();
} catch(\LogicException $e) {
$comment->setCreationDateTime(new \DateTime());
}
@ -191,10 +175,9 @@ class Manager implements ICommentsManager {
* returns the topmost parent id of a given comment identified by ID
*
* @param string $id
* @return string
* @throws NotFoundException
*/
protected function determineTopmostParentId($id) {
protected function determineTopmostParentId($id): string {
$comment = $this->get($id);
if ($comment->getParentId() === '0') {
return $comment->getId();
@ -210,7 +193,7 @@ class Manager implements ICommentsManager {
* @param \DateTime $cDateTime the date time of the most recent child
* @throws NotFoundException
*/
protected function updateChildrenInformation($id, \DateTime $cDateTime) {
protected function updateChildrenInformation($id, \DateTime $cDateTime): void {
$qb = $this->dbConn->getQueryBuilder();
$query = $qb->select($qb->func()->count('id'))
->from('comments')
@ -237,7 +220,7 @@ class Manager implements ICommentsManager {
* @param string $id
* @throws \InvalidArgumentException
*/
protected function checkRoleParameters($role, $type, $id) {
protected function checkRoleParameters($role, $type, $id): void {
if (
!is_string($type) || empty($type)
|| !is_string($id) || empty($id)
@ -248,10 +231,8 @@ class Manager implements ICommentsManager {
/**
* run-time caches a comment
*
* @param IComment $comment
*/
protected function cache(IComment $comment) {
protected function cache(IComment $comment): void {
$id = $comment->getId();
if (empty($id)) {
return;
@ -264,7 +245,7 @@ class Manager implements ICommentsManager {
*
* @param mixed $id the comment's id
*/
protected function uncache($id) {
protected function uncache($id): void {
$id = (string)$id;
if (isset($this->commentsCache[$id])) {
unset($this->commentsCache[$id]);
@ -275,12 +256,11 @@ class Manager implements ICommentsManager {
* returns a comment instance
*
* @param string $id the ID of the comment
* @return IComment
* @throws NotFoundException
* @throws \InvalidArgumentException
* @since 9.0.0
*/
public function get($id) {
public function get($id): IComment {
if ((int)$id === 0) {
throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
}
@ -309,35 +289,9 @@ class Manager implements ICommentsManager {
}
/**
* returns the comment specified by the id and all it's child comments.
* At this point of time, we do only support one level depth.
*
* @param string $id
* @param int $limit max number of entries to return, 0 returns all
* @param int $offset the start entry
* @return array
* @since 9.0.0
*
* The return array looks like this
* [
* 'comment' => IComment, // root comment
* 'replies' =>
* [
* 0 =>
* [
* 'comment' => IComment,
* 'replies' => []
* ]
* 1 =>
* [
* 'comment' => IComment,
* 'replies'=> []
* ],
* …
* ]
* ]
* @inheritDoc
*/
public function getTree($id, $limit = 0, $offset = 0) {
public function getTree($id, $limit = 0, $offset = 0): array {
$tree = [];
$tree['comment'] = $this->get($id);
$tree['replies'] = [];
@ -382,7 +336,7 @@ class Manager implements ICommentsManager {
* @param int $offset optional, starting point
* @param \DateTime $notOlderThan optional, timestamp of the oldest comments
* that may be returned
* @return IComment[]
* @return list<IComment>
* @since 9.0.0
*/
public function getForObject(
@ -434,8 +388,7 @@ class Manager implements ICommentsManager {
* @param int $limit optional, number of maximum comments to be returned. if
* set to 0, all comments are returned.
* @param bool $includeLastKnown
* @return IComment[]
* @return array
* @return list<IComment>
*/
public function getForObjectSince(
string $objectType,
@ -465,7 +418,7 @@ class Manager implements ICommentsManager {
* @param int $limit optional, number of maximum comments to be returned. if
* set to 0, all comments are returned.
* @param bool $includeLastKnown
* @return IComment[]
* @return list<IComment>
*/
public function getCommentsWithVerbForObjectSinceComment(
string $objectType,
@ -565,11 +518,10 @@ class Manager implements ICommentsManager {
* @param string $objectType the object type, e.g. 'files'
* @param string $objectId the id of the object
* @param int $id the comment to look for
* @return Comment|null
*/
protected function getLastKnownComment(string $objectType,
string $objectId,
int $id) {
int $id): ?IComment {
$query = $this->dbConn->getQueryBuilder();
$query->select('*')
->from('comments')
@ -599,7 +551,7 @@ class Manager implements ICommentsManager {
* @param string $verb Limit the verb of the comment
* @param int $offset
* @param int $limit
* @return IComment[]
* @return list<IComment>
*/
public function search(string $search, string $objectType, string $objectId, string $verb, int $offset, int $limit = 50): array {
$objectIds = [];
@ -618,7 +570,7 @@ class Manager implements ICommentsManager {
* @param string $verb Limit the verb of the comment
* @param int $offset
* @param int $limit
* @return IComment[]
* @return list<IComment>
*/
public function searchForObjects(string $search, string $objectType, array $objectIds, string $verb, int $offset, int $limit = 50): array {
$query = $this->dbConn->getQueryBuilder();

12
lib/public/Comments/ICommentsManager.php
View file

@ -61,12 +61,12 @@ interface ICommentsManager {
public function get($id);
/**
* returns the comment specified by the id and all it's child comments
* Returns the comment specified by the id and all it's child comments
*
* @param string $id
* @param int $limit max number of entries to return, 0 returns all
* @param int $offset the start entry
* @return array
* @return array{comment: IComment, replies: list<array{comment: IComment, replies: array<empty, empty>}>}
* @since 9.0.0
*
* The return array looks like this
@ -110,7 +110,7 @@ interface ICommentsManager {
* @param int $offset optional, starting point
* @param \DateTime|null $notOlderThan optional, timestamp of the oldest comments
* that may be returned
* @return IComment[]
* @return list<IComment>
* @since 9.0.0
*/
public function getForObject(
@ -129,7 +129,7 @@ interface ICommentsManager {
* @param int $limit optional, number of maximum comments to be returned. if
* set to 0, all comments are returned.
* @param bool $includeLastKnown
* @return IComment[]
* @return list<IComment>
* @since 14.0.0
* @deprecated 24.0.0 - Use getCommentsWithVerbForObjectSinceComment instead
*/
@ -151,7 +151,7 @@ interface ICommentsManager {
* @param int $limit optional, number of maximum comments to be returned. if
* set to 0, all comments are returned.
* @param bool $includeLastKnown
* @return IComment[]
* @return list<IComment>
* @since 24.0.0
*/
public function getCommentsWithVerbForObjectSinceComment(
@ -173,7 +173,7 @@ interface ICommentsManager {
* @param string $verb Limit the verb of the comment
* @param int $offset
* @param int $limit
* @return IComment[]
* @return list<IComment>
* @since 14.0.0
*/
public function search(string $search, string $objectType, string $objectId, string $verb, int $offset, int $limit = 50): array;