Frontend | Backend | Api

Documentation default templates (Backend)

This page contains an overview of the default templates for the Documentation module.

The overview is generated based on controllers using the specified template as their default layout and containing GET methods; thus depending on the configuration the controller might not use the template at all or other controllers might use the template too.
The table is only meant as a first orientation which ResponseVariables can likely be expected when working with the template.

File Controller GET Response variables GET Description
documentation/backend/comments/add.html Comments\Add
Name Type Description
comment Comment Single (empty) Comment record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
documentation/backend/comments/edit.html Comments\Edit
Name Type Description
comment Comment Retrieved Comment record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve a single record and display the edit page for the record
documentation/backend/comments/manage.html Comments\Manage
Name Type Description
comments Collection (Comment) Collection of Comments
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve available records and assign them to the template for editing.
documentation/backend/global-comments/add.html GlobalComments\Add
Name Type Description
globalComment GlobalComment Single (empty) GlobalComment record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
documentation/backend/global-comments/edit.html GlobalComments\Edit
Name Type Description
globalComment GlobalComment Retrieved GlobalComment record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve a single record and display the edit page for the record
documentation/backend/global-comments/manage.html GlobalComments\Manage
Name Type Description
globalComments Collection (GlobalComment) Collection of GlobalComments
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve available records and assign them to the template for editing.
documentation/backend/global-pages/add.html GlobalPages\Add
Name Type Description
globalPage GlobalPage Single (empty) GlobalPage record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
documentation/backend/global-pages/edit.html GlobalPages\Edit
Name Type Description
globalPage GlobalPage Retrieved GlobalPage record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve a single record and display the edit page for the record
documentation/backend/global-pages/manage.html GlobalPages\Manage
Name Type Description
globalPages Collection (GlobalPage) Collection of GlobalPages
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve available records and assign them to the template for editing.
documentation/backend/pages/add.html Pages\Add
Name Type Description
page Page Single (empty) Page record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
documentation/backend/pages/edit.html Pages\Edit
Name Type Description
page Page Retrieved Page record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve a single record and display the edit page for the record
documentation/backend/pages/manage.html Pages\Manage
Name Type Description
pages Collection (Page) Collection of Pages
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve available records and assign them to the template for editing.