Package: pages
Generated from api/packages/pages
Source: api/packages/pages · imported version 0.1.11. The sections after the README are extracted from the code on every docs build.
README
Section titled “README”Static page management package
What does it do
Section titled “What does it do”This package allows you to create static pages in Laravel app.
Installing
Section titled “Installing”composer require ulams/pages,php artisan migratephp artisan db:seed --class="Ulams\Pages\Database\Seeders\PermissionTableSeeder"
Endpoints
Section titled “Endpoints”All the endpoints are defined in
Run ./vendor/bin/phpunit --filter 'Ulams\\Pages\\Tests' to run tests. See tests a quite good starting point for creating your own.
Permissions
Section titled “Permissions”Permissions are defined in seeder
Database relation
Section titled “Database relation”AuthorPage is related belong to with User
Page 1 -> 1 AuthorMore documentation in the package
Section titled “More documentation in the package”API endpoints
Section titled “API endpoints”| Method | Path | Auth | Action |
|---|---|---|---|
GET |
/api/admin/pages |
yes | PagesAdminApiController@list |
GET |
/api/admin/pages/{id} |
yes | PagesAdminApiController@read |
POST |
/api/admin/pages |
yes | PagesAdminApiController@create |
DELETE |
/api/admin/pages/{id} |
yes | PagesAdminApiController@delete |
PATCH |
/api/admin/pages/{id} |
yes | PagesAdminApiController@update |
GET |
/api/pages |
PagesApiController@list |
|
GET |
/api/pages/{slug} |
PagesApiController@read |
Permissions
Section titled “Permissions”| Permission | Seeded for roles | Constant |
|---|---|---|
page_list |
admin | PagesPermissionsEnum::PAGE_LIST |
page_read |
admin | PagesPermissionsEnum::PAGE_READ |
page_create |
admin | PagesPermissionsEnum::PAGE_CREATE |
page_delete |
admin | PagesPermissionsEnum::PAGE_DELETE |
page_update |
admin | PagesPermissionsEnum::PAGE_UPDATE |
Settings
Section titled “Settings”Registered with AdministrableConfig::registerConfig (editable in the admin panel under Configuration → Settings).
None.
Events
Section titled “Events”None.
Artisan commands
Section titled “Artisan commands”None.
Scheduled jobs
Section titled “Scheduled jobs”None.
Environment variables read
Section titled “Environment variables read”None.