2012-01-09 11:37:13 +01:00
|
|
|
<?php
|
|
|
|
/**
|
2012-03-01 17:06:15 +01:00
|
|
|
* This class is an GridField Component that add Delete action for Objects in the GridField.
|
|
|
|
* See {@link GridFieldRelationDelete} for detaching an item from the current relationship instead.
|
2012-01-09 11:37:13 +01:00
|
|
|
*/
|
2012-03-06 12:57:16 +01:00
|
|
|
class GridFieldDeleteAction implements GridField_ColumnProvider, GridField_ActionProvider {
|
2012-01-09 11:37:13 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a column 'Delete'
|
|
|
|
*
|
|
|
|
* @param type $gridField
|
|
|
|
* @param array $columns
|
|
|
|
*/
|
|
|
|
public function augmentColumns($gridField, &$columns) {
|
2012-02-07 23:21:34 +01:00
|
|
|
if(!in_array('Actions', $columns))
|
|
|
|
$columns[] = 'Actions';
|
2012-01-09 11:37:13 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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) {
|
2012-02-07 23:21:34 +01:00
|
|
|
if($columnName == 'Actions') {
|
2012-01-09 17:16:07 +01:00
|
|
|
return array('title' => '');
|
2012-01-09 11:37:13 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Which columns are handled by this component
|
|
|
|
*
|
|
|
|
* @param type $gridField
|
|
|
|
* @return type
|
|
|
|
*/
|
|
|
|
public function getColumnsHandled($gridField) {
|
2012-02-07 23:21:34 +01:00
|
|
|
return array('Actions');
|
2012-01-09 11:37:13 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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) {
|
2012-03-08 01:58:53 +01:00
|
|
|
if(!$record->canDelete()) {
|
|
|
|
return;
|
|
|
|
}
|
2012-03-06 12:51:57 +01:00
|
|
|
$field = Object::create('GridField_FormAction',
|
2012-01-09 17:16:07 +01:00
|
|
|
$gridField,
|
|
|
|
'DeleteRecord'.$record->ID,
|
2012-03-06 16:58:13 +01:00
|
|
|
false,
|
2012-01-09 17:16:07 +01:00
|
|
|
"deleterecord",
|
|
|
|
array('RecordID' => $record->ID)
|
2012-03-06 16:58:13 +01:00
|
|
|
)
|
|
|
|
->addExtraClass('gridfield-button-delete')
|
|
|
|
->setAttribute('title', _t('GridAction.Delete', "delete"))
|
|
|
|
->setAttribute('data-icon', 'decline');
|
|
|
|
return $field->Field();
|
2012-01-09 11:37:13 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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') {
|
2012-02-09 02:35:33 +01:00
|
|
|
$id = $arguments['RecordID'];
|
2012-03-01 17:06:15 +01:00
|
|
|
// Always deletes a record. Use GridFieldRelationDelete to detach it from the current relationship.
|
2012-02-09 02:35:33 +01:00
|
|
|
$item = $gridField->getList()->byID($id);
|
2012-03-08 01:58:53 +01:00
|
|
|
if(!$item->canDelete()) {
|
|
|
|
throw new ValidationException(_t('GridFieldAction_Delete.DeletePermissionsFailure',"No delete permissions"),0);
|
|
|
|
}
|
2012-02-09 02:35:33 +01:00
|
|
|
if(!$item) return;
|
|
|
|
$item->delete();
|
2012-01-09 11:37:13 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|