tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-09-28 20:29:15 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #9360 from andrewandante/docs/carpentry_for_url_variable_tools_tables

Browse Source 
fix markdown tables for url variables documentation
This commit is contained in:
Loz Calver 2019-12-19 11:19:34 +00:00 committed by GitHub
commit ff763d30b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/en/02_Developer_Guides/07_Debugging/02_URL_Variable_Tools.md
View File

@ -20,55 +20,55 @@ session variables, used templates and much more.
## Templates
| URL Variable | | Values | | Description |
| ------------ | | ------ | | ----------- |
| flush | | 1 | | Clears out all caches. Used mainly during development, e.g. when adding new classes or templates. Requires "dev" mode or ADMIN login |
| showtemplate | | 1 | | Show the compiled version of all the templates used, including line numbers. Good when you have a syntax error in a template. Cannot be used on a Live site without **isDev**. |
| URL Variable | Values | Description |
| ------------ | ------ | ----------- |
| flush | 1 | Clears out all caches. Used mainly during development, e.g. when adding new classes or templates. Requires "dev" mode or ADMIN login |
| showtemplate | 1 | Show the compiled version of all the templates used, including line numbers. Good when you have a syntax error in a template. Cannot be used on a Live site without **isDev**. |
## General Testing
| URL Variable | | Values | | Description |
| ------------ | | ------ | | ----------- |
| isDev | | 1 | | Put the site into [development mode](../), enabling debugging messages to the browser on a live server. For security, you'll be asked to log in with an administrator log-in. Will persist for the current browser session. |
| isTest | | 1 | | See above. |
| debug | | 1 | | Show a collection of debugging information about the director / controller operation |
| debug_request | | 1 | | Show all steps of the request from initial [HTTPRequest](api:SilverStripe\Control\HTTPRequest) to [Controller](api:SilverStripe\Control\Controller) to Template Rendering |
| execmetric | | 1 | | Display the execution time and peak memory usage for the request |
| URL Variable | Values | Description |
| ------------ | ------ | ----------- |
| isDev | 1 | Put the site into [development mode](../), enabling debugging messages to the browser on a live server. For security, you'll be asked to log in with an administrator log-in. Will persist for the current browser session. |
| isTest | 1 | See above. |
| debug | 1 | Show a collection of debugging information about the director / controller operation |
| debug_request | 1 | Show all steps of the request from initial [HTTPRequest](api:SilverStripe\Control\HTTPRequest) to [Controller](api:SilverStripe\Control\Controller) to Template Rendering |
| execmetric | 1 | Display the execution time and peak memory usage for the request |
## Classes and Objects
| URL Variable | | Values | | Description |
| ------------ | | ------ | | ----------- |
| debugfailover | | 1 | | Shows failover methods from classes extended |
| URL Variable | Values | Description |
| ------------ | ------ | ----------- |
| debugfailover | 1 | Shows failover methods from classes extended |
## Database
| URL Variable | | Values | | Description |
| ------------ | | --------- | | ----------- |
| showqueries | | 1|inline | | List all SQL queries executed, the `inline` option will do a fudge replacement of parameterised queries |
| showqueries | | 1|backtrace | | List all SQL queries executed, the `backtrace` option will do a fudge replacement of parameterised queries *and* show a backtrace of every query |
| previewwrite | | 1 | | List all insert / update SQL queries, and **don't** execute them. Useful for previewing writes to the database. |
| URL Variable | Values | Description |
| ------------ | ------------------ | ----------- |
| showqueries | 1 | inline | List all SQL queries executed, the `inline` option will do a fudge replacement of parameterised queries |
| showqueries | 1 | backtrace | List all SQL queries executed, the `backtrace` option will do a fudge replacement of parameterised queries *and* show a backtrace of every query |
| previewwrite | 1 | List all insert / update SQL queries, and **don't** execute them. Useful for previewing writes to the database. |
## Security Redirects
You can set an URL to redirect back to after a [Security](/developer_guides/security) action. See the section on [URL
Redirections](/developer_guides/controllers/redirection) for more information and examples.
| URL Variable | | Values | | Description |
| ------------ | | ------ | | ----------- |
| BackURL | | URL | | Set to a relative URL string to use once Security Action is complete |
| URL Variable | Values | Description |
| ------------ | ------ | ----------- |
| BackURL | URL | Set to a relative URL string to use once Security Action is complete |
## Building and Publishing URLS
| Site URL | | Action |
| -------- | | ------ |
| http://localhost**/dev/build** | | Rebuild the entire database and manifest, see below for additional URL Variables |
| http://localhost**/admin/pages/publishall/** | | Publish all pages on the site. Only works reliably on smaller sites.
| Site URL | Action |
| --------------------------------------------- | ------ |
| http://localhost**/dev/build** | Rebuild the entire database and manifest, see below for additional URL Variables |
| http://localhost**/admin/pages/publishall/** | Publish all pages on the site. Only works reliably on smaller sites. |
### /dev/build
| URL Variable | | Values | | Description |
| ------------ | | ------ | | ----------- |
| quiet | | 1 | | Don't show messages during build |
| dont_populate | | 1 | | Don't run **requireDefaultRecords()** on the models when building. This will build the table but not insert any records |
| URL Variable | Values | Description |
| ------------ | ------ | ----------- |
| quiet | 1 | Don't show messages during build |
| dont_populate | 1 | Don't run **requireDefaultRecords()** on the models when building. This will build the table but not insert any records |