nswdpc/silverstripe-notices

Simple notices adminisration

v1.0.0-rc3 2023-07-28 01:05 UTC

Requires

• gorriecoe/silverstripe-linkfield: ^1.1
• silverstripe/admin: ^2

Requires (Dev)

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

Suggests

• nswdpc/silverstripe-schema-specialannouncement: Related - schema.org SpecialAnnouncement module

BSD-3-Clause

• James

• silverstripe
• notices

README

Simple, unopinionated, module to store notices for use by a project.

Options

A notice contains:

• A title, with 'show title' option
• Some content (not HTML)
• A link
• A auto dismiss value (seconds)
• A site-wide option (one allowed)
• An active option (enabled)

Permissions

The module adds permissions for view/add/edit/delete

Template

The module ships a basic meta template, nominally for testing purposes.

Override this template in your project to provide your own notice layout based on the notice options.

Installation

composer require nswdpc/silverstripe-notices

License

BSD-3-Clause

Documentation

Once installed, a "Notices" admin link will be available.

Configuration

None

Maintainers

• dpcdigital@NSWDPC:~$

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.

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.

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.