Merged in bugfix/PMCORE-3111 (pull request #7990)

PMCORE-3111 Service - CRUD for the custom cases List

Approved-by: Julio Cesar Laura Avendaño

tests/unit/workflow/engine/src/ProcessMaker/Model/CaseListTest.php

@@ -0,0 +1,275 @@
+<?php
+
+namespace tests\unit\workflow\engine\src\ProcessMaker\Model;
+
+use ProcessMaker\Model\CaseList;
+use Tests\TestCase;
+
+class CaseListTest extends TestCase
+{
+
+    /**
+     * setUp method.
+     */
+    public function setUp()
+    {
+        parent::setUp();
+    }
+
+    /**
+     * teardown method.
+     */
+    public function tearDown()
+    {
+        parent::tearDown();
+    }
+
+    /**
+     * This tests the getColumnNameFromAlias method.
+     * @test
+     * @covers  \ProcessMaker\Model\CaseList::createSetting()
+     */
+    public function it_should_test_getColumnNameFromAlias()
+    {
+        $data = [
+            'id' => 1,
+            'type' => 'inbox',
+            'name' => 'test1',
+            'description' => 'my description',
+            'tableUid' => '',
+            'columns' => [],
+            'userId' => 1,
+            'iconList' => 'deafult.png',
+            'iconColor' => 'red',
+            'iconColorScreen' => 'blue',
+            'createDate' => date('Y-m-d H:m:s'),
+            'updateDate' => date('Y-m-d H:m:s')
+        ];
+        $array = CaseList::getColumnNameFromAlias($data);
+
+        //asserts
+        $this->assertArrayHasKey("CAL_ID", $array);
+        $this->assertArrayHasKey("CAL_TYPE", $array);
+        $this->assertArrayHasKey("CAL_NAME", $array);
+        $this->assertArrayHasKey("CAL_DESCRIPTION", $array);
+        $this->assertArrayHasKey("ADD_TAB_UID", $array);
+        $this->assertArrayHasKey("CAL_COLUMNS", $array);
+        $this->assertArrayHasKey("USR_ID", $array);
+        $this->assertArrayHasKey("CAL_ICON_LIST", $array);
+        $this->assertArrayHasKey("CAL_ICON_COLOR", $array);
+        $this->assertArrayHasKey("CAL_ICON_COLOR_SCREEN", $array);
+        $this->assertArrayHasKey("CAL_CREATE_DATE", $array);
+        $this->assertArrayHasKey("CAL_UPDATE_DATE", $array);
+    }
+
+    /**
+     * This tests the getAliasFromColumnName method.
+     * @test
+     * @covers  \ProcessMaker\Model\CaseList::createSetting()
+     */
+    public function it_should_test_getAliasFromColumnName()
+    {
+        $data = [
+            'CAL_ID' => 1,
+            'CAL_TYPE' => 'inbox',
+            'CAL_NAME' => 'test1',
+            'CAL_DESCRIPTION' => 'my description',
+            'ADD_TAB_UID' => 'my description',
+            'CAL_COLUMNS' => [],
+            'USR_ID' => 1,
+            'CAL_ICON_LIST' => 'deafult.png',
+            'CAL_ICON_COLOR' => 'red',
+            'CAL_ICON_COLOR_SCREEN' => 'blue',
+            'CAL_CREATE_DATE' => date('Y-m-d H:m:s'),
+            'CAL_UPDATE_DATE' => date('Y-m-d H:m:s')
+        ];
+        $array = CaseList::getAliasFromColumnName($data);
+
+        //asserts
+        $this->assertArrayHasKey("id", $array);
+        $this->assertArrayHasKey("type", $array);
+        $this->assertArrayHasKey("name", $array);
+        $this->assertArrayHasKey("description", $array);
+        $this->assertArrayHasKey("tableUid", $array);
+        $this->assertArrayHasKey("columns", $array);
+        $this->assertArrayHasKey("userId", $array);
+        $this->assertArrayHasKey("iconList", $array);
+        $this->assertArrayHasKey("iconColor", $array);
+        $this->assertArrayHasKey("iconColorScreen", $array);
+        $this->assertArrayHasKey("createDate", $array);
+        $this->assertArrayHasKey("updateDate", $array);
+    }
+
+    /**
+     * This tests the createSetting method.
+     * @test
+     * @covers  \ProcessMaker\Model\CaseList::createSetting()
+     */
+    public function it_should_test_createSetting()
+    {
+        $data = [
+            'type' => 'inbox',
+            'name' => 'test1',
+            'description' => 'my description',
+            'tableUid' => '',
+            'columns' => [],
+            'userId' => 1,
+            'iconList' => 'deafult.png',
+            'iconColor' => 'red',
+            'iconColorScreen' => 'blue',
+            'createDate' => date('Y-m-d H:m:s'),
+            'updateDate' => date('Y-m-d H:m:s')
+        ];
+        $caseList = CaseList::createSetting($data);
+
+        //asserts
+        $this->assertEquals($data['type'], $caseList->CAL_TYPE);
+        $this->assertEquals($data['name'], $caseList->CAL_NAME);
+        $this->assertEquals($data['description'], $caseList->CAL_DESCRIPTION);
+        $this->assertEquals($data['tableUid'], $caseList->ADD_TAB_UID);
+        $this->assertEquals($data['columns'], $caseList->CAL_COLUMNS);
+        $this->assertEquals($data['userId'], $caseList->USR_ID);
+        $this->assertEquals($data['iconList'], $caseList->CAL_ICON_LIST);
+        $this->assertEquals($data['iconColor'], $caseList->CAL_ICON_COLOR);
+        $this->assertEquals($data['iconColorScreen'], $caseList->CAL_ICON_COLOR_SCREEN);
+    }
+
+    /**
+     * This tests the updateSetting method.
+     * @test
+     * @covers  \ProcessMaker\Model\CaseList::updateSetting()
+     */
+    public function it_should_test_updateSetting()
+    {
+        $data = [
+            'type' => 'inbox',
+            'name' => 'test1',
+            'description' => 'my description',
+            'tableUid' => '',
+            'columns' => [],
+            'userId' => 1,
+            'iconList' => 'deafult.png',
+            'iconColor' => 'red',
+            'iconColorScreen' => 'blue',
+            'createDate' => date('Y-m-d H:m:s'),
+            'updateDate' => date('Y-m-d H:m:s')
+        ];
+        $model = CaseList::createSetting($data);
+
+        $id = $model->CAL_ID;
+        $data2 = [
+            'type' => 'todo',
+            'name' => 'new name',
+            'description' => 'new deescription',
+        ];
+        $caseList = CaseList::updateSetting($id, $data2);
+
+        //asserts
+        $this->assertEquals($data2['type'], $caseList->CAL_TYPE);
+        $this->assertEquals($data2['name'], $caseList->CAL_NAME);
+        $this->assertEquals($data2['description'], $caseList->CAL_DESCRIPTION);
+        $this->assertEquals($data['tableUid'], $caseList->ADD_TAB_UID);
+        $this->assertEquals($data['columns'], $caseList->CAL_COLUMNS);
+        $this->assertEquals($data['userId'], $caseList->USR_ID);
+        $this->assertEquals($data['iconList'], $caseList->CAL_ICON_LIST);
+        $this->assertEquals($data['iconColor'], $caseList->CAL_ICON_COLOR);
+        $this->assertEquals($data['iconColorScreen'], $caseList->CAL_ICON_COLOR_SCREEN);
+    }
+
+    /**
+     * This tests the deleteSetting method.
+     * @test
+     * @covers  \ProcessMaker\Model\CaseList::deleteSetting()
+     */
+    public function it_should_test_deleteSetting()
+    {
+        $data = [
+            'type' => 'inbox',
+            'name' => 'test1',
+            'description' => 'my description',
+            'tableUid' => '',
+            'columns' => [],
+            'userId' => 1,
+            'iconList' => 'deafult.png',
+            'iconColor' => 'red',
+            'iconColorScreen' => 'blue',
+            'createDate' => date('Y-m-d H:m:s'),
+            'updateDate' => date('Y-m-d H:m:s')
+        ];
+        $model = CaseList::createSetting($data);
+
+        $id = $model->CAL_ID;
+        $caseList = CaseList::deleteSetting($id);
+
+        //asserts
+        $this->assertEquals($data['type'], $caseList->CAL_TYPE);
+        $this->assertEquals($data['name'], $caseList->CAL_NAME);
+        $this->assertEquals($data['description'], $caseList->CAL_DESCRIPTION);
+        $this->assertEquals($data['tableUid'], $caseList->ADD_TAB_UID);
+        $this->assertEquals($data['columns'], $caseList->CAL_COLUMNS);
+        $this->assertEquals($data['userId'], $caseList->USR_ID);
+        $this->assertEquals($data['iconList'], $caseList->CAL_ICON_LIST);
+        $this->assertEquals($data['iconColor'], $caseList->CAL_ICON_COLOR);
+        $this->assertEquals($data['iconColorScreen'], $caseList->CAL_ICON_COLOR_SCREEN);
+    }
+
+    /**
+     * This tests the getSetting method.
+     * @test
+     * @covers  \ProcessMaker\Model\CaseList::deleteSetting()
+     */
+    public function it_should_test_getSetting()
+    {
+        CaseList::truncate();
+
+        $data = [
+            'type' => 'inbox',
+            'name' => 'test1',
+            'description' => 'my description',
+            'tableUid' => '',
+            'columns' => [],
+            'userId' => 1,
+            'iconList' => 'deafult.png',
+            'iconColor' => 'red',
+            'iconColorScreen' => 'blue'
+        ];
+        $model1 = CaseList::createSetting($data);
+        $model2 = CaseList::createSetting($data);
+        $model3 = CaseList::createSetting($data);
+        $model4 = CaseList::createSetting($data);
+
+        //assert total
+        $result = CaseList::getSetting('inbox', '', 0, 10);
+        $this->assertArrayHasKey("total", $result);
+        $this->assertArrayHasKey("data", $result);
+        $this->assertEquals(4, $result['total']);
+
+        //assert page 1
+        $result = CaseList::getSetting('inbox', '', 0, 2);
+        $this->assertArrayHasKey("total", $result);
+        $this->assertArrayHasKey("data", $result);
+        $this->assertEquals(4, $result['total']);
+        $this->assertEquals(2, count($result['data']));
+
+        //assert page 2
+        $result = CaseList::getSetting('inbox', '', 2, 2);
+        $this->assertArrayHasKey("total", $result);
+        $this->assertArrayHasKey("data", $result);
+        $this->assertEquals(4, $result['total']);
+        $this->assertEquals(2, count($result['data']));
+
+        //assert search
+        $result = CaseList::getSetting('inbox', 'test1', 0, 10);
+        $this->assertArrayHasKey("total", $result);
+        $this->assertArrayHasKey("data", $result);
+        $this->assertEquals(4, $result['total']);
+        $this->assertEquals(4, count($result['data']));
+
+        //assert search no exist result
+        $result = CaseList::getSetting('inbox', 'xxxx', 0, 10);
+        $this->assertArrayHasKey("total", $result);
+        $this->assertArrayHasKey("data", $result);
+        $this->assertEquals(0, $result['total']);
+        $this->assertEquals(0, count($result['data']));
+    }
+}

workflow/engine/classes/model/CaseList.php

@@ -0,0 +1,19 @@
+<?php
+
+require_once 'classes/model/om/BaseCaseList.php';
+
+
+/**
+ * Skeleton subclass for representing a row from the 'CASE_LIST' table.
+ *
+ * 
+ *
+ * You should add additional methods to this class to meet the
+ * application requirements.  This class will only be generated as
+ * long as it does not already exist in the output directory.
+ *
+ * @package    classes.model
+ */
+class CaseList extends BaseCaseList {
+
+} // CaseList

workflow/engine/classes/model/CaseListPeer.php

@@ -0,0 +1,23 @@
+<?php
+
+  // include base peer class
+  require_once 'classes/model/om/BaseCaseListPeer.php';
+
+  // include object class
+  include_once 'classes/model/CaseList.php';
+
+
+/**
+ * Skeleton subclass for performing query and update operations on the 'CASE_LIST' table.
+ *
+ * 
+ *
+ * You should add additional methods to this class to meet the
+ * application requirements.  This class will only be generated as
+ * long as it does not already exist in the output directory.
+ *
+ * @package    classes.model
+ */
+class CaseListPeer extends BaseCaseListPeer {
+
+} // CaseListPeer

workflow/engine/classes/model/map/CaseListMapBuilder.php

@@ -0,0 +1,94 @@
+<?php
+
+require_once 'propel/map/MapBuilder.php';
+include_once 'creole/CreoleTypes.php';
+
+
+/**
+ * This class adds structure of 'CASE_LIST' table to 'workflow' DatabaseMap object.
+ *
+ *
+ *
+ * These statically-built map classes are used by Propel to do runtime db structure discovery.
+ * For example, the createSelectSql() method checks the type of a given column used in an
+ * ORDER BY clause to know whether it needs to apply SQL to make the ORDER BY case-insensitive
+ * (i.e. if it's a text column type).
+ *
+ * @package    workflow.classes.model.map
+ */
+class CaseListMapBuilder
+{
+
+    /**
+     * The (dot-path) name of this class
+     */
+    const CLASS_NAME = 'classes.model.map.CaseListMapBuilder';
+
+    /**
+     * The database map.
+     */
+    private $dbMap;
+
+    /**
+     * Tells us if this DatabaseMapBuilder is built so that we
+     * don't have to re-build it every time.
+     *
+     * @return     boolean true if this DatabaseMapBuilder is built, false otherwise.
+     */
+    public function isBuilt()
+    {
+        return ($this->dbMap !== null);
+    }
+
+    /**
+     * Gets the databasemap this map builder built.
+     *
+     * @return     the databasemap
+     */
+    public function getDatabaseMap()
+    {
+        return $this->dbMap;
+    }
+
+    /**
+     * The doBuild() method builds the DatabaseMap
+     *
+     * @return     void
+     * @throws     PropelException
+     */
+    public function doBuild()
+    {
+        $this->dbMap = Propel::getDatabaseMap('workflow');
+
+        $tMap = $this->dbMap->addTable('CASE_LIST');
+        $tMap->setPhpName('CaseList');
+
+        $tMap->setUseIdGenerator(true);
+
+        $tMap->addPrimaryKey('CAL_ID', 'CalId', 'int', CreoleTypes::INTEGER, true, null);
+
+        $tMap->addColumn('CAL_TYPE', 'CalType', 'string', CreoleTypes::VARCHAR, true, 255);
+
+        $tMap->addColumn('CAL_NAME', 'CalName', 'string', CreoleTypes::VARCHAR, true, 255);
+
+        $tMap->addColumn('CAL_DESCRIPTION', 'CalDescription', 'string', CreoleTypes::LONGVARCHAR, false, null);
+
+        $tMap->addColumn('ADD_TAB_UID', 'AddTabUid', 'string', CreoleTypes::VARCHAR, true, 32);
+
+        $tMap->addColumn('CAL_COLUMNS', 'CalColumns', 'string', CreoleTypes::LONGVARCHAR, false, null);
+
+        $tMap->addColumn('USR_ID', 'UsrId', 'string', CreoleTypes::BIGINT, true, 20);
+
+        $tMap->addColumn('CAL_ICON_LIST', 'CalIconList', 'string', CreoleTypes::LONGVARCHAR, false, null);
+
+        $tMap->addColumn('CAL_ICON_COLOR', 'CalIconColor', 'string', CreoleTypes::VARCHAR, false, 255);
+
+        $tMap->addColumn('CAL_ICON_COLOR_SCREEN', 'CalIconColorScreen', 'string', CreoleTypes::VARCHAR, false, 255);
+
+        $tMap->addColumn('CAL_CREATE_DATE', 'CalCreateDate', 'int', CreoleTypes::TIMESTAMP, true, null);
+
+        $tMap->addColumn('CAL_UPDATE_DATE', 'CalUpdateDate', 'int', CreoleTypes::TIMESTAMP, true, null);
+
+    } // doBuild()
+
+} // CaseListMapBuilder

workflow/engine/config/schema.xml

@@ -6117,4 +6117,22 @@
         <column name="USC_NAME" type="VARCHAR" size="255" required="true" primaryKey="true"/>
         <column name="USC_SETTING" type="LONGVARCHAR" required="true"/>
     </table>
+    <table name="CASE_LIST" idMethod="native">
+        <vendor type="mysql">
+            <parameter name="Engine" value="InnoDB"/>
+            <parameter name="Collation" value="utf8"/>
+        </vendor>
+        <column name="CAL_ID" type="INTEGER" required="true" autoIncrement="true" primaryKey="true"/>
+        <column name="CAL_TYPE" type="VARCHAR" size="255" required="true"/>
+        <column name="CAL_NAME" type="VARCHAR" size="255" required="true"/>
+        <column name="CAL_DESCRIPTION" type="LONGVARCHAR"/>
+        <column name="ADD_TAB_UID" type="VARCHAR" size="32" required="true"/>
+        <column name="CAL_COLUMNS" type="LONGVARCHAR"/>
+        <column name="USR_ID" type="BIGINT" size="20" required="true"/>
+        <column name="CAL_ICON_LIST" type="LONGVARCHAR"/>
+        <column name="CAL_ICON_COLOR" type="VARCHAR" size="255"/>
+        <column name="CAL_ICON_COLOR_SCREEN" type="VARCHAR" size="255"/>
+        <column name="CAL_CREATE_DATE" type="TIMESTAMP" required="true"/>
+        <column name="CAL_UPDATE_DATE" type="TIMESTAMP" required="true"/>
+    </table>
 </database>

workflow/engine/data/mysql/schema.sql

@@ -3406,5 +3406,28 @@ CREATE TABLE `USER_CONFIG`
 	`USC_SETTING` MEDIUMTEXT  NOT NULL,
 	PRIMARY KEY (`USR_ID`,`USC_NAME`)
 )ENGINE=InnoDB  DEFAULT CHARSET='utf8';
+#-----------------------------------------------------------------------------
+#-- CASE_LIST
+#-----------------------------------------------------------------------------
+
+DROP TABLE IF EXISTS `CASE_LIST`;
+
+
+CREATE TABLE `CASE_LIST`
+(
+	`CAL_ID` INTEGER  NOT NULL AUTO_INCREMENT,
+	`CAL_TYPE` VARCHAR(255)  NOT NULL,
+	`CAL_NAME` VARCHAR(255)  NOT NULL,
+	`CAL_DESCRIPTION` MEDIUMTEXT,
+	`ADD_TAB_UID` VARCHAR(32)  NOT NULL,
+	`CAL_COLUMNS` MEDIUMTEXT,
+	`USR_ID` BIGINT(20)  NOT NULL,
+	`CAL_ICON_LIST` MEDIUMTEXT,
+	`CAL_ICON_COLOR` VARCHAR(255),
+	`CAL_ICON_COLOR_SCREEN` VARCHAR(255),
+	`CAL_CREATE_DATE` DATETIME  NOT NULL,
+	`CAL_UPDATE_DATE` DATETIME  NOT NULL,
+	PRIMARY KEY (`CAL_ID`)
+)ENGINE=InnoDB  DEFAULT CHARSET='utf8';
 # This restores the fkey checks, after having unset them earlier
 SET FOREIGN_KEY_CHECKS = 1;

workflow/engine/src/ProcessMaker/Model/CaseList.php

@@ -0,0 +1,215 @@
+<?php
+
+namespace ProcessMaker\Model;
+
+use ProcessMaker\Core\System;
+use ProcessMaker\Model\AdditionalTables;
+use ProcessMaker\Model\User;
+use Illuminate\Database\Eloquent\Model;
+
+class CaseList extends Model
+{
+    /**
+     * The table associated with the model.
+     * @var string
+     */
+    protected $table = 'CASE_LIST';
+
+    /**
+     * The primary key for the model.
+     * @var string
+     */
+    protected $primaryKey = 'CAL_ID';
+
+    /**
+     * Indicates if the IDs are auto-incrementing.
+     * @var bool
+     */
+    public $incrementing = true;
+
+    /**
+     * Indicates if the model should be timestamped.
+     * @var bool
+     */
+    public $timestamps = false;
+
+    /**
+     * The attributes that aren't mass assignable.
+     * @var array
+     */
+    protected $guarded = [];
+
+    /**
+     * Represents the column aliases.
+     * @var array
+     */
+    private static $columnAliases = [
+        'CAL_ID' => 'id',
+        'CAL_TYPE' => 'type',
+        'CAL_NAME' => 'name',
+        'CAL_DESCRIPTION' => 'description',
+        'ADD_TAB_UID' => 'tableUid',
+        'CAL_COLUMNS' => 'columns',
+        'USR_ID' => 'userId',
+        'CAL_ICON_LIST' => 'iconList',
+        'CAL_ICON_COLOR' => 'iconColor',
+        'CAL_ICON_COLOR_SCREEN' => 'iconColorScreen',
+        'CAL_CREATE_DATE' => 'createDate',
+        'CAL_UPDATE_DATE' => 'updateDate',
+        'USR_USERNAME' => 'userName',
+        'USR_FIRSTNAME' => 'userFirstname',
+        'USR_LASTNAME' => 'userLastname',
+        'USR_EMAIL' => 'userEmail',
+        'ADD_TAB_NAME' => 'tableName'
+    ];
+
+    /**
+     * Get column name from alias.
+     * @param array $array
+     * @return array
+     */
+    public static function getColumnNameFromAlias(array $array): array
+    {
+        foreach (self::$columnAliases as $key => $value) {
+            if (array_key_exists($value, $array)) {
+                $array[$key] = $array[$value];
+                unset($array[$value]);
+            }
+        }
+        return $array;
+    }
+
+    /**
+     * Get alias from column name.
+     * @param array $array
+     * @return array
+     */
+    public static function getAliasFromColumnName(array $array)
+    {
+        foreach (self::$columnAliases as $key => $value) {
+            if (array_key_exists($key, $array)) {
+                $array[$value] = $array[$key];
+                unset($array[$key]);
+            }
+        }
+        return $array;
+    }
+
+    /**
+     * Create and save this model from array values.
+     * @param array $values
+     * @return object
+     */
+    public static function createSetting(array $values)
+    {
+        $attributes = CaseList::getColumnNameFromAlias($values);
+
+        $attributes['CAL_CREATE_DATE'] = date("Y-m-d H:i:s");
+        $attributes['CAL_UPDATE_DATE'] = date("Y-m-d H:i:s");
+        if (empty($attributes['CAL_COLUMNS'])) {
+            $attributes['CAL_COLUMNS'] = [];
+        }
+        $attributes['CAL_COLUMNS'] = json_encode($attributes['CAL_COLUMNS']);
+
+        $model = CaseList::create($attributes);
+        $model->CAL_COLUMNS = json_decode($model->CAL_COLUMNS);
+        return $model;
+    }
+
+    /**
+     * Update and save this model from array values.
+     * @param int $id
+     * @param array $values
+     * @return object
+     */
+    public static function updateSetting(int $id, array $values)
+    {
+        $attributes = CaseList::getColumnNameFromAlias($values);
+
+        $attributes['CAL_UPDATE_DATE'] = date("Y-m-d H:i:s");
+        if (empty($attributes['CAL_COLUMNS'])) {
+            $attributes['CAL_COLUMNS'] = [];
+        }
+        $attributes['CAL_COLUMNS'] = json_encode($attributes['CAL_COLUMNS']);
+
+        $caseList = CaseList::where('CAL_ID', '=', $id);
+        $caseList->update($attributes);
+        $model = $caseList->get()->first();
+        if (!is_null($model)) {
+            $model->CAL_COLUMNS = json_decode($model->CAL_COLUMNS);
+        }
+        return $model;
+    }
+
+    /**
+     * Delete this model.
+     * @param int $id
+     * @return object
+     */
+    public static function deleteSetting(int $id)
+    {
+        $caseList = CaseList::where('CAL_ID', '=', $id);
+        $model = $caseList->get()->first();
+        if (!is_null($model)) {
+            $caseList->delete();
+            $model->CAL_COLUMNS = json_decode($model->CAL_COLUMNS);
+        }
+        return $model;
+    }
+
+    /**
+     * Get the array of the elements of this model, this method supports the filter by: 
+     * name, description, user name, first user name, second user name, user email. 
+     * The result is returned based on the delimiters to allow pagination and the total 
+     * of the existing models.
+     * @param string $type
+     * @param string $search
+     * @param int $offset
+     * @param int $limit
+     * @return array
+     */
+    public static function getSetting(string $type, string $search, int $offset, int $limit): array
+    {
+        $order = 'asc';
+        $model = CaseList::where('CAL_TYPE', '=', $type)
+            ->leftJoin('USERS', 'USERS.USR_ID', '=', 'CASE_LIST.USR_ID')
+            ->leftJoin('ADDITIONAL_TABLES', 'ADDITIONAL_TABLES.ADD_TAB_UID', '=', 'CASE_LIST.ADD_TAB_UID')
+            ->select([
+                'CASE_LIST.*',
+                'USERS.USR_UID', 'USERS.USR_USERNAME', 'USERS.USR_FIRSTNAME', 'USERS.USR_LASTNAME', 'USERS.USR_EMAIL',
+                'ADDITIONAL_TABLES.ADD_TAB_NAME'
+            ])
+            ->where(function ($query) use ($search) {
+                $query
+                ->orWhere('CASE_LIST.CAL_NAME', 'like', '%' . $search . '%')
+                ->orWhere('CASE_LIST.CAL_DESCRIPTION', 'like', '%' . $search . '%')
+                ->orWhere('USERS.USR_USERNAME', 'like', '%' . $search . '%')
+                ->orWhere('USERS.USR_FIRSTNAME', 'like', '%' . $search . '%')
+                ->orWhere('USERS.USR_LASTNAME', 'like', '%' . $search . '%')
+                ->orWhere('USERS.USR_EMAIL', 'like', '%' . $search . '%');
+            })
+            ->orderBy('CASE_LIST.CAL_NAME', $order);
+
+        $count = $model->count();
+
+        $data = $model->offset($offset)->limit($limit)->get();
+        $data->transform(function ($item, $key) {
+            if (is_null($item->CAL_COLUMNS)) {
+                $item->CAL_COLUMNS = '[]';
+            }
+
+            $result = CaseList::getAliasFromColumnName($item->toArray());
+
+            $result['columns'] = json_decode($result['columns']);
+            $result['userAvatar'] = System::getServerMainPath() . '/users/users_ViewPhotoGrid?pUID=' . $result['USR_UID'] . '&h=' . microtime(true);
+            unset($result['USR_UID']);
+
+            return $result;
+        });
+
+        return [
+            'total' => $count,
+            'data' => $data
+        ];
+    }
+}

workflow/engine/src/ProcessMaker/Services/Api/CaseList.php

@@ -0,0 +1,148 @@
+<?php
+
+namespace ProcessMaker\Services\Api;
+
+use Exception;
+use G;
+use Luracast\Restler\RestException;
+use ProcessMaker\Model\CaseList as CaseListBusinessModel;
+use ProcessMaker\Services\Api;
+use RBAC;
+
+class CaseList extends Api
+{
+
+    /**
+     * Constructor of the class.
+     * @global object $RBAC
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        global $RBAC;
+        if (!isset($RBAC)) {
+            $RBAC = RBAC::getSingleton(PATH_DATA, session_id());
+            $RBAC->sSystem = 'PROCESSMAKER';
+            $RBAC->initRBAC();
+            $RBAC->loadUserRolePermission($RBAC->sSystem, $this->getUserId());
+        }
+    }
+
+    /**
+     * Create the Case List setting.
+     * @url POST
+     * @param array $request_data
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
+     * @return array
+     */
+    public function doPost(array $request_data)
+    {
+        $caseList = CaseListBusinessModel::createSetting($request_data);
+        $caseList = CaseListBusinessModel::getAliasFromColumnName($caseList->toArray());
+        return $caseList;
+    }
+
+    /**
+     * Update the Case List setting.
+     * @url PUT /:id
+     * @param string $id
+     * @param array $request_data
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
+     * @throws RestException
+     * @return array
+     */
+    public function doPut(int $id, array $request_data)
+    {
+        $caseList = CaseListBusinessModel::updateSetting($id, $request_data);
+        if (is_null($caseList)) {
+            throw new RestException(Api::STAT_APP_EXCEPTION, G::LoadTranslation('ID_DOES_NOT_EXIST'));
+        }
+        $caseList = CaseListBusinessModel::getAliasFromColumnName($caseList->toArray());
+        return $caseList;
+    }
+
+    /**
+     * Delete the Case List setting.
+     * @url DELETE /:id
+     * @param string $id
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
+     * @throws RestException
+     * @return array
+     */
+    public function doDelete(int $id)
+    {
+        try {
+            $caseList = CaseListBusinessModel::deleteSetting($id);
+            if (is_null($caseList)) {
+                throw new RestException(Api::STAT_APP_EXCEPTION, G::LoadTranslation('ID_DOES_NOT_EXIST'));
+            }
+            $caseList = CaseListBusinessModel::getAliasFromColumnName($caseList->toArray());
+            return $caseList;
+        } catch (Exception $e) {
+            throw new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage());
+        }
+    }
+
+    /**
+     * Get inbox Case List settings.
+     * @url GET /inbox
+     * @param string $search
+     * @param string $offset
+     * @param string $limit
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
+     * @return array
+     */
+    public function doGetInbox(string $search = '', int $offset = 0, int $limit = 10)
+    {
+        return CaseListBusinessModel::getSetting('inbox', $search, $offset, $limit);
+    }
+
+    /**
+     * Get draft Case List settings.
+     * @url GET /draft
+     * @param string $search
+     * @param string $offset
+     * @param string $limit
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
+     * @return array
+     */
+    public function doGetDraft(string $search = '', int $offset = 0, int $limit = 10)
+    {
+        return CaseListBusinessModel::getSetting('draft', $search, $offset, $limit);
+    }
+
+    /**
+     * Get paused Case List settings.
+     * @url GET /paused
+     * @param string $search
+     * @param string $offset
+     * @param string $limit
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
+     * @return array
+     */
+    public function doGetPaused(string $search = '', int $offset = 0, int $limit = 10)
+    {
+        return CaseListBusinessModel::getSetting('paused', $search, $offset, $limit);
+    }
+
+    /**
+     * Get unassigned Case List settings.
+     * @url GET /unassigned
+     * @param string $search
+     * @param string $offset
+     * @param string $limit
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
+     * @return array
+     */
+    public function doGetUnassigned(string $search, int $offset, int $limit)
+    {
+        return CaseListBusinessModel::getSetting('unassigned', $search, $offset, $limit);
+    }
+}