2017-09-13 01:16:11 +02:00
# Content Review module developer documentation
2009-11-02 05:02:57 +01:00
2016-01-05 03:47:56 +01:00
## Configuration
2009-11-02 05:02:57 +01:00
2016-01-05 03:47:56 +01:00
### Global settings
2014-02-19 03:09:20 +01:00
2016-01-05 03:47:56 +01:00
The module is set up in the `Settings` section of the CMS, see the [User guide ](userguide/index.md ).
2014-02-19 03:09:20 +01:00
2016-01-05 03:47:56 +01:00
### Reminder emails
2009-11-02 05:02:57 +01:00
2015-07-31 06:07:18 +02:00
In order for the contentreview module to send emails, you need to *either* :
2017-09-13 01:16:11 +02:00
* Setup the `ContentReviewEmails` script to run daily via a system cron job.
* Install the [queuedjobs ](https://github.com/symbiote/silverstripe-queuedjobs ) module and follow the configuration steps to create a cron job for that module. Once installed, you can just run `dev/build` to have a job created, which will run at 9am every day by default.
2010-01-11 21:39:46 +01:00
2016-01-05 03:47:56 +01:00
## Using
2017-09-13 01:16:11 +02:00
See the [user guide ](userguide/index.md ).
2014-02-19 03:09:20 +01:00
2015-09-15 07:46:13 +02:00
## Testing
2015-10-29 19:22:35 +01:00
cd to the site root, and run:
```sh
2017-09-13 01:16:11 +02:00
$ php vendor/bin/behat @contentreview
2015-10-29 19:22:35 +01:00
```
2017-09-13 01:16:11 +02:00
or to run the unit test suite:
2015-09-15 07:46:13 +02:00
2015-10-29 19:22:35 +01:00
```sh
2017-09-13 01:16:11 +02:00
$ php vendor/bin/phpunit contentreview/tests
2015-10-29 19:22:35 +01:00
```
2013-03-18 03:20:51 +01:00
## Migration
2015-10-29 19:22:35 +01:00
If you are upgrading from an older version, you may need to run the `ContentReviewOwnerMigrationTask`