-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathTransformerInterface.php
More file actions
51 lines (45 loc) · 1.33 KB
/
TransformerInterface.php
File metadata and controls
51 lines (45 loc) · 1.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<?php
declare(strict_types=1);
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter\API;
/**
* Interface for transforming resources into arrays.
*
* This interface can be implemented by classes that need to transform
* data into a standardized array format, such as for API responses.
*/
interface TransformerInterface
{
/**
* Converts the resource to an array representation.
* This is overridden by child classes to define specific fields.
*
* @param mixed $resource The resource being transformed
*
* @return array<string, mixed>
*/
public function toArray(mixed $resource): array;
/**
* Transforms the given resource into an array.
*
* @param array<string, mixed>|object|null $resource
*
* @return array<string, mixed>
*/
public function transform(array|object|null $resource): array;
/**
* Transforms a collection of resources using $this->transform() on each item.
*
* @param array<int|string, mixed> $resources
*
* @return array<int, array<string, mixed>>
*/
public function transformMany(array $resources): array;
}