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

Merge pull request #8585 from zzdjk6/patch-1

Browse Source 
DOC: Update documentation on `How to extend the CMS interface`
This commit is contained in:
Robbie Averill 2018-12-12 19:53:18 +00:00 committed by GitHub
commit 79887cbea7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/Extend_CMS_Interface.md
View File

@ -24,10 +24,10 @@ the common `Page` object (a new PHP class `MyPage` will look for a `MyPage.ss` t
We can use this to create a different base template with `LeftAndMain.ss` We can use this to create a different base template with `LeftAndMain.ss`
(which corresponds to the `LeftAndMain` PHP controller class). (which corresponds to the `LeftAndMain` PHP controller class).
Copy the template markup of the base implementation at `templates/SilverStripe/Admin/Includes/LeftAndMain_Menu.ss` Copy the template markup of the base implementation at `templates/SilverStripe/Admin/Includes/LeftAndMain_MenuList.ss`
from the `silverstripe/admin` module from the `silverstripe/admin` module
into `app/templates/Includes/LeftAndMain_Menu.ss`. It will automatically be picked up by into `app/templates/SilverStripe/Admin/Includes/LeftAndMain_MenuList.ss`. It will automatically be picked up by
the CMS logic. Add a new section into the `<ul class="cms-menu-list">` the CMS logic. Add a new section into the `<ul class="cms-menu__list">`
```ss ```ss
@ -69,26 +69,42 @@ SilverStripe\Admin\LeftAndMain:
- app/css/BookmarkedPages.css - app/css/BookmarkedPages.css
``` ```
In order to let the frontend have the access to our `css` files, we need to `expose` them in the `composer.json`:
```javascript
"extra": {
...
"expose": [
"app/css"
]
},
```
Then run `composer vendor-expose`. This command will publish all the `css` files under the `app/css` folder to their public-facing paths.
> Note: don't forget to `flush`.
## Create a "bookmark" flag on pages ## Create a "bookmark" flag on pages
Now we'll define which pages are actually bookmarked, a flag that is stored in Now we'll define which pages are actually bookmarked, a flag that is stored in
the database. For this we need to decorate the page record with a the database. For this we need to decorate the page record with a
`DataExtension`. Create a new file called `app/code/BookmarkedPageExtension.php` `DataExtension`. Create a new file called `app/src/BookmarkedPageExtension.php`
and insert the following code. and insert the following code.
```php ```php
use SilverStripe\Forms\CheckboxField; use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\FieldList;
use SilverStripe\ORM\DataExtension; use SilverStripe\ORM\DataExtension;
class BookmarkedPageExtension extends DataExtension class BookmarkedPageExtension extends DataExtension
{ {
private static $db = [ private static $db = [
'IsBookmarked' => 'Boolean' 'IsBookmarked' => 'Boolean'
]; ];
public function updateCMSFields(FieldList $fields) public function updateCMSFields(FieldList $fields)
{ {
$fields->addFieldToTab('Root.Main', $fields->addFieldToTab('Root.Main',
new CheckboxField('IsBookmarked', "Show in CMS bookmarks?") new CheckboxField('IsBookmarked', "Show in CMS bookmarks?")
@ -117,7 +133,7 @@ pages from the database into the template we've already created (with hardcoded
links)? Again, we extend a core class: The main CMS controller called links)? Again, we extend a core class: The main CMS controller called
`LeftAndMain`. `LeftAndMain`.
Add the following code to a new file `app/code/BookmarkedLeftAndMainExtension.php`; Add the following code to a new file `app/src/BookmarkedLeftAndMainExtension.php`;
```php ```php
@ -143,12 +159,12 @@ SilverStripe\Admin\LeftAndMain:
``` ```
As the last step, replace the hardcoded links with our list from the database. As the last step, replace the hardcoded links with our list from the database.
Find the `<ul>` you created earlier in `app/admin/templates/LeftAndMain.ss` Find the `<ul>` you created earlier in `app/templates/SilverStripe/Admin/Includes/LeftAndMain_MenuList.ss`
and replace it with the following: and replace it with the following:
```ss ```ss
<ul class="cms-menu-list"> <ul class="cms-menu__list">
<!-- ... --> <!-- ... -->
<% loop $BookmarkedPages %> <% loop $BookmarkedPages %>
<li class="bookmarked-link $FirstLast"> <li class="bookmarked-link $FirstLast">
@ -168,7 +184,7 @@ The following conventions apply:
* New actions can be added by redefining `getCMSActions`, or adding an extension * New actions can be added by redefining `getCMSActions`, or adding an extension
with `updateCMSActions`. with `updateCMSActions`.
* It is required the actions are contained in a `FieldSet` (`getCMSActions` * It is required the actions are contained in a `FieldList` (`getCMSActions`
returns this already). returns this already).
* Standalone buttons are created by adding a top-level `FormAction` (no such * Standalone buttons are created by adding a top-level `FormAction` (no such
button is added by default). button is added by default).