nathancox/versionedgridrows

A SilverStripe extension to mark gridfield rows for versioned objects as draft or modified

SilverStripe VersionedGridRows

This module extends GridField to add some styles and labels for showing the published state of versioned objects., _(*1)

, _(*2)

Maintainer Contacts

Nathan Cox (me@nathan.net.nz), _(*3)

Requirements

• SilverStripe 3.1+

Documentation

GitHub, _(*4)

Installation Instructions

With composer:, _(*5)

composer require nathancox/versionedgridrows

Usage Overview

Configuration via config.yml:, _(*6)

VersionedGridRows:
  mode: 'component'         # can be "component", "config" or "always"
  show_published: false     # set to true to show a flag on published items as well

Options for the mode setting:, _(*7)

mode: 'component', _(*8)

Only add row styles to GridFields with the VersionGridRows component added to them. This is done like any other component:, _(*9)

$gridFieldConfig->addComponent(new VersionedGridRows('Title'));

The constructor argument ("Title") specifies the name of the column the "draft" or "modified" flags will be appended to. Leave blank to not automatically append the flags., _(*10)

mode: 'always', _(*11)

Styles will be added to all GridFields that managed versioned objects. If you want to add flags you need to do it manually with something like this:, _(*12)

$summary_fields = array(
    'VersionedTitle' => 'Title'
);

...

public function VersionedTitle()
{
    return VersionedGridRows::get_column_content($this, $this->Title);
}

mode: 'config', _(*13)

Specify a list of classes that styles will be added to., _(*14)

VersionedGridRow:
  mode: 'config'
  classes:
    - Page
    - StaffMember
    - HomepageSlide

You will have to add version status flags manually as shown above., _(*15)

Known Issues

Issue Tracker, _(*16)