Add @return non-empty-string annotations to AbstractUid and relevant …

…functions
symfony · derrabus · Dec 7, 2024 · Dec 3, 2024 · Dec 7, 2024 · 41dacf7f2e09ce8efaf5535d6fd3f44f8a6a9de2
commit 41dacf7f2e09ce8efaf5535d6fd3f44f8a6a9de2
diff --git a/src/Symfony/Component/Uid/AbstractUid.php b/src/Symfony/Component/Uid/AbstractUid.php
@@ -85,13 +85,17 @@ public static function fromRfc4122(string $uid): static

    /**
     * Returns the identifier as a raw binary string.
+     *
+     * @return non-empty-string
     */
    abstract public function toBinary(): string;

    /**
     * Returns the identifier as a base58 case-sensitive string.
     *
     * @example 2AifFTC3zXgZzK5fPrrprL (len=22)
+     *
+     * @return non-empty-string
     */
    public function toBase58(): string
    {
@@ -104,6 +108,8 @@ public function toBase58(): string
     * @see https://tools.ietf.org/html/rfc4648#section-6
     *
     * @example 09EJ0S614A9FXVG9C5537Q9ZE1 (len=26)
+     *
+     * @return non-empty-string
     */
    public function toBase32(): string
    {
@@ -127,6 +133,8 @@ public function toBase32(): string
     * @see https://datatracker.ietf.org/doc/html/rfc9562/#section-4
     *
     * @example 09748193-048a-4bfb-b825-8528cf74fdc1 (len=36)
+     *
+     * @return non-empty-string
     */
    public function toRfc4122(): string
    {
@@ -143,6 +151,8 @@ public function toRfc4122(): string
     * Returns the identifier as a prefixed hexadecimal case insensitive string.
     *
     * @example 0x09748193048a4bfbb8258528cf74fdc1 (len=34)
+     *
+     * @return non-empty-string
     */
    public function toHex(): string
    {
@@ -161,6 +171,9 @@ public function equals(mixed $other): bool
        return $this->uid === $other->uid;
    }

+    /**
+     * @return non-empty-string
+     */
    public function hash(): string
    {
        return $this->uid;
@@ -171,16 +184,25 @@ public function compare(self $other): int
        return (\strlen($this->uid) - \strlen($other->uid)) ?: ($this->uid <=> $other->uid);
    }

+    /**
+     * @return non-empty-string
+     */
    final public function toString(): string
    {
        return $this->__toString();
    }

+    /**
+     * @return non-empty-string
+     */
    public function __toString(): string
    {
        return $this->uid;
    }

+    /**
+     * @return non-empty-string
+     */
    public function jsonSerialize(): string
    {
        return $this->uid;