silverstripe-blog/forms/gridfield/GridFieldAddByDBField.php

<?php

/**
 * Adds a component which allows a user to add a new DataObject by database field.
 *
 * @package silverstripe
 * @subpackage blog
 *
 * @author Michael Strong <micmania@hotmail.co.uk>
**/
class GridFieldAddByDBField implements GridField_ActionProvider, GridField_HTMLProvider {

	/**
	 * HTML Fragment to render the field.
	 *
	 * @var string
	**/
	protected $targetFragment;



	/**
	 * Default field to create the dataobject by should be Title.
	 *
	 * @var string
	**/
	protected $dataObjectField = "Title";



	/**
	 * Creates a text field and add button which allows the user to directly create a new
	 * DataObject by just entering the title.
	 *
	 * @param $targetFragment string
	**/
	public function __construct($targetFragment = 'before', $dataObjectField = "Title") {
		$this->targetFragment = $targetFragment;
		$this->dataObjectField = (string) $dataObjectField;
	}



	/**
	 * Provide actions to this component.
	 *
	 * @param $gridField GridField
	 *
	 * @return array
	**/
	public function getActions($gridField) {
		return array("add");
	}



	/**
	 * Handles the add action for the given DataObject
	 *
	 * @param $gridFIeld GridFIeld
	 * @param $actionName string
	 * @param $arguments mixed
	 * @param $data array
	**/
	public function handleAction(GridField $gridField, $actionName, $arguments, $data) {
		if($actionName == "add") {
			$dbField = $this->getDataObjectField();

			$objClass = $gridField->getModelClass();
			$obj = new $objClass();
			if($obj->hasField($dbField)) {
				$obj->setCastedField($dbField, $data['gridfieldaddbydbfield'][$obj->ClassName][$dbField]);

				$id = $gridField->getList()->add($obj);
				if(!$id) {
					$gridField->setError(_t(
						"GridFieldAddByDBField.AddFail", 
						"Unable to save {class} to the database.", 
						"Unable to add the DataObject.",
						array(
							"class" => $obj->class
						)), 
						"error"
					);
				}
			} else {
				throw new UnexpectedValueException("Invalid field (" . $dbField . ") on  " . $obj->ClassName . ".");
			}
		}
	}



	/**
	 * Renders the TextField and add button to the GridField.
	 *
	 * @param $girdField GridField
	 *
	 * @return string HTML
	**/
	public function getHTMLFragments($gridField) {
		$dataClass = $gridField->getList()->dataClass();
		$obj = singleton($dataClass);
		$dbField = $this->getDataObjectField();

		$textField = TextField::create("gridfieldaddbydbfield[" . $obj->ClassName . "][" . Convert::raw2htmlatt($dbField) . "]")
			->setAttribute("placeholder", $obj->fieldLabel($dbField))
			->addExtraClass("no-change-track");

		$addAction = new GridField_FormAction($gridField, 
			'add',
			_t('GridFieldAddByDBField.Add', "Add {name}", "Add button text", array("name" => $obj->i18n_singular_name())), 
			'add', 
			'add'
		);
		$addAction->setAttribute('data-icon', 'add');

		// Start thinking about rending this back to the GF
		$forTemplate = new ArrayData(array());
		$forTemplate->Fields = new ArrayList();

		$forTemplate->Fields->push($textField);
		$forTemplate->Fields->push($addAction);

		return array(
			$this->targetFragment => $forTemplate->renderWith("GridFieldAddByDBField")
		);
	}



	/**
	 * Returns the database field for which we'll add the new data object.
	 *
	 * @return string
	**/
	public function getDataObjectField() {
		return $this->dataObjectField;
	}



	/**
	 * Set the database field.
	 *
	 * @param $field string
	**/
	public function setDataObjectField($field) {
		$this->dataObjectField = (string) $field;
	}

}