fernando/luos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PMCORE-3050 Rest Services - CRUD My task column settings

Browse Source
This commit is contained in:
Roly Rudy Gutierrez Pinto
2021-07-07 10:35:28 -04:00
parent 759075c979
commit 12dff0c33e
10 changed files with 1618 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
tests/unit/workflow/engine/src/ProcessMaker/Model/UserConfigTest.php Normal file
View File

@@ -0,0 +1,113 @@
<?php
namespace Tests\unit\workflow\src\ProcessMaker\Model;
use G;
use ProcessMaker\Model\UserConfig;
use Tests\TestCase;
class UserConfigTest extends TestCase
{
/**
* Setup method,
*/
public function setUp()
{
parent::setUp();
}
/**
* Teardown method.
*/
public function tearDown()
{
parent::tearDown();
}
/**
* It test the method getSetting.
* @test
* @covers \ProcessMaker\Model\UserConfig::getSetting()
*/
public function it_should_test_getSetting()
{
$id = 1;
$name = "test";
$setting = json_encode(["test" => 1]);
$result = UserConfig::addSetting($id, $name, $setting);
//assert get
$result = UserConfig::getSetting($id, $name);
$this->assertArrayHasKey("id", $result);
$this->assertArrayHasKey("name", $result);
$this->assertArrayHasKey("setting", $result);
$this->assertEquals($result["id"], $id);
$this->assertEquals($result["name"], $name);
$this->assertEquals($result["setting"], json_decode($setting));
}
/**
* It test the method addSetting.
* @test
* @covers \ProcessMaker\Model\UserConfig::addSetting()
*/
public function it_should_test_addSetting()
{
$id = 1;
$name = "test";
$setting = json_encode(["test" => 1]);
$result = UserConfig::addSetting($id, $name, $setting);
$this->assertArrayHasKey("id", $result);
$this->assertArrayHasKey("name", $result);
$this->assertArrayHasKey("setting", $result);
$this->assertEquals($result["id"], $id);
$this->assertEquals($result["name"], $name);
$this->assertEquals($result["setting"], json_decode($setting));
}
/**
* It test the method editSetting.
* @test
* @covers \ProcessMaker\Model\UserConfig::editSetting()
*/
public function it_should_test_editSetting()
{
$id = 1;
$name = "test";
$setting = json_encode(["test" => 1]);
$result = UserConfig::addSetting($id, $name, $setting);
//assert edit
$setting = json_encode(["test" => 2, "test2" => 3]);
$result = UserConfig::editSetting($id, $name, $setting);
$this->assertArrayHasKey("id", $result);
$this->assertArrayHasKey("name", $result);
$this->assertArrayHasKey("setting", $result);
$this->assertEquals($result["id"], $id);
$this->assertEquals($result["name"], $name);
$this->assertEquals($result["setting"], json_decode($setting));
}
/**
* It test the method deleteSetting.
* @test
* @covers \ProcessMaker\Model\UserConfig::deleteSetting()
*/
public function it_should_test_deleteSetting()
{
$id = 2;
$name = "test2";
$setting = json_encode(["test2" => 1]);
$result = UserConfig::addSetting($id, $name, $setting);
//assert delete
$result = UserConfig::deleteSetting($id, $name);
$this->assertArrayHasKey("id", $result);
$this->assertArrayHasKey("name", $result);
$this->assertArrayHasKey("setting", $result);
$this->assertEquals($result["id"], $id);
$this->assertEquals($result["name"], $name);
}
}

19
workflow/engine/classes/model/UserConfig.php Normal file
View File

@@ -0,0 +1,19 @@
<?php
require_once 'classes/model/om/BaseUserConfig.php';
/**
* Skeleton subclass for representing a row from the 'USER_CONFIG' 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 UserConfig extends BaseUserConfig {
} // UserConfig

23
workflow/engine/classes/model/UserConfigPeer.php Normal file
View File

@@ -0,0 +1,23 @@
<?php
// include base peer class
require_once 'classes/model/om/BaseUserConfigPeer.php';
// include object class
include_once 'classes/model/UserConfig.php';
/**
* Skeleton subclass for performing query and update operations on the 'USER_CONFIG' 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 UserConfigPeer extends BaseUserConfigPeer {
} // UserConfigPeer

76
workflow/engine/classes/model/map/UserConfigMapBuilder.php Normal file
View File

@@ -0,0 +1,76 @@
<?php
require_once 'propel/map/MapBuilder.php';
include_once 'creole/CreoleTypes.php';
/**
* This class adds structure of 'USER_CONFIG' 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 UserConfigMapBuilder
{
/**
* The (dot-path) name of this class
*/
const CLASS_NAME = 'classes.model.map.UserConfigMapBuilder';
/**
* 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('USER_CONFIG');
$tMap->setPhpName('UserConfig');
$tMap->setUseIdGenerator(false);
$tMap->addPrimaryKey('USR_ID', 'UsrId', 'string', CreoleTypes::BIGINT, true, 20);
$tMap->addPrimaryKey('USC_NAME', 'UscName', 'string', CreoleTypes::VARCHAR, true, 255);
$tMap->addColumn('USC_SETTING', 'UscSetting', 'string', CreoleTypes::LONGVARCHAR, true, null);
} // doBuild()
} // UserConfigMapBuilder

638
workflow/engine/classes/model/om/BaseUserConfig.php Normal file
View File

@@ -0,0 +1,638 @@
<?php
require_once 'propel/om/BaseObject.php';
require_once 'propel/om/Persistent.php';
include_once 'propel/util/Criteria.php';
include_once 'classes/model/UserConfigPeer.php';
/**
* Base class that represents a row from the 'USER_CONFIG' table.
*
*
*
* @package workflow.classes.model.om
*/
abstract class BaseUserConfig extends BaseObject implements Persistent
{
/**
* The Peer class.
* Instance provides a convenient way of calling static methods on a class
* that calling code may not be able to identify.
* @var UserConfigPeer
*/
protected static $peer;
/**
* The value for the usr_id field.
* @var string
*/
protected $usr_id;
/**
* The value for the usc_name field.
* @var string
*/
protected $usc_name;
/**
* The value for the usc_setting field.
* @var string
*/
protected $usc_setting;
/**
* Flag to prevent endless save loop, if this object is referenced
* by another object which falls in this transaction.
* @var boolean
*/
protected $alreadyInSave = false;
/**
* Flag to prevent endless validation loop, if this object is referenced
* by another object which falls in this transaction.
* @var boolean
*/
protected $alreadyInValidation = false;
/**
* Get the [usr_id] column value.
*
* @return string
*/
public function getUsrId()
{
return $this->usr_id;
}
/**
* Get the [usc_name] column value.
*
* @return string
*/
public function getUscName()
{
return $this->usc_name;
}
/**
* Get the [usc_setting] column value.
*
* @return string
*/
public function getUscSetting()
{
return $this->usc_setting;
}
/**
* Set the value of [usr_id] column.
*
* @param string $v new value
* @return void
*/
public function setUsrId($v)
{
// Since the native PHP type for this column is string,
// we will cast the input to a string (if it is not).
if ($v !== null && !is_string($v)) {
$v = (string) $v;
}
if ($this->usr_id !== $v) {
$this->usr_id = $v;
$this->modifiedColumns[] = UserConfigPeer::USR_ID;
}
} // setUsrId()
/**
* Set the value of [usc_name] column.
*
* @param string $v new value
* @return void
*/
public function setUscName($v)
{
// Since the native PHP type for this column is string,
// we will cast the input to a string (if it is not).
if ($v !== null && !is_string($v)) {
$v = (string) $v;
}
if ($this->usc_name !== $v) {
$this->usc_name = $v;
$this->modifiedColumns[] = UserConfigPeer::USC_NAME;
}
} // setUscName()
/**
* Set the value of [usc_setting] column.
*
* @param string $v new value
* @return void
*/
public function setUscSetting($v)
{
// Since the native PHP type for this column is string,
// we will cast the input to a string (if it is not).
if ($v !== null && !is_string($v)) {
$v = (string) $v;
}
if ($this->usc_setting !== $v) {
$this->usc_setting = $v;
$this->modifiedColumns[] = UserConfigPeer::USC_SETTING;
}
} // setUscSetting()
/**
* Hydrates (populates) the object variables with values from the database resultset.
*
* An offset (1-based "start column") is specified so that objects can be hydrated
* with a subset of the columns in the resultset rows. This is needed, for example,
* for results of JOIN queries where the resultset row includes columns from two or
* more tables.
*
* @param ResultSet $rs The ResultSet class with cursor advanced to desired record pos.
* @param int $startcol 1-based offset column which indicates which restultset column to start with.
* @return int next starting column
* @throws PropelException - Any caught Exception will be rewrapped as a PropelException.
*/
public function hydrate(ResultSet $rs, $startcol = 1)
{
try {
$this->usr_id = $rs->getString($startcol + 0);
$this->usc_name = $rs->getString($startcol + 1);
$this->usc_setting = $rs->getString($startcol + 2);
$this->resetModified();
$this->setNew(false);
// FIXME - using NUM_COLUMNS may be clearer.
return $startcol + 3; // 3 = UserConfigPeer::NUM_COLUMNS - UserConfigPeer::NUM_LAZY_LOAD_COLUMNS).
} catch (Exception $e) {
throw new PropelException("Error populating UserConfig object", $e);
}
}
/**
* Removes this object from datastore and sets delete attribute.
*
* @param Connection $con
* @return void
* @throws PropelException
* @see BaseObject::setDeleted()
* @see BaseObject::isDeleted()
*/
public function delete($con = null)
{
if ($this->isDeleted()) {
throw new PropelException("This object has already been deleted.");
}
if ($con === null) {
$con = Propel::getConnection(UserConfigPeer::DATABASE_NAME);
}
try {
$con->begin();
UserConfigPeer::doDelete($this, $con);
$this->setDeleted(true);
$con->commit();
} catch (PropelException $e) {
$con->rollback();
throw $e;
}
}
/**
* Stores the object in the database. If the object is new,
* it inserts it; otherwise an update is performed. This method
* wraps the doSave() worker method in a transaction.
*
* @param Connection $con
* @return int The number of rows affected by this insert/update
* @throws PropelException
* @see doSave()
*/
public function save($con = null)
{
if ($this->isDeleted()) {
throw new PropelException("You cannot save an object that has been deleted.");
}
if ($con === null) {
$con = Propel::getConnection(UserConfigPeer::DATABASE_NAME);
}
try {
$con->begin();
$affectedRows = $this->doSave($con);
$con->commit();
return $affectedRows;
} catch (PropelException $e) {
$con->rollback();
throw $e;
}
}
/**
* Stores the object in the database.
*
* If the object is new, it inserts it; otherwise an update is performed.
* All related objects are also updated in this method.
*
* @param Connection $con
* @return int The number of rows affected by this insert/update and any referring
* @throws PropelException
* @see save()
*/
protected function doSave($con)
{
$affectedRows = 0; // initialize var to track total num of affected rows
if (!$this->alreadyInSave) {
$this->alreadyInSave = true;
// If this object has been modified, then save it to the database.
if ($this->isModified()) {
if ($this->isNew()) {
$pk = UserConfigPeer::doInsert($this, $con);
$affectedRows += 1; // we are assuming that there is only 1 row per doInsert() which
// should always be true here (even though technically
// BasePeer::doInsert() can insert multiple rows).
$this->setNew(false);
} else {
$affectedRows += UserConfigPeer::doUpdate($this, $con);
}
$this->resetModified(); // [HL] After being saved an object is no longer 'modified'
}
$this->alreadyInSave = false;
}
return $affectedRows;
} // doSave()
/**
* Array of ValidationFailed objects.
* @var array ValidationFailed[]
*/
protected $validationFailures = array();
/**
* Gets any ValidationFailed objects that resulted from last call to validate().
*
*
* @return array ValidationFailed[]
* @see validate()
*/
public function getValidationFailures()
{
return $this->validationFailures;
}
/**
* Validates the objects modified field values and all objects related to this table.
*
* If $columns is either a column name or an array of column names
* only those columns are validated.
*
* @param mixed $columns Column name or an array of column names.
* @return boolean Whether all columns pass validation.
* @see doValidate()
* @see getValidationFailures()
*/
public function validate($columns = null)
{
$res = $this->doValidate($columns);
if ($res === true) {
$this->validationFailures = array();
return true;
} else {
$this->validationFailures = $res;
return false;
}
}
/**
* This function performs the validation work for complex object models.
*
* In addition to checking the current object, all related objects will
* also be validated. If all pass then <code>true</code> is returned; otherwise
* an aggreagated array of ValidationFailed objects will be returned.
*
* @param array $columns Array of column names to validate.
* @return mixed <code>true</code> if all validations pass;
array of <code>ValidationFailed</code> objects otherwise.
*/
protected function doValidate($columns = null)
{
if (!$this->alreadyInValidation) {
$this->alreadyInValidation = true;
$retval = null;
$failureMap = array();
if (($retval = UserConfigPeer::doValidate($this, $columns)) !== true) {
$failureMap = array_merge($failureMap, $retval);
}
$this->alreadyInValidation = false;
}
return (!empty($failureMap) ? $failureMap : true);
}
/**
* Retrieves a field from the object by name passed in as a string.
*
* @param string $name name
* @param string $type The type of fieldname the $name is of:
* one of the class type constants TYPE_PHPNAME,
* TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
* @return mixed Value of field.
*/
public function getByName($name, $type = BasePeer::TYPE_PHPNAME)
{
$pos = UserConfigPeer::translateFieldName($name, $type, BasePeer::TYPE_NUM);
return $this->getByPosition($pos);
}
/**
* Retrieves a field from the object by Position as specified in the xml schema.
* Zero-based.
*
* @param int $pos position in xml schema
* @return mixed Value of field at $pos
*/
public function getByPosition($pos)
{
switch($pos) {
case 0:
return $this->getUsrId();
break;
case 1:
return $this->getUscName();
break;
case 2:
return $this->getUscSetting();
break;
default:
return null;
break;
} // switch()
}
/**
* Exports the object as an array.
*
* You can specify the key type of the array by passing one of the class
* type constants.
*
* @param string $keyType One of the class type constants TYPE_PHPNAME,
* TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
* @return an associative array containing the field names (as keys) and field values
*/
public function toArray($keyType = BasePeer::TYPE_PHPNAME)
{
$keys = UserConfigPeer::getFieldNames($keyType);
$result = array(
$keys[0] => $this->getUsrId(),
$keys[1] => $this->getUscName(),
$keys[2] => $this->getUscSetting(),
);
return $result;
}
/**
* Sets a field from the object by name passed in as a string.
*
* @param string $name peer name
* @param mixed $value field value
* @param string $type The type of fieldname the $name is of:
* one of the class type constants TYPE_PHPNAME,
* TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
* @return void
*/
public function setByName($name, $value, $type = BasePeer::TYPE_PHPNAME)
{
$pos = UserConfigPeer::translateFieldName($name, $type, BasePeer::TYPE_NUM);
return $this->setByPosition($pos, $value);
}
/**
* Sets a field from the object by Position as specified in the xml schema.
* Zero-based.
*
* @param int $pos position in xml schema
* @param mixed $value field value
* @return void
*/
public function setByPosition($pos, $value)
{
switch($pos) {
case 0:
$this->setUsrId($value);
break;
case 1:
$this->setUscName($value);
break;
case 2:
$this->setUscSetting($value);
break;
} // switch()
}
/**
* Populates the object using an array.
*
* This is particularly useful when populating an object from one of the
* request arrays (e.g. $_POST). This method goes through the column
* names, checking to see whether a matching key exists in populated
* array. If so the setByName() method is called for that column.
*
* You can specify the key type of the array by additionally passing one
* of the class type constants TYPE_PHPNAME, TYPE_COLNAME, TYPE_FIELDNAME,
* TYPE_NUM. The default key type is the column's phpname (e.g. 'authorId')
*
* @param array $arr An array to populate the object from.
* @param string $keyType The type of keys the array uses.
* @return void
*/
public function fromArray($arr, $keyType = BasePeer::TYPE_PHPNAME)
{
$keys = UserConfigPeer::getFieldNames($keyType);
if (array_key_exists($keys[0], $arr)) {
$this->setUsrId($arr[$keys[0]]);
}
if (array_key_exists($keys[1], $arr)) {
$this->setUscName($arr[$keys[1]]);
}
if (array_key_exists($keys[2], $arr)) {
$this->setUscSetting($arr[$keys[2]]);
}
}
/**
* Build a Criteria object containing the values of all modified columns in this object.
*
* @return Criteria The Criteria object containing all modified values.
*/
public function buildCriteria()
{
$criteria = new Criteria(UserConfigPeer::DATABASE_NAME);
if ($this->isColumnModified(UserConfigPeer::USR_ID)) {
$criteria->add(UserConfigPeer::USR_ID, $this->usr_id);
}
if ($this->isColumnModified(UserConfigPeer::USC_NAME)) {
$criteria->add(UserConfigPeer::USC_NAME, $this->usc_name);
}
if ($this->isColumnModified(UserConfigPeer::USC_SETTING)) {
$criteria->add(UserConfigPeer::USC_SETTING, $this->usc_setting);
}
return $criteria;
}
/**
* Builds a Criteria object containing the primary key for this object.
*
* Unlike buildCriteria() this method includes the primary key values regardless
* of whether or not they have been modified.
*
* @return Criteria The Criteria object containing value(s) for primary key(s).
*/
public function buildPkeyCriteria()
{
$criteria = new Criteria(UserConfigPeer::DATABASE_NAME);
$criteria->add(UserConfigPeer::USR_ID, $this->usr_id);
$criteria->add(UserConfigPeer::USC_NAME, $this->usc_name);
return $criteria;
}
/**
* Returns the composite primary key for this object.
* The array elements will be in same order as specified in XML.
* @return array
*/
public function getPrimaryKey()
{
$pks = array();
$pks[0] = $this->getUsrId();
$pks[1] = $this->getUscName();
return $pks;
}
/**
* Set the [composite] primary key.
*
* @param array $keys The elements of the composite key (order must match the order in XML file).
* @return void
*/
public function setPrimaryKey($keys)
{
$this->setUsrId($keys[0]);
$this->setUscName($keys[1]);
}
/**
* Sets contents of passed object to values from current object.
*
* If desired, this method can also make copies of all associated (fkey referrers)
* objects.
*
* @param object $copyObj An object of UserConfig (or compatible) type.
* @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
* @throws PropelException
*/
public function copyInto($copyObj, $deepCopy = false)
{
$copyObj->setUscSetting($this->usc_setting);
$copyObj->setNew(true);
$copyObj->setUsrId(NULL); // this is a pkey column, so set to default value
$copyObj->setUscName(NULL); // this is a pkey column, so set to default value
}
/**
* Makes a copy of this object that will be inserted as a new row in table when saved.
* It creates a new object filling in the simple attributes, but skipping any primary
* keys that are defined for the table.
*
* If desired, this method can also make copies of all associated (fkey referrers)
* objects.
*
* @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
* @return UserConfig Clone of current object.
* @throws PropelException
*/
public function copy($deepCopy = false)
{
// we use get_class(), because this might be a subclass
$clazz = get_class($this);
$copyObj = new $clazz();
$this->copyInto($copyObj, $deepCopy);
return $copyObj;
}
/**
* Returns a peer instance associated with this om.
*
* Since Peer classes are not to have any instance attributes, this method returns the
* same instance for all member of this class. The method could therefore
* be static, but this would prevent one from overriding the behavior.
*
* @return UserConfigPeer
*/
public function getPeer()
{
if (self::$peer === null) {
self::$peer = new UserConfigPeer();
}
return self::$peer;
}
}

567
workflow/engine/classes/model/om/BaseUserConfigPeer.php Normal file
View File

@@ -0,0 +1,567 @@
<?php
require_once 'propel/util/BasePeer.php';
// The object class -- needed for instanceof checks in this class.
// actual class may be a subclass -- as returned by UserConfigPeer::getOMClass()
include_once 'classes/model/UserConfig.php';
/**
* Base static class for performing query and update operations on the 'USER_CONFIG' table.
*
*
*
* @package workflow.classes.model.om
*/
abstract class BaseUserConfigPeer
{
/** the default database name for this class */
const DATABASE_NAME = 'workflow';
/** the table name for this class */
const TABLE_NAME = 'USER_CONFIG';
/** A class that can be returned by this peer. */
const CLASS_DEFAULT = 'classes.model.UserConfig';
/** The total number of columns. */
const NUM_COLUMNS = 3;
/** The number of lazy-loaded columns. */
const NUM_LAZY_LOAD_COLUMNS = 0;
/** the column name for the USR_ID field */
const USR_ID = 'USER_CONFIG.USR_ID';
/** the column name for the USC_NAME field */
const USC_NAME = 'USER_CONFIG.USC_NAME';
/** the column name for the USC_SETTING field */
const USC_SETTING = 'USER_CONFIG.USC_SETTING';
/** The PHP to DB Name Mapping */
private static $phpNameMap = null;
/**
* holds an array of fieldnames
*
* first dimension keys are the type constants
* e.g. self::$fieldNames[self::TYPE_PHPNAME][0] = 'Id'
*/
private static $fieldNames = array (
BasePeer::TYPE_PHPNAME => array ('UsrId', 'UscName', 'UscSetting', ),
BasePeer::TYPE_COLNAME => array (UserConfigPeer::USR_ID, UserConfigPeer::USC_NAME, UserConfigPeer::USC_SETTING, ),
BasePeer::TYPE_FIELDNAME => array ('USR_ID', 'USC_NAME', 'USC_SETTING', ),
BasePeer::TYPE_NUM => array (0, 1, 2, )
);
/**
* holds an array of keys for quick access to the fieldnames array
*
* first dimension keys are the type constants
* e.g. self::$fieldNames[BasePeer::TYPE_PHPNAME]['Id'] = 0
*/
private static $fieldKeys = array (
BasePeer::TYPE_PHPNAME => array ('UsrId' => 0, 'UscName' => 1, 'UscSetting' => 2, ),
BasePeer::TYPE_COLNAME => array (UserConfigPeer::USR_ID => 0, UserConfigPeer::USC_NAME => 1, UserConfigPeer::USC_SETTING => 2, ),
BasePeer::TYPE_FIELDNAME => array ('USR_ID' => 0, 'USC_NAME' => 1, 'USC_SETTING' => 2, ),
BasePeer::TYPE_NUM => array (0, 1, 2, )
);
/**
* @return MapBuilder the map builder for this peer
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
*/
public static function getMapBuilder()
{
include_once 'classes/model/map/UserConfigMapBuilder.php';
return BasePeer::getMapBuilder('classes.model.map.UserConfigMapBuilder');
}
/**
* Gets a map (hash) of PHP names to DB column names.
*
* @return array The PHP to DB name map for this peer
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
* @deprecated Use the getFieldNames() and translateFieldName() methods instead of this.
*/
public static function getPhpNameMap()
{
if (self::$phpNameMap === null) {
$map = UserConfigPeer::getTableMap();
$columns = $map->getColumns();
$nameMap = array();
foreach ($columns as $column) {
$nameMap[$column->getPhpName()] = $column->getColumnName();
}
self::$phpNameMap = $nameMap;
}
return self::$phpNameMap;
}
/**
* Translates a fieldname to another type
*
* @param string $name field name
* @param string $fromType One of the class type constants TYPE_PHPNAME,
* TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
* @param string $toType One of the class type constants
* @return string translated name of the field.
*/
static public function translateFieldName($name, $fromType, $toType)
{
$toNames = self::getFieldNames($toType);
$key = isset(self::$fieldKeys[$fromType][$name]) ? self::$fieldKeys[$fromType][$name] : null;
if ($key === null) {
throw new PropelException("'$name' could not be found in the field names of type '$fromType'. These are: " . print_r(self::$fieldKeys[$fromType], true));
}
return $toNames[$key];
}
/**
* Returns an array of of field names.
*
* @param string $type The type of fieldnames to return:
* One of the class type constants TYPE_PHPNAME,
* TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
* @return array A list of field names
*/
static public function getFieldNames($type = BasePeer::TYPE_PHPNAME)
{
if (!array_key_exists($type, self::$fieldNames)) {
throw new PropelException('Method getFieldNames() expects the parameter $type to be one of the class constants TYPE_PHPNAME, TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM. ' . $type . ' was given.');
}
return self::$fieldNames[$type];
}
/**
* Convenience method which changes table.column to alias.column.
*
* Using this method you can maintain SQL abstraction while using column aliases.
* <code>
* $c->addAlias("alias1", TablePeer::TABLE_NAME);
* $c->addJoin(TablePeer::alias("alias1", TablePeer::PRIMARY_KEY_COLUMN), TablePeer::PRIMARY_KEY_COLUMN);
* </code>
* @param string $alias The alias for the current table.
* @param string $column The column name for current table. (i.e. UserConfigPeer::COLUMN_NAME).
* @return string
*/
public static function alias($alias, $column)
{
return str_replace(UserConfigPeer::TABLE_NAME.'.', $alias.'.', $column);
}
/**
* Add all the columns needed to create a new object.
*
* Note: any columns that were marked with lazyLoad="true" in the
* XML schema will not be added to the select list and only loaded
* on demand.
*
* @param criteria object containing the columns to add.
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
*/
public static function addSelectColumns(Criteria $criteria)
{
$criteria->addSelectColumn(UserConfigPeer::USR_ID);
$criteria->addSelectColumn(UserConfigPeer::USC_NAME);
$criteria->addSelectColumn(UserConfigPeer::USC_SETTING);
}
const COUNT = 'COUNT(USER_CONFIG.USR_ID)';
const COUNT_DISTINCT = 'COUNT(DISTINCT USER_CONFIG.USR_ID)';
/**
* Returns the number of rows matching criteria.
*
* @param Criteria $criteria
* @param boolean $distinct Whether to select only distinct columns (You can also set DISTINCT modifier in Criteria).
* @param Connection $con
* @return int Number of matching rows.
*/
public static function doCount(Criteria $criteria, $distinct = false, $con = null)
{
// we're going to modify criteria, so copy it first
$criteria = clone $criteria;
// clear out anything that might confuse the ORDER BY clause
$criteria->clearSelectColumns()->clearOrderByColumns();
if ($distinct || in_array(Criteria::DISTINCT, $criteria->getSelectModifiers())) {
$criteria->addSelectColumn(UserConfigPeer::COUNT_DISTINCT);
} else {
$criteria->addSelectColumn(UserConfigPeer::COUNT);
}
// just in case we're grouping: add those columns to the select statement
foreach ($criteria->getGroupByColumns() as $column) {
$criteria->addSelectColumn($column);
}
$rs = UserConfigPeer::doSelectRS($criteria, $con);
if ($rs->next()) {
return $rs->getInt(1);
} else {
// no rows returned; we infer that means 0 matches.
return 0;
}
}
/**
* Method to select one object from the DB.
*
* @param Criteria $criteria object used to create the SELECT statement.
* @param Connection $con
* @return UserConfig
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
*/
public static function doSelectOne(Criteria $criteria, $con = null)
{
$critcopy = clone $criteria;
$critcopy->setLimit(1);
$objects = UserConfigPeer::doSelect($critcopy, $con);
if ($objects) {
return $objects[0];
}
return null;
}
/**
* Method to do selects.
*
* @param Criteria $criteria The Criteria object used to build the SELECT statement.
* @param Connection $con
* @return array Array of selected Objects
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
*/
public static function doSelect(Criteria $criteria, $con = null)
{
return UserConfigPeer::populateObjects(UserConfigPeer::doSelectRS($criteria, $con));
}
/**
* Prepares the Criteria object and uses the parent doSelect()
* method to get a ResultSet.
*
* Use this method directly if you want to just get the resultset
* (instead of an array of objects).
*
* @param Criteria $criteria The Criteria object used to build the SELECT statement.
* @param Connection $con the connection to use
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
* @return ResultSet The resultset object with numerically-indexed fields.
* @see BasePeer::doSelect()
*/
public static function doSelectRS(Criteria $criteria, $con = null)
{
if ($con === null) {
$con = Propel::getConnection(self::DATABASE_NAME);
}
if (!$criteria->getSelectColumns()) {
$criteria = clone $criteria;
UserConfigPeer::addSelectColumns($criteria);
}
// Set the correct dbName
$criteria->setDbName(self::DATABASE_NAME);
// BasePeer returns a Creole ResultSet, set to return
// rows indexed numerically.
return BasePeer::doSelect($criteria, $con);
}
/**
* The returned array will contain objects of the default type or
* objects that inherit from the default.
*
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
*/
public static function populateObjects(ResultSet $rs)
{
$results = array();
// set the class once to avoid overhead in the loop
$cls = UserConfigPeer::getOMClass();
$cls = Propel::import($cls);
// populate the object(s)
while ($rs->next()) {
$obj = new $cls();
$obj->hydrate($rs);
$results[] = $obj;
}
return $results;
}
/**
* Returns the TableMap related to this peer.
* This method is not needed for general use but a specific application could have a need.
* @return TableMap
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
*/
public static function getTableMap()
{
return Propel::getDatabaseMap(self::DATABASE_NAME)->getTable(self::TABLE_NAME);
}
/**
* The class that the Peer will make instances of.
*
* This uses a dot-path notation which is tranalted into a path
* relative to a location on the PHP include_path.
* (e.g. path.to.MyClass -> 'path/to/MyClass.php')
*
* @return string path.to.ClassName
*/
public static function getOMClass()
{
return UserConfigPeer::CLASS_DEFAULT;
}
/**
* Method perform an INSERT on the database, given a UserConfig or Criteria object.
*
* @param mixed $values Criteria or UserConfig object containing data that is used to create the INSERT statement.
* @param Connection $con the connection to use
* @return mixed The new primary key.
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
*/
public static function doInsert($values, $con = null)
{
if ($con === null) {
$con = Propel::getConnection(self::DATABASE_NAME);
}
if ($values instanceof Criteria) {
$criteria = clone $values; // rename for clarity
} else {
$criteria = $values->buildCriteria(); // build Criteria from UserConfig object
}
// Set the correct dbName
$criteria->setDbName(self::DATABASE_NAME);
try {
// use transaction because $criteria could contain info
// for more than one table (I guess, conceivably)
$con->begin();
$pk = BasePeer::doInsert($criteria, $con);
$con->commit();
} catch (PropelException $e) {
$con->rollback();
throw $e;
}
return $pk;
}
/**
* Method perform an UPDATE on the database, given a UserConfig or Criteria object.
*
* @param mixed $values Criteria or UserConfig object containing data create the UPDATE statement.
* @param Connection $con The connection to use (specify Connection exert more control over transactions).
* @return int The number of affected rows (if supported by underlying database driver).
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
*/
public static function doUpdate($values, $con = null)
{
if ($con === null) {
$con = Propel::getConnection(self::DATABASE_NAME);
}
$selectCriteria = new Criteria(self::DATABASE_NAME);
if ($values instanceof Criteria) {
$criteria = clone $values; // rename for clarity
$comparison = $criteria->getComparison(UserConfigPeer::USR_ID);
$selectCriteria->add(UserConfigPeer::USR_ID, $criteria->remove(UserConfigPeer::USR_ID), $comparison);
$comparison = $criteria->getComparison(UserConfigPeer::USC_NAME);
$selectCriteria->add(UserConfigPeer::USC_NAME, $criteria->remove(UserConfigPeer::USC_NAME), $comparison);
} else {
$criteria = $values->buildCriteria(); // gets full criteria
$selectCriteria = $values->buildPkeyCriteria(); // gets criteria w/ primary key(s)
}
// set the correct dbName
$criteria->setDbName(self::DATABASE_NAME);
return BasePeer::doUpdate($selectCriteria, $criteria, $con);
}
/**
* Method to DELETE all rows from the USER_CONFIG table.
*
* @return int The number of affected rows (if supported by underlying database driver).
*/
public static function doDeleteAll($con = null)
{
if ($con === null) {
$con = Propel::getConnection(self::DATABASE_NAME);
}
$affectedRows = 0; // initialize var to track total num of affected rows
try {
// use transaction because $criteria could contain info
// for more than one table or we could emulating ON DELETE CASCADE, etc.
$con->begin();
$affectedRows += BasePeer::doDeleteAll(UserConfigPeer::TABLE_NAME, $con);
$con->commit();
return $affectedRows;
} catch (PropelException $e) {
$con->rollback();
throw $e;
}
}
/**
* Method perform a DELETE on the database, given a UserConfig or Criteria object OR a primary key value.
*
* @param mixed $values Criteria or UserConfig object or primary key or array of primary keys
* which is used to create the DELETE statement
* @param Connection $con the connection to use
* @return int The number of affected rows (if supported by underlying database driver).
* This includes CASCADE-related rows
* if supported by native driver or if emulated using Propel.
* @throws PropelException Any exceptions caught during processing will be
* rethrown wrapped into a PropelException.
*/
public static function doDelete($values, $con = null)
{
if ($con === null) {
$con = Propel::getConnection(UserConfigPeer::DATABASE_NAME);
}
if ($values instanceof Criteria) {
$criteria = clone $values; // rename for clarity
} elseif ($values instanceof UserConfig) {
$criteria = $values->buildPkeyCriteria();
} else {
// it must be the primary key
$criteria = new Criteria(self::DATABASE_NAME);
// primary key is composite; we therefore, expect
// the primary key passed to be an array of pkey
// values
if (count($values) == count($values, COUNT_RECURSIVE)) {
// array is not multi-dimensional
$values = array($values);
}
$vals = array();
foreach ($values as $value) {
$vals[0][] = $value[0];
$vals[1][] = $value[1];
}
$criteria->add(UserConfigPeer::USR_ID, $vals[0], Criteria::IN);
$criteria->add(UserConfigPeer::USC_NAME, $vals[1], Criteria::IN);
}
// Set the correct dbName
$criteria->setDbName(self::DATABASE_NAME);
$affectedRows = 0; // initialize var to track total num of affected rows
try {
// use transaction because $criteria could contain info
// for more than one table or we could emulating ON DELETE CASCADE, etc.
$con->begin();
$affectedRows += BasePeer::doDelete($criteria, $con);
$con->commit();
return $affectedRows;
} catch (PropelException $e) {
$con->rollback();
throw $e;
}
}
/**
* Validates all modified columns of given UserConfig object.
* If parameter $columns is either a single column name or an array of column names
* than only those columns are validated.
*
* NOTICE: This does not apply to primary or foreign keys for now.
*
* @param UserConfig $obj The object to validate.
* @param mixed $cols Column name or array of column names.
*
* @return mixed TRUE if all columns are valid or the error message of the first invalid column.
*/
public static function doValidate(UserConfig $obj, $cols = null)
{
$columns = array();
if ($cols) {
$dbMap = Propel::getDatabaseMap(UserConfigPeer::DATABASE_NAME);
$tableMap = $dbMap->getTable(UserConfigPeer::TABLE_NAME);
if (! is_array($cols)) {
$cols = array($cols);
}
foreach ($cols as $colName) {
if ($tableMap->containsColumn($colName)) {
$get = 'get' . $tableMap->getColumn($colName)->getPhpName();
$columns[$colName] = $obj->$get();
}
}
} else {
}
return BasePeer::doValidate(UserConfigPeer::DATABASE_NAME, UserConfigPeer::TABLE_NAME, $columns);
}
/**
* Retrieve object using using composite pkey values.
* @param string $usr_id
* @param string $usc_name
* @param Connection $con
* @return UserConfig
*/
public static function retrieveByPK($usr_id, $usc_name, $con = null)
{
if ($con === null) {
$con = Propel::getConnection(self::DATABASE_NAME);
}
$criteria = new Criteria();
$criteria->add(UserConfigPeer::USR_ID, $usr_id);
$criteria->add(UserConfigPeer::USC_NAME, $usc_name);
$v = UserConfigPeer::doSelect($criteria, $con);
return !empty($v) ? $v[0] : null;
}
}
// static code to register the map builder for this Peer with the main Propel class
if (Propel::isInit()) {
// the MapBuilder classes register themselves with Propel during initialization
// so we need to load them here.
try {
BaseUserConfigPeer::getMapBuilder();
} catch (Exception $e) {
Propel::log('Could not initialize Peer: ' . $e->getMessage(), Propel::LOG_ERR);
}
} else {
// even if Propel is not yet initialized, the map builder class can be registered
// now and then it will be loaded when Propel initializes.
require_once 'classes/model/map/UserConfigMapBuilder.php';
Propel::registerMapBuilder('classes.model.map.UserConfigMapBuilder');
}

9
workflow/engine/config/schema.xml
View File

@@ -6102,4 +6102,13 @@
<column name="UEA_OWNER" type="BIGINT" size="20" required="false"/> <column name="UEA_OWNER" type="BIGINT" size="20" required="false"/>
<column name="UEA_DATE_CREATE" type="TIMESTAMP" required="false"/> <column name="UEA_DATE_CREATE" type="TIMESTAMP" required="false"/>
</table> </table>
<table name="USER_CONFIG" idMethod="native">
<vendor type="mysql">
<parameter name="Engine" value="InnoDB"/>
<parameter name="Collation" value="utf8"/>
</vendor>
<column name="USR_ID" type="BIGINT" size="20" required="true" primaryKey="true"/>
<column name="USC_NAME" type="VARCHAR" size="255" required="true" primaryKey="true"/>
<column name="USC_SETTING" type="LONGVARCHAR" required="true"/>
</table>
</database> </database>

14
workflow/engine/data/mysql/schema.sql
View File

@@ -3388,5 +3388,19 @@ CREATE TABLE `USER_EXTENDED_ATTRIBUTES`
`UEA_DATE_CREATE` DATETIME, `UEA_DATE_CREATE` DATETIME,
PRIMARY KEY (`UEA_ID`) PRIMARY KEY (`UEA_ID`)
)ENGINE=InnoDB DEFAULT CHARSET='utf8'; )ENGINE=InnoDB DEFAULT CHARSET='utf8';
#-----------------------------------------------------------------------------
#-- USER_CONFIG
#-----------------------------------------------------------------------------
DROP TABLE IF EXISTS `USER_CONFIG`;
CREATE TABLE `USER_CONFIG`
(
`USR_ID` BIGINT(20) NOT NULL,
`USC_NAME` VARCHAR(255) NOT NULL,
`USC_SETTING` MEDIUMTEXT NOT NULL,
PRIMARY KEY (`USR_ID`,`USC_NAME`)
)ENGINE=InnoDB DEFAULT CHARSET='utf8';
# This restores the fkey checks, after having unset them earlier # This restores the fkey checks, after having unset them earlier
SET FOREIGN_KEY_CHECKS = 1; SET FOREIGN_KEY_CHECKS = 1;

96
workflow/engine/src/ProcessMaker/Model/UserConfig.php Normal file
View File

@@ -0,0 +1,96 @@
<?php
namespace ProcessMaker\Model;
use Illuminate\Database\Eloquent\Model;
use stdClass;
class UserConfig extends Model
{
/**
* Bind table.
* @var string
*/
protected $table = 'USER_CONFIG';
/**
* Column timestamps.
* @var boolean
*/
public $timestamps = false;
/**
* Get user setting.
* @param int $id
* @param string $name
* @return mix array|null
*/
public static function getSetting(int $id, string $name)
{
$userConfig = UserConfig::where('USR_ID', '=', $id)
->where('USC_NAME', '=', $name)
->get()
->first();
if (empty($userConfig)) {
return null;
}
return [
"id" => $userConfig->USR_ID,
"name" => $userConfig->USC_NAME,
"setting" => json_decode($userConfig->USC_SETTING)
];
}
/**
* Add user setting.
* @param int $id
* @param string $name
* @param string $setting
* @return mix array|null
*/
public static function addSetting(int $id, string $name, string $setting)
{
$userConfig = UserConfig::getSetting($id, $name);
if (empty($userConfig)) {
$model = new UserConfig();
$model->USR_ID = $id;
$model->USC_NAME = $name;
$model->USC_SETTING = $setting;
$model->save();
$userConfig = UserConfig::getSetting($id, $name);
}
return $userConfig;
}
/**
* Edit user setting.
* @param int $id
* @param string $name
* @param string $setting
* @return mix array|null
*/
public static function editSetting(int $id, string $name, string $setting)
{
UserConfig::where('USR_ID', '=', $id)
->where('USC_NAME', '=', $name)
->update(["USC_SETTING" => $setting]);
return UserConfig::getSetting($id, $name);
}
/**
* Delete user setting.
* @param int $id
* @param string $name
* @return mix array|null
*/
public static function deleteSetting(int $id, string $name)
{
$userConfig = UserConfig::getSetting($id, $name);
UserConfig::where('USR_ID', '=', $id)
->where('USC_NAME', '=', $name)
->delete();
return $userConfig;
}
}

63
workflow/engine/src/ProcessMaker/Services/Api/Home.php
View File

@@ -17,6 +17,7 @@ use ProcessMaker\BusinessModel\Cases\Unassigned;
use ProcessMaker\Model\Delegation; use ProcessMaker\Model\Delegation;
use ProcessMaker\Model\Process; use ProcessMaker\Model\Process;
use ProcessMaker\Model\User; use ProcessMaker\Model\User;
use ProcessMaker\Model\UserConfig;
use ProcessMaker\Model\Task; use ProcessMaker\Model\Task;
use ProcessMaker\Services\Api; use ProcessMaker\Services\Api;
use ProcessMaker\Util\DateTime; use ProcessMaker\Util\DateTime;
@@ -732,4 +733,66 @@ class Home extends Api
throw new RestException(404, "Process with Uid '{$processUid}'."); throw new RestException(404, "Process with Uid '{$processUid}'.");
} }
} }
/**
* Get user setting.
* @params int $id
* @params string $name
* @url GET /config
* @return array
* @throws Exception
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doGetConfig(int $id, string $name)
{
return UserConfig::getSetting($id, $name);
}
/**
* Add user setting.
* @params int $id
* @params string $name
* @params string $setting
* @url POST /config
* @return array
* @throws Exception
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doPostConfig(int $id, string $name, string $setting)
{
return UserConfig::addSetting($id, $name, $setting);
}
/**
* Update user setting.
* @params int $id
* @params string $name
* @params string $setting
* @url PUT /config
* @return array
* @throws Exception
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doPutConfig(int $id, string $name, string $setting)
{
return UserConfig::editSetting($id, $name, $setting);
}
/**
* Delete user setting.
* @params int $id
* @params string $name
* @url DELETE /config
* @return array
* @throws Exception
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doDeleteConfig(int $id, string $name)
{
return UserConfig::deleteSetting($id, $name);
}
} }