namespace Kanboard\Action; | |
use Kanboard\Model\TaskModel; | |
/** | |
* Close automatically a task in a specific column | |
* | |
* @package Kanboard\Action | |
* @author Frederic Guillot | |
*/ | |
class TaskCloseColumn extends Base | |
{ | |
/** | |
* Get automatic action description | |
* | |
* @access public | |
* @return string | |
*/ | |
public function getDescription() | |
{ | |
return t('Close a task in a specific column'); | |
} | |
/** | |
* Get the list of compatible events | |
* | |
* @access public | |
* @return array | |
*/ | |
public function getCompatibleEvents() | |
{ | |
return array( | |
TaskModel::EVENT_MOVE_COLUMN, | |
); | |
} | |
/** | |
* Get the required parameter for the action (defined by the user) | |
* | |
* @access public | |
* @return array | |
*/ | |
public function getActionRequiredParameters() | |
{ | |
return array('column_id' => t('Column')); | |
} | |
/** | |
* Get the required parameter for the event | |
* | |
* @access public | |
* @return string[] | |
*/ | |
public function getEventRequiredParameters() | |
{ | |
return array( | |
'task_id', | |
'task' => array( | |
'project_id', | |
'column_id', | |
) | |
); | |
} | |
/** | |
* Execute the action (close the task) | |
* | |
* @access public | |
* @param array $data Event data dictionary | |
* @return bool True if the action was executed or false when not executed | |
*/ | |
public function doAction(array $data) | |
{ | |
return $this->taskStatusModel->close($data['task_id']); | |
} | |
/** | |
* Check if the event data meet the action condition | |
* | |
* @access public | |
* @param array $data Event data dictionary | |
* @return bool | |
*/ | |
public function hasRequiredCondition(array $data) | |
{ | |
return $data['task']['column_id'] == $this->getParam('column_id'); | |
} | |
} | |