Rector tweaks

rotexsoft · Apr 13, 2021 · 57dfcc6 · 57dfcc6
1 parent e96f5b5
commit 57dfcc6
Show file tree

Hide file tree

Showing 13 changed files with 57 additions and 48 deletions.
diff --git a/src/ArraysCollection.php b/src/ArraysCollection.php
@@ -31,6 +31,9 @@ class ArraysCollection implements StrictlyTypedCollectionInterface
 
     use StrictlyTypedCollectionInterfaceImplementationTrait;
 
+    /**
+     * @param array[] ...$arrays
+     */
     public function __construct(array ...$arrays) {
 
         $this->versatile_collections_items = $arrays;

diff --git a/src/CallablesCollection.php b/src/CallablesCollection.php
@@ -31,6 +31,9 @@ class CallablesCollection implements StrictlyTypedCollectionInterface
 
     use StrictlyTypedCollectionInterfaceImplementationTrait;
 
+    /**
+     * @param callable[] ...$callables
+     */
     public function __construct(callable ...$callables) {
 
         $this->versatile_collections_items = $callables;

diff --git a/src/CollectionInterface.php b/src/CollectionInterface.php
@@ -585,18 +585,17 @@ public function containsKey($key): bool;
     public function containsKeys(array $keys): bool;
 
     /**
-     * 
+     *
      * Appends all items from $other collection to the end of $this collection. 
      * Note that appended items will be assigned numeric keys.
-     * 
-     * 
-     * 
+     *
+     *
+     *
      * @used-for: adding-items
-     * 
+     *
      * @title: Appends all items from a specified collection to the end of a collection. Note that appended items will be assigned numeric keys.
-     * 
+     *
      * @noRector \Rector\TypeDeclaration\Rector\ClassMethod\AddArrayReturnDocTypeRector
-     * 
      */
     public function appendCollection(CollectionInterface $other): CollectionInterface;
 
@@ -617,18 +616,17 @@ public function appendCollection(CollectionInterface $other): CollectionInterfac
     public function appendItem($item): CollectionInterface;
 
     /**
-     * 
+     *
      * Prepends all items from $other collection to the front of $this collection. 
      * Note that all numeric keys will be modified to start counting from zero while literal keys won't be changed.
-     * 
-     * 
-     * 
+     *
+     *
+     *
      * @used-for: adding-items
-     * 
+     *
      * @title: Prepends all items from a specified collection to the front of a collection.
-     * 
+     *
      * @noRector \Rector\TypeDeclaration\Rector\ClassMethod\AddArrayReturnDocTypeRector
-     * 
      */
     public function prependCollection(CollectionInterface $other): CollectionInterface;
 

diff --git a/src/CollectionInterfaceImplementationTrait.php b/src/CollectionInterfaceImplementationTrait.php
@@ -382,9 +382,10 @@ public function offsetExists($key): bool {
     }
 
     /**
-     *  
+     * 
      * @see \VersatileCollections\CollectionInterface::offsetGet()
-     *  
+     *
+     * @return mixed|void 
      */
     public function offsetGet($key) {
 
@@ -438,9 +439,10 @@ public function toArray(): array {
     }
 
     /**
-     *  
+     * 
      * @see \VersatileCollections\CollectionInterface::getIterator()
-     *  
+     *
+     * @return \ArrayIterator 
      */
     public function getIterator(): Iterator {
 
@@ -471,9 +473,10 @@ public function __construct(...$items) {
     ////////////////////////////////////////////////////////////////////////////
     ////////// OTHER COLLECTION METHODS ////////////////////////////////////////
     /**
-     *  
+     * 
      * @see \VersatileCollections\CollectionInterface::firstItem()
-     *  
+     *
+     * @return null|mixed 
      */
     public function firstItem(){
 
@@ -483,9 +486,10 @@ public function firstItem(){
     }
 
     /**
-     *  
+     * 
      * @see \VersatileCollections\CollectionInterface::lastItem()
-     *  
+     *
+     * @return null|mixed 
      */
     public function lastItem(){
 
@@ -856,9 +860,9 @@ public function containsKeys(array $keys): bool {
     }
 
     /**
-     *  
+     *
      * @see \VersatileCollections\CollectionInterface::appendCollection()
-     *  
+     *
      * @psalm-suppress LessSpecificImplementedReturnType
      */
     public function appendCollection(CollectionInterface $other): CollectionInterface
@@ -930,9 +934,9 @@ public function mergeMeWith(array $items): CollectionInterface
     }
 
     /**
-     *  
+     *
      * @see \VersatileCollections\CollectionInterface::prependCollection()
-     * 
+     *
      * @psalm-suppress LessSpecificImplementedReturnType 
      */
     public function prependCollection(CollectionInterface $other): CollectionInterface

diff --git a/src/FloatsCollection.php b/src/FloatsCollection.php
@@ -49,20 +49,18 @@ public function getType() {
 
     /**
      * @param $str
-     * @return float
      * @noinspection PhpMissingReturnTypeInspection
      */
-    protected function itemFromString($str) {
+    protected function itemFromString(string $str): float {
 
         return ((float) ($str.''));
     }
 
     /**
      * @param $item
-     * @return string
      * @noinspection PhpMissingReturnTypeInspection
      */
-    protected function itemToString($item) {
+    protected function itemToString($item): string {
 
         return $item.'';
     }

diff --git a/src/IntsCollection.php b/src/IntsCollection.php
@@ -49,20 +49,18 @@ public function getType() {
 
     /**
      * @param $str
-     * @return int
      * @noinspection PhpMissingReturnTypeInspection
      */
-    protected function itemFromString($str) {
+    protected function itemFromString(string $str): int {
 
         return ((int) ($str.''));
     }
 
     /**
      * @param $item
-     * @return string
      * @noinspection PhpMissingReturnTypeInspection
      */
-    protected function itemToString($item) {
+    protected function itemToString($item): string {
 
         return $item.'';
     }

diff --git a/src/MultiSortParameters.php b/src/MultiSortParameters.php
@@ -35,7 +35,9 @@ class MultiSortParameters {
         SORT_FLAG_CASE, (SORT_FLAG_CASE | SORT_STRING), (SORT_FLAG_CASE | SORT_NATURAL)
     ];
 
-    /** @noinspection PhpUnhandledExceptionInspection */
+    /** @noinspection PhpUnhandledExceptionInspection
+     * @param int $sort_direction
+     * @param int $sort_type */
     public function __construct(string $field_name, ?int $sort_direction=null, ?int $sort_type=null) {
 
         if( $this->validateFieldName($field_name) ) {

diff --git a/src/NumericsCollection.php b/src/NumericsCollection.php
@@ -76,7 +76,7 @@ public function getType() {
      *
      * @noinspection PhpMissingParamTypeInspection
      */
-    protected function itemFromString($str) {
+    protected function itemFromString(string $str) {
 
         if( \strpos($str, '.') !== false ) {
 
@@ -96,7 +96,7 @@ protected function itemFromString($str) {
      *
      * @noinspection PhpMissingReturnTypeInspection
      */
-    protected function itemToString($item) {
+    protected function itemToString($item): string {
 
         return $item.'';
     }

diff --git a/src/ObjectsCollection.php b/src/ObjectsCollection.php
@@ -37,6 +37,9 @@ class ObjectsCollection implements StrictlyTypedCollectionInterface
         StrictlyTypedCollectionInterfaceImplementationTrait::__construct as strictlyTypedCollectionTrait__construct;
     }
 
+    /**
+     * @param object[] ...$objects
+     */
     public function __construct(object ...$objects) {
 
         $this->versatile_collections_items = $objects;

diff --git a/src/SpecificObjectsCollection.php b/src/SpecificObjectsCollection.php
@@ -35,6 +35,7 @@ final class SpecificObjectsCollection extends ObjectsCollection {
 
     /** @noinspection PhpMissingParentConstructorInspection
      * @noinspection PhpUnnecessaryStaticReferenceInspection
+     * @param object[] ...$objects
      */
     protected function __construct(object ...$objects) {
 

diff --git a/src/StrictlyTypedCollectionInterfaceImplementationTrait.php b/src/StrictlyTypedCollectionInterfaceImplementationTrait.php
@@ -52,7 +52,7 @@ public function __construct(...$arr_objs) {
     }
 
     /**
-     *  
+     *
      * @see \VersatileCollections\CollectionInterface::appendCollection()
      *
      * @noinspection PhpDocSignatureInspection
@@ -125,12 +125,12 @@ public function offsetSet($key, $val): void {
     }
 
     /**
-     *  
+     *
      * @see \VersatileCollections\CollectionInterface::prependCollection()
      *
      * @noinspection PhpDocSignatureInspection
      * @noinspection PhpUnhandledExceptionInspection
-     * 
+     *
      * @psalm-suppress LessSpecificImplementedReturnType
      */
     public function prependCollection(CollectionInterface $other): CollectionInterface {

diff --git a/src/Utils.php b/src/Utils.php
@@ -74,7 +74,7 @@ public static function canReallyBind(callable $callback): bool {
     /**
      *
      *
-     * @return mixed
+     * @return int|string|null
      */
     public static function array_key_first(array $array) {
 
@@ -85,7 +85,7 @@ public static function array_key_first(array $array) {
     /**
      *
      *
-     * @return mixed
+     * @return int|string|null
      */
     public static function array_key_last(array $array) {
 

diff --git a/src/helper-functions.php b/src/helper-functions.php
@@ -97,21 +97,20 @@ function get_object_property_value(object $obj, $property, $default_val=null, bo
     }
 
     /**
-     *  
+     * 
      * A more robust way than property_exists of checking if an instance of a class
      * has a specified property.
-     *  
+     * 
      * @param object $obj
      * @param string|int $property
-     *  
-     * @return bool
-     *  
+     * 
+     * 
      * @throws InvalidArgumentException
      *
      * @noinspection PhpMissingReturnTypeInspection
      * @psalm-suppress DocblockTypeContradiction
      */
-    function object_has_property(object $obj, $property) {
+    function object_has_property(object $obj, $property): bool {
 
         if( !\is_string($property) && !\is_int($property) ) {