nswdpc/silverstripe-pruner-userforms

Silverstripe userforms support for nswdpc/silverstripe-pruner

v1.0.0 2024-07-26 02:54 UTC

Requires

• nswdpc/silverstripe-pruner: ^1
• silverstripe/userforms: ^6

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• phpunit/phpunit: ^9.5

Suggests

• dnadesign/silverstripe-elemental-userforms: Forms as elemental blocks

BSD-3-Clause

• James Ellis

• userforms
• removal
• pruning

README

Userforms extension to nswdpc/silverstripe-pruner, to remove submitted form records after a configured time period.

Install

composer require nswdpc/silverstripe-pruner-userforms

Using

1. Create a NSWDPC\Pruner\PruneJob queued job with the following constructor arguments:
   1. days_ago (float, remove records older than this number of days)
   2. limit (int, limit records in this operation to this number)
   3. targets (string SilverStripe\UserForms\Model\Submission\SubmittedForm)
   4. report_only (1|0, set to 1 to run the job in report only mode, nothing is removed)
2. Run the job

Example: report only on the removal of submitted form records older than 28 days at the time the job runs, 500 records per run:

Limits

As SubmittedForm has a polymorphic has_one parent, the limit parameter specified is used per parent class. If you have specified a limit of 50 and have multiple parent classes for the SubmittedForm model, that limit will be set per parent.

This will be the case if you have dnadesign/silverstripe-elemental-userforms active alongside silverstripe/userforms.

Maintainers

• dpcdigital@NSWDPC:~$

License

BSD-3-Clause

Security

If you have found a security issue with this module, please email digital[@]dpc.nsw.gov.au in the first instance, detailing your findings.

Bugtracker

We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.

Please review the code of conduct prior to opening a new issue.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Please review the code of conduct prior to completing a pull request.