mirror of
https://github.com/YunoHost-Apps/kanboard_ynh.git
synced 2024-09-03 19:36:17 +02:00
375 lines
11 KiB
PHP
375 lines
11 KiB
PHP
<?php
|
|
|
|
namespace Model;
|
|
|
|
use SimpleValidator\Validator;
|
|
use SimpleValidator\Validators;
|
|
|
|
/**
|
|
* Board model
|
|
*
|
|
* @package model
|
|
* @author Frederic Guillot
|
|
*/
|
|
class Board extends Base
|
|
{
|
|
/**
|
|
* SQL table name
|
|
*
|
|
* @var string
|
|
*/
|
|
const TABLE = 'columns';
|
|
|
|
/**
|
|
* Get Kanboard default columns
|
|
*
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function getDefaultColumns()
|
|
{
|
|
return array(t('Backlog'), t('Ready'), t('Work in progress'), t('Done'));
|
|
}
|
|
|
|
/**
|
|
* Create a board with default columns, must be executed inside a transaction
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @param array $columns Column parameters [ 'title' => 'boo', 'task_limit' => 2 ... ]
|
|
* @return boolean
|
|
*/
|
|
public function create($project_id, array $columns)
|
|
{
|
|
$position = 0;
|
|
|
|
foreach ($columns as $column) {
|
|
|
|
$values = array(
|
|
'title' => $column['title'],
|
|
'position' => ++$position,
|
|
'project_id' => $project_id,
|
|
'task_limit' => $column['task_limit'],
|
|
);
|
|
|
|
if (! $this->db->table(self::TABLE)->save($values)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Copy board columns from a project to another one
|
|
*
|
|
* @author Antonio Rabelo
|
|
* @param integer $project_from Project Template
|
|
* @return integer $project_to Project that receives the copy
|
|
* @return boolean
|
|
*/
|
|
public function duplicate($project_from, $project_to)
|
|
{
|
|
$columns = $this->db->table(Board::TABLE)
|
|
->columns('title', 'task_limit')
|
|
->eq('project_id', $project_from)
|
|
->asc('position')
|
|
->findAll();
|
|
|
|
return $this->board->create($project_to, $columns);
|
|
}
|
|
|
|
/**
|
|
* Add a new column to the board
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @param string $title Column title
|
|
* @param integer $task_limit Task limit
|
|
* @return boolean
|
|
*/
|
|
public function addColumn($project_id, $title, $task_limit = 0)
|
|
{
|
|
return $this->db->table(self::TABLE)->save(array(
|
|
'project_id' => $project_id,
|
|
'title' => $title,
|
|
'task_limit' => $task_limit,
|
|
'position' => $this->getLastColumnPosition($project_id) + 1,
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Update columns
|
|
*
|
|
* @access public
|
|
* @param array $values Form values
|
|
* @return boolean
|
|
*/
|
|
public function update(array $values)
|
|
{
|
|
$columns = array();
|
|
|
|
foreach (array('title', 'task_limit') as $field) {
|
|
foreach ($values[$field] as $column_id => $value) {
|
|
$columns[$column_id][$field] = $value;
|
|
}
|
|
}
|
|
|
|
$this->db->startTransaction();
|
|
|
|
foreach ($columns as $column_id => $values) {
|
|
$this->updateColumn($column_id, $values['title'], (int) $values['task_limit']);
|
|
}
|
|
|
|
$this->db->closeTransaction();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Update a column
|
|
*
|
|
* @access public
|
|
* @param integer $column_id Column id
|
|
* @param string $title Column title
|
|
* @param integer $task_limit Task limit
|
|
* @return boolean
|
|
*/
|
|
public function updateColumn($column_id, $title, $task_limit = 0)
|
|
{
|
|
return $this->db->table(self::TABLE)->eq('id', $column_id)->update(array(
|
|
'title' => $title,
|
|
'task_limit' => $task_limit,
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Move a column down, increment the column position value
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @param integer $column_id Column id
|
|
* @return boolean
|
|
*/
|
|
public function moveDown($project_id, $column_id)
|
|
{
|
|
$columns = $this->db->table(self::TABLE)->eq('project_id', $project_id)->asc('position')->listing('id', 'position');
|
|
$positions = array_flip($columns);
|
|
|
|
if (isset($columns[$column_id]) && $columns[$column_id] < count($columns)) {
|
|
|
|
$position = ++$columns[$column_id];
|
|
$columns[$positions[$position]]--;
|
|
|
|
$this->db->startTransaction();
|
|
$this->db->table(self::TABLE)->eq('id', $column_id)->update(array('position' => $position));
|
|
$this->db->table(self::TABLE)->eq('id', $positions[$position])->update(array('position' => $columns[$positions[$position]]));
|
|
$this->db->closeTransaction();
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Move a column up, decrement the column position value
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @param integer $column_id Column id
|
|
* @return boolean
|
|
*/
|
|
public function moveUp($project_id, $column_id)
|
|
{
|
|
$columns = $this->db->table(self::TABLE)->eq('project_id', $project_id)->asc('position')->listing('id', 'position');
|
|
$positions = array_flip($columns);
|
|
|
|
if (isset($columns[$column_id]) && $columns[$column_id] > 1) {
|
|
|
|
$position = --$columns[$column_id];
|
|
$columns[$positions[$position]]++;
|
|
|
|
$this->db->startTransaction();
|
|
$this->db->table(self::TABLE)->eq('id', $column_id)->update(array('position' => $position));
|
|
$this->db->table(self::TABLE)->eq('id', $positions[$position])->update(array('position' => $columns[$positions[$position]]));
|
|
$this->db->closeTransaction();
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get all columns and tasks for a given project
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @param array $filters
|
|
* @return array
|
|
*/
|
|
public function get($project_id, array $filters = array())
|
|
{
|
|
$this->db->startTransaction();
|
|
|
|
$columns = $this->getColumns($project_id);
|
|
|
|
$filters[] = array('column' => 'project_id', 'operator' => 'eq', 'value' => $project_id);
|
|
$filters[] = array('column' => 'is_active', 'operator' => 'eq', 'value' => Task::STATUS_OPEN);
|
|
|
|
$tasks = $this->task->find($filters);
|
|
|
|
foreach ($columns as &$column) {
|
|
|
|
$column['tasks'] = array();
|
|
|
|
foreach ($tasks as &$task) {
|
|
if ($task['column_id'] == $column['id']) {
|
|
$column['tasks'][] = $task;
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->db->closeTransaction();
|
|
|
|
return $columns;
|
|
}
|
|
|
|
/**
|
|
* Get the first column id for a given project
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @return integer
|
|
*/
|
|
public function getFirstColumn($project_id)
|
|
{
|
|
return $this->db->table(self::TABLE)->eq('project_id', $project_id)->asc('position')->findOneColumn('id');
|
|
}
|
|
|
|
/**
|
|
* Get the list of columns sorted by position [ column_id => title ]
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @return array
|
|
*/
|
|
public function getColumnsList($project_id)
|
|
{
|
|
return $this->db->table(self::TABLE)->eq('project_id', $project_id)->asc('position')->listing('id', 'title');
|
|
}
|
|
|
|
/**
|
|
* Get all columns sorted by position for a given project
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @return array
|
|
*/
|
|
public function getColumns($project_id)
|
|
{
|
|
return $this->db->table(self::TABLE)->eq('project_id', $project_id)->asc('position')->findAll();
|
|
}
|
|
|
|
/**
|
|
* Get the number of columns for a given project
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @return integer
|
|
*/
|
|
public function countColumns($project_id)
|
|
{
|
|
return $this->db->table(self::TABLE)->eq('project_id', $project_id)->count();
|
|
}
|
|
|
|
/**
|
|
* Get a column by the id
|
|
*
|
|
* @access public
|
|
* @param integer $column_id Column id
|
|
* @return array
|
|
*/
|
|
public function getColumn($column_id)
|
|
{
|
|
return $this->db->table(self::TABLE)->eq('id', $column_id)->findOne();
|
|
}
|
|
|
|
/**
|
|
* Get the position of the last column for a given project
|
|
*
|
|
* @access public
|
|
* @param integer $project_id Project id
|
|
* @return integer
|
|
*/
|
|
public function getLastColumnPosition($project_id)
|
|
{
|
|
return (int) $this->db
|
|
->table(self::TABLE)
|
|
->eq('project_id', $project_id)
|
|
->desc('position')
|
|
->findOneColumn('position');
|
|
}
|
|
|
|
/**
|
|
* Remove a column and all tasks associated to this column
|
|
*
|
|
* @access public
|
|
* @param integer $column_id Column id
|
|
* @return boolean
|
|
*/
|
|
public function removeColumn($column_id)
|
|
{
|
|
return $this->db->table(self::TABLE)->eq('id', $column_id)->remove();
|
|
}
|
|
|
|
/**
|
|
* Validate column modification
|
|
*
|
|
* @access public
|
|
* @param array $columns Original columns List
|
|
* @param array $values Required parameters to update a column
|
|
* @return array $valid, $errors [0] = Success or not, [1] = List of errors
|
|
*/
|
|
public function validateModification(array $columns, array $values)
|
|
{
|
|
$rules = array();
|
|
|
|
foreach ($columns as $column_id => $column_title) {
|
|
$rules[] = new Validators\Integer('task_limit['.$column_id.']', t('This value must be an integer'));
|
|
$rules[] = new Validators\GreaterThan('task_limit['.$column_id.']', t('This value must be greater than %d', 0), 0);
|
|
$rules[] = new Validators\Required('title['.$column_id.']', t('The title is required'));
|
|
$rules[] = new Validators\MaxLength('title['.$column_id.']', t('The maximum length is %d characters', 50), 50);
|
|
}
|
|
|
|
$v = new Validator($values, $rules);
|
|
|
|
return array(
|
|
$v->execute(),
|
|
$v->getErrors()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Validate column creation
|
|
*
|
|
* @access public
|
|
* @param array $values Required parameters to save an action
|
|
* @return array $valid, $errors [0] = Success or not, [1] = List of errors
|
|
*/
|
|
public function validateCreation(array $values)
|
|
{
|
|
$v = new Validator($values, array(
|
|
new Validators\Required('project_id', t('The project id is required')),
|
|
new Validators\Integer('project_id', t('This value must be an integer')),
|
|
new Validators\Required('title', t('The title is required')),
|
|
new Validators\MaxLength('title', t('The maximum length is %d characters', 50), 50),
|
|
));
|
|
|
|
return array(
|
|
$v->execute(),
|
|
$v->getErrors()
|
|
);
|
|
}
|
|
}
|