Skip to content

Commit

Permalink
Update typing information.
Browse files Browse the repository at this point in the history
  • Loading branch information
drupol committed Aug 16, 2020
1 parent 119cdfe commit 81b7a6f
Show file tree
Hide file tree
Showing 65 changed files with 71 additions and 74 deletions.
2 changes: 1 addition & 1 deletion src/Contract/Operation/Appendable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Appendable
*
* @param mixed ...$items
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function append(...$items): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Applyable.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface Applyable
* @param callable ...$callables
* @psalm-param callable(TKey, T):(bool) ...$callables
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function apply(callable ...$callables): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Cacheable.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
interface Cacheable
{
/**
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function cache(?CacheItemPoolInterface $cache = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Chunkable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Chunkable
*
* @param int ...$size
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function chunk(int ...$size): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Collapseable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Collapseable
/**
* Collapse a collection of items into a simple flat collection.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function collapse(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Columnable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Columnable
*
* @param int|string $index
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function column($index): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Combinateable.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface Combinateable
* @param int $length
* The length.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function combinate(?int $length = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Combineable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Combineable
*
* @param mixed ...$keys
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function combine(...$keys): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Compactable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Compactable
*
* @param mixed ...$values
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function compact(...$values): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Cycleable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Cycleable
{
/**
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function cycle(?int $length = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Diffable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Diffable
/**
* @param mixed ...$values
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function diff(...$values): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Diffkeysable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Diffkeysable
/**
* @param mixed ...$values
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function diffKeys(...$values): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Distinctable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Distinctable
{
/**
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function distinct(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Explodeable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Explodeable
*
* @param mixed ...$explodes
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function explode(...$explodes): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Filterable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Filterable
*
* @param callable ...$callbacks
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function filter(callable ...$callbacks): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Flattenable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Flattenable
/**
* Flatten a collection of items into a simple flat collection.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function flatten(int $depth = PHP_INT_MAX): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Flipable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Flipable
/**
* Flip keys and items in a collection.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function flip(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Forgetable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Forgetable
*
* @param mixed ...$keys
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function forget(...$keys): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Frequencyable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Frequencyable
{
/**
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function frequency(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Groupable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Groupable
{
/**
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function group(?callable $callback = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Intersectable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Intersectable
/**
* @param mixed ...$values
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function intersect(...$values): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Intersectkeysable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Intersectkeysable
/**
* @param mixed ...$values
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function intersectKeys(...$values): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Intersperseable.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface Intersperseable
*
* @param mixed $element
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function intersperse($element, int $every = 1, int $startAt = 0): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Iterateable.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ interface Iterateable
*
* @param mixed ...$parameters
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public static function iterate(callable $callback, ...$parameters): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Keysable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Keysable
/**
* Get the keys of the items.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function keys(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Limitable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Limitable
/**
* Limit the first {$limit} items.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function limit(int $limit): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Loopable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Loopable
{
/**
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function loop(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Mapable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Mapable
*
* @param callable ...$callbacks
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function map(callable ...$callbacks): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Mergeable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Mergeable
*
* @param iterable<mixed> ...$sources
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function merge(iterable ...$sources): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Normalizeable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Normalizeable
/**
* Replace, reorder and use numeric keys on a collection.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function normalize(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Nthable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Nthable
/**
* Get every n-th element of a collection.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function nth(int $step, int $offset = 0): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Onlyable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Onlyable
*
* @param mixed ...$keys
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function only(...$keys): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Padable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Padable
*
* @param mixed $value
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function pad(int $size, $value): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Pairable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Pairable
{
/**
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function pair(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Permutateable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Permutateable
/**
* Find all the permutations of a collection.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function permutate(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Pluckable.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface Pluckable
* @param array<int, string>|string $pluck
* @param mixed|null $default
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function pluck($pluck, $default = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Prependable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Prependable
*
* @param mixed ...$items
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function prepend(...$items): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Productable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Productable
*
* @param iterable<mixed> ...$iterables
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function product(iterable ...$iterables): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/RSampleable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface RSampleable
{
/**
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function rsample(float $probability): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Randomable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Randomable
{
/**
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function random(int $size = 1): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Rangeable.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface Rangeable
* @psalm-template TKey of array-key
* @psalm-template T
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public static function range(float $start = 0.0, float $end = INF, float $step = 1.0): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Reductionable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Reductionable
*
* @param mixed $initial
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function reduction(callable $callback, $initial = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Reverseable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Reverseable
/**
* Reverse order items of a collection.
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function reverse(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Scaleable.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ interface Scaleable
* @param ?float $wantedUpperBound
* @param ?float $base
*
* @return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
*/
public function scale(
float $lowerBound,
Expand Down

0 comments on commit 81b7a6f

Please sign in to comment.