Add column restrictions to custom project roles

1 files changed, 152 insertions, 0 deletions

diff --git a/app/Model/ColumnRestrictionModel.php b/app/Model/ColumnRestrictionModel.php
new file mode 100644
index 00000000..92b2ac60
--- /dev/null
+++ b/app/Model/ColumnRestrictionModel.php
@@ -0,0 +1,152 @@
+<?php
+
+namespace Kanboard\Model;
+
+use Kanboard\Core\Base;
+
+/**
+ * Class ColumnRestrictionModel
+ *
+ * @package Kanboard\Model
+ * @author  Frederic Guillot
+ */
+class ColumnRestrictionModel extends Base
+{
+    const TABLE = 'column_has_restrictions';
+
+    const RULE_ALLOW_TASK_CREATION    = 'allow.task_creation';
+    const RULE_ALLOW_TASK_OPEN_CLOSE  = 'allow.task_open_close';
+    const RULE_BLOCK_TASK_CREATION    = 'block.task_creation';
+    const RULE_BLOCK_TASK_OPEN_CLOSE  = 'block.task_open_close';
+
+    /**
+     * Get rules
+     *
+     * @return array
+     */
+    public function getRules()
+    {
+        return array(
+            self::RULE_ALLOW_TASK_CREATION    => t('Task creation is permitted for this column'),
+            self::RULE_ALLOW_TASK_OPEN_CLOSE  => t('Closing or opening a task is permitted for this column'),
+            self::RULE_BLOCK_TASK_CREATION    => t('Task creation is blocked for this column'),
+            self::RULE_BLOCK_TASK_OPEN_CLOSE  => t('Closing or opening a task is blocked for this column'),
+        );
+    }
+
+    /**
+     * Fetch one restriction
+     *
+     * @param  int $project_id
+     * @param  int $restriction_id
+     * @return array|null
+     */
+    public function getById($project_id, $restriction_id)
+    {
+        return $this->db
+            ->table(self::TABLE)
+            ->columns(
+                self::TABLE.'.restriction_id',
+                self::TABLE.'.project_id',
+                self::TABLE.'.role_id',
+                self::TABLE.'.column_id',
+                self::TABLE.'.rule',
+                'pr.role',
+                'c.title as column_title'
+            )
+            ->left(ColumnModel::TABLE, 'c', 'id', self::TABLE, 'column_id')
+            ->left(ProjectRoleModel::TABLE, 'pr', 'role_id', self::TABLE, 'role_id')
+            ->eq(self::TABLE.'.project_id', $project_id)
+            ->eq(self::TABLE.'.restriction_id', $restriction_id)
+            ->findOne();
+    }
+
+    /**
+     * Get all project column restrictions
+     *
+     * @param  int $project_id
+     * @return array
+     */
+    public function getAll($project_id)
+    {
+        $rules = $this->getRules();
+        $restrictions = $this->db
+            ->table(self::TABLE)
+            ->columns(
+                self::TABLE.'.restriction_id',
+                self::TABLE.'.project_id',
+                self::TABLE.'.role_id',
+                self::TABLE.'.column_id',
+                self::TABLE.'.rule',
+                'pr.role',
+                'c.title as column_title'
+            )
+            ->left(ColumnModel::TABLE, 'c', 'id', self::TABLE, 'column_id')
+            ->left(ProjectRoleModel::TABLE, 'pr', 'role_id', self::TABLE, 'role_id')
+            ->eq(self::TABLE.'.project_id', $project_id)
+            ->findAll();
+
+        foreach ($restrictions as &$restriction) {
+            $restriction['title'] = $rules[$restriction['rule']];
+        }
+
+        return $restrictions;
+    }
+
+    /**
+     * Get restrictions
+     *
+     * @param  int    $project_id
+     * @param  string $role
+     * @return array
+     */
+    public function getAllByRole($project_id, $role)
+    {
+        return $this->db
+            ->table(self::TABLE)
+            ->columns(
+                self::TABLE.'.restriction_id',
+                self::TABLE.'.project_id',
+                self::TABLE.'.role_id',
+                self::TABLE.'.column_id',
+                self::TABLE.'.rule',
+                'pr.role'
+            )
+            ->eq(self::TABLE.'.project_id', $project_id)
+            ->eq('pr.role', $role)
+            ->left(ProjectRoleModel::TABLE, 'pr', 'role_id', self::TABLE, 'role_id')
+            ->findAll();
+    }
+
+    /**
+     * Create a new column restriction
+     *
+     * @param  int    $project_id
+     * @param  int    $role_id
+     * @param  int    $column_id
+     * @param  int    $rule
+     * @return bool|int
+     */
+    public function create($project_id, $role_id, $column_id, $rule)
+    {
+        return $this->db
+            ->table(self::TABLE)
+            ->persist(array(
+                'project_id' => $project_id,
+                'role_id' => $role_id,
+                'column_id' => $column_id,
+                'rule' => $rule,
+            ));
+    }
+
+    /**
+     * Remove a permission
+     *
+     * @param  int $restriction_id
+     * @return bool
+     */
+    public function remove($restriction_id)
+    {
+        return $this->db->table(self::TABLE)->eq('restriction_id', $restriction_id)->remove();
+    }
+}