You are here

Home » API reference » Config Entity Revisions 8.2

README.txt in Config Entity Revisions 8.2

Same filename in this branch
  1. 8.2 README.txt
  2. 8.2 modules/contact_form_revisions/README.txt
  3. 8.2 modules/webform_revisions/README.txt
  4. 8.2 modules/view_revisions/README.txt
Contact Form Revisions
======================

This module integrates config entity revisions with the Contact Form module,
providing revisions and moderation for contact form changes.


[ ] Review the module you're wanting to extend, noting:
    Module Machine Name: core:contact
    Config Entity Machine Name: contact_form
    Config Entity Parameter Placeholder: contact_form
    Admin Routes:
    - Add form: contact.form_add
    - Edit form: entity.contact_form.edit_form
    - Delete form: entity.contact_form.delete_form
    - Your proposed revisions path and route name:
      /admin/structure/contact/manage/{contact_form}/revisions
    - Your proposed revision view, revert and delete paths and route names:
      /admin/structure/contact/manage/{contact_form}/revision/{revision_id}
      /admin/structure/contact/manage/{contact_form}/revision/{revision_id}/delete
      /admin/structure/contact/manage/{contact_form}/revision/{revision_id}/revert
    - Proposed permissions needed to view and manage revisions
    - Any route callbacks you might also need to extend / override
      (Are there content entities related to the config entity that will need
      to have revision IDs recorded and get the associated config entity
      revision loaded when the content entity is loaded? - see webform
      submissions).
      Associated Content Entity Machine Name: Message
[ ] Copy an existing implementation module
[ ] Rename files and classes
[ ] Basic submodule info (.info.yml)
[ ] Documentation (ideally do as you complete the following)
[ ] Unit tests (ideally do as you complete the following)
[ ] Update install schema
[ ] Implement install hooks as required
[ ] Implement uninstall hooks
[ ] Revision creation
[ ] Revision table
[ ] Parameter Converter for config entity (easier to debug when you have some
    revisions already created)
[ ] Revision Reversion
[ ] Revision Deletion (associated content entities!)
[ ] Workflow integration
[ ] Views Integration

If there's an associated content entity:
[ ] Add form uses currently published config entity revision
[ ] Add form stores the current config entity revision ID
[ ] Edit form loads the matching config entity revision
[ ] View content entity loads appropriate config entity revision
[ ] Deletion of a config entity revision cascade deletes content entities
    after warning (or other handling if more appropriate)

File

modules/contact_form_revisions/README.txt
View source 
  1. Contact Form Revisions

  2. ======================

  3. 

  4. This module integrates config entity revisions with the Contact Form module,

  5. providing revisions and moderation for contact form changes.

  6. 

  7. 

  8. [ ] Review the module you're wanting to extend, noting:

  9.     Module Machine Name: core:contact

  10.     Config Entity Machine Name: contact_form

  11.     Config Entity Parameter Placeholder: contact_form

  12.     Admin Routes:

  13.     - Add form: contact.form_add

  14.     - Edit form: entity.contact_form.edit_form

  15.     - Delete form: entity.contact_form.delete_form

  16.     - Your proposed revisions path and route name:

  17.       /admin/structure/contact/manage/{contact_form}/revisions

  18.     - Your proposed revision view, revert and delete paths and route names:

  19.       /admin/structure/contact/manage/{contact_form}/revision/{revision_id}

  20.       /admin/structure/contact/manage/{contact_form}/revision/{revision_id}/delete

  21.       /admin/structure/contact/manage/{contact_form}/revision/{revision_id}/revert

  22.     - Proposed permissions needed to view and manage revisions

  23.     - Any route callbacks you might also need to extend / override

  24.       (Are there content entities related to the config entity that will need

  25.       to have revision IDs recorded and get the associated config entity

  26.       revision loaded when the content entity is loaded? - see webform

  27.       submissions).

  28.       Associated Content Entity Machine Name: Message

  29. [ ] Copy an existing implementation module

  30. [ ] Rename files and classes

  31. [ ] Basic submodule info (.info.yml)

  32. [ ] Documentation (ideally do as you complete the following)

  33. [ ] Unit tests (ideally do as you complete the following)

  34. [ ] Update install schema

  35. [ ] Implement install hooks as required

  36. [ ] Implement uninstall hooks

  37. [ ] Revision creation

  38. [ ] Revision table

  39. [ ] Parameter Converter for config entity (easier to debug when you have some

  40.     revisions already created)

  41. [ ] Revision Reversion

  42. [ ] Revision Deletion (associated content entities!)

  43. [ ] Workflow integration

  44. [ ] Views Integration

  45. 

  46. If there's an associated content entity:

  47. [ ] Add form uses currently published config entity revision

  48. [ ] Add form stores the current config entity revision ID

  49. [ ] Edit form loads the matching config entity revision

  50. [ ] View content entity loads appropriate config entity revision

  51. [ ] Deletion of a config entity revision cascade deletes content entities

  52.     after warning (or other handling if more appropriate)