SilverStripe DataObject Preview

Provides the ability to preview DataObjects in the CMS., _(*1)

Installation (with composer)

$ composer require heyday/silverstripe-dataobjectpreview

Filesystem permissions

The cache/ directory in this module needs to be writable by PHP for DataObject Preview to work. Previews are rendered to file here to avoid repeated rendering of the same content., _(*2)

When installing via Composer, you may want to add a post-install script in your project's composer.json to configure these permissions. For example:, _(*3)

{
    // ...

    "scripts": {
        "post-install-cmd": [
            "chmod 777 silverstripe-dataobjectpreview/cache"
        ]
    }
}

Example

DataObject Preview Example , _(*4)

Usage

DataObjects that you want to preview must implement, DataObjectPreviewInterface, which consists of one method getPreviewHtml., _(*5)

This method getPreviewHtml must return a string., _(*6)

getPreviewHtml, _(*7)

public function getPreviewHtml()
{
    return "<html><body>Hello</body></html>";
}

DataObjectPreviewField

getCMSFields, _(*8)


$fields->addFieldToTab(
    'Root.Main',
    new DataObjectPreviewField(
        'SomeDataObject',
        $this,
        new DataObjectPreviewer($generator)
    )
);

GridFieldDataObjectPreview

getCMSFields, _(*9)

$fields->addFieldsToTab(
    'Root.Items',
    new GridField(
        'Items',
        'Items',
        $this->Items(),
        $config = GridFieldConfig_RelationEditor::create()
    )
);

$config->addComponent(
    new GridFieldDataObjectPreview(
        new DataObjectPreviewer($generator)
    )
);