CollectsCases::sort() - Code Metrics - cerbero90/enum - Measure and Improve Code Quality continuously with Scrutinizer

CollectsCases::sort() A
last analyzed 2025-06-25 19:36 UTC

↳ Parent: CollectsCases

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1

<?php

declare(strict_types=1);

namespace Cerbero\Enum\Concerns;

use Cerbero\Enum\CasesCollection;

/**
 * The trait to collect the cases of an enum.
 */
trait CollectsCases
{
    /**
     * Retrieve a collection with all the cases.
     *
     * @return CasesCollection<self>
     */
    public static function collect(): CasesCollection
    {
        return new CasesCollection(self::cases());
    }

    /**
     * Retrieve the count of cases.
     */
    public static function count(): int
    {
        return self::collect()->count();
    }

    /**
     * Retrieve the first case.
     *
     * @param ?callable(self, array-key): bool $callback
     */
    public static function first(?callable $callback = null): ?self
    {
        return self::collect()->first($callback);
    }

    /**
     * Retrieve the name of all the cases.
     *
     * @return string[]
     */
    public static function names(): array
    {
        return self::collect()->names();
    }

    /**
     * Retrieve the value of all the backed cases.
     *
     * @return list<string|int>
     */
    public static function values(): array
    {
        return self::collect()->values();
    }

    /**
     * Retrieve an array of values optionally keyed by the given key.
     *
     * @template TPluckValue
     *
     * @param (callable(self): TPluckValue)|string $value

     * @param (callable(self): array-key)|string|null $key
     * @return array<array-key, TPluckValue>

     */
    public static function pluck(callable|string $value, callable|string|null $key = null): array
    {
        return self::collect()->pluck($value, $key);
    }

    /**
     * Retrieve the result of mapping over all the cases.
     *
     * @template TMapValue
     *
     * @param callable(self, array-key): TMapValue $callback
     * @return array<array-key, TMapValue>

     */
    public static function map(callable $callback): array
    {
        return self::collect()->map($callback);
    }

    /**
     * Retrieve all the cases keyed by their own name.
     *
     * @return CasesCollection<self>
     */
    public static function keyByName(): CasesCollection
    {
        return self::collect()->keyByName();
    }

    /**
     * Retrieve all the cases keyed by the given key.
     *
     * @param (callable(self): array-key)|string $key

     * @return CasesCollection<self>
     */
    public static function keyBy(callable|string $key): CasesCollection
    {
        return self::collect()->keyBy($key);
    }

    /**
     * Retrieve all the cases keyed by their own value.
     *
     * @return CasesCollection<self>
     */
    public static function keyByValue(): CasesCollection
    {
        return self::collect()->keyByValue();
    }

    /**
     * Retrieve all the cases grouped by the given key.
     *
     * @param (callable(self): array-key)|string $key

     * @return array<array-key, CasesCollection<self>>

     */
    public static function groupBy(callable|string $key): array
    {
        return self::collect()->groupBy($key);
    }

    /**
     * Retrieve only the filtered cases.
     *
     * @param (callable(self): bool)|string $filter

     * @return CasesCollection<self>
     */
    public static function filter(callable|string $filter): CasesCollection
    {
        return self::collect()->filter($filter);
    }

    /**
     * Retrieve only the cases having the given names.
     *
     * @return CasesCollection<self>
     */
    public static function only(string ...$names): CasesCollection
    {
        return self::collect()->only(...$names);
    }

    /**
     * Retrieve only the cases not having the given names.
     *
     * @return CasesCollection<self>
     */
    public static function except(string ...$names): CasesCollection
    {
        return self::collect()->except(...$names);
    }

    /**
     * Retrieve only the cases having the given values.
     *
     * @return CasesCollection<self>
     */
    public static function onlyValues(string|int ...$values): CasesCollection
    {
        return self::collect()->onlyValues(...$values);
    }

    /**
     * Retrieve only the cases not having the given values.
     *
     * @return CasesCollection<self>
     */
    public static function exceptValues(string|int ...$values): CasesCollection
    {
        return self::collect()->exceptValues(...$values);
    }

    /**
     * Retrieve all the cases sorted by their own name ascending.
     *
     * @return CasesCollection<self>
     */
    public static function sort(): CasesCollection
    {
        return self::collect()->sort();
    }

    /**
     * Retrieve all the cases sorted by the given key ascending.
     *
     * @param (callable(self): mixed)|string $key

     * @return CasesCollection<self>
     */
    public static function sortBy(callable|string $key): CasesCollection
    {
        return self::collect()->sortBy($key);
    }

    /**
     * Retrieve all the cases sorted by their own value ascending.
     *
     * @return CasesCollection<self>
     */
    public static function sortByValue(): CasesCollection
    {
        return self::collect()->sortByValue();
    }

    /**
     * Retrieve all the cases sorted by their own name descending.
     *
     * @return CasesCollection<self>
     */
    public static function sortDesc(): CasesCollection
    {
        return self::collect()->sortDesc();
    }

    /**
     * Retrieve all the cases sorted by the given key descending.
     *
     * @param (callable(self): mixed)|string $key

     * @return CasesCollection<self>
     */
    public static function sortByDesc(callable|string $key): CasesCollection
    {
        return self::collect()->sortByDesc($key);
    }

    /**
     * Retrieve all the cases sorted by their own value descending.
     *
     * @return CasesCollection<self>
     */
    public static function sortByDescValue(): CasesCollection
    {
        return self::collect()->sortByDescValue();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Cerbero\Enum\Concerns;
6
7		use Cerbero\Enum\CasesCollection;
8
9		/**
10		* The trait to collect the cases of an enum.
11		*/
12		trait CollectsCases
13		{
14		/**
15		* Retrieve a collection with all the cases.
16		*
17		* @return CasesCollection<self>
18		*/
19	34	public static function collect(): CasesCollection
20		{
21	34	return new CasesCollection(self::cases());
22		}
23
24		/**
25		* Retrieve the count of cases.
26		*/
27	1	public static function count(): int
28		{
29	1	return self::collect()->count();
30		}
31
32		/**
33		* Retrieve the first case.
34		*
35		* @param ?callable(self, array-key): bool $callback
36		*/
37	2	public static function first(?callable $callback = null): ?self
38		{
39	2	return self::collect()->first($callback);
40		}
41
42		/**
43		* Retrieve the name of all the cases.
44		*
45		* @return string[]
46		*/
47	1	public static function names(): array
48		{
49	1	return self::collect()->names();
50		}
51
52		/**
53		* Retrieve the value of all the backed cases.
54		*
55		* @return list<string\|int>
56		*/
57	1	public static function values(): array
58		{
59	1	return self::collect()->values();
60		}
61
62		/**
63		* Retrieve an array of values optionally keyed by the given key.
64		*
65		* @template TPluckValue
66		*
67		* @param (callable(self): TPluckValue)\|string $value
		0 ignored issues – show Documentation Bug introduced 2024-10-05 19:09 UTC by Report Bug Copy Issue Report The doc comment `(callable(self): TPluckValue)\|string` at position `1` could not be parsed: Expected ')' at position 1, but found 'callable'. Loading history...
68		* @param (callable(self): array-key)\|string\|null $key
69		* @return array<array-key, TPluckValue>
		0 ignored issues – show Documentation Bug introduced 2024-10-05 19:09 UTC by Report Bug Copy Issue Report The doc comment `array<array-key, TPluckValue>` at position `2` could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, TPluckValue>. Loading history...
70		*/
71	4	public static function pluck(callable\|string $value, callable\|string\|null $key = null): array
72		{
73	4	return self::collect()->pluck($value, $key);
74		}
75
76		/**
77		* Retrieve the result of mapping over all the cases.
78		*
79		* @template TMapValue
80		*
81		* @param callable(self, array-key): TMapValue $callback
82		* @return array<array-key, TMapValue>
		0 ignored issues – show Documentation Bug introduced 2024-10-05 19:09 UTC by Report Bug Copy Issue Report The doc comment `array<array-key, TMapValue>` at position `2` could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, TMapValue>. Loading history...
83		*/
84	2	public static function map(callable $callback): array
85		{
86	2	return self::collect()->map($callback);
87		}
88
89		/**
90		* Retrieve all the cases keyed by their own name.
91		*
92		* @return CasesCollection<self>
93		*/
94	1	public static function keyByName(): CasesCollection
95		{
96	1	return self::collect()->keyByName();
97		}
98
99		/**
100		* Retrieve all the cases keyed by the given key.
101		*
102		* @param (callable(self): array-key)\|string $key
		0 ignored issues – show Documentation Bug introduced 2024-10-05 19:09 UTC by Report Bug Copy Issue Report The doc comment `(callable(self): array-key)\|string` at position `1` could not be parsed: Expected ')' at position 1, but found 'callable'. Loading history...
103		* @return CasesCollection<self>
104		*/
105	2	public static function keyBy(callable\|string $key): CasesCollection
106		{
107	2	return self::collect()->keyBy($key);
108		}
109
110		/**
111		* Retrieve all the cases keyed by their own value.
112		*
113		* @return CasesCollection<self>
114		*/
115	1	public static function keyByValue(): CasesCollection
116		{
117	1	return self::collect()->keyByValue();
118		}
119
120		/**
121		* Retrieve all the cases grouped by the given key.
122		*
123		* @param (callable(self): array-key)\|string $key
		0 ignored issues – show Documentation Bug introduced 2024-10-05 19:09 UTC by Report Bug Copy Issue Report The doc comment `(callable(self): array-key)\|string` at position `1` could not be parsed: Expected ')' at position 1, but found 'callable'. Loading history...
124		* @return array<array-key, CasesCollection<self>>
		0 ignored issues – show Documentation Bug introduced 2025-01-09 18:37 UTC by Report Bug Copy Issue Report The doc comment `array<array-key, CasesCollection<self>>` at position `2` could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, CasesCollection<self>>. Loading history...
125		*/
126	4	public static function groupBy(callable\|string $key): array
127		{
128	4	return self::collect()->groupBy($key);
129		}
130
131		/**
132		* Retrieve only the filtered cases.
133		*
134		* @param (callable(self): bool)\|string $filter
		0 ignored issues – show Documentation Bug introduced 2024-10-05 19:09 UTC by Report Bug Copy Issue Report The doc comment `(callable(self): bool)\|string` at position `1` could not be parsed: Expected ')' at position 1, but found 'callable'. Loading history...
135		* @return CasesCollection<self>
136		*/
137	3	public static function filter(callable\|string $filter): CasesCollection
138		{
139	3	return self::collect()->filter($filter);
140		}
141
142		/**
143		* Retrieve only the cases having the given names.
144		*
145		* @return CasesCollection<self>
146		*/
147	1	public static function only(string ...$names): CasesCollection
148		{
149	1	return self::collect()->only(...$names);
150		}
151
152		/**
153		* Retrieve only the cases not having the given names.
154		*
155		* @return CasesCollection<self>
156		*/
157	1	public static function except(string ...$names): CasesCollection
158		{
159	1	return self::collect()->except(...$names);
160		}
161
162		/**
163		* Retrieve only the cases having the given values.
164		*
165		* @return CasesCollection<self>
166		*/
167	1	public static function onlyValues(string\|int ...$values): CasesCollection
168		{
169	1	return self::collect()->onlyValues(...$values);
170		}
171
172		/**
173		* Retrieve only the cases not having the given values.
174		*
175		* @return CasesCollection<self>
176		*/
177	1	public static function exceptValues(string\|int ...$values): CasesCollection
178		{
179	1	return self::collect()->exceptValues(...$values);
180		}
181
182		/**
183		* Retrieve all the cases sorted by their own name ascending.
184		*
185		* @return CasesCollection<self>
186		*/
187	1	public static function sort(): CasesCollection
188		{
189	1	return self::collect()->sort();
190		}
191
192		/**
193		* Retrieve all the cases sorted by the given key ascending.
194		*
195		* @param (callable(self): mixed)\|string $key
		0 ignored issues – show Documentation Bug introduced 2024-10-05 19:09 UTC by Report Bug Copy Issue Report The doc comment `(callable(self): mixed)\|string` at position `1` could not be parsed: Expected ')' at position 1, but found 'callable'. Loading history...
196		* @return CasesCollection<self>
197		*/
198	2	public static function sortBy(callable\|string $key): CasesCollection
199		{
200	2	return self::collect()->sortBy($key);
201		}
202
203		/**
204		* Retrieve all the cases sorted by their own value ascending.
205		*
206		* @return CasesCollection<self>
207		*/
208	1	public static function sortByValue(): CasesCollection
209		{
210	1	return self::collect()->sortByValue();
211		}
212
213		/**
214		* Retrieve all the cases sorted by their own name descending.
215		*
216		* @return CasesCollection<self>
217		*/
218	1	public static function sortDesc(): CasesCollection
219		{
220	1	return self::collect()->sortDesc();
221		}
222
223		/**
224		* Retrieve all the cases sorted by the given key descending.
225		*
226		* @param (callable(self): mixed)\|string $key
		0 ignored issues – show Documentation Bug introduced 2024-10-05 19:09 UTC by Report Bug Copy Issue Report The doc comment `(callable(self): mixed)\|string` at position `1` could not be parsed: Expected ')' at position 1, but found 'callable'. Loading history...
227		* @return CasesCollection<self>
228		*/
229	2	public static function sortByDesc(callable\|string $key): CasesCollection
230		{
231	2	return self::collect()->sortByDesc($key);
232		}
233
234		/**
235		* Retrieve all the cases sorted by their own value descending.
236		*
237		* @return CasesCollection<self>
238		*/
239	1	public static function sortByDescValue(): CasesCollection
240		{
241	1	return self::collect()->sortByDescValue();
242		}
243		}
244

cerbero90 / enum

CollectsCases::sort() A last analyzed 2025-06-25 19:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CollectsCases::sort() A
last analyzed 2025-06-25 19:36 UTC