Package: core

Source: api/packages/core · imported version 1.3.15. The sections after the README are extracted from the code on every docs build.

README

Ulams LMS Core Package

Package contains all basic classes and features used in Ulams LMS, and it’s obligatory to work with any other LMS package.

Repositories

Package contains Ulams\Core\Repositories\BaseRepository class, that should extend all other repositories.

For searching and filtering data you may use Criteria array, basic criteria are also provided in this package.

// TODO: Example of Criteria usage

Users

User model and migrations provided by this package are the simplest user model that may be used in LMS. In the real app, you should setup your own guard, that may extend Ulams\Ulams\Models\User and use user traits from other packages.

API endpoints

Method	Path	Auth	Action
GET	/api/core/packages	yes	CoreController@packages
GET	/api/core/health-check		HealthCheckController@healthCheck
POST	/api/csp-report		CspReportController@store
GET	/api/admin/csp-reports	yes	CspReportController@index

Permissions

None.

Settings

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

None.

Events

None.

Artisan commands

Command	Description	Signature
csp-reports:prune	Delete aggregated CSP violation reports that were not seen for a while	csp-reports:prune {--days= : Keep reports seen within this many days (default: ulams.core.csp.retention_days)}

Scheduled jobs

Kind	Target	Frequency
command	'csp-reports:prune'	dailyAt('03:20')

Environment variables read

ADMIN_URL, CSP_REPORT_RETENTION_DAYS, ORIGIN_CHECK, TRUSTED_ORIGINS