Skip to content
ulamsulamsulams docs

Package: stationary-events

Generated from api/packages/stationary-events

Source: api/packages/stationary-events · imported version 0.1.11. The sections after the README are extracted from the code on every docs build.

README

Section titled “README”

What does it do

Section titled “What does it do”

This package is used to manage stationary events.

Installing

Section titled “Installing”
  • composer require ulams/stationary-events
  • php artisan migrate
  • php artisan db:seed --class="Ulams\StationaryEvents\Database\Seeders\StationaryEventPermissionSeeder"

Database

Section titled “Database”

  1. stationary_events - main table, contains information about the event

    id name description started_at finished_at max_participants place program created_at updated_at image_path short_desc status
    1 EdCamp 1 Ratione velit nisi autem et et et. 2022-07-05 16:57:57 2022-07-05 20:57:57 105 Bruenport NULL 2022-04-14 08:54:03 2022-04-14 08:54:03 NULL Et nihil et ut laudantium consequatur quasi architecto et et laudantium. draft
    2 EdCamp 2 Qui maxime aut fugit quam ea similique. 2022-06-19 07:18:33 2022-06-19 10:18:33 52 Meggiemouth NULL 2022-04-14 08:54:04 2022-04-14 08:54:04 NULL Dignissimos libero impedit eos omnis consequuntur quos officiis sit non dolore consectetur dolore sunt. published
    3 EdCamp 3 Optio voluptatem labore quia voluptas non. 2022-08-16 07:01:18 2022-08-16 12:01:18 118 Port Paulineberg NULL 2022-04-14 08:54:04 2022-04-14 08:54:04 NULL Sed culpa in possimus nihil ducimus fugiat inventore. published

  2. stationary_event_users - table to store assigned users

  3. stationary_event_authors - table to store assigned authors

  4. category_stationary_event - table to store assigned categories

StationaryEvent n -> n User (using pivot table StationaryEventUser)
StationaryEvent n -> n User (using pivot table StationaryEventAuthor)
StationaryEvent n -> n Category (using pivot table CategoryStationaryEvent)

Endpoints

Section titled “Endpoints”

All the endpoints are defined in swagger

Tests

Section titled “Tests”

Run ./vendor/bin/phpunit to run tests.

Test details codecov

Events

Section titled “Events”
  1. StationaryEventAssigned - event dispatched after assigning user to stationary event
  2. StationaryEventUnassigned - event dispatched after detaching user form stationary event
  3. StationaryEventAuthorAssigned - event dispatched after assigning author to stationary event
  4. StationaryEventAuthorUnassigned - event dispatched after detaching author from stationary event

How to use this on frontend

Section titled “How to use this on frontend”

Admin panel

Section titled “Admin panel”

List of stationary events List of stationary events

Stationary event form Form

Permissions

Section titled “Permissions”

Permissions are defined in seeder

More documentation in the package

Section titled “More documentation in the package”

API endpoints

Section titled “API endpoints”
Method Path Auth Action
GET /api/admin/stationary-events yes StationaryEventAdminApiController@index
POST /api/admin/stationary-events yes StationaryEventAdminApiController@store
PUT /api/admin/stationary-events/{id} yes StationaryEventAdminApiController@update
GET /api/admin/stationary-events/{id} yes StationaryEventAdminApiController@show
DELETE /api/admin/stationary-events/{id} yes StationaryEventAdminApiController@delete
GET /api/stationary-events/me yes StationaryEventApiController@forCurrentUser
GET /api/stationary-events StationaryEventApiController@index
GET /api/stationary-events/{id} StationaryEventApiController@show

Permissions

Section titled “Permissions”
Permission Seeded for roles Constant
stationary-event_list admin, tutor StationaryEventPermissionsEnum::STATIONARY_EVENT_LIST
stationary-event_create admin, tutor StationaryEventPermissionsEnum::STATIONARY_EVENT_CREATE
stationary-event_read admin, tutor StationaryEventPermissionsEnum::STATIONARY_EVENT_READ
stationary-event_update admin, tutor StationaryEventPermissionsEnum::STATIONARY_EVENT_UPDATE
stationary-event_delete admin, tutor StationaryEventPermissionsEnum::STATIONARY_EVENT_DELETE

Settings

Section titled “Settings”

Registered with AdministrableConfig::registerConfig (editable in the admin panel under Configuration → Settings).

None.

Events

Section titled “Events”
Event Description Notification templates
StationaryEventAssigned
StationaryEventAuthorAssigned
StationaryEventAuthorUnassigned
StationaryEventUnassigned

Artisan commands

Section titled “Artisan commands”

None.

Scheduled jobs

Section titled “Scheduled jobs”

None.

Environment variables read

Section titled “Environment variables read”

None.