openstackid-resources/app/Http/Utils/PagingResponse.php
smarcet 9f01b9e3b3 Booking Rooms Model
* model changes

* Endpoint to get all avaible booking rooms per summit

GET /api/v1/summits/{id}/locations/bookable-rooms

query string params

page ( int ) current page number
per_page ( int) max amount of items per page
filter ( allowed fields: name, description, cost, capacity, availability_day[epoch], attribute[string|number])
order ( allowed fields id,name,capacity)
expand ( allowed relations venue,floor,attribute_type)

scopes
%s/bookable-rooms/read
%s/summits/read/all

* Endpoint to get slot availability  per room

GET /api/v1/summits/{id}/locations/bookable-rooms/{room_id}/availability/{day}

where id is summit id (integer)
room_id ( integer)
and day (epoch timestamp)

scopes
%s/bookable-rooms/read
%s/summits/read/all

* endpoint create reservation

POST /api/v1/summits/{id}/locations/bookable-rooms/{room_id}/reservations

payload

'currency'       => 'required|string|currency_iso',
'amount'         => 'required|integer',
'start_datetime' => 'required|date_format:U',
'end_datetime'   => 'required|date_format:U|after:start_datetime',

scopes
%s/bookable-rooms/my-reservations/write

* endpoint to get all my reservations

GET /api/v1/summits/{id}/locations/bookable-rooms/all/reservations/me

query string params

expand [owner, room, type]

scopes
%s/bookable-rooms/my-reservations/read

* endpoint to cancel/ask for refund a reservation

DELETE /api/v1/summits/{id}/locations/bookable-rooms/all/reservations/{reservation_id}

scopes
%s/bookable-rooms/my-reservations/write

Change-Id: I741878c6ffc833ba23fca40f09f4664b42c8edd4
2019-06-03 19:20:15 -03:00

124 lines
2.8 KiB
PHP

<?php namespace utils;
/**
* Copyright 2015 OpenStack Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use models\utils\IEntity;
use ModelSerializers\SerializerRegistry;
use Request;
/**
* Class PagingResponse
* @package utils
*/
final class PagingResponse
{
/**
* @var int
*/
private $total;
/**
* @var int
*/
private $per_page;
/**
* @var int
*/
private $page;
/**
* @var int
*/
private $last_page;
/**
* @var array
*/
private $items;
/**
* @param int $total
* @param int $per_page
* @param int $page
* @param int $last_page
* @param array $items
*/
public function __construct($total, $per_page, $page, $last_page, array $items)
{
$this->total = $total;
$this->per_page = $per_page;
$this->page = $page;
$this->last_page = $last_page;
$this->items = $items;
}
public function getTotal()
{
return $this->total;
}
/**
* @return int
*/
public function getPerPage()
{
return $this->per_page;
}
/**
* @return int
*/
public function getCurrentPage()
{
return $this->page;
}
/**
* @return int
*/
public function getLastPage()
{
return $this->last_page;
}
/**
* @return array
*/
public function getItems()
{
return $this->items;
}
/**
* @param null $expand
* @param array $fields
* @param array $relations
* @param array $params
* @param string $serializer_type
* @return array
*/
public function toArray($expand = null, array $fields = [], array $relations = [], array $params = [], $serializer_type = SerializerRegistry::SerializerType_Public )
{
$items = [];
foreach($this->items as $i)
{
$items[] = SerializerRegistry::getInstance()->getSerializer($i, $serializer_type)->serialize($expand, $fields, $relations, $params);;
}
return
[
'total' => $this->total,
'per_page' => $this->per_page,
'current_page' => $this->page,
'last_page' => $this->last_page,
'data' => $items,
];
}
}