Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor comments app #39236

Merged
merged 2 commits into from Sep 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 4 additions & 6 deletions apps/comments/lib/Activity/Filter.php
Expand Up @@ -27,12 +27,10 @@
use OCP\IURLGenerator;

class Filter implements IFilter {
protected IL10N $l;
protected IURLGenerator $url;

public function __construct(IL10N $l, IURLGenerator $url) {
$this->l = $l;
$this->url = $url;
public function __construct(
protected IL10N $l,
protected IURLGenerator $url,
) {
}

public function getIdentifier(): string {
Expand Down
30 changes: 8 additions & 22 deletions apps/comments/lib/Activity/Listener.php
Expand Up @@ -35,28 +35,14 @@
use OCP\Share\IShareHelper;

class Listener {
protected IManager $activityManager;
protected IUserSession $session;
protected IAppManager $appManager;
protected IMountProviderCollection $mountCollection;
protected IRootFolder $rootFolder;
protected IShareHelper $shareHelper;

/**
* Listener constructor.
*/
public function __construct(IManager $activityManager,
IUserSession $session,
IAppManager $appManager,
IMountProviderCollection $mountCollection,
IRootFolder $rootFolder,
IShareHelper $shareHelper) {
$this->activityManager = $activityManager;
$this->session = $session;
$this->appManager = $appManager;
$this->mountCollection = $mountCollection;
$this->rootFolder = $rootFolder;
$this->shareHelper = $shareHelper;
public function __construct(
protected IManager $activityManager,
protected IUserSession $session,
protected IAppManager $appManager,
protected IMountProviderCollection $mountCollection,
protected IRootFolder $rootFolder,
protected IShareHelper $shareHelper,
) {
}

public function commentEvent(CommentsEvent $event): void {
Expand Down
22 changes: 9 additions & 13 deletions apps/comments/lib/Activity/Provider.php
Expand Up @@ -35,19 +35,15 @@
use OCP\L10N\IFactory;

class Provider implements IProvider {
protected IFactory $languageFactory;
protected ?IL10N $l = null;
protected IUrlGenerator $url;
protected ICommentsManager $commentsManager;
protected IUserManager $userManager;
protected IManager $activityManager;

public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) {
$this->languageFactory = $languageFactory;
$this->url = $url;
$this->commentsManager = $commentsManager;
$this->userManager = $userManager;
$this->activityManager = $activityManager;

public function __construct(
protected IFactory $languageFactory,
protected IURLGenerator $url,
protected ICommentsManager $commentsManager,
protected IUserManager $userManager,
protected IManager $activityManager,
) {
}

/**
Expand Down Expand Up @@ -168,7 +164,7 @@ protected function parseMessage(IEvent $event): void {
return;
}

$commentId = isset($messageParameters['commentId']) ? $messageParameters['commentId'] : $messageParameters[0];
$commentId = $messageParameters['commentId'] ?? $messageParameters[0];

try {
$comment = $this->commentsManager->get((string) $commentId);
Expand Down
7 changes: 3 additions & 4 deletions apps/comments/lib/Activity/Setting.php
Expand Up @@ -26,10 +26,9 @@
use OCP\IL10N;

class Setting implements ISetting {
protected IL10N $l;

public function __construct(IL10N $l) {
$this->l = $l;
public function __construct(
protected IL10N $l,
) {
}

public function getIdentifier(): string {
Expand Down
7 changes: 3 additions & 4 deletions apps/comments/lib/Collaboration/CommentersSorter.php
Expand Up @@ -27,10 +27,9 @@
use OCP\Comments\ICommentsManager;

class CommentersSorter implements ISorter {
private ICommentsManager $commentsManager;

public function __construct(ICommentsManager $commentsManager) {
$this->commentsManager = $commentsManager;
public function __construct(
private ICommentsManager $commentsManager,
) {
}

public function getId(): string {
Expand Down
25 changes: 5 additions & 20 deletions apps/comments/lib/Controller/NotificationsController.php
Expand Up @@ -43,31 +43,16 @@
*/
#[IgnoreOpenAPI]
class NotificationsController extends Controller {

protected IRootFolder $rootFolder;
protected ICommentsManager $commentsManager;
protected IURLGenerator $urlGenerator;
protected IManager $notificationManager;
protected IUserSession $userSession;

/**
* NotificationsController constructor.
*/
public function __construct(
string $appName,
IRequest $request,
ICommentsManager $commentsManager,
IRootFolder $rootFolder,
IURLGenerator $urlGenerator,
IManager $notificationManager,
IUserSession $userSession
protected ICommentsManager $commentsManager,
protected IRootFolder $rootFolder,
protected IURLGenerator $urlGenerator,
protected IManager $notificationManager,
protected IUserSession $userSession
) {
parent::__construct($appName, $request);
$this->commentsManager = $commentsManager;
$this->rootFolder = $rootFolder;
$this->urlGenerator = $urlGenerator;
$this->notificationManager = $notificationManager;
$this->userSession = $userSession;
}

/**
Expand Down
10 changes: 4 additions & 6 deletions apps/comments/lib/EventHandler.php
Expand Up @@ -34,12 +34,10 @@
* @package OCA\Comments
*/
class EventHandler implements ICommentsEventHandler {
private ActivityListener $activityListener;
private NotificationListener $notificationListener;

public function __construct(ActivityListener $activityListener, NotificationListener $notificationListener) {
$this->activityListener = $activityListener;
$this->notificationListener = $notificationListener;
public function __construct(
private ActivityListener $activityListener,
private NotificationListener $notificationListener,
) {
}

public function handle(CommentsEvent $event): void {
Expand Down
10 changes: 4 additions & 6 deletions apps/comments/lib/Listener/CommentsEntityEventListener.php
Expand Up @@ -31,12 +31,10 @@
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 __construct(
private IRootFolder $rootFolder,
private ?string $userId = null,
) {
}

public function handle(Event $event): void {
Expand Down
8 changes: 3 additions & 5 deletions apps/comments/lib/Listener/LoadSidebarScripts.php
Expand Up @@ -34,11 +34,9 @@
use OCP\Util;

class LoadSidebarScripts implements IEventListener {

private ICommentsManager $commentsManager;

public function __construct(ICommentsManager $commentsManager) {
$this->commentsManager = $commentsManager;
public function __construct(
private ICommentsManager $commentsManager,
) {
}

public function handle(Event $event): void {
Expand Down
7 changes: 3 additions & 4 deletions apps/comments/lib/MaxAutoCompleteResultsInitialState.php
Expand Up @@ -31,10 +31,9 @@
use OCP\IConfig;

class MaxAutoCompleteResultsInitialState extends InitialStateProvider {
private IConfig $config;

public function __construct(IConfig $config) {
$this->config = $config;
public function __construct(
private IConfig $config,
) {
}

public function getKey(): string {
Expand Down
9 changes: 2 additions & 7 deletions apps/comments/lib/Notification/Listener.php
Expand Up @@ -30,15 +30,10 @@
use OCP\Notification\INotification;

class Listener {
protected IManager $notificationManager;
protected IUserManager $userManager;

public function __construct(
IManager $notificationManager,
IUserManager $userManager
protected IManager $notificationManager,
protected IUserManager $userManager
) {
$this->notificationManager = $notificationManager;
$this->userManager = $userManager;
}

public function evaluate(CommentsEvent $event): void {
Expand Down
21 changes: 5 additions & 16 deletions apps/comments/lib/Notification/Notifier.php
Expand Up @@ -36,24 +36,13 @@
use OCP\Notification\INotifier;

class Notifier implements INotifier {
protected IFactory $l10nFactory;
protected IRootFolder $rootFolder;
protected ICommentsManager $commentsManager;
protected IURLGenerator $url;
protected IUserManager $userManager;

public function __construct(
IFactory $l10nFactory,
IRootFolder $rootFolder,
ICommentsManager $commentsManager,
IURLGenerator $url,
IUserManager $userManager
protected IFactory $l10nFactory,
protected IRootFolder $rootFolder,
protected ICommentsManager $commentsManager,
protected IURLGenerator $url,
protected IUserManager $userManager
) {
$this->l10nFactory = $l10nFactory;
$this->rootFolder = $rootFolder;
$this->commentsManager = $commentsManager;
$this->url = $url;
$this->userManager = $userManager;
}

/**
Expand Down
21 changes: 7 additions & 14 deletions apps/comments/lib/Search/CommentsSearchProvider.php
Expand Up @@ -39,19 +39,12 @@
use function pathinfo;

class CommentsSearchProvider implements IProvider {
private IUserManager $userManager;
private IL10N $l10n;
private IURLGenerator $urlGenerator;
private LegacyProvider $legacyProvider;

public function __construct(IUserManager $userManager,
IL10N $l10n,
IURLGenerator $urlGenerator,
LegacyProvider $legacyProvider) {
$this->userManager = $userManager;
$this->l10n = $l10n;
$this->urlGenerator = $urlGenerator;
$this->legacyProvider = $legacyProvider;
public function __construct(
private IUserManager $userManager,
private IL10N $l10n,
private IURLGenerator $urlGenerator,
private LegacyProvider $legacyProvider,
) {
}

public function getId(): string {
Expand Down Expand Up @@ -84,7 +77,7 @@ public function search(IUser $user, ISearchQuery $query): SearchResult {
$avatarUrl,
$result->name,
$path,
$this->urlGenerator->linkToRouteAbsolute('files.view.index',[
$this->urlGenerator->linkToRouteAbsolute('files.view.index', [
'dir' => $pathInfo['dirname'],
'scrollto' => $pathInfo['basename'],
]),
Expand Down
1 change: 0 additions & 1 deletion apps/comments/lib/Search/LegacyProvider.php
Expand Up @@ -35,7 +35,6 @@
use function count;

class LegacyProvider extends Provider {

/**
* Search for $query
*
Expand Down
14 changes: 8 additions & 6 deletions apps/comments/lib/Search/Result.php
Expand Up @@ -47,7 +47,7 @@ class Result extends BaseResult {
/**
* @deprecated 20.0.0
*/
public $authorName;
public string $authorName;
/**
* @deprecated 20.0.0
*/
Expand All @@ -61,14 +61,16 @@ class Result extends BaseResult {
* @throws NotFoundException
* @deprecated 20.0.0
*/
public function __construct(string $search,
IComment $comment,
string $authorName,
string $path) {
public function __construct(
string $search,
IComment $comment,
string $authorName,
string $path,
) {
parent::__construct(
$comment->getId(),
$comment->getMessage()
/* @todo , [link to file] */
/* @todo , [link to file] */
);

$this->comment = $this->getRelevantMessagePart($comment->getMessage(), $search);
Expand Down