kb / app /Action /TaskAssignCategorySwimlaneChange.php
Xv Zan
ULFS
e4f4821
<?php
namespace Kanboard\Action;
use Kanboard\Model\TaskModel;
/**
* Assign a category when the task is moved to a specific swimlane
*
* @package Kanboard\Action
* @author @Interleaved
*/
class TaskAssignCategorySwimlaneChange extends Base
{
/**
* Get automatic action description
*
* @access public
* @return string
*/
public function getDescription()
{
return t('Assign a category when the task is moved to a specific swimlane');
}
/**
* Get the list of compatible events
*
* @access public
* @return array
*/
public function getCompatibleEvents()
{
return array(
TaskModel::EVENT_CREATE,
TaskModel::EVENT_MOVE_SWIMLANE,
);
}
/**
* Get the required parameter for the action (defined by the user)
*
* @access public
* @return array
*/
public function getActionRequiredParameters()
{
return array(
'swimlane_id' => t('Swimlane'),
'category_id' => t('Category'),
);
}
/**
* Get the required parameter for the event
*
* @access public
* @return string[]
*/
public function getEventRequiredParameters()
{
return array(
'task_id',
'task' => array(
'project_id',
'swimlane_id',
)
);
}
/**
* Execute the action (set the task category)
*
* @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)
{
$values = array(
'id' => $data['task_id'],
'category_id' => $this->getParam('category_id'),
);
return $this->taskModificationModel->update($values, false);
}
/**
* 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']['swimlane_id'] == $this->getParam('swimlane_id');
}
}