Content Slices for SilverStripe
Content management in "slices" configured via YAML; separate content components, each with their own template, fields and visual settings that can be created and arranged by a user in the CMS., (*1)
Usage
It's best to use silverstripe-slices with lots of generic fields on the base slice class, since this allows templates to share fields and be configured in YAML without creating a class for each slice. silverstripe-adaptivecontent works well for this (and used to be integrated with this module)., (*2)
# Use the generic fields in silverstripe-adaptivecontent
Slice:
extensions:
- 'AdaptiveContent'
- "AdaptiveContentRelated('Page')"
Templates
Each slice type/template has it's own template file with the name [BaseSliceClass]_[TemplateName]. These should go in themes/[theme]/templates/[MyProject]/DataObjects/Slices to separate them from the other templates in your site., (*3)
Adding Slices to Page
This module comes with an extension for easily setting up Slices on Page:, (*4)
Page:
extensions:
- Heyday\Extensions\PageSlicesExtension
In templates, all slices can be rendered using this:, (*5)
<% if $Slices %>
<% loop $Slices %>
$forTemplate
<% end_loop %>
<% end_if %>
Subclassing Slice
Subclassing Slice is a normal use case, however note that when subclassing it, you'll need to override the method getBaseSliceClass method in your "base" slice subclass (the one you point to in a has_many from Page) for the slice to save correctly:, (*6)
<?php
namespace MyProject\DataObjects\Slices;
use Heyday\SilverStripeSlices\DataObjects\Slice;
class ContentSlice extends Slice
{
protected function getBaseSliceClass()
{
return __CLASS__;
}
}
class VideoSlice extends ContentSlice
{
// Subclasses of your 'base' subclass don't need anything special
}
This is due to the the module needing a "default" class to fall back to when the className key has not been set in a template config., (*7)
You also need to extends the Extension, (*8)
<?php
namespace MyProject\Extensions;
use MyProject\DataObjects\Slices\ContentSlice;
use Heyday\SilverStripeSlices\Extensions\PageSlicesExtension as BasePageSlicesExtension;
/**
* Extension to add slice management to Page
*/
class PageSlicesExtension extends BasePageSlicesExtension
{
/**
* @var array
*/
private static $has_many = [
// update the relation with your sub class
'Slices' => ContentSlice::class
];
}
And update the configuration accordingly., (*9)
Page:
extensions:
- MyProject\Extensions\PageSlicesExtension
Using Slices on a sub class of a Page/SiteTree
In case you want to use the slices on a custom page type, you will also need to override the has_one relation to match your sub class., (*10)
Let's say you have a custom page type named GenericPage., (*11)
<?php
namespace MyProject\Pages;
use SilverStripe\CMS\Model\SiteTree;
/**
* Class GenericPage
*/
class GenericPage extends SiteTree
{
// ...
You need to add the following Extension:, (*12)
<?php
namespace MyProject\Extensions;
use MyProject\Pages\GenericPage;
use SilverStripe\ORM\DataExtension;
/**
* Extension to change the parent of a slice
*/
class SliceExtension extends DataExtension
{
private static $has_one = array(
'Parent' => GenericPage::class
);
}
Then udpate the configuration:, (*13)
Heyday\SilverStripeSlices\DataObjects\Slice:
extensions:
- Caltex\Extensions\SliceExtension
Customising CMS fields
Adding and modifying fields in YourBaseSlice::getCMSFields is an expected use case. Note that things configured in the slices YAML configuration will be overriden if, for example, you replace a field with something custom. In this case, you can re-apply the slices config with the following at the end of your getCMSFields function:, (*14)
// Re-apply slices config
$config = $this->getCurrentTemplateConfig();
$this->configureFieldsFromConfig($fields, $config);
Example config
Slice:
# Define stylesheets to be used when previewing slices in the CMS
previewStylesheets:
- /themes/base/css/styles.css
# Automatically configure the upload folder for these file fields on Slice
# Files and images will be uploaded to assets/Uploads/Slices/[TemplateName]
uploadFolderFields:
- LeadImage
- SecondaryImage
- LeadFile
# The default slice template can be specified, or defaults to the first defined
# This is just what is selected by default when a new slice is created
defaultTemplate: TwoColumnImage
templates:
Quote:
fields:
Title: Quotee
Content:
# Set the CMS "title" of the field
label: Quote
# Change the form component used for this field
fieldClass: TextareaField
# Cast the field to something when rendering it in the template
casting: Text
# Value to use for the field's "right title"
help: ~20 - 30 words
# Value to use when previewing what the slice will look like
exampleValue: Dolor exercitation sint ad minim et deserunt nisi aliquip cillum laboris ipsum esse nulla commodo cupidatat ipsum proident exercitation veniam
# Options exposed in the CMS for configuring the slice template
# The key is accessible in templates, and the value is used as the CMS title
visualOptions:
no-icon: No icon
bold-quote: Bold quoted text
TwoColumnImage:
# Name to show for the template in the CMS
name: Two column with image
# Class to change to when using this template
# This allows complex slices to have extra fields and code
className: MyProject\DataObjects\Slices\TwoColumnImageSlice
# Fields that only need a label configured can be defined using a shortcut:
# (The order fields are defined here also controls the order they show in the CMS)
fields:
Title: ~
Content: Text column
LeadImage:
name: Image
# Images can be specified as file names in example content
exampleValue: themes/base/images/examples/random-guy.jpg
visualOptions:
image-right: Image in right column
title-centered: Center title above columns
Compatibility
This module requires at least SilverStripe 4 and PHP 5.6., (*15)
Wallogit.com
