g
Frontend | Backend | Api

Documentation routes

Name Request Response variables Description
addPage

GET /cdna-admin/documentation/add-page/{parent.id}

parent.id \d+
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.
addGlobalPage

GET /cdna-admin/documentation/add-global-page/{parent.id}

parent.id \d+
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.
managePages

GET /cdna-admin/documentation/pages

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.
manageGlobalPages

GET /cdna-admin/documentation/global-pages

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.
addComment

GET /cdna-admin/documentation/add-comment/{page.id}/{parent.id}

page.id \d+
parent.id \d+
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.
editComment

GET /cdna-admin/documentation/comment/{id}

id \d+
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
manageComments

GET /cdna-admin/documentation/comments/{page.id}

page.id \d+
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.
addGlobalComment

GET /cdna-admin/documentation/add-global-comment/{page.id}/{parent.id}

page.id \d+
parent.id \d+
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.
editGlobalComment

GET /cdna-admin/documentation/global-comment/{id}

id \d+
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
manageGlobalComments

GET /cdna-admin/documentation/global-comments/{page.id}

page.id \d+
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.