vivutio / front-desk-module
The front desk for vivutio: a day's arrivals, guests in house and departures at a place, checking in and out, no-shows, and the units each stay is given.
Package info
github.com/utafitilabs/vivutio-front-desk-module
Type:symfony-bundle
pkg:composer/vivutio/front-desk-module
Requires
- php: >=8.4
- doctrine/doctrine-bundle: ^3.0
- doctrine/orm: ^3.5
- psr/clock: ^1.0
- symfony/clock: ^8.0
- symfony/config: ^8.0
- symfony/dependency-injection: ^8.0
- symfony/framework-bundle: ^8.0
- symfony/http-foundation: ^8.0
- symfony/http-kernel: ^8.0
- symfony/routing: ^8.0
- symfony/security-bundle: ^8.0
- symfony/security-csrf: ^8.0
- symfony/security-http: ^8.0
- symfony/twig-bundle: ^8.0
- twig/twig: ^3.21
- vivutio/vivutio: ^0.1.20
Requires (Dev)
- doctrine/doctrine-migrations-bundle: ^4.0
- friendsofphp/php-cs-fixer: ^3.95
- phpstan/phpstan: ^2.2
- phpunit/phpunit: ^13.2
- symfony/browser-kit: ^8.0
- symfony/css-selector: ^8.0
- symfony/dom-crawler: ^8.0
- symfony/filesystem: ^8.0
- symfony/yaml: ^8.0
Suggests
- vivutio/property-module: Offers its bookings as stays and its room types as units.
Provides
None
Conflicts
None
Replaces
None
README
The front desk for vivutio. A day at a place's desk: the arrivals still expected, the guests in house, those due out, those who left and those who never came; checking in, with the units each stay is given, checking out, and no-shows.
Contents
Install
In a vivutio installation:
composer require vivutio/front-desk-module php bin/console doctrine:migrations:migrate
Its recipe registers the bundle and mounts its pages with
config/routes/front_desk.yaml, a file the installation owns.
How it works
The desk names no other module. It works from whatever the installation's
packages offer through the core's stay contracts (Vivutio\Contracts\Stay):
- stays, guests expected at a place for some nights, each with the units it takes (the property module offers its confirmed bookings);
- units, what a place has to put guests in, by kind and how many (the property module offers its room types: Tented Room 1 to 20).
The desk keeps only its own record of each stay, by its kind and id: when it was checked in and out, or that its guests never came, and the units it was given.
- Checking in: from the arrival day until before the departure, with as many units of each kind as the stay takes, each one the place has and none a guest in house holds.
- Checking out: any guest in house, due out or leaving early.
- No-shows: an expected stay not yet in, from its arrival day; the mark is taken back if they come after all.
Who may do what
| Pair | Who |
|---|---|
front_desk.read |
The places it serves and a place's board |
front_desk.record |
Checking in and out, and no-shows |
Both are a module's pairs, held where the person's department, or one they
support, allows them too, and asked about the place, so where a person's
permissions apply narrows them. The suite extends the core's authority test
base; tests/authority-table.md is the reviewed table.
Development
composer update composer check
Licence
AGPL-3.0-or-later. See LICENSE.