DOC Document new AdminController #598
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Lint failure is unrelated |
7 tasks
GuySartorelli
force-pushed
the
pulls/6/new-admincontroller
branch
from
7933621 to
0335e3f
Compare
GuySartorelli
commented
Oct 16, 2024
| We'll now add an `Extension` subclass to `LeftAndMain`, which is the main CMS controller. | ||
| We'll now add an `Extension` subclass to `LeftAndMain`, which is the main CMS UI controller. |
There was a problem hiding this comment.
AdminController is the main CMS controller, but LeftAndMain is still the main CMS UI controller which is what this section is talking about.
GuySartorelli
commented
Oct 16, 2024
Comment on lines
-512
to
+524
| You can change the level of entropy required by passing one of the valid [minScore values](https://symfony.com/doc/current/reference/constraints/PasswordStrength.html#minscore) into [`api:SilverStripe\Forms\ConfirmedPasswordField::setMinPasswordStrength()`](ConfirmedPasswordField::setMinPasswordStrength()). | ||
| You can change the level of entropy required by passing one of the valid [minScore values](https://symfony.com/doc/current/reference/constraints/PasswordStrength.html#minscore) into [`ConfirmedPasswordField::setMinPasswordStrength()`](api:SilverStripe\Forms\ConfirmedPasswordField::setMinPasswordStrength()). |
There was a problem hiding this comment.
Unrelated - link syntax was the wrong way around.
GuySartorelli
commented
Oct 16, 2024
|
|
||
| [`LeftAndMain`](api:SilverStripe\Admin\LeftAndMain) has historically been the superclass for all controllers routed in `/admin/*` (i.e. all controllers used in the CMS). That class includes a lot of boilerplate functionality for setting up a menu, edit form, etc which a lot of controllers don't need. | ||
|
|
||
| A new [`AdminController`](api:SilverStripe\Admin\AdminController) has been created which provides the `/admin/*` routing functionality and permission checks that `LeftAndMain` used to be responsible for. If you have a controller which needs to be routed through `/admin/*` with the relevant CMS permission checks, but which does *not* need a menu item on the left or an edit form, you should update that class to be a subclass of `AdminController` instead. |
There was a problem hiding this comment.
I'm over-simplifying here - no need to mention that AdminRootController does the actual routing part, I think.
GuySartorelli
commented
Oct 16, 2024
|
|
||
| [`LeftAndMain`](api:SilverStripe\Admin\LeftAndMain) has historically been the superclass for all controllers routed in `/admin/*` (i.e. all controllers used in the CMS). That class includes a lot of boilerplate functionality for setting up a menu, edit form, etc which a lot of controllers don't need. | ||
|
|
||
| A new [`AdminController`](api:SilverStripe\Admin\AdminController) has been created which provides the `/admin/*` routing functionality and permission checks that `LeftAndMain` used to be responsible for. If you have a controller which needs to be routed through `/admin/*` with the relevant CMS permission checks, but which does *not* need a menu item on the left or an edit form, you should update that class to be a subclass of `AdminController` instead. |
There was a problem hiding this comment.
Also not mentioning anything about formschema here because there's a follow-up card which will change where that code lives and I don't want to write a bunch of doc and then change it immediately afterward.
emteknetnz
approved these changes
Oct 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mostly reflects the changes in silverstripe/silverstripe-admin#1836
There's a few minor improvements dotted in (adding backticks around code references, etc)
Issue
admin/*routing logic fromLeftAndMaininto its own abstract class silverstripe-admin#1761