From d828c081eb1ac9342ae1e3c75956f3b73b02f10f Mon Sep 17 00:00:00 2001 From: davidcallizaya Date: Wed, 11 Oct 2017 11:19:53 -0400 Subject: [PATCH 1/4] HOR-3967 Complete access control for PUT endpoints. --- .../Services/Api/ActionsByEmail.php | 4 ++ .../ProcessMaker/Services/Api/Calendar.php | 1 - .../src/ProcessMaker/Services/Api/Cases.php | 41 ++++++++----------- .../Services/Api/Cases/Variable.php | 3 +- .../src/ProcessMaker/Services/Api/Catalog.php | 6 +-- .../Services/Api/Consolidated.php | 6 +-- .../ProcessMaker/Services/Api/Dashboard.php | 15 +++---- .../ProcessMaker/Services/Api/Department.php | 9 ++-- .../ProcessMaker/Services/Api/EmailServer.php | 4 +- .../src/ProcessMaker/Services/Api/Group.php | 3 +- .../src/ProcessMaker/Services/Api/Light.php | 7 +++- .../Services/Api/Light/NotificationDevice.php | 4 +- .../src/ProcessMaker/Services/Api/Pmtable.php | 9 +--- .../src/ProcessMaker/Services/Api/Process.php | 10 +++++ .../Services/Api/ProcessCategory.php | 8 ++-- .../Services/Api/Project/Activity.php | 15 ++++--- .../Services/Api/Project/Activity/Step.php | 2 + .../Api/Project/Activity/Step/Trigger.php | 4 ++ .../Services/Api/Project/CaseScheduler.php | 4 +- .../Services/Api/Project/CaseTracker.php | 3 +- .../Api/Project/CaseTrackerObject.php | 3 +- .../Api/Project/DataBaseConnection.php | 9 ++-- .../Services/Api/Project/DynaForm.php | 5 ++- .../Services/Api/Project/EmailEvent.php | 3 +- .../Services/Api/Project/Event.php | 8 +--- .../Services/Api/Project/FilesManager.php | 3 +- .../Services/Api/Project/InputDocument.php | 3 +- .../Api/Project/MessageEventDefinition.php | 3 +- .../Services/Api/Project/MessageType.php | 3 +- .../Api/Project/MessageType/Variable.php | 3 +- .../Services/Api/Project/OutputDocuments.php | 3 +- .../Api/Project/ProcessPermissions.php | 8 +--- .../Api/Project/ProcessSupervisors.php | 7 ++-- .../Services/Api/Project/ReportTable.php | 7 +--- .../Services/Api/Project/ScriptTask.php | 3 +- .../Services/Api/Project/SubProcess.php | 7 +--- .../Services/Api/Project/TimerEvent.php | 3 +- .../Services/Api/Project/Trigger.php | 6 +-- .../Services/Api/Project/TriggerWizard.php | 3 +- .../Services/Api/Project/Variable.php | 3 +- .../Services/Api/Project/WebEntry.php | 2 + .../Services/Api/Project/WebEntryEvent.php | 2 +- .../src/ProcessMaker/Services/Api/Role.php | 5 ++- .../src/ProcessMaker/Services/Api/User.php | 3 +- 44 files changed, 137 insertions(+), 126 deletions(-) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php b/workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php index 13db20a7d..5a5d97bff 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php @@ -65,6 +65,8 @@ class ActionsByEmail extends Api /** * * @url PUT /updateTemplate + * @class AccessControl {@permission PM_SETUP_EMAIL} + * @access protected */ public function updateTemplate($params) { @@ -83,6 +85,8 @@ class ActionsByEmail extends Api /** * * @url PUT /saveConfiguration + * @class AccessControl {@permission PM_SETUP_EMAIL} + * @access protected */ public function saveConfiguration($params) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Calendar.php b/workflow/engine/src/ProcessMaker/Services/Api/Calendar.php index e12490240..53dadcd0e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Calendar.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Calendar.php @@ -84,7 +84,6 @@ class Calendar extends Api * @access protected * @class AccessControl {@permission PM_SETUP_CALENDAR} * @url PUT /:cal_uid - * * @param string $cal_uid {@min 32}{@max 32} * @param array $request_data */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php index 47818ac73..594b2f680 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php @@ -802,6 +802,8 @@ class Cases extends Api * @param string $usr_uid_source {@from body} {@min 32}{@max 32} * @param string $usr_uid_target {@from body} {@min 32}{@max 32} * @param string $del_index {@from body} + * @class AccessControl {@permission PM_REASSIGNCASE,PM_REASSIGNCASE_SUPERVISOR} + * @access protected */ public function doPutReassignCase($app_uid, $usr_uid_source, $usr_uid_target, $del_index = null) { @@ -816,10 +818,12 @@ class Cases extends Api /** * Route Case - * @url PUT /:app_uid/route-case * + * @url PUT /:app_uid/route-case * @param string $app_uid {@min 32}{@max 32} * @param string $del_index {@from body} + * @class AccessControl {@permission PM_CASES} + * @access protected */ public function doPutRouteCase($app_uid, $del_index = null) { @@ -836,10 +840,8 @@ class Cases extends Api * Cancel Case * * @param string $cas_uid {@min 1}{@max 32} - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * + * @class AccessControl {@permission PM_CANCELCASE} + * @access protected * @url PUT /:cas_uid/cancel */ public function doPutCancelCase($cas_uid) @@ -858,10 +860,8 @@ class Cases extends Api * * @param string $cas_uid {@min 1}{@max 32} * @param string $unpaused_date {@from body} - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * + * @class AccessControl {@permission PM_CASES} + * @access protected * @url PUT /:cas_uid/pause */ public function doPutPauseCase($cas_uid, $unpaused_date = null) @@ -883,10 +883,8 @@ class Cases extends Api * Unpause Case * * @param string $cas_uid {@min 1}{@max 32} - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * + * @class AccessControl {@permission PM_CASES} + * @access protected * @url PUT /:cas_uid/unpause */ public function doPutUnpauseCase($cas_uid) @@ -905,10 +903,8 @@ class Cases extends Api * * @param string $cas_uid {@min 1}{@max 32} * @param string $tri_uid {@min 1}{@max 32} - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * + * @class AccessControl {@permission PM_CASES} + * @access protected * @url PUT /:cas_uid/execute-trigger/:tri_uid */ public function doPutExecuteTriggerCase($cas_uid, $tri_uid) @@ -977,10 +973,8 @@ class Cases extends Api * @param array $request_data * @param string $dyn_uid {@from path} * @param int $del_index {@from path} - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * + * @class AccessControl {@permission PM_CASES} + * @access protected * @url PUT /:app_uid/variable */ public function doPutCaseVariables($app_uid, $request_data, $dyn_uid = '', $del_index = 0) @@ -1144,9 +1138,8 @@ class Cases extends Api * @param int $del_index {@from body} * @param string $obj_type {@from body} * @param string $obj_uid {@from body} - * - * @copyright Colosa - Bolivia - * + * @class AccessControl {@permission PM_CASES} + * @access protected * @url PUT /:app_uid/execute-triggers */ public function doPutExecuteTriggers($app_uid, $del_index, $obj_type, $obj_uid) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php index 61620f006..b32622d88 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php @@ -105,7 +105,8 @@ class Variable extends Api * @param int $del_index {@min 1} * @param string $var_name * @param array $request_data - * + * @class AccessControl {@permission PM_CASES} + * @access protected * @status 204 */ public function doPutVariable($app_uid, $del_index, $var_name, array $request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php index 1e9fd1bcd..3db7504e6 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php @@ -63,13 +63,11 @@ class Catalog extends Api /** * @url PUT /:cat_uid/:cat_type - * * @param string $cat_uid {@min 32}{@max 32} * @param string $cat_type {@min 32}{@max 32} * @param array $request_data - * - * @author Marco Antonio Nina - * @copyright Colosa - Bolivia + * @class AccessControl {@permission PM_DASHBOARD} + * @access protected */ public function doPut($cat_uid, $cat_type, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php index 78ba6ccc6..3b7693b0a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php @@ -113,10 +113,8 @@ class Consolidated extends Api * @param string $pro_uid {@min 1} {@max 32} * @param array $request_data * @return array - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * + * @class AccessControl {@permission PM_CASES} + * @access protected * @url PUT /cases/:tas_uid/:dyn_uid/:pro_uid */ public function doPutCasesConsolidated($tas_uid, $dyn_uid, $pro_uid, $request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php index f10132042..db70262ab 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php @@ -243,10 +243,9 @@ class Dashboard extends Api * Put dashboards configuration * * @param array $request_data - * - * * @url PUT - * + * @class AccessControl {@permission PM_DASHBOARD} + * @access protected */ public function doPutDashboard($request_data) { @@ -340,9 +339,8 @@ class Dashboard extends Api * Put Indicator * * @param array $request_data - * - * @url PUT /indicator - * + * @class AccessControl {@permission PM_DASHBOARD} + * @access protected */ public function doPutIndicator($request_data) { @@ -417,9 +415,8 @@ class Dashboard extends Api * Put dashboards configuration by usr_uid * * @param array $request_data - * - * @url PUT /config - * + * @class AccessControl {@permission PM_DASHBOARD} + * @access protected */ public function doPutDashboardConfigByUsrUid($request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Department.php b/workflow/engine/src/ProcessMaker/Services/Api/Department.php index 967d91484..19d24be83 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Department.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Department.php @@ -142,12 +142,11 @@ class Department extends Api /** * @url PUT /:dep_uid/set-manager/:usr_uid - * + * @class AccessControl {@permission PM_USERS} + * @access protected * @param string $dep_uid {@min 1}{@max 32} * @param string $usr_uid {@min 1}{@max 32} - * * @return array - * */ public function doPutSetManager($dep_uid, $usr_uid) { @@ -203,10 +202,10 @@ class Department extends Api /** * @url PUT /:dep_uid - * * @param string $dep_uid {@min 1}{@max 32} * @param array $request_data - * + * @class AccessControl {@permission PM_USERS} + * @access protected */ public function doPut($dep_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php index 3e401eb1c..a42517a5e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php @@ -124,10 +124,10 @@ class EmailServer extends Api /** * @url PUT /:mess_uid - * * @param string $mess_uid {@min 32}{@max 32} * @param array $request_data - * + * @class AccessControl {@permission PM_SETUP_EMAIL} + * @access protected * @status 200 */ public function doPut($mess_uid, array $request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group.php b/workflow/engine/src/ProcessMaker/Services/Api/Group.php index 2b73e904a..de94e7334 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group.php @@ -97,7 +97,8 @@ class Group extends Api /** * @url PUT /:grp_uid - * + * @class AccessControl {@permission PM_USERS} + * @access protected * @param string $grp_uid {@min 32}{@max 32} * @param array $request_data */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light.php b/workflow/engine/src/ProcessMaker/Services/Api/Light.php index d5d849b73..61f199a7d 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light.php @@ -1175,8 +1175,10 @@ class Light extends Api /** * Route Case - * @url PUT /cases/:app_uid/route-case * + * @url PUT /cases/:app_uid/route-case + * @class AccessControl {@permission PM_CASES} + * @access protected * @param string $app_uid {@min 32}{@max 32} * @param int $del_index {@from body} * @param array $tasks {@from body} @@ -1720,7 +1722,8 @@ class Light extends Api * @param array $request_data * @param string $dyn_uid {@from path} * @param int $del_index {@from path} - * + * @class AccessControl {@permission PM_CASES} + * @access protected * @url PUT /:app_uid/variable */ public function doPutCaseVariables($app_uid, $request_data, $dyn_uid = '', $del_index = 0) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php b/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php index 8f8b8981a..d861d34f9 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php @@ -40,11 +40,9 @@ class NotificationDevice extends Api * * @param string $dev_uid {@min 32}{@max 32} * @param array $request_data - * - * @author Ronald Quenta * @return array - * * @url PUT /notification/:dev_uid + * @throws RestException */ public function updateDeviceLanguage($dev_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php b/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php index d2c5d1933..bd1d8c5a1 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php @@ -146,7 +146,7 @@ class Pmtable extends Api * @copyright Colosa - Bolivia * * @access protected - * @class AccessControl {@permission PM_SETUP_PM_TABLES} + * @class AccessControl {@permission PM_SETUP_PM_TABLES} * @url PUT /:pmt_uid */ public function doPutPmTable( @@ -164,15 +164,10 @@ class Pmtable extends Api /** * @param string $pmt_uid {@min 1} {@max 32} - * * @param array $request_data * @return array - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * * @access protected - * @class AccessControl {@permission PM_SETUP_PM_TABLES} + * @class AccessControl {@permission PM_SETUP_PM_TABLES} * @url PUT /:pmt_uid/data */ public function doPutPmTableData( diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Process.php b/workflow/engine/src/ProcessMaker/Services/Api/Process.php index d8070507d..2296bda19 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Process.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Process.php @@ -78,6 +78,16 @@ class Process extends Api } } + /** + * Update a process by UID. + * + * @param type $processUid + * @param type $request_data + * @return type + * @throws RestException + * @class AccessControl {@permission PM_FACTORY} + * @access protected + */ public function put($processUid, $request_data = null) { $response = array(); diff --git a/workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php b/workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php index d83b2f91e..4dcbe8a73 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php @@ -90,13 +90,13 @@ class ProcessCategory extends Api } /** - * - * @access protected - * @class AccessControl {@permission PM_SETUP_PROCESS_CATEGORIES} - * @url PUT /category/:cat_uid * + * @access protected + * @class AccessControl {@permission PM_FACTORY,PM_SETUP_PROCESS_CATEGORIES} + * @url PUT /category/:cat_uid * @param string $cat_uid {@min 32}{@max 32} * @param array $request_data + * @throws RestException */ public function doPutCategory($cat_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php index d95f3f47b..21c8320ee 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php @@ -101,17 +101,17 @@ class Activity extends Api } } - /** + * Update an activity. + * * @param string $prj_uid {@min 32} {@max 32} * @param string $act_uid {@min 32} {@max 32} * @param ActivityPropertiesStructure $properties {@from body} - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @return array - * * @url PUT /:prj_uid/activity/:act_uid + * @throws RestException */ public function doPutProjectActivity($prj_uid, $act_uid, ActivityPropertiesStructure $properties, $request_data = array()) { @@ -217,9 +217,12 @@ class Activity extends Api } /** - * @url PUT /:prj_uid/activity/validate-active-cases + * Get activity validate self service. * + * @url PUT /:prj_uid/activity/validate-active-cases * @param string $prj_uid {@min 32}{@max 32} + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doGetActivityValidateSelfService($prj_uid, $request_data = array()) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php index 69ef59c9b..2d05de43b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php @@ -84,6 +84,8 @@ class Step extends Api * @param string $step_condition {@from body} * @param int $step_position {@from body}{@min 1} * @param string $step_mode {@from body}{@choice EDIT,VIEW} + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutActivityStep( $step_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step/Trigger.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step/Trigger.php index 90a193a01..63f6347ec 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step/Trigger.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step/Trigger.php @@ -64,6 +64,8 @@ class Trigger extends Api * @param string $act_uid * @param string $prj_uid * @param StepTriggerPutStructure $request_data + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutActivityStepTrigger($tri_uid, $step_uid, $act_uid, $prj_uid, StepTriggerPutStructure $request_data = null) { @@ -150,6 +152,8 @@ class Trigger extends Api * @param string $act_uid * @param string $prj_uid * @param StepAssignTaskTriggerPutStructure $request_data + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutActivityStepAssignTaskTrigger($tri_uid, $act_uid, $prj_uid, StepAssignTaskTriggerPutStructure $request_data = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php index fb766c4a5..f8050fa23 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php @@ -76,11 +76,11 @@ class CaseScheduler extends Api /** * @url PUT /:prjUid/case-scheduler/:schUid - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $prjUid {@min 32} {@max 32} * @param string $schUid {@min 32} {@max 32} * @param CaseSchedulerStructure $request_data - * */ public function doPutProjectCaseScheduler($prjUid, $schUid, CaseSchedulerStructure $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php index 31fc0d7d6..804ccbe82 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php @@ -31,7 +31,8 @@ class CaseTracker extends Api /** * @url PUT /:prj_uid/case-tracker/property - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * @param string $map_type {@from body}{@choice NONE,PROCESSMAP,STAGES} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php index 434bd6e3e..9f6cf1c1c 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php @@ -65,7 +65,8 @@ class CaseTrackerObject extends Api /** * @url PUT /:prj_uid/case-tracker/object/:cto_uid - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $cto_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php index 27d57ae9b..7337d6188 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php @@ -133,10 +133,11 @@ class DataBaseConnection extends Api } /** + * Update database connection. + * * @param string $prj_uid {@min 1} {@max 32} * @param string $dbs_uid {@min 1} {@max 32} * @param array $request_data - * * @param string $dbs_type {@from body} {@required true} * @param string $dbs_server {@from body} {@required true} * @param string $dbs_database_name {@from body} {@required true} @@ -145,11 +146,9 @@ class DataBaseConnection extends Api * @param string $dbs_password {@from body} * @param string $dbs_description {@from body} * @return void - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * * @url PUT /:prj_uid/database-connection/:dbs_uid + * @class AccessControl {@permission PM_SETUP} + * @access protected */ public function doPutDataBaseConnection( $prj_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php index cd9dff8d6..dc59a24aa 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php @@ -63,8 +63,11 @@ class DynaForm extends Api } /** - * @url PUT /:prj_uid/dynaform/:dyn_uid + * Update dynaform. * + * @url PUT /:prj_uid/dynaform/:dyn_uid + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php index 712bf2834..c10ee5235 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php @@ -80,7 +80,8 @@ class EmailEvent extends Api /** * @url PUT /:prj_uid/email-event/:email_event_uid - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $prj_uid {@min 32}{@max 32} * @param string $email_event_uid {@min 32}{@max 32} * @param array $request_data diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php index d1e5efbfe..ef99e25d8 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php @@ -155,13 +155,9 @@ class Event extends Api * @param string $evn_tas_uid_from {@from body} * @param string $evn_tas_uid_to {@from body} * @param string $evn_conditions {@from body} - * - * @access public - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @return void - * * @url PUT /:prj_uid/event/:evn_uid */ public function doPutEvent ( diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php index 2a31bea36..41f870f12 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php @@ -83,7 +83,8 @@ class FilesManager extends Api * @param string $prj_uid {@min 32} {@max 32} * @param ProcessFilesManagerStructure $request_data * @param string $prf_uid {@min 32} {@max 32} - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @url PUT /:prj_uid/file-manager/:prf_uid */ public function doPutProcessFilesManager($prj_uid, ProcessFilesManagerStructure $request_data, $prf_uid) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php index 1ed147b51..93db3a995 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php @@ -59,10 +59,11 @@ class InputDocument extends Api /** * @url PUT /:prj_uid/input-document/:inp_doc_uid - * * @param string $inp_doc_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutInputDocument($inp_doc_uid, $prj_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php index b6ddc236b..ac7c453a7 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php @@ -102,7 +102,8 @@ class MessageEventDefinition extends Api /** * @url PUT /:prj_uid/message-event-definition/:msged_uid - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $prj_uid {@min 32}{@max 32} * @param string $msged_uid {@min 32}{@max 32} * @param array $request_data diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php index 32b47c377..d4a50ddae 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php @@ -87,7 +87,8 @@ class MessageType extends Api /** * @url PUT /:prj_uid/message-type/:msgt_uid - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param string $msgt_uid {@min 32}{@max 32} * @param array $request_data diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php index db199b197..c8b4badf7 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php @@ -90,7 +90,8 @@ class Variable extends Api /** * @url PUT /:prj_uid/message-type/:msgt_uid/variable/:msgtv_uid - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $prj_uid {@min 32}{@max 32} * @param string $msgt_uid {@min 32}{@max 32} * @param string $msgtv_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php index 5e8231b04..44baabf71 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php @@ -79,7 +79,8 @@ class OutputDocuments extends Api * @param string $prjUid {@min 32} {@max 32} * @param string $outputDocumentUid {@min 32} {@max 32} * @param array $request_data - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutProjectOutputDocument($prjUid, $outputDocumentUid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php index 974f18116..9d4926f4a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php @@ -118,7 +118,6 @@ class ProcessPermissions extends Api * @param string $prj_uid {@min 1} {@max 32} * @param string $ob_uid {@min 1} {@max 32} * @param array $request_data - * * @param string $usr_uid {@from body} {@min 1} {@max 32} * @param string $op_user_relation {@from body} {@choice 1,2} * @param string $op_case_status {@from body} {@choice ALL,DRAFT,TO_DO,PAUSED,COMPLETED} @@ -130,13 +129,10 @@ class ProcessPermissions extends Api * @param string $dynaforms {@from body} * @param string $inputs {@from body} * @param string $outputs {@from body} - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * * @return array - * * @url PUT /:prj_uid/process-permission/:ob_uid + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutProcessPermission( $prj_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php index 1bfe40447..f41d88230 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php @@ -358,12 +358,12 @@ class ProcessSupervisors extends Api /** * @url PUT /:prjUid/process-supervisor/dynaform/:pud_uid - * * @param string $prjUid {@min 32} {@max 32} * @param string $pud_uid {@min 32} {@max 32} * @param int $pud_position - * * @status 201 + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutProcessSupervisorDynaform($prjUid, $pud_uid, $pud_position = null) { @@ -385,8 +385,9 @@ class ProcessSupervisors extends Api * @param string $prjUid {@min 32} {@max 32} * @param string $pui_uid {@min 32} {@max 32} * @param int $pui_position - * * @status 201 + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutProcessSupervisorInputDocument($prjUid, $pui_uid, $pui_position = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php index 7d1894259..bd8b2525b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php @@ -136,13 +136,10 @@ class ReportTable extends Api * @param string $prj_uid {@min 1} {@max 32} * @param string $rep_uid {@min 1} {@max 32} * @param array $request_data - * * @param string $rep_tab_dsc {@from body} * @return void - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @url PUT /:prj_uid/report-table/:rep_uid */ public function doPutReportTable( diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php index 3cd658e76..f2fbca313 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php @@ -102,7 +102,8 @@ class ScriptTask extends Api /** * @url PUT /:prj_uid/script-task/:scrtas_uid - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $prj_uid {@min 32}{@max 32} * @param string $scrtas_uid {@min 32}{@max 32} * @param array $request_data diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/SubProcess.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/SubProcess.php index 5953173e9..bdd62700a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/SubProcess.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/SubProcess.php @@ -46,12 +46,9 @@ class Subprocess extends Api * @param string $prj_uid {@min 1} {@max 32} * @param string $tas_uid {@min 1} {@max 32} * @param array $request_data - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * * @return void - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @url PUT /:prj_uid/subprocess/:tas_uid */ public function doPutSubprocess($prj_uid, $tas_uid, $request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php index 62d40a8ce..d9d42e358 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php @@ -110,7 +110,8 @@ class TimerEvent extends Api /** * @url PUT /:prj_uid/timer-event/:tmrevn_uid - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $prj_uid {@min 32}{@max 32} * @param string $tmrevn_uid {@min 32}{@max 32} * @param array $request_data diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php index 14a5a2501..68967bcc3 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php @@ -91,11 +91,9 @@ class Trigger extends Api * @param string $tri_webbot {@from body} * @param string $tri_param {@from body} * @return void - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * * @url PUT /:projectUid/trigger/:triggerUid + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutTrigger($projectUid, $triggerUid, $request_data, $tri_title = '', $tri_description = '', $tri_type = 'SCRIPT', $tri_webbot = '', $tri_param = '') { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php index b7f4c29e2..55c0c577a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php @@ -94,7 +94,8 @@ class TriggerWizard extends Api /** * @url PUT /:prj_uid/trigger-wizard/:lib_name/:fn_name/:tri_uid - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $prj_uid {@min 32}{@max 32} * @param string $lib_name * @param string $fn_name diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php index b86f00e14..e01b60a10 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php @@ -73,7 +73,8 @@ class Variable extends Api /** * @url PUT /:prj_uid/process-variable/:var_uid - * + * @class AccessControl {@permission PM_FACTORY} + * @access protected * @param string $prj_uid {@min 32}{@max 32} * @param string $var_uid {@min 32}{@max 32} * @param array $request_data diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php index 06c0f0490..0a15520b8 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php @@ -98,6 +98,8 @@ class WebEntry extends Api * @param string $prj_uid {@min 32}{@max 32} * @param string $we_uid {@min 32}{@max 32} * @param array $request_data + * @class AccessControl {@permission PM_FACTORY} + * @access protected */ public function doPutWebEntry($prj_uid, $we_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php index 7a0402055..cf5ed591f 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php @@ -112,7 +112,7 @@ class WebEntryEvent extends Api /** * @url PUT /:prj_uid/web-entry-event/:wee_uid * @class AccessControl {@permission PM_FACTORY} - * + * @access protected * @param string $prj_uid {@min 32}{@max 32} * @param string $wee_uid {@min 32}{@max 32} * @param array $request_data diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Role.php b/workflow/engine/src/ProcessMaker/Services/Api/Role.php index d5fecc8b2..66165ec1c 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Role.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Role.php @@ -99,12 +99,15 @@ class Role extends Api } /** + * Update a role. + * * @access protected * @class AccessControl {@permission PM_USERS} * @url PUT /:rol_uid - * + * @class AccessControl {@permission PM_USERS} * @param string $rol_uid {@min 32}{@max 32} * @param array $request_data + * @throws RestException */ public function doPut($rol_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/User.php b/workflow/engine/src/ProcessMaker/Services/Api/User.php index cc5c50985..d52de2f0f 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/User.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/User.php @@ -83,10 +83,11 @@ class User extends Api } /** + * Update a user. + * * @access protected * @class AccessControl {@permission PM_USERS} * @url PUT /:usr_uid - * * @param string $usr_uid {@min 32}{@max 32} * @param array $request_data */ From 3584cc2975a91bd22d4b738e5054ff7773cd6b02 Mon Sep 17 00:00:00 2001 From: davidcallizaya Date: Fri, 13 Oct 2017 10:59:18 -0400 Subject: [PATCH 2/4] HOR-3967 Fix CR observations and CS. --- .../Services/Api/ActionsByEmail.php | 14 +++- .../ProcessMaker/Services/Api/Calendar.php | 11 ++- .../src/ProcessMaker/Services/Api/Cases.php | 67 ++++++++++++++----- .../Services/Api/Cases/Variable.php | 9 ++- .../src/ProcessMaker/Services/Api/Catalog.php | 8 ++- .../Services/Api/Consolidated.php | 8 ++- .../ProcessMaker/Services/Api/Dashboard.php | 18 ++++- .../ProcessMaker/Services/Api/Department.php | 18 ++++- .../ProcessMaker/Services/Api/EmailServer.php | 10 ++- .../src/ProcessMaker/Services/Api/Group.php | 10 ++- .../src/ProcessMaker/Services/Api/Light.php | 16 +++-- .../Services/Api/Light/NotificationDevice.php | 6 +- .../src/ProcessMaker/Services/Api/Pmtable.php | 18 +++-- .../src/ProcessMaker/Services/Api/Process.php | 4 +- .../Services/Api/ProcessCategory.php | 14 ++-- .../Services/Api/Project/Activity.php | 17 +++-- .../Services/Api/Project/Activity/Step.php | 7 +- .../Api/Project/Activity/Step/Trigger.php | 14 +++- .../Services/Api/Project/CaseScheduler.php | 12 +++- .../Services/Api/Project/CaseTracker.php | 10 ++- .../Api/Project/CaseTrackerObject.php | 10 ++- .../Api/Project/DataBaseConnection.php | 8 ++- .../Services/Api/Project/DynaForm.php | 8 ++- .../Services/Api/Project/EmailEvent.php | 10 ++- .../Services/Api/Project/Event.php | 12 +++- .../Services/Api/Project/FilesManager.php | 10 ++- .../Services/Api/Project/InputDocument.php | 8 ++- .../Api/Project/MessageEventDefinition.php | 10 ++- .../Services/Api/Project/MessageType.php | 10 ++- .../Api/Project/MessageType/Variable.php | 10 ++- .../Services/Api/Project/OutputDocuments.php | 7 +- .../Api/Project/ProcessPermissions.php | 10 ++- .../Api/Project/ProcessSupervisors.php | 19 ++++-- .../Services/Api/Project/ReportTable.php | 10 ++- .../Services/Api/Project/ScriptTask.php | 10 ++- .../Services/Api/Project/SubProcess.php | 10 ++- .../Services/Api/Project/TimerEvent.php | 10 ++- .../Services/Api/Project/Trigger.php | 10 ++- .../Services/Api/Project/TriggerWizard.php | 10 ++- .../Services/Api/Project/Variable.php | 10 ++- .../Services/Api/Project/WebEntry.php | 7 +- .../Services/Api/Project/WebEntryEvent.php | 11 ++- .../src/ProcessMaker/Services/Api/Role.php | 8 ++- .../src/ProcessMaker/Services/Api/User.php | 8 ++- 44 files changed, 411 insertions(+), 116 deletions(-) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php b/workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php index 5a5d97bff..339b5bb27 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php @@ -63,10 +63,14 @@ class ActionsByEmail extends Api } /** + * Update template. * * @url PUT /updateTemplate - * @class AccessControl {@permission PM_SETUP_EMAIL} + * + * @param type $params + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function updateTemplate($params) { @@ -83,10 +87,16 @@ class ActionsByEmail extends Api } /** + * Update configuration. * * @url PUT /saveConfiguration - * @class AccessControl {@permission PM_SETUP_EMAIL} + * + * @param type $params + * + * @return mixed + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function saveConfiguration($params) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Calendar.php b/workflow/engine/src/ProcessMaker/Services/Api/Calendar.php index 53dadcd0e..4669c772b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Calendar.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Calendar.php @@ -80,12 +80,17 @@ class Calendar extends Api } /** - * - * @access protected - * @class AccessControl {@permission PM_SETUP_CALENDAR} + * Update calendar. + * * @url PUT /:cal_uid + * * @param string $cal_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_SETUP_CALENDAR} */ public function doPut($cal_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php index 594b2f680..483a79833 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php @@ -796,14 +796,19 @@ class Cases extends Api } /** + * Update case reassignment. + * * @url PUT /:app_uid/reassign-case * * @param string $app_uid {@min 32}{@max 32} * @param string $usr_uid_source {@from body} {@min 32}{@max 32} * @param string $usr_uid_target {@from body} {@min 32}{@max 32} * @param string $del_index {@from body} - * @class AccessControl {@permission PM_REASSIGNCASE,PM_REASSIGNCASE_SUPERVISOR} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_REASSIGNCASE,PM_REASSIGNCASE_SUPERVISOR} */ public function doPutReassignCase($app_uid, $usr_uid_source, $usr_uid_target, $del_index = null) { @@ -817,13 +822,17 @@ class Cases extends Api } /** - * Route Case + * Route Case. * * @url PUT /:app_uid/route-case + * * @param string $app_uid {@min 32}{@max 32} * @param string $del_index {@from body} - * @class AccessControl {@permission PM_CASES} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPutRouteCase($app_uid, $del_index = null) { @@ -839,10 +848,14 @@ class Cases extends Api /** * Cancel Case * - * @param string $cas_uid {@min 1}{@max 32} - * @class AccessControl {@permission PM_CANCELCASE} - * @access protected * @url PUT /:cas_uid/cancel + * + * @param string $cas_uid {@min 1}{@max 32} + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_CANCELCASE} */ public function doPutCancelCase($cas_uid) { @@ -858,11 +871,15 @@ class Cases extends Api /** * Pause Case * + * @url PUT /:cas_uid/pause + * * @param string $cas_uid {@min 1}{@max 32} * @param string $unpaused_date {@from body} - * @class AccessControl {@permission PM_CASES} + * + * @throws RestException + * * @access protected - * @url PUT /:cas_uid/pause + * @class AccessControl {@permission PM_CASES} */ public function doPutPauseCase($cas_uid, $unpaused_date = null) { @@ -882,10 +899,14 @@ class Cases extends Api /** * Unpause Case * - * @param string $cas_uid {@min 1}{@max 32} - * @class AccessControl {@permission PM_CASES} - * @access protected * @url PUT /:cas_uid/unpause + * + * @param string $cas_uid {@min 1}{@max 32} + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPutUnpauseCase($cas_uid) { @@ -899,13 +920,17 @@ class Cases extends Api } /** - * Unpause Case + * Execute trigger in a case. + * + * @url PUT /:cas_uid/execute-trigger/:tri_uid * * @param string $cas_uid {@min 1}{@max 32} * @param string $tri_uid {@min 1}{@max 32} - * @class AccessControl {@permission PM_CASES} + * + * @throws RestException + * * @access protected - * @url PUT /:cas_uid/execute-trigger/:tri_uid + * @class AccessControl {@permission PM_CASES} */ public function doPutExecuteTriggerCase($cas_uid, $tri_uid) { @@ -969,13 +994,17 @@ class Cases extends Api /** * Put Case Variables * + * @url PUT /:app_uid/variable + * * @param string $app_uid {@min 1}{@max 32} * @param array $request_data * @param string $dyn_uid {@from path} * @param int $del_index {@from path} - * @class AccessControl {@permission PM_CASES} + * + * @throws RestException + * * @access protected - * @url PUT /:app_uid/variable + * @class AccessControl {@permission PM_CASES} */ public function doPutCaseVariables($app_uid, $request_data, $dyn_uid = '', $del_index = 0) { @@ -1134,13 +1163,17 @@ class Cases extends Api /** * Execute triggers * + * @url PUT /:app_uid/execute-triggers + * * @param string $app_uid {@min 1}{@max 32} * @param int $del_index {@from body} * @param string $obj_type {@from body} * @param string $obj_uid {@from body} + * + * @throws RestException + * * @class AccessControl {@permission PM_CASES} * @access protected - * @url PUT /:app_uid/execute-triggers */ public function doPutExecuteTriggers($app_uid, $del_index, $obj_type, $obj_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php index b32622d88..23f0c1a9a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php @@ -99,15 +99,20 @@ class Variable extends Api } /** + * Update variable. + * * @url PUT /:app_uid/:del_index/variable/:var_name + * @status 204 * * @param string $app_uid {@min 32}{@max 32} * @param int $del_index {@min 1} * @param string $var_name * @param array $request_data - * @class AccessControl {@permission PM_CASES} + * + * @throws RestException + * * @access protected - * @status 204 + * @class AccessControl {@permission PM_CASES} */ public function doPutVariable($app_uid, $del_index, $var_name, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php index 3db7504e6..aa1ab0af9 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php @@ -62,12 +62,18 @@ class Catalog extends Api } /** + * Update catalog. + * * @url PUT /:cat_uid/:cat_type + * * @param string $cat_uid {@min 32}{@max 32} * @param string $cat_type {@min 32}{@max 32} * @param array $request_data - * @class AccessControl {@permission PM_DASHBOARD} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_DASHBOARD} */ public function doPut($cat_uid, $cat_type, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php index 3b7693b0a..773d48767 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php @@ -108,14 +108,18 @@ class Consolidated extends Api /** * Get Cases Consolidated * + * @url PUT /cases/:tas_uid/:dyn_uid/:pro_uid + * * @param string $tas_uid {@min 1} {@max 32} * @param string $dyn_uid {@min 1} {@max 32} * @param string $pro_uid {@min 1} {@max 32} * @param array $request_data + * * @return array - * @class AccessControl {@permission PM_CASES} + * @throws RestException + * * @access protected - * @url PUT /cases/:tas_uid/:dyn_uid/:pro_uid + * @class AccessControl {@permission PM_CASES} */ public function doPutCasesConsolidated($tas_uid, $dyn_uid, $pro_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php index db70262ab..fc47b510f 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php @@ -242,10 +242,14 @@ class Dashboard extends Api /** * Put dashboards configuration * - * @param array $request_data * @url PUT - * @class AccessControl {@permission PM_DASHBOARD} + * + * @param array $request_data + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_DASHBOARD} */ public function doPutDashboard($request_data) { @@ -339,6 +343,9 @@ class Dashboard extends Api * Put Indicator * * @param array $request_data + * + * @throws RestException + * * @class AccessControl {@permission PM_DASHBOARD} * @access protected */ @@ -414,9 +421,14 @@ class Dashboard extends Api /** * Put dashboards configuration by usr_uid * + * @url PUT /config + * * @param array $request_data - * @class AccessControl {@permission PM_DASHBOARD} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_DASHBOARD} */ public function doPutDashboardConfigByUsrUid($request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Department.php b/workflow/engine/src/ProcessMaker/Services/Api/Department.php index 19d24be83..fbc81504b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Department.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Department.php @@ -141,12 +141,18 @@ class Department extends Api } /** + * Update manager user + * * @url PUT /:dep_uid/set-manager/:usr_uid - * @class AccessControl {@permission PM_USERS} - * @access protected + * * @param string $dep_uid {@min 1}{@max 32} * @param string $usr_uid {@min 1}{@max 32} + * * @return array + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_USERS} */ public function doPutSetManager($dep_uid, $usr_uid) { @@ -201,11 +207,17 @@ class Department extends Api } /** + * Update department. + * * @url PUT /:dep_uid + * * @param string $dep_uid {@min 1}{@max 32} * @param array $request_data - * @class AccessControl {@permission PM_USERS} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_USERS} */ public function doPut($dep_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php index a42517a5e..2546b6813 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php @@ -123,12 +123,18 @@ class EmailServer extends Api } /** + * Update email server. + * * @url PUT /:mess_uid + * @status 200 + * * @param string $mess_uid {@min 32}{@max 32} * @param array $request_data - * @class AccessControl {@permission PM_SETUP_EMAIL} + * + * @throws RestException + * * @access protected - * @status 200 + * @class AccessControl {@permission PM_SETUP_EMAIL} */ public function doPut($mess_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group.php b/workflow/engine/src/ProcessMaker/Services/Api/Group.php index de94e7334..6db82acf6 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group.php @@ -96,11 +96,17 @@ class Group extends Api } /** + * Update group. + * * @url PUT /:grp_uid - * @class AccessControl {@permission PM_USERS} - * @access protected + * * @param string $grp_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_USERS} */ public function doPut($grp_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light.php b/workflow/engine/src/ProcessMaker/Services/Api/Light.php index 61f199a7d..ab8457553 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light.php @@ -1177,11 +1177,15 @@ class Light extends Api * Route Case * * @url PUT /cases/:app_uid/route-case - * @class AccessControl {@permission PM_CASES} - * @access protected + * * @param string $app_uid {@min 32}{@max 32} * @param int $del_index {@from body} * @param array $tasks {@from body} + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPutRouteCase($app_uid, $del_index = null, $tasks = array()) { @@ -1718,13 +1722,17 @@ class Light extends Api /** * Put Case Variables * + * @url PUT /:app_uid/variable + * * @param string $app_uid {@min 1}{@max 32} * @param array $request_data * @param string $dyn_uid {@from path} * @param int $del_index {@from path} - * @class AccessControl {@permission PM_CASES} + * + * @throws RestException + * * @access protected - * @url PUT /:app_uid/variable + * @class AccessControl {@permission PM_CASES} */ public function doPutCaseVariables($app_uid, $request_data, $dyn_uid = '', $del_index = 0) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php b/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php index d861d34f9..52bb67e84 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php @@ -36,12 +36,14 @@ class NotificationDevice extends Api } /** - * Post Create register device with userUid + * Update device language. + * + * @url PUT /notification/:dev_uid * * @param string $dev_uid {@min 32}{@max 32} * @param array $request_data + * * @return array - * @url PUT /notification/:dev_uid * @throws RestException */ public function updateDeviceLanguage($dev_uid, $request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php b/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php index bd1d8c5a1..9919fad2d 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php @@ -137,17 +137,17 @@ class Pmtable extends Api } /** + * Update pm-table. + * + * @url PUT /:pmt_uid + * * @param string $pmt_uid {@min 1} {@max 32} - * * @param array $request_data - * @return void * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia + * @return void * * @access protected * @class AccessControl {@permission PM_SETUP_PM_TABLES} - * @url PUT /:pmt_uid */ public function doPutPmTable( $pmt_uid, @@ -163,12 +163,18 @@ class Pmtable extends Api } /** + * Update pm-table data. + * + * @url PUT /:pmt_uid/data + * * @param string $pmt_uid {@min 1} {@max 32} * @param array $request_data + * * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_SETUP_PM_TABLES} - * @url PUT /:pmt_uid/data */ public function doPutPmTableData( $pmt_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Process.php b/workflow/engine/src/ProcessMaker/Services/Api/Process.php index 2296bda19..1d3b8bb5c 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Process.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Process.php @@ -83,10 +83,12 @@ class Process extends Api * * @param type $processUid * @param type $request_data + * * @return type * @throws RestException - * @class AccessControl {@permission PM_FACTORY} + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function put($processUid, $request_data = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php b/workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php index 4dcbe8a73..1f08a375c 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php @@ -90,13 +90,17 @@ class ProcessCategory extends Api } /** + * Update category. + * + * @url PUT /category/:cat_uid + * + * @param string $cat_uid {@min 32}{@max 32} + * @param array $request_data + * + * @throws RestException * * @access protected - * @class AccessControl {@permission PM_FACTORY,PM_SETUP_PROCESS_CATEGORIES} - * @url PUT /category/:cat_uid - * @param string $cat_uid {@min 32}{@max 32} - * @param array $request_data - * @throws RestException + * @class AccessControl {@permission PM_SETUP_PROCESS_CATEGORIES} */ public function doPutCategory($cat_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php index 21c8320ee..f9bff74f6 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php @@ -104,14 +104,18 @@ class Activity extends Api /** * Update an activity. * + * @url PUT /:prj_uid/activity/:act_uid + * * @param string $prj_uid {@min 32} {@max 32} * @param string $act_uid {@min 32} {@max 32} * @param ActivityPropertiesStructure $properties {@from body} - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * @param array $request_data + * * @return array - * @url PUT /:prj_uid/activity/:act_uid * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutProjectActivity($prj_uid, $act_uid, ActivityPropertiesStructure $properties, $request_data = array()) { @@ -220,9 +224,14 @@ class Activity extends Api * Get activity validate self service. * * @url PUT /:prj_uid/activity/validate-active-cases + * * @param string $prj_uid {@min 32}{@max 32} - * @class AccessControl {@permission PM_FACTORY} + * @param array $request_data + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doGetActivityValidateSelfService($prj_uid, $request_data = array()) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php index 2d05de43b..74bda2f4e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php @@ -73,6 +73,8 @@ class Step extends Api } /** + * Update step. + * * @url PUT /:prj_uid/activity/:act_uid/step/:step_uid * * @param string $step_uid {@min 32}{@max 32} @@ -84,8 +86,11 @@ class Step extends Api * @param string $step_condition {@from body} * @param int $step_position {@from body}{@min 1} * @param string $step_mode {@from body}{@choice EDIT,VIEW} - * @class AccessControl {@permission PM_FACTORY} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutActivityStep( $step_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step/Trigger.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step/Trigger.php index 63f6347ec..be096667f 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step/Trigger.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step/Trigger.php @@ -57,6 +57,8 @@ class Trigger extends Api } /** + * Update activity step trigger. + * * @url PUT /:prj_uid/activity/:act_uid/step/:step_uid/trigger/:tri_uid * * @param string $tri_uid @@ -64,8 +66,11 @@ class Trigger extends Api * @param string $act_uid * @param string $prj_uid * @param StepTriggerPutStructure $request_data - * @class AccessControl {@permission PM_FACTORY} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutActivityStepTrigger($tri_uid, $step_uid, $act_uid, $prj_uid, StepTriggerPutStructure $request_data = null) { @@ -146,14 +151,19 @@ class Trigger extends Api } /** + * Update activity step assign task trigger. + * * @url PUT /:prj_uid/activity/:act_uid/step/trigger/:tri_uid * * @param string $tri_uid * @param string $act_uid * @param string $prj_uid * @param StepAssignTaskTriggerPutStructure $request_data - * @class AccessControl {@permission PM_FACTORY} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutActivityStepAssignTaskTrigger($tri_uid, $act_uid, $prj_uid, StepAssignTaskTriggerPutStructure $request_data = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php index f8050fa23..dd1b647c8 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php @@ -75,12 +75,18 @@ class CaseScheduler extends Api } /** + * Update project case scheduler. + * * @url PUT /:prjUid/case-scheduler/:schUid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prjUid {@min 32} {@max 32} * @param string $schUid {@min 32} {@max 32} - * @param CaseSchedulerStructure $request_data + * @param CaseSchedulerStructure $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutProjectCaseScheduler($prjUid, $schUid, CaseSchedulerStructure $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php index 804ccbe82..4ae4faa11 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php @@ -30,14 +30,20 @@ class CaseTracker extends Api } /** + * Update case tracker. + * * @url PUT /:prj_uid/case-tracker/property - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * @param string $map_type {@from body}{@choice NONE,PROCESSMAP,STAGES} * @param int $routing_history {@from body}{@choice 0,1} * @param int $message_history {@from body}{@choice 0,1} + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutCaseTracker( $prj_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php index 9f6cf1c1c..9c1f9dfc4 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php @@ -64,9 +64,10 @@ class CaseTrackerObject extends Api } /** + * Update case tracker object. + * * @url PUT /:prj_uid/case-tracker/object/:cto_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $cto_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data @@ -74,6 +75,11 @@ class CaseTrackerObject extends Api * @param string $cto_uid_obj {@from body}{@min 32}{@max 32} * @param string $cto_condition {@from body} * @param int $cto_position {@from body}{@min 1} + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutCaseTrackerObject( $cto_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php index 7337d6188..fecb178c8 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php @@ -135,6 +135,8 @@ class DataBaseConnection extends Api /** * Update database connection. * + * @url PUT /:prj_uid/database-connection/:dbs_uid + * * @param string $prj_uid {@min 1} {@max 32} * @param string $dbs_uid {@min 1} {@max 32} * @param array $request_data @@ -145,10 +147,12 @@ class DataBaseConnection extends Api * @param string $dbs_encode {@from body} {@required true} * @param string $dbs_password {@from body} * @param string $dbs_description {@from body} + * * @return void - * @url PUT /:prj_uid/database-connection/:dbs_uid - * @class AccessControl {@permission PM_SETUP} + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_SETUP} */ public function doPutDataBaseConnection( $prj_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php index dc59a24aa..ecbe66b22 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php @@ -66,11 +66,15 @@ class DynaForm extends Api * Update dynaform. * * @url PUT /:prj_uid/dynaform/:dyn_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutDynaForm($dyn_uid, $prj_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php index c10ee5235..b6ad92274 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php @@ -79,12 +79,18 @@ class EmailEvent extends Api } /** + * Update email event. + * * @url PUT /:prj_uid/email-event/:email_event_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prj_uid {@min 32}{@max 32} * @param string $email_event_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutEmailEvent($prj_uid, $email_event_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php index ef99e25d8..470134a60 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php @@ -139,6 +139,10 @@ class Event extends Api } /** + * Update event. + * + * @url PUT /:prj_uid/event/:evn_uid + * * @param string $prj_uid {@min 1} {@max 32} * @param string $evn_uid {@min 1} {@max 32} * @param array $request_data @@ -155,10 +159,12 @@ class Event extends Api * @param string $evn_tas_uid_from {@from body} * @param string $evn_tas_uid_to {@from body} * @param string $evn_conditions {@from body} - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @return void - * @url PUT /:prj_uid/event/:evn_uid + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutEvent ( $prj_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php index 41f870f12..4fe15ec6a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php @@ -80,12 +80,18 @@ class FilesManager extends Api } /** + * Update process files manager + * + * @url PUT /:prj_uid/file-manager/:prf_uid + * * @param string $prj_uid {@min 32} {@max 32} * @param ProcessFilesManagerStructure $request_data * @param string $prf_uid {@min 32} {@max 32} - * @class AccessControl {@permission PM_FACTORY} + * + * @throws RestException + * * @access protected - * @url PUT /:prj_uid/file-manager/:prf_uid + * @class AccessControl {@permission PM_FACTORY} */ public function doPutProcessFilesManager($prj_uid, ProcessFilesManagerStructure $request_data, $prf_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php index 93db3a995..ad85a60e8 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php @@ -58,12 +58,18 @@ class InputDocument extends Api } /** + * Update input document. + * * @url PUT /:prj_uid/input-document/:inp_doc_uid + * * @param string $inp_doc_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @class AccessControl {@permission PM_FACTORY} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutInputDocument($inp_doc_uid, $prj_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php index ac7c453a7..99cc1b495 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php @@ -101,12 +101,18 @@ class MessageEventDefinition extends Api } /** + * Update message event definition. + * * @url PUT /:prj_uid/message-event-definition/:msged_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prj_uid {@min 32}{@max 32} * @param string $msged_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutMessageEventDefinition($prj_uid, $msged_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php index d4a50ddae..3d2470442 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php @@ -86,12 +86,18 @@ class MessageType extends Api } /** + * Update message type. + * * @url PUT /:prj_uid/message-type/:msgt_uid - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 32}{@max 32} * @param string $msgt_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutMessageType($prj_uid, $msgt_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php index c8b4badf7..5e494f077 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php @@ -89,13 +89,19 @@ class Variable extends Api } /** + * Update message type variable. + * * @url PUT /:prj_uid/message-type/:msgt_uid/variable/:msgtv_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prj_uid {@min 32}{@max 32} * @param string $msgt_uid {@min 32}{@max 32} * @param string $msgtv_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutMessageTypeVariable($prj_uid, $msgt_uid, $msgtv_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php index 44baabf71..4e59812cd 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php @@ -74,13 +74,18 @@ class OutputDocuments extends Api } /** + * Update project output document. + * * @url PUT /:prjUid/output-document/:outputDocumentUid * * @param string $prjUid {@min 32} {@max 32} * @param string $outputDocumentUid {@min 32} {@max 32} * @param array $request_data - * @class AccessControl {@permission PM_FACTORY} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutProjectOutputDocument($prjUid, $outputDocumentUid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php index 9d4926f4a..5ecb03639 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php @@ -115,6 +115,10 @@ class ProcessPermissions extends Api } /** + * Update process permisson. + * + * @url PUT /:prj_uid/process-permission/:ob_uid + * * @param string $prj_uid {@min 1} {@max 32} * @param string $ob_uid {@min 1} {@max 32} * @param array $request_data @@ -129,10 +133,12 @@ class ProcessPermissions extends Api * @param string $dynaforms {@from body} * @param string $inputs {@from body} * @param string $outputs {@from body} + * * @return array - * @url PUT /:prj_uid/process-permission/:ob_uid - * @class AccessControl {@permission PM_FACTORY} + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutProcessPermission( $prj_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php index f41d88230..cce54fd1e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php @@ -357,13 +357,19 @@ class ProcessSupervisors extends Api } /** + * Update process supervisor dynaform. + * * @url PUT /:prjUid/process-supervisor/dynaform/:pud_uid + * @status 201 + * * @param string $prjUid {@min 32} {@max 32} * @param string $pud_uid {@min 32} {@max 32} * @param int $pud_position - * @status 201 - * @class AccessControl {@permission PM_FACTORY} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutProcessSupervisorDynaform($prjUid, $pud_uid, $pud_position = null) { @@ -380,14 +386,19 @@ class ProcessSupervisors extends Api } /** + * Update process supervisor input document. + * * @url PUT /:prjUid/process-supervisor/input-document/:pui_uid + * @status 201 * * @param string $prjUid {@min 32} {@max 32} * @param string $pui_uid {@min 32} {@max 32} * @param int $pui_position - * @status 201 - * @class AccessControl {@permission PM_FACTORY} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutProcessSupervisorInputDocument($prjUid, $pui_uid, $pui_position = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php index bd8b2525b..edc74d4f9 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php @@ -133,14 +133,20 @@ class ReportTable extends Api } /** + * Update report table. + * + * @url PUT /:prj_uid/report-table/:rep_uid + * * @param string $prj_uid {@min 1} {@max 32} * @param string $rep_uid {@min 1} {@max 32} * @param array $request_data * @param string $rep_tab_dsc {@from body} + * * @return void - * @class AccessControl {@permission PM_FACTORY} + * @throws RestException + * * @access protected - * @url PUT /:prj_uid/report-table/:rep_uid + * @class AccessControl {@permission PM_FACTORY} */ public function doPutReportTable( $prj_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php index f2fbca313..7d34a8d9d 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php @@ -101,12 +101,18 @@ class ScriptTask extends Api } /** + * Update script task. + * * @url PUT /:prj_uid/script-task/:scrtas_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prj_uid {@min 32}{@max 32} * @param string $scrtas_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutScriptTask($prj_uid, $scrtas_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/SubProcess.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/SubProcess.php index bdd62700a..0abf7c12e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/SubProcess.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/SubProcess.php @@ -43,13 +43,19 @@ class Subprocess extends Api } /** + * Update subprocess. + * + * @url PUT /:prj_uid/subprocess/:tas_uid + * * @param string $prj_uid {@min 1} {@max 32} * @param string $tas_uid {@min 1} {@max 32} * @param array $request_data + * * @return void - * @class AccessControl {@permission PM_FACTORY} + * @throws RestException + * * @access protected - * @url PUT /:prj_uid/subprocess/:tas_uid + * @class AccessControl {@permission PM_FACTORY} */ public function doPutSubprocess($prj_uid, $tas_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php index d9d42e358..25e1c7a7d 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php @@ -109,12 +109,18 @@ class TimerEvent extends Api } /** + * Update timer event. + * * @url PUT /:prj_uid/timer-event/:tmrevn_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prj_uid {@min 32}{@max 32} * @param string $tmrevn_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutTimerEvent($prj_uid, $tmrevn_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php index 68967bcc3..1db3d6ace 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php @@ -82,6 +82,10 @@ class Trigger extends Api } /** + * Update trigger. + * + * @url PUT /:projectUid/trigger/:triggerUid + * * @param string $projectUid {@min 1} {@max 32} * @param string $triggerUid {@min 1} {@max 32} * @param array $request_data @@ -90,10 +94,12 @@ class Trigger extends Api * @param string $tri_type {@from body} * @param string $tri_webbot {@from body} * @param string $tri_param {@from body} + * * @return void - * @url PUT /:projectUid/trigger/:triggerUid - * @class AccessControl {@permission PM_FACTORY} + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutTrigger($projectUid, $triggerUid, $request_data, $tri_title = '', $tri_description = '', $tri_type = 'SCRIPT', $tri_webbot = '', $tri_param = '') { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php index 55c0c577a..68d88de70 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php @@ -93,14 +93,20 @@ class TriggerWizard extends Api } /** + * Update trigger wizard. + * * @url PUT /:prj_uid/trigger-wizard/:lib_name/:fn_name/:tri_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prj_uid {@min 32}{@max 32} * @param string $lib_name * @param string $fn_name * @param string $tri_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutTriggerWizard($prj_uid, $lib_name, $fn_name, $tri_uid, $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php index e01b60a10..219edf9c4 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php @@ -72,12 +72,18 @@ class Variable extends Api } /** + * Update variable. + * * @url PUT /:prj_uid/process-variable/:var_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prj_uid {@min 32}{@max 32} * @param string $var_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutVariable($prj_uid, $var_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php index 0a15520b8..4dd8d69fb 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php @@ -93,13 +93,18 @@ class WebEntry extends Api } /** + * Update web-entry. + * * @url PUT /:prj_uid/web-entry/:we_uid * * @param string $prj_uid {@min 32}{@max 32} * @param string $we_uid {@min 32}{@max 32} * @param array $request_data - * @class AccessControl {@permission PM_FACTORY} + * + * @throws RestException + * * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutWebEntry($prj_uid, $we_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php index cf5ed591f..cd4732873 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php @@ -110,12 +110,19 @@ class WebEntryEvent extends Api } /** + * Update web-entry event. + * * @url PUT /:prj_uid/web-entry-event/:wee_uid - * @class AccessControl {@permission PM_FACTORY} - * @access protected + * * @param string $prj_uid {@min 32}{@max 32} * @param string $wee_uid {@min 32}{@max 32} * @param array $request_data + * + * @return mixed + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPutWebEntryEvent($prj_uid, $wee_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Role.php b/workflow/engine/src/ProcessMaker/Services/Api/Role.php index 66165ec1c..f16777593 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Role.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Role.php @@ -101,13 +101,15 @@ class Role extends Api /** * Update a role. * - * @access protected - * @class AccessControl {@permission PM_USERS} * @url PUT /:rol_uid - * @class AccessControl {@permission PM_USERS} + * * @param string $rol_uid {@min 32}{@max 32} * @param array $request_data + * * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_USERS} */ public function doPut($rol_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/User.php b/workflow/engine/src/ProcessMaker/Services/Api/User.php index d52de2f0f..43842be7a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/User.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/User.php @@ -85,11 +85,15 @@ class User extends Api /** * Update a user. * - * @access protected - * @class AccessControl {@permission PM_USERS} * @url PUT /:usr_uid + * * @param string $usr_uid {@min 32}{@max 32} * @param array $request_data + * + * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_USERS} */ public function doPutUser($usr_uid, $request_data) { From 6b8ef940151f26fa21ad5bae24de8ef0718e16b8 Mon Sep 17 00:00:00 2001 From: davidcallizaya Date: Wed, 18 Oct 2017 14:33:38 -0400 Subject: [PATCH 3/4] HOR-3967 Fix PUT catalog and deprecate it. --- .../src/ProcessMaker/BusinessModel/Catalog.php | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/workflow/engine/src/ProcessMaker/BusinessModel/Catalog.php b/workflow/engine/src/ProcessMaker/BusinessModel/Catalog.php index bdb01c969..f05549483 100644 --- a/workflow/engine/src/ProcessMaker/BusinessModel/Catalog.php +++ b/workflow/engine/src/ProcessMaker/BusinessModel/Catalog.php @@ -43,20 +43,25 @@ class Catalog } /** - * Update Catalog + * Update Catalog. * * @param string $cat_uid Unique id of Group * @param string $cat_type Unique id of Group * @param array $arrayData Data * - * return array Return data of the new Group update - * - * @author Marco Antonio Nina + * @return array Return data of the new Group update + * + * @access private + * @deprecated since 3.2.2 */ public function update($cat_uid, $cat_type, $arrayData) { $catalog = new \Catalog(); - $response = $catalog->update($cat_uid, $cat_type, $arrayData); + $arrayData['CAT_UID'] = $cat_uid; + $arrayData['CAT_TYPE'] = !isset($arrayData['CAT_TYPE']) + ? $cat_type + : $arrayData['CAT_TYPE']; + $response = $catalog->createOrUpdate($arrayData); return $response; } From d473d9afad42590fb66d982bfd0e406757fade51 Mon Sep 17 00:00:00 2001 From: davidcallizaya Date: Thu, 19 Oct 2017 15:54:11 -0400 Subject: [PATCH 4/4] HOR-3967 Fix CR obervations about documentation. --- workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php | 3 +++ workflow/engine/src/ProcessMaker/Services/Api/Light.php | 1 + workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php | 1 + workflow/engine/src/ProcessMaker/Services/Api/Process.php | 6 +++--- .../src/ProcessMaker/Services/Api/Project/Activity.php | 3 ++- .../src/ProcessMaker/Services/Api/Project/CaseScheduler.php | 1 + .../src/ProcessMaker/Services/Api/Project/FilesManager.php | 1 + .../Services/Api/Project/ProcessSupervisors.php | 1 + 8 files changed, 13 insertions(+), 4 deletions(-) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php index fc47b510f..6bce76f2a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php @@ -246,6 +246,7 @@ class Dashboard extends Api * * @param array $request_data * + * @return string * @throws RestException * * @access protected @@ -344,6 +345,7 @@ class Dashboard extends Api * * @param array $request_data * + * @return string * @throws RestException * * @class AccessControl {@permission PM_DASHBOARD} @@ -425,6 +427,7 @@ class Dashboard extends Api * * @param array $request_data * + * @return array * @throws RestException * * @access protected diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light.php b/workflow/engine/src/ProcessMaker/Services/Api/Light.php index ab8457553..a7a970434 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light.php @@ -1182,6 +1182,7 @@ class Light extends Api * @param int $del_index {@from body} * @param array $tasks {@from body} * + * @return array * @throws RestException * * @access protected diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php b/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php index 9919fad2d..36698c25a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php @@ -145,6 +145,7 @@ class Pmtable extends Api * @param array $request_data * * @return void + * @throw RestException * * @access protected * @class AccessControl {@permission PM_SETUP_PM_TABLES} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Process.php b/workflow/engine/src/ProcessMaker/Services/Api/Process.php index 1d3b8bb5c..3a7619b78 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Process.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Process.php @@ -81,10 +81,10 @@ class Process extends Api /** * Update a process by UID. * - * @param type $processUid - * @param type $request_data + * @param string $processUid + * @param array $request_data * - * @return type + * @return array * @throws RestException * * @access protected diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php index f9bff74f6..4de02af2c 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php @@ -111,7 +111,7 @@ class Activity extends Api * @param ActivityPropertiesStructure $properties {@from body} * @param array $request_data * - * @return array + * @return void * @throws RestException * * @access protected @@ -228,6 +228,7 @@ class Activity extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return \StdClass * @throws RestException * * @access protected diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php index dd1b647c8..6a404f853 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php @@ -83,6 +83,7 @@ class CaseScheduler extends Api * @param string $schUid {@min 32} {@max 32} * @param CaseSchedulerStructure $request_data * + * @return array * @throws RestException * * @access protected diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php index 4fe15ec6a..9f6e37924 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php @@ -88,6 +88,7 @@ class FilesManager extends Api * @param ProcessFilesManagerStructure $request_data * @param string $prf_uid {@min 32} {@max 32} * + * @return array * @throws RestException * * @access protected diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php index cce54fd1e..f4bcd9876 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php @@ -395,6 +395,7 @@ class ProcessSupervisors extends Api * @param string $pui_uid {@min 32} {@max 32} * @param int $pui_position * + * @return array * @throws RestException * * @access protected