silverstripe-framework/src/Forms/GridField/GridFieldToolbarHeader.php
GuySartorelli 5c54276b6f
ENH Make all GridField components injectable (using abstract class) (#10204)
* ENH Make all GridField components injectable.

Some components were already injectable, but all GridField components shipped in silverstripe should be injectable.
This makes it a LOT easier to make global project-specific changes to a given component.
The new AbstractGridFieldComponent also makes it easy to make similar wide-spread changes in the future.

* DOCS Encourage injection for GridField and GridFieldComponents.
2022-02-02 11:14:33 +13:00

28 lines
682 B
PHP

<?php
namespace SilverStripe\Forms\GridField;
use SilverStripe\View\SSViewer;
/**
* Adding this class to a {@link GridFieldConfig} of a {@link GridField} adds
* a header title to that field.
*
* The header serves to display the name of the data the GridField is showing.
*/
class GridFieldToolbarHeader extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
/**
* @param GridField $gridField
* @return array
*/
public function getHTMLFragments($gridField)
{
$templates = SSViewer::get_templates_by_class($this, '', __CLASS__);
return [
'header' => $gridField->renderWith($templates)
];
}
}