Add strict type declarations and modernize codebase

composer.json

@@ -15,7 +15,7 @@
         }
     },
     "require": {
-        "php": ">=7.2",
+        "php": ">=8.2",
         "ext-openssl": "*",
         "evenement/evenement": "^3.0.1"
     }

src/BaseFilter.php

@@ -4,10 +4,10 @@
 
 use ipl\Stdlib\Filter\Rule;
 
 trait BaseFilter
 {
-    /** @var Rule Base filter */
-    private $baseFilter;
+    /** @var ?Rule Base filter */
+    private ?Rule $baseFilter = null;
 
     /**
      * Get whether a base filter has been set
@@ -24,7 +24,7 @@
      *
      * @return ?Rule
      */
-    public function getBaseFilter()
+    public function getBaseFilter(): ?Rule
     {
         return $this->baseFilter;
     }
@@ -36,7 +36,7 @@
      *
      * @return $this
      */
-    public function setBaseFilter(?Rule $baseFilter = null): self
+    public function setBaseFilter(?Rule $baseFilter = null): static
     {
         $this->baseFilter = $baseFilter;
 

src/Contract/Filterable.php

@@ -11,7 +11,7 @@ interface Filterable
      *
      * @return Filter\Chain
      */
-    public function getFilter();
+    public function getFilter(): Filter\Chain;
 
     /**
      * Add a filter to the query
@@ -23,7 +23,7 @@ public function getFilter();
      *
      * @return $this
      */
-    public function filter(Filter\Rule $filter);
+    public function filter(Filter\Rule $filter): static;
 
     /**
      * Add a filter to the query
@@ -35,7 +35,7 @@ public function filter(Filter\Rule $filter);
      *
      * @return $this
      */
-    public function orFilter(Filter\Rule $filter);
+    public function orFilter(Filter\Rule $filter): static;
 
     /**
      * Add a filter to the query
@@ -47,7 +47,7 @@ public function orFilter(Filter\Rule $filter);
      *
      * @return $this
      */
-    public function notFilter(Filter\Rule $filter);
+    public function notFilter(Filter\Rule $filter): static;
 
     /**
      * Add a filter to the query
@@ -59,5 +59,5 @@ public function notFilter(Filter\Rule $filter);
      *
      * @return $this
      */
-    public function orNotFilter(Filter\Rule $filter);
+    public function orNotFilter(Filter\Rule $filter): static;
 }

src/Contract/Paginatable.php

@@ -11,46 +11,46 @@ interface Paginatable extends Countable
      *
      * @return bool
      */
-    public function hasLimit();
+    public function hasLimit(): bool;
 
     /**
      * Get the limit
      *
-     * @return int|null
+     * @return ?int
      */
-    public function getLimit();
+    public function getLimit(): ?int;
 
     /**
      * Set the limit
      *
-     * @param int|null $limit Maximum number of items to return. If you want to disable the limit,
-     *                        it is best practice to use null or a negative value
+     * @param ?int $limit Maximum number of items to return. If you want to disable the limit,
+     *   it is best practice to use null or a negative value
      *
      * @return $this
      */
-    public function limit($limit);
+    public function limit(?int $limit): static;
 
     /**
      * Get whether an offset is set
      *
      * @return bool
      */
-    public function hasOffset();
+    public function hasOffset(): bool;
 
     /**
      * Get the offset
      *
-     * @return int|null
+     * @return ?int
      */
-    public function getOffset();
+    public function getOffset(): ?int;
 
     /**
      * Set the offset
      *
-     * @param int|null $offset Start result set after this many rows. If you want to disable the offset,
-     *                         it is best practice to use null or a negative value
+     * @param ?int $offset Start result set after this many rows. If you want to disable the offset,
+     *   it is best practice to use null or a negative value
      *
      * @return $this
      */
-    public function offset($offset);
+    public function offset(?int $offset): static;
 }

src/Contract/PluginLoader.php

@@ -17,5 +17,5 @@ interface PluginLoader
      *
      * @return string|false FQN of the plugin's class if found, false otherwise
      */
-    public function load($name);
+    public function load(string $name): string|false;
 }

src/Contract/Translator.php

@@ -11,11 +11,11 @@ interface Translator
      * Translate a message
      *
      * @param string $message
-     * @param string $context Message context
+     * @param ?string $context Message context
      *
      * @return string Translated message or original message if no translation is found
      */
-    public function translate($message, $context = null);
+    public function translate(string $message, ?string $context = null): string;
 
     /**
      * Translate a message in the given domain
@@ -24,11 +24,11 @@ public function translate($message, $context = null);
      *
      * @param string $domain
      * @param string $message
-     * @param string $context Message context
+     * @param ?string $context Message context
      *
      * @return string Translated message or original message if no translation is found
      */
-    public function translateInDomain($domain, $message, $context = null);
+    public function translateInDomain(string $domain, string $message, ?string $context = null): string;
 
     /**
      * Translate a plural message
@@ -37,13 +37,13 @@ public function translateInDomain($domain, $message, $context = null);
      * That is also the case if no translation is found.
      *
      * @param string $singular Singular message
-     * @param string $plural   Plural message
-     * @param int    $number   Number to decide between the returned singular and plural forms
-     * @param string $context  Message context
+     * @param string $plural Plural message
+     * @param int $number Number to decide between the returned singular and plural forms
+     * @param ?string $context Message context
      *
      * @return string Translated message or original message if no translation is found
      */
-    public function translatePlural($singular, $plural, $number, $context = null);
+    public function translatePlural(string $singular, string $plural, int $number, ?string $context = null): string;
 
     /**
      * Translate a plural message in the given domain
@@ -55,11 +55,17 @@ public function translatePlural($singular, $plural, $number, $context = null);
      *
      * @param string $domain
      * @param string $singular Singular message
-     * @param string $plural   Plural message
-     * @param int    $number   Number to decide between the returned singular and plural forms
-     * @param string $context  Message context
+     * @param string $plural Plural message
+     * @param int $number Number to decide between the returned singular and plural forms
+     * @param ?string $context Message context
      *
      * @return string Translated message or original message if no translation is found
      */
-    public function translatePluralInDomain($domain, $singular, $plural, $number, $context = null);
+    public function translatePluralInDomain(
+        string $domain,
+        string $singular,
+        string $plural,
+        int $number,
+        ?string $context = null
+    ): string;
 }

src/Data.php

@@ -5,14 +5,14 @@
 class Data
 {
     /** @var array<string, mixed> */
-    protected $data = [];
+    protected array $data = [];
 
     /**
      * Check whether there's any data
      *
      * @return bool
      */
-    public function isEmpty()
+    public function isEmpty(): bool
     {
         return empty($this->data);
     }
@@ -24,7 +24,7 @@ public function isEmpty()
      *
      * @return bool
      */
-    public function has($name)
+    public function has(string $name): bool
     {
         return array_key_exists($name, $this->data);
     }
@@ -37,7 +37,7 @@ public function has($name)
      *
      * @return mixed
      */
-    public function get($name, $default = null)
+    public function get(string $name, mixed $default = null): mixed
     {
         if ($this->has($name)) {
             return $this->data[$name];
@@ -54,7 +54,7 @@ public function get($name, $default = null)
      *
      * @return $this
      */
-    public function set($name, $value)
+    public function set(string $name, mixed $value): static
     {
         $this->data[$name] = $value;
 
@@ -68,7 +68,7 @@ public function set($name, $value)
      *
      * @return $this
      */
-    public function merge(self $with)
+    public function merge(self $with): static
     {
         $this->data = array_merge($this->data, $with->data);
 
@@ -80,7 +80,7 @@ public function merge(self $with)
      *
      * @return $this
      */
-    public function clear()
+    public function clear(): static
     {
         $this->data = [];
 

src/Events.php

@@ -5,20 +5,20 @@
 use Evenement\EventEmitterTrait;
 use InvalidArgumentException;
 
 trait Events
 {
     use EventEmitterTrait {
         EventEmitterTrait::on as private evenementUnvalidatedOn;
     }
 
     /** @var array */
-    protected $eventsEmittedOnce = [];
+    protected array $eventsEmittedOnce = [];
 
     /**
      * @param string $event
      * @param array $arguments
      */
-    protected function emitOnce($event, array $arguments = [])
+    protected function emitOnce(string $event, array $arguments = []): void
     {
         if (! isset($this->eventsEmittedOnce[$event])) {
             $this->eventsEmittedOnce[$event] = true;
@@ -31,15 +31,15 @@
      * @param callable $listener
      * @return $this
      */
-    public function on($event, callable $listener)
+    public function on($event, callable $listener): static
     {
         $this->assertValidEvent($event);
         $this->evenementUnvalidatedOn($event, $listener);
 
         return $this;
     }
 
-    protected function assertValidEvent($event)
+    protected function assertValidEvent(string $event): void
     {
         if (! $this->isValidEvent($event)) {
             throw new InvalidArgumentException("$event is not a valid event");