invia / channelmanagerinterface
Interface classes and objects for the Invia channel manager interface
Requires
- php: >=7.2
- symfony/http-foundation: ^3.4
Requires (Dev)
- symfony/phpunit-bridge: ^3.4|^4.0
Suggests
- twig/twig: Required if you want to use the TwigInterface with your adapter
Conflicts
- twig/twig: <2.0
README
This library provides the interfaces and classes for the ChannelManager Interface of the company Invia to write your own adapters. To do this, the adapter must implement the supplied adapter interface.
AdapterInterface
The following methods must be implemented:
getAdapterKey
Each adapter requires a unique key to load it later and assign it to one (or more) channel manager(s).
getUrlPath
Each adapter will be accessible on a special endpoint in the ChannelManager Interface. To do this, the adapter must define the last part of the url.
setRequest(Request request)
The request received at the endpoint of the channel manager interface is passed to the adapter using this method.
getCredentials
With the getCredentials method, the adapter must read and return the credentials from the request.
handleRequest(FacadeInterface facade)
If the credentials have been accepted by the ChannelManager Interface, the handleRequest method is called on the adapter and must process the request. The adapter can access the possible methods of the ChannelManager Interface via the given facade.
handleException(CMIException exception)
If an exception is thrown (by the ChannelManager Interface or an adapter), this method has to handle this exception and creating valid response.
BookingNotifyInterface
The adapter can also implement the BookingNotifyInterface. A Channel Manager can be informed about a new booking by a customer.
bookingNotify(Booking booking)
The booking object contains all the necessary information that is collected during a booking.
TwigInterface
If you require Twig to render a response, the adapter can implement the TwigInterface.
setTwig(Twig\Environment twig)
A method which set the Twig environment direct before the handleRequest method is called.
FacadeInterface
getHotel(HotelRequest hotelRequest)
Get Hotel with basic information.
getRooms(RoomRequest roomRequest)
A query of all rooms for the requested hotel.
getRatePlans(RatePlanRequest ratePlanRequest)
A query of all rate plans for the requested hotel.
getBookings(BookingRequest bookingRequest)
A query for bookings using parameters that can be combined in different ways.
getRates(RateRequest rateRequest)
A query for rates in a given date range.
saveRates(RateSaveRequest rateSaveRequest)
Add/update multiple rates in a given date range. The added/updated rates will be returned.