A module to make managing pages in a GridField easy without losing any of the functionality that you're used to in the CMS.
This is intended to be used in cases where the SiteTree grows beyond a manageable level. eg. blogs, news sections, shops, etc.
This module was born out of and decoupled from micmania1/silverstripe-blog.
silverstripe/cms: 3.1+
composer require silverstripe/lumberjack
- Easily define which page types to show in the SiteTree and which to manage in a GridField.
- Keep all functionality that comes with the CMS, including versioning and preview.
In this example we have a NewsHolder page which is the root of our news section, containing NewsArticles and
NewsPages. We want to display NewsPage in the site tree but we want to display NewsArticles in a GridField.
<?php
class NewsHolder extends Page {
private static $extensions = array(
'Lumberjack',
);
private static $allowed_children = array(
'NewsArticle',
'NewsPage',
);
}
class NewsArticle extends Page {
private static $show_in_sitetree = false;
private static $allowed_children = array();
}
class NewsPage extends Page {
private static $show_in_sitetree = true;
}
If show_in_sitetree is not explicitly defined on a class, then it will default to true. You can add this setting to
core classes and modules using the YAML config system. It is not recommended to add the LumberJack extension to
the SiteTree or Page class.
:::yaml
BlogHolder:
extensions:
- 'Lumberjack'
BlogEntry:
show_in_sitetree: false
By default all children in Lumberjack GridField are sorted by SiteTree default Sort and can be filtered by their Title. This is restrictive but neccessary because there can be multiple different child classes and these are the values they all have in common.
If you are only using one single child class in a Lumberjack Gridfield you can overcome this restriction by setting the $child classname to the class extending Lumberjack via config.
This will enable the following functionality:
$default_sortof child class is picked upGridFieldSortableHeaderwill work with all variables of the child classGridFieldFilterHeaderwill work with all variables of the child class
Add the $child_classname value to the class extending Lumberjack via config.yml:
NewsHolder:
extensions:
- Lumberjack
child_classname: 'NewsPage'or via static variable inside the extended Class:
class NewsHolder extends Page {
private static $extensions = array('Lumberjack');
private static $child_classname = 'NewsPage'
}