DOC Document new CMSEditLink extension. #85
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
5 tasks
f931340 to
48ef5a2
Compare
991517a to
353eff5
Compare
353eff5 to
2621b64
Compare
2621b64 to
be6cd68
Compare
emteknetnz
requested changes
Sep 29, 2022
|
|
||
| When using this extension, your model must also declare its `cms_edit_owner` as a | ||
| [configuration property](../configuration/configuration/#configuration-properties). The value must either be the class name of the | ||
| `ModelAdmin` that directly manages the record, or the `has_one` relation for the record that this model is edited on. |
There was a problem hiding this comment.
Suggested change
| `ModelAdmin` that directly manages the record, or the `has_one` relation for the record that this model is edited on. | |
| `ModelAdmin` that directly manages the record, or the `has_one` relation for the record that this model is edited on, which is often the parent DataObject |
|
|
||
| ## Getting an edit link | ||
|
|
||
| To get a link for editing a record, other than some exceptions like `SiteTree`, you have historically had to generate the link mostly |
There was a problem hiding this comment.
I don't think we need to provide a historical background. The docs we provide are always for the latest version. Unfortunately we don't contain docs for older minor versions, though that's just a limitation of our documentation system, and not something we should attempt to handle here
| If the `cms_edit_owner` is a `has_one` relation, the class on the other end of the relation _must_ have | ||
| a reciprocal `has_many` relation as documented in [Relations](./relations#has-many). For best results, use dot notation on the | ||
| `has_many` relation. It must also implement a [getCMSEditLinkForManagedDataObject()](api:SilverStripe\Admin\CMSEditLinkExtension::getCMSEditLinkForManagedDataObject()) | ||
| method. The easiest way to do that is for it to have `CMSEditLinkExtension` applied as well. |
There was a problem hiding this comment.
Suggested change
| method. The easiest way to do that is for it to have `CMSEditLinkExtension` applied as well. | |
| method. The easiest way to do that is for it to apply the `CMSEditLinkExtension` to the reciprocal class. |
|
|
||
| [hint] | ||
| If the `cms_edit_owner` is in some vendor dependency that you don't control, you can always apply `CMSEditLinkExtension` | ||
| and the `cms_edit_owner` via yaml. |
There was a problem hiding this comment.
Suggested change
| and the `cms_edit_owner` via yaml. | |
| and the `cms_edit_owner` via yml. |
en/04_Changelogs/4.12.0.md
Outdated
|
|
||
| ### New `CMSEditLinkExtension` | ||
|
|
||
| The silverstripe/admin module has a new [CMSEditLinkExtension](api:SilverStripe\Admin\CMSEditLinkExtension) which makes it trivial to generate an edit link for any `DataObject` even in nested `GridField` setups. This is useful, for example, when [making a previewable `DataObject`](/developer_guides/customising_the_admin_interface/preview/) or as links in reminder emails for stale content. |
There was a problem hiding this comment.
Suggested change
| The silverstripe/admin module has a new [CMSEditLinkExtension](api:SilverStripe\Admin\CMSEditLinkExtension) which makes it trivial to generate an edit link for any `DataObject` even in nested `GridField` setups. This is useful, for example, when [making a previewable `DataObject`](/developer_guides/customising_the_admin_interface/preview/) or as links in reminder emails for stale content. | |
| The `silverstripe/admin module` has a new [CMSEditLinkExtension](api:SilverStripe\Admin\CMSEditLinkExtension) which is used to generate CMS edit links for `DataObject`s, including those in nested `GridField` setups. | |
| This allows you to share DataObject edit links directly with others. This extension is also used to facilitate CMS preview of DataObjects |
be6cd68 to
2c45760
Compare
emteknetnz
approved these changes
Sep 30, 2022
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.
Documents the new extension in silverstripe/silverstripe-admin#1361
Assumes silverstripe/silverstripe-cms#2778 is also merged.
Related Issue