Files
luos/workflow/engine/src/ProcessMaker/Services/Api/User.php

144 lines
4.1 KiB
PHP
Raw Normal View History

<?php
namespace ProcessMaker\Services\Api;
use \ProcessMaker\Services\Api;
use \Luracast\Restler\RestException;
/**
* User Api Controller
*
* @protected
*/
class User extends Api
{
private $arrayFieldIso8601 = [
'usr_create_date',
'usr_update_date'
];
/**
2016-07-20 10:56:24 -04:00
* @access protected
* @class AccessControl {@permission PM_USERS,PM_FACTORY}
* @url GET
*/
2017-04-21 15:03:02 -04:00
public function index($filter = null, $lfilter = null, $rfilter = null, $start = null, $limit = null, $status = null)
{
try {
$user = new \ProcessMaker\BusinessModel\User();
PM-3659 "Uso de interface lenta (assignment rules) cuando..." SOLVED Issue: Uso de interface lenta (assignment rules) cuando se tienen varios usuarios (40000) Cause: No se realizo de manera correcta el paginado de registros Solution: > Se a implementado los siguientes end-points: GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/available-assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/adhoc-assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/adhoc-available-assignee/paged Estos end-points aceptan los siguientes parametros: /paged?filter={filter}&start={start}&limit={limit}&type={type} /paged?lfilter={lfilter}&start={start}&limit={limit}&type={type} /paged?rfilter={rfilter}&start={start}&limit={limit}&type={type} Donde: filter: Representa la busqueda de registros que contienen este valor lfilter: Representa la busqueda de registros que empiezan con este valor rfilter: Representa la busqueda de registros que terminan con este valor type: Acepta los siguentes valores: "user", "group" Ejemplo: GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/assignee/paged?start=0&limit=3 <<<<< 200 { "total": 15, "start": 0, "limit": 3, "filter": "", "data": [ { "aas_uid": "60593768854492f8fa43aa2064326562", "aas_name": "GROUP1 (2 Users)", "aas_lastname": "", "aas_username": "", "aas_type": "group" }, { "aas_uid": "11886228656016c9329c898096916123", "aas_name": "GROUP2 (1 User)", "aas_lastname": "", "aas_username": "", "aas_type": "group" }, { "aas_uid": "52242914255f202805bd552031573543", "aas_name": "user1", "aas_lastname": "user1", "aas_username": "user1", "aas_type": "user" } ] } > Se a mejorado los siguientes end-points: GET /api/1.0/{workspace}/users?filter={filter}&start={start}&limit={limit} GET /api/1.0/{workspace}/users?lfilter={lfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/users?rfilter={rfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?filter={filter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?lfilter={lfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?rfilter={rfilter}&start={start}&limit={limit}
2015-09-25 15:11:42 -04:00
$user->setFormatFieldNameInUppercase(false);
$arrayFilterData = array(
"filter" => (!is_null($filter))? $filter : ((!is_null($lfilter))? $lfilter : ((!is_null($rfilter))? $rfilter : null)),
"filterOption" => (!is_null($filter))? "" : ((!is_null($lfilter))? "LEFT" : ((!is_null($rfilter))? "RIGHT" : ""))
);
2017-04-21 15:03:02 -04:00
$response = $user->getUsers($arrayFilterData, null, null, $start, $limit, false, true, $status);
PM-3659 "Uso de interface lenta (assignment rules) cuando..." SOLVED Issue: Uso de interface lenta (assignment rules) cuando se tienen varios usuarios (40000) Cause: No se realizo de manera correcta el paginado de registros Solution: > Se a implementado los siguientes end-points: GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/available-assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/adhoc-assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/adhoc-available-assignee/paged Estos end-points aceptan los siguientes parametros: /paged?filter={filter}&start={start}&limit={limit}&type={type} /paged?lfilter={lfilter}&start={start}&limit={limit}&type={type} /paged?rfilter={rfilter}&start={start}&limit={limit}&type={type} Donde: filter: Representa la busqueda de registros que contienen este valor lfilter: Representa la busqueda de registros que empiezan con este valor rfilter: Representa la busqueda de registros que terminan con este valor type: Acepta los siguentes valores: "user", "group" Ejemplo: GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/assignee/paged?start=0&limit=3 <<<<< 200 { "total": 15, "start": 0, "limit": 3, "filter": "", "data": [ { "aas_uid": "60593768854492f8fa43aa2064326562", "aas_name": "GROUP1 (2 Users)", "aas_lastname": "", "aas_username": "", "aas_type": "group" }, { "aas_uid": "11886228656016c9329c898096916123", "aas_name": "GROUP2 (1 User)", "aas_lastname": "", "aas_username": "", "aas_type": "group" }, { "aas_uid": "52242914255f202805bd552031573543", "aas_name": "user1", "aas_lastname": "user1", "aas_username": "user1", "aas_type": "user" } ] } > Se a mejorado los siguientes end-points: GET /api/1.0/{workspace}/users?filter={filter}&start={start}&limit={limit} GET /api/1.0/{workspace}/users?lfilter={lfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/users?rfilter={rfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?filter={filter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?lfilter={lfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?rfilter={rfilter}&start={start}&limit={limit}
2015-09-25 15:11:42 -04:00
return \ProcessMaker\Util\DateTime::convertUtcToIso8601($response['data'], $this->arrayFieldIso8601);
} catch (\Exception $e) {
PM-3659 "Uso de interface lenta (assignment rules) cuando..." SOLVED Issue: Uso de interface lenta (assignment rules) cuando se tienen varios usuarios (40000) Cause: No se realizo de manera correcta el paginado de registros Solution: > Se a implementado los siguientes end-points: GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/available-assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/adhoc-assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/adhoc-available-assignee/paged Estos end-points aceptan los siguientes parametros: /paged?filter={filter}&start={start}&limit={limit}&type={type} /paged?lfilter={lfilter}&start={start}&limit={limit}&type={type} /paged?rfilter={rfilter}&start={start}&limit={limit}&type={type} Donde: filter: Representa la busqueda de registros que contienen este valor lfilter: Representa la busqueda de registros que empiezan con este valor rfilter: Representa la busqueda de registros que terminan con este valor type: Acepta los siguentes valores: "user", "group" Ejemplo: GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/assignee/paged?start=0&limit=3 <<<<< 200 { "total": 15, "start": 0, "limit": 3, "filter": "", "data": [ { "aas_uid": "60593768854492f8fa43aa2064326562", "aas_name": "GROUP1 (2 Users)", "aas_lastname": "", "aas_username": "", "aas_type": "group" }, { "aas_uid": "11886228656016c9329c898096916123", "aas_name": "GROUP2 (1 User)", "aas_lastname": "", "aas_username": "", "aas_type": "group" }, { "aas_uid": "52242914255f202805bd552031573543", "aas_name": "user1", "aas_lastname": "user1", "aas_username": "user1", "aas_type": "user" } ] } > Se a mejorado los siguientes end-points: GET /api/1.0/{workspace}/users?filter={filter}&start={start}&limit={limit} GET /api/1.0/{workspace}/users?lfilter={lfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/users?rfilter={rfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?filter={filter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?lfilter={lfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?rfilter={rfilter}&start={start}&limit={limit}
2015-09-25 15:11:42 -04:00
throw new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage());
}
}
/**
2016-07-20 10:56:24 -04:00
* @access protected
* @class AccessControl {@permission PM_USERS,PM_FACTORY}
* @url GET /:usr_uid
*
* @param string $usr_uid {@min 32}{@max 32}
*/
public function doGetUser($usr_uid)
{
try {
$user = new \ProcessMaker\BusinessModel\User();
PM-3659 "Uso de interface lenta (assignment rules) cuando..." SOLVED Issue: Uso de interface lenta (assignment rules) cuando se tienen varios usuarios (40000) Cause: No se realizo de manera correcta el paginado de registros Solution: > Se a implementado los siguientes end-points: GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/available-assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/adhoc-assignee/paged GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/adhoc-available-assignee/paged Estos end-points aceptan los siguientes parametros: /paged?filter={filter}&start={start}&limit={limit}&type={type} /paged?lfilter={lfilter}&start={start}&limit={limit}&type={type} /paged?rfilter={rfilter}&start={start}&limit={limit}&type={type} Donde: filter: Representa la busqueda de registros que contienen este valor lfilter: Representa la busqueda de registros que empiezan con este valor rfilter: Representa la busqueda de registros que terminan con este valor type: Acepta los siguentes valores: "user", "group" Ejemplo: GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/assignee/paged?start=0&limit=3 <<<<< 200 { "total": 15, "start": 0, "limit": 3, "filter": "", "data": [ { "aas_uid": "60593768854492f8fa43aa2064326562", "aas_name": "GROUP1 (2 Users)", "aas_lastname": "", "aas_username": "", "aas_type": "group" }, { "aas_uid": "11886228656016c9329c898096916123", "aas_name": "GROUP2 (1 User)", "aas_lastname": "", "aas_username": "", "aas_type": "group" }, { "aas_uid": "52242914255f202805bd552031573543", "aas_name": "user1", "aas_lastname": "user1", "aas_username": "user1", "aas_type": "user" } ] } > Se a mejorado los siguientes end-points: GET /api/1.0/{workspace}/users?filter={filter}&start={start}&limit={limit} GET /api/1.0/{workspace}/users?lfilter={lfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/users?rfilter={rfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?filter={filter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?lfilter={lfilter}&start={start}&limit={limit} GET /api/1.0/{workspace}/groups?rfilter={rfilter}&start={start}&limit={limit}
2015-09-25 15:11:42 -04:00
$user->setFormatFieldNameInUppercase(false);
$response = $user->getUser($usr_uid);
return \ProcessMaker\Util\DateTime::convertUtcToIso8601($response, $this->arrayFieldIso8601);
} catch (\Exception $e) {
throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage()));
}
}
/**
2016-07-20 10:56:24 -04:00
* @access protected
* @class AccessControl {@permission PM_USERS}
* @url POST
*
* @param array $request_data
*
* @status 201
*/
public function doPostUser($request_data)
{
try {
$user = new \ProcessMaker\BusinessModel\User();
$arrayData = $user->create($request_data);
$response = $arrayData;
return $response;
} catch (\Exception $e) {
throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage()));
}
}
/**
* Update a user.
*
* @url PUT /:usr_uid
2017-10-13 10:59:18 -04:00
*
* @param string $usr_uid {@min 32}{@max 32}
* @param array $request_data
2017-10-13 10:59:18 -04:00
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_USERS}
*/
public function doPutUser($usr_uid, $request_data)
{
try {
$userLoggedUid = $this->getUserId();
$user = new \ProcessMaker\BusinessModel\User();
$arrayData = $user->update($usr_uid, $request_data, $userLoggedUid);
} catch (\Exception $e) {
throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage()));
}
}
/**
2016-07-20 10:56:24 -04:00
* @access protected
* @class AccessControl {@permission PM_USERS}
* @url DELETE /:usr_uid
*
* @param string $usr_uid {@min 32}{@max 32}
*/
public function doDeleteUser($usr_uid)
{
try {
$user = new \ProcessMaker\BusinessModel\User();
$user->delete($usr_uid);
} catch (\Exception $e) {
throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage()));
}
}
/**
* @param string $usr_uid {@min 32} {@max 32}
*
2016-07-20 10:56:24 -04:00
* @access protected
* @class AccessControl {@permission PM_USERS}
* @url POST /:usr_uid/image-upload
*/
public function doPostUserImageUpload($usr_uid)
{
try {
$user = new \ProcessMaker\BusinessModel\User();
$user->uploadImage($usr_uid);
} catch (\Exception $e) {
//response
throw new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage());
}
}
}