nextcloud / server

lib/public/Notification/INotifier.php

Indentation +29 added lines, -29 removed lines

@@ -12,35 +12,35 @@
 
 #[Implementable(since: '9.0.0')]
 interface INotifier {
-	/**
-	 * Identifier of the notifier, only use [a-z0-9_]
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getID(): string;
+    /**
+     * Identifier of the notifier, only use [a-z0-9_]
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getID(): string;
 
-	/**
-	 * Human-readable name describing the notifier
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getName(): string;
+    /**
+     * Human-readable name describing the notifier
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getName(): string;
 
-	/**
-	 * @param INotification $notification
-	 * @param string $languageCode The code of the language that should be used to prepare the notification
-	 * @return INotification
-	 * @throws UnknownNotificationException When the notification was not prepared by a notifier
-	 * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
-	 * @throws IncompleteParsedNotificationException Only to be thrown by the {@see IManager}
-	 * @since 9.0.0
-	 * @since 30.0.0 Notifiers should throw {@see UnknownNotificationException} instead of \InvalidArgumentException
-	 *  when they did not handle the notification. Throwing \InvalidArgumentException directly is deprecated and will
-	 *  be logged as an error in Nextcloud 39.
-	 * @since 30.0.0 Throws {@see IncompleteParsedNotificationException} when not all required fields
-	 *  are set at the end of the manager or after a INotifier that claimed to have parsed the notification.
-	 */
-	public function prepare(INotification $notification, string $languageCode): INotification;
+    /**
+     * @param INotification $notification
+     * @param string $languageCode The code of the language that should be used to prepare the notification
+     * @return INotification
+     * @throws UnknownNotificationException When the notification was not prepared by a notifier
+     * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
+     * @throws IncompleteParsedNotificationException Only to be thrown by the {@see IManager}
+     * @since 9.0.0
+     * @since 30.0.0 Notifiers should throw {@see UnknownNotificationException} instead of \InvalidArgumentException
+     *  when they did not handle the notification. Throwing \InvalidArgumentException directly is deprecated and will
+     *  be logged as an error in Nextcloud 39.
+     * @since 30.0.0 Throws {@see IncompleteParsedNotificationException} when not all required fields
+     *  are set at the end of the manager or after a INotifier that claimed to have parsed the notification.
+     */
+    public function prepare(INotification $notification, string $languageCode): INotification;
 }

lib/public/Calendar/CalendarEventStatus.php

Indentation +3 added lines, -3 removed lines

@@ -11,7 +11,7 @@
 
 #[Listenable(since: '32.0.0')]
 enum CalendarEventStatus: string {
-	case TENTATIVE = 'TENTATIVE';
-	case CONFIRMED = 'CONFIRMED';
-	case CANCELLED = 'CANCELLED';
+    case TENTATIVE = 'TENTATIVE';
+    case CONFIRMED = 'CONFIRMED';
+    case CANCELLED = 'CANCELLED';
 };

lib/public/AppFramework/Attribute/ExceptionalImplementable.php

Indentation +11 added lines, -11 removed lines

@@ -22,17 +22,17 @@
 #[Consumable(since: '32.0.0')]
 #[Implementable(since: '32.0.0')]
 class ExceptionalImplementable {
-	public function __construct(
-		protected string $app,
-		protected ?string $class = null,
-	) {
-	}
+    public function __construct(
+        protected string $app,
+        protected ?string $class = null,
+    ) {
+    }
 
-	public function getApp(): string {
-		return $this->app;
-	}
+    public function getApp(): string {
+        return $this->app;
+    }
 
-	public function getClass(): ?string {
-		return $this->class;
-	}
+    public function getClass(): ?string {
+        return $this->class;
+    }
 }

lib/public/AppFramework/Attribute/ASince.php

Indentation +12 added lines, -12 removed lines

@@ -18,17 +18,17 @@
  */
 #[Consumable(since: '32.0.0')]
 abstract class ASince {
-	/**
-	 * @param string $since For shipped apps and server code such as core/ and lib/,
-	 *                      this should be the server version. For other apps it
-	 *                      should be the semantic app version.
-	 */
-	public function __construct(
-		protected string $since,
-	) {
-	}
+    /**
+     * @param string $since For shipped apps and server code such as core/ and lib/,
+     *                      this should be the server version. For other apps it
+     *                      should be the semantic app version.
+     */
+    public function __construct(
+        protected string $since,
+    ) {
+    }
 
-	public function getSince(): string {
-		return $this->since;
-	}
+    public function getSince(): string {
+        return $this->since;
+    }
 }

build/psalm/OcpSinceChecker.php

Indentation +196 added lines, -196 removed lines

@@ -16,200 +16,200 @@
 use Psalm\Plugin\EventHandler\Event\AfterClassLikeVisitEvent;
 
 class OcpSinceChecker implements Psalm\Plugin\EventHandler\AfterClassLikeVisitInterface {
-	public static function afterClassLikeVisit(AfterClassLikeVisitEvent $event): void {
-		$classLike = $event->getStmt();
-		$statementsSource = $event->getStatementsSource();
-
-		if (!str_contains($statementsSource->getFilePath(), '/lib/public/')) {
-			return;
-		}
-
-		$isTesting = str_contains($statementsSource->getFilePath(), '/lib/public/Notification/')
-			|| str_contains($statementsSource->getFilePath(), 'CalendarEventStatus');
-
-		if ($isTesting) {
-			self::checkStatementAttributes($classLike, $statementsSource);
-		} else {
-			self::checkClassComment($classLike, $statementsSource);
-		}
-
-		foreach ($classLike->stmts as $stmt) {
-			if ($stmt instanceof ClassConst) {
-				self::checkStatementComment($stmt, $statementsSource, 'constant');
-			}
-
-			if ($stmt instanceof ClassMethod) {
-				self::checkStatementComment($stmt, $statementsSource, 'method');
-			}
-
-			if ($stmt instanceof EnumCase) {
-				if ($isTesting) {
-					self::checkStatementAttributes($classLike, $statementsSource);
-				} else {
-					self::checkStatementComment($stmt, $statementsSource, 'enum');
-				}
-			}
-		}
-	}
-
-	private static function checkStatementAttributes(ClassLike $stmt, FileSource $statementsSource): void {
-		$hasAppFrameworkAttribute = false;
-		$mustBeConsumable = false;
-		$isConsumable = false;
-		foreach ($stmt->attrGroups as $attrGroup) {
-			foreach ($attrGroup->attrs as $attr) {
-				if (in_array($attr->name->getLast(), [
-					'Catchable',
-					'Consumable',
-					'Dispatchable',
-					'Implementable',
-					'Listenable',
-					'Throwable',
-				], true)) {
-					$hasAppFrameworkAttribute = true;
-					self::checkAttributeHasValidSinceVersion($attr, $statementsSource);
-				}
-				if (in_array($attr->name->getLast(), [
-					'Catchable',
-					'Consumable',
-					'Listenable',
-				], true)) {
-					$isConsumable = true;
-				}
-				if ($attr->name->getLast() === 'ExceptionalImplementable') {
-					$mustBeConsumable = true;
-				}
-			}
-		}
-
-		if ($mustBeConsumable && !$isConsumable) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					'Attribute OCP\\AppFramework\\Attribute\\ExceptionalImplementable is only valid on classes that also have OCP\\AppFramework\\Attribute\\Consumable',
-					new CodeLocation($statementsSource, $stmt)
-				)
-			);
-		}
-
-		if (!$hasAppFrameworkAttribute) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					'At least one of the OCP\\AppFramework\\Attribute attributes is required',
-					new CodeLocation($statementsSource, $stmt)
-				)
-			);
-		}
-	}
-
-	private static function checkClassComment(ClassLike $stmt, FileSource $statementsSource): void {
-		$docblock = $stmt->getDocComment();
-
-		if ($docblock === null) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					'PHPDoc is required for classes/interfaces in OCP.',
-					new CodeLocation($statementsSource, $stmt)
-				)
-			);
-			return;
-		}
-
-		try {
-			$parsedDocblock = DocComment::parsePreservingLength($docblock);
-		} catch (DocblockParseException $e) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					$e->getMessage(),
-					new CodeLocation($statementsSource, $stmt)
-				)
-			);
-			return;
-		}
-
-		if (!isset($parsedDocblock->tags['since'])) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					'@since is required for classes/interfaces in OCP.',
-					new CodeLocation($statementsSource, $stmt)
-				)
-			);
-		}
-
-		if (isset($parsedDocblock->tags['depreacted'])) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					'Typo in @deprecated for classes/interfaces in OCP.',
-					new CodeLocation($statementsSource, $stmt)
-				)
-			);
-		}
-	}
-
-	private static function checkStatementComment(Stmt $stmt, FileSource $statementsSource, string $type): void {
-		$docblock = $stmt->getDocComment();
-
-		if ($docblock === null) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					'PHPDoc is required for ' . $type . 's in OCP.',
-					new CodeLocation($statementsSource, $stmt)
-				),
-			);
-			return;
-		}
-
-		try {
-			$parsedDocblock = DocComment::parsePreservingLength($docblock);
-		} catch (DocblockParseException $e) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					$e->getMessage(),
-					new CodeLocation($statementsSource, $stmt)
-				)
-			);
-			return;
-		}
-
-		if (!isset($parsedDocblock->tags['since'])) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					'@since is required for ' . $type . 's in OCP.',
-					new CodeLocation($statementsSource, $stmt)
-				)
-			);
-		}
-
-		if (isset($parsedDocblock->tags['depreacted'])) {
-			IssueBuffer::maybeAdd(
-				new InvalidDocblock(
-					'Typo in @deprecated for ' . $type . ' in OCP.',
-					new CodeLocation($statementsSource, $stmt)
-				)
-			);
-		}
-	}
-
-	private static function checkAttributeHasValidSinceVersion(\PhpParser\Node\Attribute $stmt, FileSource $statementsSource): void {
-		foreach ($stmt->args as $arg) {
-			if ($arg->name?->name === 'since') {
-				if (!$arg->value instanceof \PhpParser\Node\Scalar\String_) {
-					IssueBuffer::maybeAdd(
-						new InvalidDocblock(
-							'Attribute since argument is not a valid version string',
-							new CodeLocation($statementsSource, $stmt)
-						)
-					);
-				} else {
-					if (!preg_match('/^[1-9][0-9]*(\.[0-9]+){0,3}$/', $arg->value->value)) {
-						IssueBuffer::maybeAdd(
-							new InvalidDocblock(
-								'Attribute since argument is not a valid version string',
-								new CodeLocation($statementsSource, $stmt)
-							)
-						);
-					}
-				}
-			}
-		}
-	}
+    public static function afterClassLikeVisit(AfterClassLikeVisitEvent $event): void {
+        $classLike = $event->getStmt();
+        $statementsSource = $event->getStatementsSource();
+
+        if (!str_contains($statementsSource->getFilePath(), '/lib/public/')) {
+            return;
+        }
+
+        $isTesting = str_contains($statementsSource->getFilePath(), '/lib/public/Notification/')
+            || str_contains($statementsSource->getFilePath(), 'CalendarEventStatus');
+
+        if ($isTesting) {
+            self::checkStatementAttributes($classLike, $statementsSource);
+        } else {
+            self::checkClassComment($classLike, $statementsSource);
+        }
+
+        foreach ($classLike->stmts as $stmt) {
+            if ($stmt instanceof ClassConst) {
+                self::checkStatementComment($stmt, $statementsSource, 'constant');
+            }
+
+            if ($stmt instanceof ClassMethod) {
+                self::checkStatementComment($stmt, $statementsSource, 'method');
+            }
+
+            if ($stmt instanceof EnumCase) {
+                if ($isTesting) {
+                    self::checkStatementAttributes($classLike, $statementsSource);
+                } else {
+                    self::checkStatementComment($stmt, $statementsSource, 'enum');
+                }
+            }
+        }
+    }
+
+    private static function checkStatementAttributes(ClassLike $stmt, FileSource $statementsSource): void {
+        $hasAppFrameworkAttribute = false;
+        $mustBeConsumable = false;
+        $isConsumable = false;
+        foreach ($stmt->attrGroups as $attrGroup) {
+            foreach ($attrGroup->attrs as $attr) {
+                if (in_array($attr->name->getLast(), [
+                    'Catchable',
+                    'Consumable',
+                    'Dispatchable',
+                    'Implementable',
+                    'Listenable',
+                    'Throwable',
+                ], true)) {
+                    $hasAppFrameworkAttribute = true;
+                    self::checkAttributeHasValidSinceVersion($attr, $statementsSource);
+                }
+                if (in_array($attr->name->getLast(), [
+                    'Catchable',
+                    'Consumable',
+                    'Listenable',
+                ], true)) {
+                    $isConsumable = true;
+                }
+                if ($attr->name->getLast() === 'ExceptionalImplementable') {
+                    $mustBeConsumable = true;
+                }
+            }
+        }
+
+        if ($mustBeConsumable && !$isConsumable) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    'Attribute OCP\\AppFramework\\Attribute\\ExceptionalImplementable is only valid on classes that also have OCP\\AppFramework\\Attribute\\Consumable',
+                    new CodeLocation($statementsSource, $stmt)
+                )
+            );
+        }
+
+        if (!$hasAppFrameworkAttribute) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    'At least one of the OCP\\AppFramework\\Attribute attributes is required',
+                    new CodeLocation($statementsSource, $stmt)
+                )
+            );
+        }
+    }
+
+    private static function checkClassComment(ClassLike $stmt, FileSource $statementsSource): void {
+        $docblock = $stmt->getDocComment();
+
+        if ($docblock === null) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    'PHPDoc is required for classes/interfaces in OCP.',
+                    new CodeLocation($statementsSource, $stmt)
+                )
+            );
+            return;
+        }
+
+        try {
+            $parsedDocblock = DocComment::parsePreservingLength($docblock);
+        } catch (DocblockParseException $e) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    $e->getMessage(),
+                    new CodeLocation($statementsSource, $stmt)
+                )
+            );
+            return;
+        }
+
+        if (!isset($parsedDocblock->tags['since'])) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    '@since is required for classes/interfaces in OCP.',
+                    new CodeLocation($statementsSource, $stmt)
+                )
+            );
+        }
+
+        if (isset($parsedDocblock->tags['depreacted'])) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    'Typo in @deprecated for classes/interfaces in OCP.',
+                    new CodeLocation($statementsSource, $stmt)
+                )
+            );
+        }
+    }
+
+    private static function checkStatementComment(Stmt $stmt, FileSource $statementsSource, string $type): void {
+        $docblock = $stmt->getDocComment();
+
+        if ($docblock === null) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    'PHPDoc is required for ' . $type . 's in OCP.',
+                    new CodeLocation($statementsSource, $stmt)
+                ),
+            );
+            return;
+        }
+
+        try {
+            $parsedDocblock = DocComment::parsePreservingLength($docblock);
+        } catch (DocblockParseException $e) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    $e->getMessage(),
+                    new CodeLocation($statementsSource, $stmt)
+                )
+            );
+            return;
+        }
+
+        if (!isset($parsedDocblock->tags['since'])) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    '@since is required for ' . $type . 's in OCP.',
+                    new CodeLocation($statementsSource, $stmt)
+                )
+            );
+        }
+
+        if (isset($parsedDocblock->tags['depreacted'])) {
+            IssueBuffer::maybeAdd(
+                new InvalidDocblock(
+                    'Typo in @deprecated for ' . $type . ' in OCP.',
+                    new CodeLocation($statementsSource, $stmt)
+                )
+            );
+        }
+    }
+
+    private static function checkAttributeHasValidSinceVersion(\PhpParser\Node\Attribute $stmt, FileSource $statementsSource): void {
+        foreach ($stmt->args as $arg) {
+            if ($arg->name?->name === 'since') {
+                if (!$arg->value instanceof \PhpParser\Node\Scalar\String_) {
+                    IssueBuffer::maybeAdd(
+                        new InvalidDocblock(
+                            'Attribute since argument is not a valid version string',
+                            new CodeLocation($statementsSource, $stmt)
+                        )
+                    );
+                } else {
+                    if (!preg_match('/^[1-9][0-9]*(\.[0-9]+){0,3}$/', $arg->value->value)) {
+                        IssueBuffer::maybeAdd(
+                            new InvalidDocblock(
+                                'Attribute since argument is not a valid version string',
+                                new CodeLocation($statementsSource, $stmt)
+                            )
+                        );
+                    }
+                }
+            }
+        }
+    }
 }