36 lines
1.9 KiB
PHP
36 lines
1.9 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/*
|
|
// MODULE_CONTRACT: Defines the data structure for a paginated collection of DealData objects.
|
|
// RESPONSIBILITY: To provide a structured, type-safe container for lists of deals returned by the API, including pagination metadata.
|
|
// INPUTS: Raw JSON array from the API response.
|
|
// OUTPUTS: An object containing pagination details and a collection of `DealData`.
|
|
// LINKS: Requests/NominalAccounts/Deals/GetDealsRequest.php
|
|
*/
|
|
|
|
namespace Apoloz\AlfaBank\Data\NominalAccounts\Deals;
|
|
|
|
// <SECTION name="module_imports" intent="Import necessary DTOs and Spatie Laravel Data components.">
|
|
// <BELIEF_STATE "This collection DTO relies on `PaginationData` for metadata and `DealData` for the individual items. `DataCollection` and `DataCollectionOf` are Spatie Data features for handling typed arrays of DTOs.">
|
|
use Apoloz\AlfaBank\Data\PaginationData;
|
|
use Spatie\LaravelData\Attributes\DataCollectionOf;
|
|
use Spatie\LaravelData\Data;
|
|
use Spatie\LaravelData\DataCollection;
|
|
|
|
// </SECTION>
|
|
|
|
// <SECTION name="class_definition" intent="Define a DTO for a collection of deals.">
|
|
// <BELIEF_STATE "A dedicated DTO for a collection ensures that the structure of paginated lists is consistent and type-safe, providing a reliable contract for consumers to manage deals.">
|
|
class DealCollectionData extends Data
|
|
{
|
|
// <SECTION name="constructor_properties" intent="Define the properties of the deal collection.">
|
|
// <BELIEF_STATE "The collection structure includes pagination metadata (`pagination`) and the actual list of deals (`deals`). The `#[DataCollectionOf(DealData::class)]` attribute is crucial for ensuring that each item in the `deals` array is automatically cast to a `DealData` DTO.">
|
|
public function __construct(
|
|
public PaginationData $pagination,
|
|
#[DataCollectionOf(DealData::class)]
|
|
public DataCollection $deals
|
|
) {}
|
|
// </SECTION>
|
|
}
|