openstackid-resources/app/Models/Foundation/Summit/Locations/SummitBookableVenueRoomAvailableSlot.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

88 lines
2.1 KiB
PHP

<?php namespace models\summit;
/**
* Copyright 2019 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.
**/
final class SummitBookableVenueRoomAvailableSlot
{
/**
* @var \DateTime
*/
private $start_date;
/**
* @var \DateTime
*/
private $end_date;
/**
* @var bool
*/
private $is_free;
/**
* @var SummitBookableVenueRoom
*/
private $room;
/**
* SummitBookableVenueRoomAvailableSlot constructor.
* @param SummitBookableVenueRoom $room
* @param \DateTime $start_date
* @param \DateTime $end_date
* @param bool $is_free
*/
public function __construct(SummitBookableVenueRoom $room, \DateTime $start_date, \DateTime $end_date, bool $is_free)
{
$this->room = $room;
$this->start_date = $start_date;
$this->end_date = $end_date;
$this->is_free = $is_free;
}
/**
* @return \DateTime
*/
public function getStartDate(): \DateTime
{
return $this->start_date;
}
/**
* @return \DateTime
*/
public function getEndDate(): \DateTime
{
return $this->end_date;
}
/**
* @return \DateTime
*/
public function getLocalStartDate(): \DateTime
{
return $this->room->getSummit()->convertDateFromUTC2TimeZone($this->start_date);
}
/**
* @return \DateTime
*/
public function getLocalEndDate(): \DateTime
{
return $this->room->getSummit()->convertDateFromUTC2TimeZone($this->end_date);
}
public function isFree():bool{
return $this->is_free;
}
}