silverstripe-framework/src/Forms/GridField/GridFieldToolbarHeader.php

28 lines
682 B
PHP
Raw Normal View History

2012-02-09 04:02:47 +01:00
<?php
namespace SilverStripe\Forms\GridField;
use SilverStripe\View\SSViewer;
2012-03-06 03:01:17 +01:00
/**
2014-08-15 08:53:05 +02:00
* 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.
2012-03-06 03:01:17 +01:00
*/
class GridFieldToolbarHeader extends AbstractGridFieldComponent implements GridField_HTMLProvider
2016-11-29 00:31:16 +01:00
{
2014-08-15 08:53:05 +02:00
2016-11-29 00:31:16 +01:00
/**
* @param GridField $gridField
* @return array
*/
2016-11-29 00:31:16 +01:00
public function getHTMLFragments($gridField)
{
$templates = SSViewer::get_templates_by_class($this, '', __CLASS__);
return [
2016-11-29 00:31:16 +01:00
'header' => $gridField->renderWith($templates)
];
2016-11-29 00:31:16 +01:00
}
2012-02-09 04:02:47 +01:00
}