Skip to content
ulamsulamsulams docs

Package: categories

Generated from api/packages/categories

Source: api/packages/categories · imported version 0.1.43. 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 for creating Categories for Ulams.

Installing

Section titled “Installing”
  • composer require ulams/categories
  • php artisan migrate
  • php artisan db:seed --class="Ulams\Consultations\Database\Seeders\ConsultationsPermissionSeeder"

Endpoints

Section titled “Endpoints”

All the endpoints are defined in swagger

Tests

Section titled “Tests”

Run ./vendor/bin/phpunit --filter 'Ulams\\Categories\\Tests' to run tests. See tests folder as it’s quite good staring point as documentation appendix.

Admin panel

Section titled “Admin panel”

Left menu

Menu

List of consultations

List of categories

Creating/editing consultation

Creating/editing category

Permissions

Section titled “Permissions”

Permissions are defined in seeder

Features

Section titled “Features”

The lib allows categories

  • adding a category
  • generate slug for category
  • edit category
  • delete category
  • show list categories
  • if you want to remove category which has sub categories, earlier delete sub categories

To play the content you can use Ulams Categories

Seeder

Section titled “Seeder”

You can seed library and content with build-in seeders that are accessible with

  • php artisan category-permissions:seed to add permissions
  • php artisan db:seed --class="\Ulams\Categories\Database\Seeders\CategoriesSeeder"
  1. Parent Category is related belong to with other category
  2. Children Category is related has many with other categories
  3. Courses Category belongs to many with models Course
  4. Users Category is related belongs to many with User
Category 1 -> 1 Category (Parent)
Category 1 -> n Category (Children)
Category 1 -> n Course
Category 1 -> n Users

More documentation in the package

Section titled “More documentation in the package”

API endpoints

Section titled “API endpoints”
Method Path Auth Action
GET /api/categories CategoryAPIController@index
GET /api/categories/tree CategoryAPIController@tree
GET /api/admin/categories yes CategoryAPIController@index
POST /api/admin/categories/sort yes CategoryAPIController@sort
GET /api/admin/categories/tree yes CategoryAPIController@tree
GET /api/admin/categories/{category} yes CategoryAPIController@show
POST /api/admin/categories yes CategoryAPIController@create
DELETE /api/admin/categories/{category} yes CategoryAPIController@delete
POST /api/admin/categories/{category} yes CategoryAPIController@update

Permissions

Section titled “Permissions”
Permission Seeded for roles Constant
category_list admin, tutor CategoriesPermissionsEnum::CATEGORY_LIST
category_read admin, tutor CategoriesPermissionsEnum::CATEGORY_READ
category_update admin, tutor CategoriesPermissionsEnum::CATEGORY_UPDATE
category_create admin, tutor CategoriesPermissionsEnum::CATEGORY_CREATE
category_delete admin, tutor CategoriesPermissionsEnum::CATEGORY_DELETE

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”
Command Description Signature
category-permissions:seed Seed the database with the permissions required to support the categories category-permissions:seed

Scheduled jobs

Section titled “Scheduled jobs”

None.

Environment variables read

Section titled “Environment variables read”

None.