lispa / amos-report
Sistema AMOS per le segnalazioni
Installs: 230
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Type:component
Requires
- php: >=5.4.0
- 2amigos/yii2-ckeditor-widget: ~1.0
- cornernote/yii2-workflow-manager: *
- open20/amos-admin: ~2.0
- open20/amos-core: ^1.9.50
- open20/amos-notify: ~1.4
- raoul2000/yii2-workflow: *
- raoul2000/yii2-workflow-view: *
- yiidoc/yii2-redactor: *
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-23 14:22:03 UTC
README
#Amos Report
Extension for report sending on contents like news, discussions, etc...
Installation
- The preferred way to install this extension is through composer.
Either run
composer require open20/amos-report
or add this row
"open20/amos-report": "dev-master"
to the require section of your composer.json
file.
-
Add module to your main config in backend:
'modules' => [ 'comments' => [ 'class' => 'open20\amos\report\AmosReport', 'modelsEnabled' => [ /** * Add here the classnames of the models for whose you want to enable reports * (i.e. 'open20\amos\news\models\News') */ ] ], ],
-
To send report notification not only to the content creator but also to the content validator, installation of amos-workflow is needed too
a. Add workflow to composer
"open20/amos-workflow": "dev-master"
b. check in config/main for 'workflow' in modules array, if present
'workflow' => [ 'class' => 'cornernote\workflow\manager\Module', ],
change the entry in:
'workflow-manager' => [ 'class' => 'cornernote\workflow\manager\Module', ],
c. add workflow entry (config/main in modules array):
'workflow' => [ 'class' => 'open20\amos\workflow\AmosWorkflow', ],
d. add 'workflow' entry to your bootstrap:
'bootstrap' => [ . . . 'workflow', . . . ],
-
Apply migrations
a. amos-report migrations
php yii migrate/up --migrationPath=@vendor/open20/amos-report/src/migrations
or add this row to your migrations config in console:
return [ . . . '@vendor/open20/amos-report/src/migrations', . . . ];
b. if workflow module is installed (see step 3), also add amos-workflow migrations:
php yii migrate/up --migrationPath=@vendor/open20/amos-workflow/src/migrations
or add this row to your migrations config in console:
return [ . . . '@vendor/open20/amos-workflow/src/migrations', . . . ];
Widgets
Amos Report provides two Widgets:
-
ReportWidget open20\amos\report\widgets\ReportWidget
Draw a flag icon related to a model. On flag click, the system opens form to insert a new report on a modal popup. -
TabReportsWidget open20\amos\report\widgets\TabReportsWidget
Draw the Report tab in a model view/form, containing the list of reports a specif content.
If a model has been enabled for reports, the tab is automatically injected in update phase (form) by AmosCore widget 'Tabs'.
Email Sending
After the creation of a new report on a content a mail is sent to:
- Content creator
- Content validator (if exixts)
- Users having the REPORT_MONITOR role for that content type (if role exists)
The role name must follow the general permission naming convention _REPORT_MONITOR as for eg. create and update permissions (MODELNAME_CREATE, MODELNAME_UPDATE).