Kanboard-Prod/app/Model/Task.php

171 lines
3.7 KiB
PHP

<?php
namespace Model;
/**
* Task model
*
* @package model
* @author Frederic Guillot
*/
class Task extends Base
{
/**
* SQL table name
*
* @var string
*/
const TABLE = 'tasks';
/**
* Task status
*
* @var integer
*/
const STATUS_OPEN = 1;
const STATUS_CLOSED = 0;
/**
* Events
*
* @var string
*/
const EVENT_MOVE_PROJECT = 'task.move.project';
const EVENT_MOVE_COLUMN = 'task.move.column';
const EVENT_MOVE_POSITION = 'task.move.position';
const EVENT_MOVE_SWIMLANE = 'task.move.swimlane';
const EVENT_UPDATE = 'task.update';
const EVENT_CREATE = 'task.create';
const EVENT_CLOSE = 'task.close';
const EVENT_OPEN = 'task.open';
const EVENT_CREATE_UPDATE = 'task.create_update';
const EVENT_ASSIGNEE_CHANGE = 'task.assignee_change';
/**
* Recurrence: status
*
* @var integer
*/
const RECURE_STATUS_NONE = 0;
const RECURE_STATUS_PENDING = 1;
const RECURE_STATUS_PROCESSED = 2;
/**
* Recurrence: trigger
*
* @var integer
*/
const RECURE_TRIGGER_MOVE = 0;
const RECURE_TRIGGER_CLOSE = 1;
/**
* Recurrence: timeframe
*
* @var integer
*/
const RECURE_DAYS = 0;
const RECURE_MONTHS = 1;
const RECURE_YEARS = 2;
/**
* Recurrence: base date used to calculate new due date
*
* @var integer
*/
const RECURE_BASEDATE_DUEDATE = 0;
const RECURE_BASEDATE_TRIGGERDATE = 1;
/**
* Remove a task
*
* @access public
* @param integer $task_id Task id
* @return boolean
*/
public function remove($task_id)
{
if (! $this->taskFinder->exists($task_id)) {
return false;
}
$this->file->removeAll($task_id);
return $this->db->table(self::TABLE)->eq('id', $task_id)->remove();
}
/**
* Get a the task id from a text
*
* Example: "Fix bug #1234" will return 1234
*
* @access public
* @param string $message Text
* @return integer
*/
public function getTaskIdFromText($message)
{
if (preg_match('!#(\d+)!i', $message, $matches) && isset($matches[1])) {
return $matches[1];
}
return 0;
}
/**
* Return the list user selectable recurrence status
*
* @access public
* @return array
*/
public function getRecurrenceStatusList()
{
return array (
Task::RECURE_STATUS_NONE => t('No'),
Task::RECURE_STATUS_PENDING => t('Yes'),
);
}
/**
* Return the list recurrence triggers
*
* @access public
* @return array
*/
public function getRecurrenceTriggerList()
{
return array (
Task::RECURE_TRIGGER_MOVE => t('When task is moved to last column'),
Task::RECURE_TRIGGER_CLOSE => t('When task is closed'),
);
}
/**
* Return the list options to calculate recurrence due date
*
* @access public
* @return array
*/
public function getRecurrenceBasedateList()
{
return array (
Task::RECURE_BASEDATE_DUEDATE => t('Existing due date'),
Task::RECURE_BASEDATE_TRIGGERDATE => t('Action date'),
);
}
/**
* Return the list recurrence timeframes
*
* @access public
* @return array
*/
public function getRecurrenceTimeframeList()
{
return array (
Task::RECURE_DAYS => t('Day(s)'),
Task::RECURE_MONTHS => t('Month(s)'),
Task::RECURE_YEARS => t('Year(s)'),
);
}
}