A free open source IT asset/license management system
<?php
namespace App\Http\Transformers;
use Illuminate\Http\Response;
use Illuminate\Pagination\LengthAwarePaginator;
/**
* Class SelectlistTransformer
*
* This handles the standardized formatting of the API response we need to provide for
* the rich (text and images) Select2 javascript.
*
* @author [A. Gianotto] [<[email protected]>]
*
* @since [v4.0.16]
*
* @return Response
*/
class SelectlistTransformer
{
public function transformSelectlist(LengthAwarePaginator $select_items)
{
$items_array = [];
// Loop through the paginated collection to set the array values
foreach ($select_items as $select_item) {
$row = [
'id' => (int) $select_item->id,
'text' => ($select_item->use_text) ? $select_item->use_text : $select_item->name,
'image' => ($select_item->use_image) ? $select_item->use_image : null,
'tag_color' => ($select_item->tag_color) ? $select_item->tag_color : null,
];
// Optional: when set, select2 renders the option as un-selectable.
// Used to enforce hierarchy / membership constraints up-front.
if (! empty($select_item->use_disabled)) {
$row['disabled'] = true;
}
$items_array[] = $row;
}
// Prepend a "No value" row when the request opts in
// via ?includeNull=1. Mostly (for now) used by the advanced
// search modal to allow searching on "no value" for
// a column with no value.
// Only prepends on the first page of results, otherwise
// it would be repeated on each "next page" load.
if (request()->boolean('includeNull')
&& !request()->filled('search')
&& $select_items->currentPage() === 1
) {
array_unshift($items_array, [
'id' => 'null',
'text' => trans('general.no_value'),
'image' => null,
'tag_color' => null,
]);
}
$results = [
'results' => $items_array,
'pagination' => [
'more' => ($select_items->currentPage() >= $select_items->lastPage()) ? false : true,
'per_page' => $select_items->perPage(),
],
'total_count' => $select_items->total(),
'page' => $select_items->currentPage(),
'page_count' => $select_items->lastPage(),
];
return $results;
}
}