<?php
/**
 * This class is an GridField Component that add Delete action for Objects in the GridField.
 * See {@link GridFieldRemoveButton} for detaching an item from the current relationship instead.
 */
class GridFieldDeleteAction implements GridField_ColumnProvider, GridField_ActionProvider {
	
	/**
	 * Add a column 'Delete'
	 * 
	 * @param type $gridField
	 * @param array $columns 
	 */
	public function augmentColumns($gridField, &$columns) {
		if(!in_array('Actions', $columns))
			$columns[] = 'Actions';
	}
	
	/**
	 * Return any special attributes that will be used for FormField::createTag()
	 *
	 * @param GridField $gridField
	 * @param DataObject $record
	 * @param string $columnName
	 * @return array
	 */
	public function getColumnAttributes($gridField, $record, $columnName) {
		return array();
	}
	
	/**
	 * Add the title 
	 * 
	 * @param GridField $gridField
	 * @param string $columnName
	 * @return array
	 */
	public function getColumnMetadata($gridField, $columnName) {
		if($columnName == 'Actions') {
			return array('title' => '');
		}
	}
	
	/**
	 * Which columns are handled by this component
	 * 
	 * @param type $gridField
	 * @return type 
	 */
	public function getColumnsHandled($gridField) {
		return array('Actions');
	}
	
	/**
	 * Which GridField actions are this component handling
	 *
	 * @param GridField $gridField
	 * @return array 
	 */
	public function getActions($gridField) {
		return array('deleterecord');
	}
	
	/**
	 *
	 * @param GridField $gridField
	 * @param DataObject $record
	 * @param string $columnName
	 * @return string - the HTML for the column 
	 */
	public function getColumnContent($gridField, $record, $columnName) {
		if(!$record->canDelete()) {
			return;
		}
		$field = Object::create('GridField_FormAction',
			$gridField, 
			'DeleteRecord'.$record->ID, 
			false, 
			"deleterecord", 
			array('RecordID' => $record->ID)
		)
			->addExtraClass('gridfield-button-delete')
			->setAttribute('title', _t('GridAction.Delete', "delete"))
			->setAttribute('data-icon', 'decline');
		return $field->Field();
	}
	
	/**
	 * Handle the actions and apply any changes to the GridField
	 *
	 * @param GridField $gridField
	 * @param string $actionName
	 * @param mixed $arguments
	 * @param array $data - form data
	 * @return void
	 */
	public function handleAction(GridField $gridField, $actionName, $arguments, $data) {
		if($actionName == 'deleterecord') {
			$id = $arguments['RecordID'];
			// Always deletes a record. Use GridFieldRemoveButton to detach it from the current relationship.
			$item = $gridField->getList()->byID($id);
			if(!$item->canDelete()) {
				throw new ValidationException(_t('GridFieldAction_Delete.DeletePermissionsFailure',"No delete permissions"),0);
			}
			if(!$item) return;
				$item->delete();
		}
	}
}