Simple custom GridField plugin

Client.php

<?php

class Client extends DataObject {
	private static $db = array(
		"Name" => "Varchar",
		"Website" => "Varchar",
	);

	private static $has_many = array(
		"Contacts" => "Contact",
		"Job" => "Job",
	);

	function getCMSFields() {
		$fields = parent::getCMSFields();

		if($jobs = $fields->dataFieldByName('Job')) {
			$config = $jobs->getConfig();
			$config->addComponent(new GridFieldSortableRows('JobSort'));

			$config->addComponent(
				new GridFieldSimpleHeader,
				'GridFieldSortableHeader');

			$config->removeComponentsByType(
				'GridFieldSortableHeader');
		}

		return $fields;
	}
	
}

Contact.php

<?php

class Contact extends DataObject {
	private static $db = array(
		"FirstName" => "Varchar",
		"Surname" => "Varchar",
		"Email" => "Varchar",
		"Phone" => "Varchar",
	);

	private static $has_one = array(
		"Client" => "Client",
	);

	private static $belongs_many_many = array(
		"Jobs" => "Job",
	);

	private static $summary_fields = array(
		"FirstName",
		"Surname",
		"Email",
	);

	function getTitle() {
		return $this->FirstName . ' ' . $this->Surname;
	}
	
}

CRMAdmin.php

<?php

class CRMAdmin extends ModelAdmin {
	private static $url_segment = "crm";

	private static $menu_title = "CRM";

	private static $managed_models = array(
		"Client",
		"Contact",
		"Job",
	);
}

GridFieldSimpleHeader.php

<?php

/**
 * A simple, non-sortable header
 */
class GridFieldSimpleHeader implements GridField_HTMLProvider {

	public function getHTMLFragments($gridField) {
		$forTemplate = new ArrayData(array());
		$forTemplate->Fields = new ArrayList;

		foreach($gridField->getColumns() as $columnField) {
			$metadata = $gridField->getColumnMetadata($columnField);
			$fieldName = str_replace('.', '-', $columnField);
			$title = $metadata['title'];

			$field = new LiteralField($fieldName,
					'<span class="non-sortable">' 
					. $title . '</span>');
			$forTemplate->Fields->push($field);
		}
	
		return array(
			// Will generate a TR, gets placed in the THEAD
			'header' => $forTemplate
			->renderWith('GridFieldSortableHeader_Row'),
		);
	}
}

instructions.md

Getting started

• Create a SilverStripe 3.1 project
• composer require undefinedoffset/sortablegridfield:*
• Put the above files into mysite/code/
• dev/build and open admin!

Challenges

1. Move the GridFieldSimpleHeader so that it's on the bottom of the table, rather than the top.

2. Add a parameter to GridFieldSimpleHeader so that you can say where it's placed, and add two of them, so that there is 1 at the top and 1 at the bottom.

Job.php

<?php

class Job extends DataObject {
	private static $db = array(
		"Name" => "Varchar",
		"StartDate" => "Date",
		"JobSort" => "Int",
	);

	private static $has_one = array(
		"Client" => "Client",
	);

	private static $many_many = array(
		"Contacts" => "Contact",
	);

	private static $summary_fields = array(
		"Name",
		"StartDate",
	);

	private static $default_sort = "StartDate";
	
}