silverstripe-framework/forms/gridfield/GridFieldFooter.php
Hamish Friedlander b8b4e98ac2 API Theme stacking
2016-07-15 16:29:25 +12:00

59 lines
1.4 KiB
PHP

<?php
/**
* Adding this class to a {@link GridFieldConfig} of a {@link GridField} adds
* a footer bar to that field.
*
* The footer looks just like the {@link GridFieldPaginator} control, except
* without the pagination controls.
*
* It only display the "Viewing 1-8 of 8" status text and (optionally) a
* configurable status message.
*
* The purpose of this class is to have a footer that can round off
* {@link GridField} without having to use pagination.
*
* @package forms
* @subpackage fields-gridfield
*/
class GridFieldFooter implements GridField_HTMLProvider {
/**
* @var string - a message to display in the footer
*/
protected $message = null;
protected $showrecordcount;
/**
*
* @param string $message - a message to display in the footer
*/
public function __construct($message = null, $showrecordcount = true) {
if($message) {
$this->message = $message;
}
$this->showrecordcount = $showrecordcount;
}
public function getHTMLFragments($gridField) {
$count = $gridField->getList()->count();
$forTemplate = new ArrayData(array(
'ShowRecordCount' => $this->showrecordcount,
'Message' => $this->message,
'FirstShownRecord' => 1,
'LastShownRecord' => $count,
'NumRecords' => $count
));
return array(
'footer' => $forTemplate->renderWith(
'Includes/GridFieldFooter',
array(
'Colspan' => count($gridField->getColumns())
)
)
);
}
}