From d828c081eb1ac9342ae1e3c75956f3b73b02f10f Mon Sep 17 00:00:00 2001 From: davidcallizaya Date: Wed, 11 Oct 2017 11:19:53 -0400 Subject: [PATCH 01/15] 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 ab5a6526de0a9b1e727b02d6c926ec055782ee37 Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Wed, 11 Oct 2017 13:47:24 -0400 Subject: [PATCH 02/15] HOR-3968 --- .../src/ProcessMaker/Services/Api/Cases.php | 21 +++--- .../Services/Api/Cases/InputDocument.php | 3 +- .../Services/Api/Cases/OutputDocument.php | 3 +- .../Services/Api/Cases/Variable.php | 4 +- .../src/ProcessMaker/Services/Api/Catalog.php | 7 +- .../Services/Api/Consolidated.php | 10 ++- .../ProcessMaker/Services/Api/Dashboard.php | 25 +++---- .../ProcessMaker/Services/Api/Department.php | 11 ++- .../ProcessMaker/Services/Api/EmailServer.php | 7 +- .../src/ProcessMaker/Services/Api/File.php | 3 +- .../src/ProcessMaker/Services/Api/Group.php | 4 +- .../ProcessMaker/Services/Api/Group/User.php | 8 +-- .../src/ProcessMaker/Services/Api/Light.php | 72 +++++++++++-------- .../src/ProcessMaker/Services/Api/Process.php | 4 ++ .../Api/Project/Activity/Assignee.php | 8 +-- .../Services/Api/Project/Activity/Step.php | 8 +-- .../Api/Project/Activity/Step/Trigger.php | 8 +-- .../Services/Api/Project/CaseScheduler.php | 6 +- .../Api/Project/CaseTrackerObject.php | 4 +- .../Api/Project/DataBaseConnection.php | 18 ++--- .../Services/Api/Project/DynaForm.php | 13 ++-- .../Services/Api/Project/EmailEvent.php | 3 +- .../Services/Api/Project/FilesManager.php | 10 +-- .../Services/Api/Project/InputDocument.php | 4 +- .../Api/Project/MessageEventDefinition.php | 4 +- .../Services/Api/Project/MessageType.php | 4 +- .../Api/Project/MessageType/Variable.php | 4 +- .../Services/Api/Project/OutputDocuments.php | 4 +- .../Api/Project/ProcessPermissions.php | 10 +-- .../Api/Project/ProcessSupervisors.php | 12 ++-- .../Services/Api/Project/ProjectUsers.php | 5 +- .../Services/Api/Project/ReportTable.php | 9 +-- .../Services/Api/Project/ScriptTask.php | 4 +- .../Services/Api/Project/TimerEvent.php | 4 +- .../Services/Api/Project/Trigger.php | 8 +-- .../Services/Api/Project/TriggerWizard.php | 4 +- .../Services/Api/Project/Variable.php | 10 +-- .../Services/Api/Project/WebEntry.php | 4 +- .../Services/Api/Project/WebEntryEvent.php | 5 +- 39 files changed, 177 insertions(+), 178 deletions(-) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php index 47818ac73..9166322e7 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php @@ -757,11 +757,11 @@ class Cases extends Api /** * @url POST - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $pro_uid {@from body} {@min 32}{@max 32} * @param string $tas_uid {@from body} {@min 32}{@max 32} * @param array $variables {@from body} - * */ public function doPostCase($pro_uid, $tas_uid, $variables = null) { @@ -777,12 +777,12 @@ class Cases extends Api /** * @url POST /impersonate - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $pro_uid {@from body} {@min 32}{@max 32} * @param string $usr_uid {@from body} {@min 32}{@max 32} * @param string $tas_uid {@from body} {@min 32}{@max 32} * @param array $variables {@from body} - * */ public function doPostCaseImpersonate($pro_uid, $usr_uid, $tas_uid, $variables = null) { @@ -1097,14 +1097,12 @@ class Cases extends Api /** * Put Case Variables * + * @url POST /:app_uid/note + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $app_uid {@min 1}{@max 32} * @param string $note_content {@min 1}{@max 500} * @param int $send_mail {@choice 1,0} - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url POST /:app_uid/note */ public function doPostCaseNote($app_uid, $note_content, $send_mail = 0) { @@ -1231,10 +1229,11 @@ class Cases extends Api /** * Mark a task process as a bookmark + * * @url POST /bookmark/:tas_uid - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $tas_uid {@min 32}{@max 32} - * */ public function doPostBookmarkStartCase($tas_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php index 45983547b..e413e2896 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php @@ -97,7 +97,8 @@ class InputDocument extends Api /** * @url POST /:app_uid/input-document - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $app_uid { @min 32}{@max 32} * @param string $tas_uid {@min 32}{@max 32} * @param string $app_doc_comment diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php index 4977f964e..65bc75ff8 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php @@ -134,7 +134,8 @@ class OutputDocument extends Api /** * @url POST /:app_uid/:del_index/output-document/:out_doc_uid - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $app_uid {@min 32}{@max 32} * @param int $del_index {@min 1} * @param string $out_doc_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php index 61620f006..4884aa284 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php @@ -79,12 +79,12 @@ class Variable extends Api /** * @url POST /:app_uid/:del_index/variable/:var_name - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $app_uid {@min 32}{@max 32} * @param int $del_index {@min 1} * @param string $var_name * @param array $request_data - * * @status 201 */ public function doPostVariable($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..d445c1a8c 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php @@ -39,12 +39,9 @@ class Catalog extends Api /** * @url POST - * + * @access protected + * @class AccessControl {@permission PM_DASHBOARD} * @param array $request_data - * - * @author Marco Antonio Nina - * @copyright Colosa - Bolivia - * * @status 201 */ public function doPost($request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php index 78ba6ccc6..bc90f1342 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php @@ -133,18 +133,16 @@ class Consolidated extends Api /** * Post Derivate * + * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/:field_grid_val + * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/ + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $app_uid {@min 1} {@max 32} * @param string $app_number * @param int $del_index * @param string $field_grid * @param string $field_grid_val * @return array - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/:field_grid_val - * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/ */ public function doPostDerivate($app_uid, $app_number, $del_index, $field_grid, $field_grid_val = '') { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php index f10132042..29e65aeb0 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php @@ -221,10 +221,9 @@ class Dashboard extends Api /** * @url POST - * + * @access protected + * @class AccessControl {@permission PM_DASHBOARD} * @param array $request_data - * - * * @status 201 */ public function doPostDashboard($request_data) @@ -279,11 +278,10 @@ class Dashboard extends Api } /** - * @param array $request_data - * - * * @url POST /owner - * + * @access protected + * @class AccessControl {@permission PM_DASHBOARD} + * @param array $request_data * @status 201 */ public function doPostOwner($request_data) @@ -317,11 +315,10 @@ class Dashboard extends Api } /** - * @param array $request_data - * - * * @url POST /indicator - * + * @access protected + * @class AccessControl {@permission PM_DASHBOARD} + * @param array $request_data * @status 201 */ public function doPostIndicator($request_data) @@ -376,10 +373,10 @@ class Dashboard extends Api /** * Post dashboards configuration by userUid * - * @param array $request_data - * * @url POST /config/ - * + * @access protected + * @class AccessControl {@permission PM_DASHBOARD} + * @param array $request_data */ public function doPostDashboardConfigByUsrUid($request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Department.php b/workflow/engine/src/ProcessMaker/Services/Api/Department.php index 967d91484..697130f86 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Department.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Department.php @@ -103,12 +103,11 @@ class Department extends Api /** * @url POST /:dep_uid/assign-user - * + * @access protected + * @class AccessControl {@permission PM_USERS} * @param string $dep_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 - * */ public function doPostAssignUser($dep_uid, array $request_data) { @@ -181,14 +180,12 @@ class Department extends Api /** * @url POST - * + * @access protected + * @class AccessControl {@permission PM_USERS} * @param array $request_data * @param string $dep_title {@from body} {@min 1} - * * @return array - * * @status 201 - * */ public function doPost($request_data, $dep_title) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php index 3e401eb1c..e524bf878 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php @@ -86,7 +86,8 @@ class EmailServer extends Api /** * @url POST /test-connection - * + * @access protected + * @class AccessControl {@permission PM_SETUP_EMAIL} * @param array $request_data */ public function doPostTestConnection(array $request_data) @@ -104,9 +105,9 @@ class EmailServer extends Api /** * @url POST - * + * @access protected + * @class AccessControl {@permission PM_SETUP_EMAIL} * @param array $request_data - * * @status 201 */ public function doPost(array $request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/File.php b/workflow/engine/src/ProcessMaker/Services/Api/File.php index ff1a94bcf..574f836ff 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/File.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/File.php @@ -12,8 +12,9 @@ use \Luracast\Restler\RestException; class File extends Api { /** - * * @url POST /upload + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param array $request_data */ public function doPostFilesUpload($request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group.php b/workflow/engine/src/ProcessMaker/Services/Api/Group.php index 2b73e904a..e06c8f7cd 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group.php @@ -74,9 +74,9 @@ class Group extends Api /** * @url POST - * + * @access protected + * @class AccessControl {@permission PM_USERS} * @param array $request_data - * * @status 201 */ public function doPost($request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php b/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php index 30281903b..837c74dce 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php @@ -13,10 +13,10 @@ class User extends Api { /** * @url POST /:grp_uid/user - * + * @access protected + * @class AccessControl {@permission PM_USERS} * @param string $grp_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostUser($grp_uid, $request_data) @@ -33,9 +33,9 @@ class User extends Api /** * @url POST /batch-users - * + * @access protected + * @class AccessControl {@permission PM_USERS} * @param array $request_data - * * @status 201 */ public function doPostBatchUsers($request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light.php b/workflow/engine/src/ProcessMaker/Services/Api/Light.php index d5d849b73..c6c96b734 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light.php @@ -967,15 +967,14 @@ class Light extends Api /** * Execute Trigger case * + * @url POST /process/:prj_uid/task/:act_uid/case/:cas_uid/step/:step_uid/execute-trigger/:type + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $prj_uid {@min 1}{@max 32} * @param string $act_uid {@min 1}{@max 32} * @param string $cas_uid {@min 1}{@max 32} * @param string $step_uid {@min 32}{@max 32} * @param string $type {@choice before,after} - * - * @copyright Colosa - Bolivia - * - * @url POST /process/:prj_uid/task/:act_uid/case/:cas_uid/step/:step_uid/execute-trigger/:type */ public function doPutExecuteTriggerCase($prj_uid, $act_uid, $cas_uid, $step_uid, $type) { @@ -1134,7 +1133,8 @@ class Light extends Api /** * @url POST /process/:pro_uid/task/:task_uid/start-case - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $pro_uid {@min 32}{@max 32} * @param string $task_uid {@min 32}{@max 32} */ @@ -1229,7 +1229,8 @@ class Light extends Api /** * @url POST /case/:app_uid/upload/location - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $app_uid { @min 32}{@max 32} * @param float $latitude {@min -90}{@max 90} * @param float $longitude {@min -180}{@max 180} @@ -1271,7 +1272,8 @@ class Light extends Api /** * @url POST /case/:app_uid/download64 - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $app_uid {@min 32}{@max 32} */ public function postDownloadFile($app_uid, $request_data) @@ -1369,7 +1371,8 @@ class Light extends Api /** * @url POST /case/:app_uid/upload - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param $access * @param $refresh * @return mixed @@ -1389,7 +1392,8 @@ class Light extends Api /** * @url POST /case/:app_uid/upload/:app_doc_uid - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param $access * @param $refresh * @return mixed @@ -1409,7 +1413,8 @@ class Light extends Api /** * @url POST /case/:app_uid/claim - * + * @access protected + * @class AccessControl {@permission PM_CASES} * @param $app_uid {@min 1}{@max 32} * @return mixed */ @@ -1500,13 +1505,13 @@ class Light extends Api /** * Post Case Notes * + * @url POST /case/:app_uid/note + * @access protected + * @class AccessControl {@permission PM_CASES} * @param string $app_uid {@min 1}{@max 32} * @param string $noteContent {@min 1}{@max 500} * @param int $sendMail {@choice 1,0} - * * @copyright Colosa - Bolivia - * - * @url POST /case/:app_uid/note */ public function doPostCaseNote($app_uid, $noteContent, $sendMail = 0) { @@ -1591,13 +1596,13 @@ class Light extends Api } /** - * @return stdclass - * @throws RestException - * + * @url POST /reassign/:app_uid/user/:to_usr_uid + * @access protected + * @class AccessControl {@permission PM_REASSIGNCASE, PM_REASSIGNCASE_SUPERVISOR} * @param string $app_uid {@min 1}{@max 32} * @param string $to_usr_uid {@min 1}{@max 32} - * - * @url POST /reassign/:app_uid/user/:to_usr_uid + * @return stdclass + * @throws RestException */ public function reassignCase($app_uid, $to_usr_uid) { @@ -1615,12 +1620,12 @@ class Light extends Api /** * Paused Case * + * @url POST /cases/:app_uid/pause + * @access protected + * @class AccessControl {@permission PM_CASES} + * @param string $app_uid {@min 1}{@max 32} * @return stdclass * @throws RestException - * - * @param string $app_uid {@min 1}{@max 32} - * - * @url POST /cases/:app_uid/pause */ public function pauseCase($app_uid, $request_data) { @@ -1639,12 +1644,12 @@ class Light extends Api /** * Unpaused Case * + * @url POST /cases/:app_uid/unpause + * @access protected + * @class AccessControl {@permission PM_CASES} + * @param string $app_uid {@min 1}{@max 32} * @return stdclass * @throws RestException - * - * @param string $app_uid {@min 1}{@max 32} - * - * @url POST /cases/:app_uid/unpause */ public function unpauseCase($app_uid) { @@ -1664,11 +1669,10 @@ class Light extends Api /** * Cancel Case * - * @param string $cas_uid {@min 1}{@max 32} - * - * @copyright Colosa - Bolivia - * * @url POST /cases/:app_uid/cancel + * @access protected + * @class AccessControl {@permission PM_CASES} + * @param string $cas_uid {@min 1}{@max 32} */ public function doPutCancelCase($app_uid) { @@ -1837,6 +1841,8 @@ class Light extends Api * Get next step * * @url POST /get-next-step/:app_uid + * @access protected + * @class AccessControl {@permission PM_CASES} * @return array */ public function doGetStep($app_uid, $request_data) @@ -1931,8 +1937,12 @@ class Light extends Api } /** - * This function checks if the application uids sent are in the draft list for the specified user + * This function checks if the application uids sent are in the draft list for + * the specified user. + * * @url POST /draft/check + * @access protected + * @class AccessControl {@permission PM_CASES} * @param array $requestData * @return array $response * @throws Exception diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Process.php b/workflow/engine/src/ProcessMaker/Services/Api/Process.php index d8070507d..8aae4c2f2 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Process.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Process.php @@ -63,6 +63,10 @@ class Process extends Api return $response; } + /** + * @access protected + * @class AccessControl {@permission PM_FACTORY} + */ public function post($request_data = null) { defined('SYS_LANG') || define("SYS_LANG", $request_data["lang"]); diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php index a1c33aa4c..f2dcb1403 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php @@ -93,12 +93,12 @@ class Assignee extends Api /** * @url POST /:prjUid/activity/:actUid/assignee - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prjUid {@min 32} {@max 32} * @param string $actUid {@min 32} {@max 32} * @param string $aas_uid {@min 32} {@max 32} * @param string $aas_type {@choice user,group} - * * @status 201 */ public function doPostActivityAssignee($prjUid, $actUid, $aas_uid, $aas_type) @@ -192,12 +192,12 @@ class Assignee extends Api /** * @url POST /:prjUid/activity/:actUid/adhoc-assignee - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prjUid {@min 32} {@max 32} * @param string $actUid {@min 32} {@max 32} * @param string $ada_uid {@min 32} {@max 32} * @param string $ada_type {@choice user,group} - * * @status 201 */ public function doPostActivityAdhocAssignee($prjUid, $actUid, $ada_uid, $ada_type) 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..ed7252d1f 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php @@ -35,7 +35,8 @@ class Step extends Api /** * @url POST /:prj_uid/activity/:act_uid/step - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $act_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data @@ -44,7 +45,6 @@ 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}{@required true} - * * @status 201 */ public function doPostActivityStep( @@ -219,7 +219,8 @@ class Step extends Api /** * @url POST /:prj_uid/activity/:act_uid/step/all - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $act_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data @@ -228,7 +229,6 @@ 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}{@required true} - * * @status 201 */ public function doPostActivityStepAll( 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..81af8c9ef 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 @@ -35,12 +35,12 @@ class Trigger extends Api /** * @url POST /:prj_uid/activity/:act_uid/step/:step_uid/trigger - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $step_uid * @param string $act_uid * @param string $prj_uid * @param StepTriggerPostStructure $request_data - * * @status 201 */ public function doPostActivityStepTrigger($step_uid, $act_uid, $prj_uid, StepTriggerPostStructure $request_data = null) @@ -123,11 +123,11 @@ class Trigger extends Api /** * @url POST /:prj_uid/activity/:act_uid/step/trigger - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $act_uid * @param string $prj_uid * @param StepAssignTaskTriggerPostStructure $request_data - * * @status 201 */ public function doPostActivityStepAssignTaskTrigger($act_uid, $prj_uid, StepAssignTaskTriggerPostStructure $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..750becc0a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php @@ -51,11 +51,11 @@ class CaseScheduler extends Api } /** + * @url POST /:prjUid/case-scheduler + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prjUid {@min 32} {@max 32} * @param CaseSchedulerStructure $request_data - * - * @url POST /:prjUid/case-scheduler - * * @status 201 */ public function doPostProjectCaseScheduler($prjUid, CaseSchedulerStructure $request_data = null) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php index 434bd6e3e..6d1e4b1b6 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php @@ -32,14 +32,14 @@ class CaseTrackerObject extends Api /** * @url POST /:prj_uid/case-tracker/object - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * @param string $cto_type_obj {@from body}{@choice DYNAFORM,INPUT_DOCUMENT,OUTPUT_DOCUMENT}{@required true} * @param string $cto_uid_obj {@from body}{@min 32}{@max 32}{@required true} * @param string $cto_condition {@from body} * @param int $cto_position {@from body}{@min 1} - * * @status 201 */ public function doPostCaseTrackerObject( diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php index 27d57ae9b..5750556d7 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php @@ -55,9 +55,11 @@ class DataBaseConnection extends Api } /** + * @url POST /:prj_uid/database-connection/test + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 1} {@max 32} * @param array $request_data - * * @param string $dbs_type {@from body} {@required true} * @param string $dbs_server {@from body} {@required false} * @param string $dbs_database_name {@from body} {@required false} @@ -66,11 +68,6 @@ class DataBaseConnection extends Api * @param string $dbs_password {@from body} * @param string $dbs_description {@from body} * @return array - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url POST /:prj_uid/database-connection/test */ public function doPostTestDataBaseConnection( $prj_uid, @@ -94,9 +91,11 @@ class DataBaseConnection extends Api } /** + * @url POST /:prj_uid/database-connection + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 1} {@max 32} * @param array $request_data - * * @param string $dbs_type {@from body} {@required true} * @param string $dbs_server {@from body} {@required false} * @param string $dbs_database_name {@from body} {@required false} @@ -105,11 +104,6 @@ class DataBaseConnection extends Api * @param string $dbs_password {@from body} * @param string $dbs_description {@from body} * @return array - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url POST /:prj_uid/database-connection * @status 201 */ public function doPostDataBaseConnection( diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php index cd9dff8d6..a59511fca 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php @@ -39,10 +39,10 @@ class DynaForm extends Api /** * @url POST /:prj_uid/dynaform - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostDynaForm($prj_uid, $request_data) @@ -138,7 +138,8 @@ class DynaForm extends Api /** * @url POST /:prj_uid/dynaform/:dyn_uid/upload-language - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} */ @@ -155,7 +156,8 @@ class DynaForm extends Api /** * @url POST /:prj_uid/dynaform/:dyn_uid/delete-language/:lang - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} */ @@ -189,7 +191,8 @@ class DynaForm extends Api /** * @url POST /:prj_uid/dynaform/:dyn_uid/history - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @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..7efb26b8e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php @@ -65,7 +65,8 @@ class EmailEvent extends Api /** * @url POST /:prj_uid/email-event - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 1} {@max 32} */ public function doPostEmailEvent($prj_uid, array $request_data) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php index 2a31bea36..7bd6012f5 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php @@ -37,11 +37,12 @@ class FilesManager extends Api } /** + * @url POST /:prj_uid/file-manager + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32} {@max 32} * @param ProcessFilesManagerStructurePost $request_data * @param string $prf_content - * - * @url POST /:prj_uid/file-manager */ public function doPostProcessFilesManager($prj_uid, ProcessFilesManagerStructurePost $request_data, $prf_content=null) { @@ -61,10 +62,11 @@ class FilesManager extends Api } /** + * @url POST /:prj_uid/file-manager/:prf_uid/upload + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32} {@max 32} * @param string $prf_uid {@min 32} {@max 32} - * - * @url POST /:prj_uid/file-manager/:prf_uid/upload */ public function doPostProcessFilesManagerUpload($prj_uid, $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..d061eca15 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php @@ -34,10 +34,10 @@ class InputDocument extends Api /** * @url POST /:prj_uid/input-document - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostInputDocument($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..3dc3fc5ef 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php @@ -81,10 +81,10 @@ class MessageEventDefinition extends Api /** * @url POST /:prj_uid/message-event-definition - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostMessageEventDefinition($prj_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 32b47c377..84cca6360 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php @@ -66,10 +66,10 @@ class MessageType extends Api /** * @url POST /:prj_uid/message-type - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostMessageType($prj_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 db199b197..f75278d8b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php @@ -68,11 +68,11 @@ class Variable extends Api /** * @url POST /:prj_uid/message-type/:msgt_uid/variable - * + * @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 - * * @status 201 */ public function doPostMessageTypeVariable($prj_uid, $msgt_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 5e8231b04..184bc27b6 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php @@ -52,10 +52,10 @@ class OutputDocuments extends Api /** * @url POST /:prjUid/output-document - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prjUid {@min 32} {@max 32} * @param OutputDocumentStructure $request_data - * * @status 201 */ public function doPostProjectOutputDocument($prjUid, OutputDocumentStructure $request_data = null) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php index 974f18116..9a67ddbd9 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php @@ -58,9 +58,11 @@ class ProcessPermissions extends Api } /** + * @url POST /:prj_uid/process-permission/ + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_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} @@ -72,13 +74,7 @@ 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 POST /:prj_uid/process-permission/ * @status 201 */ public function doPostProcessPermission( diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php index 1bfe40447..a7f9f8ff1 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php @@ -235,11 +235,11 @@ class ProcessSupervisors extends Api /** * @url POST /:prjUid/process-supervisor - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prjUid {@min 32} {@max 32} * @param string $usr_uid {@min 32} {@max 32} * @param string $pu_type {@choice SUPERVISOR,GROUP_SUPERVISOR} - * * @status 201 */ public function doPostProcessSupervisor($prjUid, $usr_uid, $pu_type) @@ -258,11 +258,11 @@ class ProcessSupervisors extends Api /** * @url POST /:prjUid/process-supervisor/dynaform - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prjUid {@min 32} {@max 32} * @param string $dyn_uid {@min 32} {@max 32} * @param int $pud_position - * * @status 201 */ public function doPostProcessSupervisorDynaform($prjUid, $dyn_uid, $pud_position = null) @@ -281,11 +281,11 @@ class ProcessSupervisors extends Api /** * @url POST /:prjUid/process-supervisor/input-document - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prjUid {@min 32} {@max 32} * @param string $inp_doc_uid {@min 32} {@max 32} * @param int $pui_position - * * @status 201 */ public function doPostProcessSupervisorInputDocument($prjUid, $inp_doc_uid, $pui_position = null) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php index 6d048cdcd..72154adda 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php @@ -70,11 +70,12 @@ class ProjectUsers extends Api } /** + * @url POST /:prj_uid/ws/user/can-start-task + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32} {@max 32} * @param string $act_uid {@min 32} {@max 32} * @param wsUserCanStartTaskStructure $request_data - * - * @url POST /:prj_uid/ws/user/can-start-task */ public function doPostProjectWsUserCanStartTask($prj_uid, $act_uid = null, wsUserCanStartTaskStructure $request_data = 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..30e7865e0 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php @@ -95,20 +95,17 @@ class ReportTable extends Api } /** + * @url POST /:prj_uid/report-table + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 1} {@max 32} * @param array $request_data - * * @param string $rep_tab_name {@from body} * @param string $rep_tab_dsc {@from body} * @param string $rep_tab_connection {@from body} * @param string $rep_tab_type {@from body} {@choice NORMAL,GRID} * @param string $rep_tab_grid {@from body} * @return array - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url POST /:prj_uid/report-table * @status 201 */ public function doPostReportTable( diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php index 3cd658e76..a9b57fc94 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php @@ -81,10 +81,10 @@ class ScriptTask extends Api /** * @url POST /:prj_uid/script-task - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostScriptTask($prj_uid, array $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..2a53031c3 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php @@ -87,10 +87,10 @@ class TimerEvent extends Api /** * @url POST /:prj_uid/timer-event - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostTimerEvent($prj_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 14a5a2501..58616ee39 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php @@ -55,6 +55,9 @@ class Trigger extends Api } /** + * @url POST /:projectUid/trigger + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $projectUid {@min 1} {@max 32} * @param array $request_data * @param string $tri_title {@from body} {@min 1} @@ -63,11 +66,6 @@ class Trigger extends Api * @param string $tri_webbot {@from body} * @param string $tri_param {@from body} * @return array - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url POST /:projectUid/trigger * @status 201 */ public function doPostTrigger($projectUid, $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..0735963c2 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php @@ -67,12 +67,12 @@ class TriggerWizard extends Api /** * @url POST /:prj_uid/trigger-wizard/:lib_name/:fn_name - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param string $lib_name * @param string $fn_name * @param array $request_data - * * @status 201 */ public function doPostTriggerWizard($prj_uid, $lib_name, $fn_name, $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 b86f00e14..0321079cd 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php @@ -49,10 +49,10 @@ class Variable extends Api /** * @url POST /:prj_uid/process-variable - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostVariable($prj_uid, $request_data) @@ -110,7 +110,8 @@ class Variable extends Api /** * @url POST /:prj_uid/process-variable/:var_name/execute-query - * + * @access protected + * @class AccessControl {@permission PM_FACTORY, PM_CASES} * @param string $prj_uid {@min 32}{@max 32} * @param string $var_name * @param array $request_data @@ -132,7 +133,8 @@ class Variable extends Api /** * @url POST /:prj_uid/process-variable/:var_name/execute-query-suggest - * + * @access protected + * @class AccessControl {@permission PM_FACTORY, PM_CASES} * @param string $prj_uid {@min 32}{@max 32} * @param string $var_name * @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..3dd31a800 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php @@ -72,10 +72,10 @@ class WebEntry extends Api /** * @url POST /:prj_uid/web-entry - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostWebEntry($prj_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..29a8cec15 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php @@ -89,11 +89,10 @@ class WebEntryEvent extends Api /** * @url POST /:prj_uid/web-entry-event - * @class AccessControl {@permission PM_FACTORY} - * + * @access protected + * @class AccessControl {@permission PM_FACTORY} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * * @status 201 */ public function doPostWebEntryEvent($prj_uid, array $request_data) From e188867c36f903db36319702c7863402f613ee6b Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Thu, 12 Oct 2017 08:32:30 -0400 Subject: [PATCH 03/15] HOR-3968 --- workflow/engine/src/ProcessMaker/Services/Api/Process.php | 2 ++ 1 file changed, 2 insertions(+) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Process.php b/workflow/engine/src/ProcessMaker/Services/Api/Process.php index 8aae4c2f2..29481f6ff 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Process.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Process.php @@ -66,6 +66,8 @@ class Process extends Api /** * @access protected * @class AccessControl {@permission PM_FACTORY} + * @param array $request_data + * @return array */ public function post($request_data = null) { From 3584cc2975a91bd22d4b738e5054ff7773cd6b02 Mon Sep 17 00:00:00 2001 From: davidcallizaya Date: Fri, 13 Oct 2017 10:59:18 -0400 Subject: [PATCH 04/15] 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 4681ebc3461876e744af261a40aaaa584886f44d Mon Sep 17 00:00:00 2001 From: Paula Quispe Date: Tue, 10 Oct 2017 16:29:36 -0400 Subject: [PATCH 05/15] HOR-3713 --- .../src/ProcessMaker/Services/Api/Cases.php | 9 +++--- .../Services/Api/Cases/InputDocument.php | 2 ++ .../Services/Api/Cases/OutputDocument.php | 2 ++ .../Services/Api/Cases/Variable.php | 2 ++ .../src/ProcessMaker/Services/Api/Catalog.php | 20 ------------ .../ProcessMaker/Services/Api/Dashboard.php | 6 ++++ .../ProcessMaker/Services/Api/Department.php | 4 +++ .../ProcessMaker/Services/Api/EmailServer.php | 2 ++ .../src/ProcessMaker/Services/Api/Group.php | 2 ++ .../ProcessMaker/Services/Api/Group/User.php | 2 ++ .../src/ProcessMaker/Services/Api/Light.php | 10 +++--- .../Services/Api/Light/NotificationDevice.php | 6 ++-- .../Api/Project/Activity/Assignee.php | 4 +++ .../Services/Api/Project/Activity/Step.php | 2 ++ .../Api/Project/Activity/Step/Trigger.php | 4 +++ .../Services/Api/Project/CaseScheduler.php | 3 ++ .../Api/Project/CaseTrackerObject.php | 2 ++ .../Api/Project/DataBaseConnection.php | 9 +++--- .../Services/Api/Project/DynaForm.php | 2 ++ .../Services/Api/Project/EmailEvent.php | 4 +++ .../Services/Api/Project/Event.php | 12 +++---- .../Services/Api/Project/FilesManager.php | 12 ++++--- .../Services/Api/Project/InputDocument.php | 2 ++ .../Api/Project/MessageEventDefinition.php | 2 ++ .../Services/Api/Project/MessageType.php | 2 ++ .../Api/Project/MessageType/Variable.php | 4 ++- .../Services/Api/Project/OutputDocuments.php | 3 ++ .../Api/Project/ProcessPermissions.php | 9 +++--- .../Api/Project/ProcessSupervisors.php | 6 ++++ .../Services/Api/Project/ReportTable.php | 8 ++--- .../Services/Api/Project/ScriptTask.php | 2 ++ .../Services/Api/Project/TimerEvent.php | 2 ++ .../Services/Api/Project/Trigger.php | 8 ++--- .../Services/Api/Project/Variable.php | 2 ++ .../Services/Api/Project/WebEntry.php | 2 ++ .../Services/Api/Project/WebEntryEvent.php | 1 + .../ProcessMaker/Services/Api/Role/User.php | 2 +- .../src/ProcessMaker/Services/Api/Test2.php | 31 ------------------- .../src/ProcessMaker/Services/Api/Test3.php | 23 -------------- 39 files changed, 111 insertions(+), 119 deletions(-) delete mode 100644 workflow/engine/src/ProcessMaker/Services/Api/Test2.php delete mode 100644 workflow/engine/src/ProcessMaker/Services/Api/Test3.php diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php index 47818ac73..3ab0e9662 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php @@ -924,13 +924,12 @@ class Cases extends Api /** * Delete Case + * @url DELETE /:cas_uid + * + * @access protected + * @class AccessControl {@permission PM_CASES} * * @param string $cas_uid {@min 1}{@max 32} - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url DELETE /:cas_uid */ public function doDeleteCase($cas_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php index 45983547b..db243a1da 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php @@ -77,6 +77,8 @@ class InputDocument extends Api /** * @url DELETE /:app_uid/:del_index/input-document/:app_doc_uid + * @access protected + * @class AccessControl {@permission PM_CASES} * * @param string $app_uid {@min 32}{@max 32} * @param int $del_index {@min 1} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php index 4977f964e..13a3dfeea 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php @@ -117,6 +117,8 @@ class OutputDocument extends Api /** * @url DELETE /:app_uid/output-document/:app_doc_uid + * @access protected + * @class AccessControl {@permission PM_CASES} * * @param string $app_uid {@min 32}{@max 32} * @param string $app_doc_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php index 61620f006..ae007ccd3 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php @@ -119,6 +119,8 @@ class Variable extends Api /** * @url DELETE /:app_uid/:del_index/variable/:var_name + * @access protected + * @class AccessControl {@permission PM_CASES} * * @param string $app_uid {@min 32}{@max 32} * @param int $del_index {@min 1} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php index 1e9fd1bcd..a1165d14a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php @@ -81,25 +81,5 @@ class Catalog extends Api throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage())); } } - - /** - * @url DELETE /:cat_uid/:cat_type - * - * @param string $cat_uid {@min 32}{@max 32} - * @param string $cat_type {@min 32}{@max 32} - * - * @author Marco Antonio Nina - * @copyright Colosa - Bolivia - */ - public function doDelete($cat_uid, $cat_type) - { - try { - $catalog = new \ProcessMaker\BusinessModel\Catalog(); - - $arrayData = $catalog->delete($cat_uid, $cat_type); - } catch (\Exception $e) { - throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage())); - } - } } diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php index f10132042..52af415d1 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php @@ -262,6 +262,8 @@ class Dashboard extends Api /** * @url DELETE /:das_uid + * @access protected + * @class AccessControl {@permission PM_DASHBOARD} * * @param string $das_uid {@min 32}{@max 32} * @@ -300,6 +302,8 @@ class Dashboard extends Api /** * @url DELETE /:das_uid/owner/:owner_uid + * @access protected + * @class AccessControl {@permission PM_DASHBOARD} * * @param string $das_uid {@min 32}{@max 32} * @param string $owner_uid {@min 32}{@max 32} @@ -358,6 +362,8 @@ class Dashboard extends Api /** * @url DELETE /indicator/:ind_uid + * @access protected + * @class AccessControl {@permission PM_DASHBOARD} * * @param string $ind_uid {@min 32}{@max 32} * diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Department.php b/workflow/engine/src/ProcessMaker/Services/Api/Department.php index 967d91484..4cfb2507b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Department.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Department.php @@ -123,6 +123,8 @@ class Department extends Api /** * @url DELETE /:dep_uid/unassign-user/:usr_uid + * @access protected + * @class AccessControl {@permission PM_USERS} * * @param string $dep_uid {@min 1}{@max 32} * @param string $usr_uid {@min 1}{@max 32} @@ -221,6 +223,8 @@ class Department extends Api /** * @url DELETE /:dep_uid + * @access protected + * @class AccessControl {@permission PM_USERS} * * @param string $dep_uid {@min 1}{@max 32} * diff --git a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php index 3e401eb1c..2fbb5dfd5 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php @@ -141,6 +141,8 @@ class EmailServer extends Api /** * @url DELETE /:mess_uid + * @access protected + * @class AccessControl {@permission PM_SETUP_EMAIL} * * @param string $mess_uid {@min 32}{@max 32} * diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group.php b/workflow/engine/src/ProcessMaker/Services/Api/Group.php index 2b73e904a..90d5b04a9 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group.php @@ -115,6 +115,8 @@ class Group extends Api /** * @url DELETE /:grp_uid + * @access protected + * @class AccessControl {@permission PM_USERS} * * @param string $grp_uid {@min 32}{@max 32} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php b/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php index 30281903b..a9f81420f 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php @@ -63,6 +63,8 @@ class User extends Api /** * @url DELETE /:grp_uid/user/:usr_uid + * @access protected + * @class AccessControl {@permission PM_USERS} * * @param string $grp_uid {@min 32}{@max 32} * @param string $usr_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light.php b/workflow/engine/src/ProcessMaker/Services/Api/Light.php index d5d849b73..89d234a69 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light.php @@ -796,24 +796,24 @@ class Light extends Api /** * Delete case * - * @copyright Colosa - Bolivia - * * @url DELETE /case/:app_uid/delete + * @access protected + * @class AccessControl {@permission PM_CASES} * * @param string $app_uid {@min 32}{@max 32} */ public function doDeleteCases($app_uid) { try { - $oCase = new ClassesCases(); - $oCase->removeCase($app_uid); + $usr_uid = $this->getUserId(); + $cases = new BusinessModelCases(); + $cases->deleteCase($app_uid, $usr_uid); $result = array( "message" => G::LoadTranslation("ID_COMMAND_EXECUTED_SUCCESSFULLY") ); } catch (Exception $e) { throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage())); } - return $result; } diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php b/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php index 8f8b8981a..d7c1fbf10 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php @@ -78,14 +78,14 @@ class NotificationDevice extends Api } /** + * @url DELETE /notification/:dev_uid + * This actions is executed in the logout action + * * Delete record device with dev_uid and usr_uid * * @param string $dev_uid {@min 32}{@max 32} * - * @author Ronald Quenta * @return array - * - * @url DELETE /notification/:dev_uid */ public function deleteDevice($dev_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php index a1c33aa4c..9e2b4863f 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php @@ -112,6 +112,8 @@ class Assignee extends Api /** * @url DELETE /:prjUid/activity/:actUid/assignee/:aasUid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prjUid {@min 32} {@max 32} * @param string $actUid {@min 32} {@max 32} @@ -211,6 +213,8 @@ class Assignee extends Api /** * @url DELETE /:prjUid/activity/:actUid/adhoc-assignee/:adaUid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prjUid {@min 32} {@max 32} * @param string $actUid {@min 32} {@max 32} 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..3f39b3e56 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php @@ -109,6 +109,8 @@ class Step extends Api /** * @url DELETE /:prj_uid/activity/:act_uid/step/:step_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $step_uid {@min 32}{@max 32} * @param string $act_uid {@min 32}{@max 32} 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..567183448 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 @@ -80,6 +80,8 @@ class Trigger extends Api /** * @url DELETE /:prj_uid/activity/:act_uid/step/:step_uid/trigger/:tri_uid/:type + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $tri_uid * @param string $step_uid @@ -166,6 +168,8 @@ class Trigger extends Api /** * @url DELETE /:prj_uid/activity/:act_uid/step/trigger/:tri_uid/:type + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $tri_uid * @param string $act_uid diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php index fb766c4a5..6d8cd209a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php @@ -100,6 +100,9 @@ class CaseScheduler extends Api /** * @url DELETE /:prjUid/case-scheduler/:schUid + * @access protected + * @class AccessControl {@permission PM_FACTORY} + * * @param string $prjUid {@min 32} {@max 32} * @param string $schUid {@min 32} {@max 32} * diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php index 434bd6e3e..8bb6f35a3 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php @@ -94,6 +94,8 @@ class CaseTrackerObject extends Api /** * @url DELETE /:prj_uid/case-tracker/object/:cto_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $cto_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php index 27d57ae9b..32460dc4a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php @@ -173,14 +173,13 @@ class DataBaseConnection extends Api } /** + * @url DELETE /:prj_uid/database-connection/:dbs_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 1} {@max 32} * @param string $dbs_uid {@min 1} {@max 32} * @return void - * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url DELETE /:prj_uid/database-connection/:dbs_uid */ public function doDeleteDataBaseConnection($prj_uid, $dbs_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..d6dbea965 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php @@ -83,6 +83,8 @@ class DynaForm extends Api /** * @url DELETE /:prj_uid/dynaform/:dyn_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php index 712bf2834..0d5594688 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php @@ -96,6 +96,8 @@ class EmailEvent extends Api /** * @url DELETE /:prj_uid/email-event/:email_event_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prj_uid {@min 32}{@max 32} * @param string $email_event_uid {@min 32}{@max 32} @@ -111,6 +113,8 @@ class EmailEvent extends Api /** * @url DELETE /:prj_uid/email-event/by-event/:act_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prj_uid {@min 32}{@max 32} * @param string $act_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php index d1e5efbfe..1580600a8 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php @@ -201,17 +201,13 @@ class Event extends Api } /** + * @url DELETE /:prj_uid/event/:evn_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 1} {@max 32} * @param string $evn_uid {@min 1} {@max 32} * @return void - * - * @access public - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @return void - * - * @url DELETE /:prj_uid/event/:evn_uid */ public function doDeleteEvent($prj_uid, $evn_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php index 2a31bea36..a93ae4e99 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php @@ -103,10 +103,12 @@ class FilesManager extends Api } /** + * @url DELETE /:prj_uid/file-manager/:prf_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 32} {@max 32} * @param string $prf_uid {@min 32} {@max 32} - * - * @url DELETE /:prj_uid/file-manager/:prf_uid */ public function doDeleteProcessFilesManager($prj_uid, $prf_uid) { @@ -137,10 +139,12 @@ class FilesManager extends Api } /** + * @url DELETE /:prj_uid/file-manager/folder + * @access protected + * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 32} {@max 32} * @param string $path - * - * @url DELETE /:prj_uid/file-manager/folder */ public function doDeleteFolderProcessFilesManager($prj_uid, $path) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php index 1ed147b51..3cec5d1ae 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php @@ -79,6 +79,8 @@ class InputDocument extends Api /** * @url DELETE /:prj_uid/input-document/:inp_doc_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $inp_doc_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php index b6ddc236b..83a8626cb 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php @@ -118,6 +118,8 @@ class MessageEventDefinition extends Api /** * @url DELETE /:prj_uid/message-event-definition/:msged_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prj_uid {@min 32}{@max 32} * @param string $msged_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php index 32b47c377..51fc0c5c2 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php @@ -103,6 +103,8 @@ class MessageType extends Api /** * @url DELETE /: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} 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..6e74d7dcb 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php @@ -106,7 +106,9 @@ class Variable extends Api } /** - * @url DELETE /:prj_uid/message-type/:msgt_uid/variable/:msgtv_uid + * @url DELETE /:prj_uid/user/message-type/:msgt_uid/variable/:msgtv_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prj_uid {@min 32}{@max 32} * @param string $msgt_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..c629045de 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php @@ -95,6 +95,9 @@ class OutputDocuments extends Api /** * @url DELETE /:prjUid/output-document/:outputDocumentUid + * @access protected + * @class AccessControl {@permission PM_FACTORY} + * * @param string $prjUid {@min 32} {@max 32} * @param string $outputDocumentUid {@min 32} {@max 32} * diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php index 974f18116..d9f25ee59 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php @@ -165,15 +165,14 @@ class ProcessPermissions extends Api } /** + * @url DELETE /:prj_uid/process-permission/:ob_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 1} {@max 32} * @param string $ob_uid {@min 1} {@max 32} * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * * @return void - * - * @url DELETE /:prj_uid/process-permission/:ob_uid */ public function doDeleteProcessPermission($prj_uid, $ob_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..a7e365804 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php @@ -304,6 +304,8 @@ class ProcessSupervisors extends Api /** * @url DELETE /:prjUid/process-supervisor/:puUid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prjUid {@min 32} {@max 32} * @param string $puUid {@min 32} {@max 32} @@ -322,6 +324,8 @@ class ProcessSupervisors extends Api /** * @url DELETE /:prjUid/process-supervisor/dynaform/:pudUid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prjUid {@min 32} {@max 32} * @param string $pudUid {@min 32} {@max 32} @@ -340,6 +344,8 @@ class ProcessSupervisors extends Api /** * @url DELETE /:prjUid/process-supervisor/input-document/:puiUid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prjUid {@min 32} {@max 32} * @param string $puiUid {@min 32} {@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php index 7d1894259..a5ccc8565 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php @@ -161,14 +161,14 @@ class ReportTable extends Api } /** + * @url DELETE /:prj_uid/report-table/:rep_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 1} {@max 32} * @param string $rep_uid {@min 1} {@max 32} * @return void * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url DELETE /:prj_uid/report-table/:rep_uid */ public function doDeleteReportTable($prj_uid, $rep_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php index 3cd658e76..86cfa86e2 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php @@ -118,6 +118,8 @@ class ScriptTask extends Api /** * @url DELETE /:prj_uid/script-task/:scrtas_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prj_uid {@min 32}{@max 32} * @param string $scrtas_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php index 62d40a8ce..86e5a79c6 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php @@ -128,6 +128,8 @@ class TimerEvent extends Api /** * @url DELETE /:prj_uid/timer-event/:tmrevn_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prj_uid {@min 32}{@max 32} * @param string $tmrevn_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php index 14a5a2501..2facf1ed5 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php @@ -109,14 +109,14 @@ class Trigger extends Api } /** + * @url DELETE /:projectUid/trigger/:triggerUid + * @access protected + * @class AccessControl {@permission PM_FACTORY} + * * @param string $projectUid {@min 1} {@max 32} * @param string $triggerUid {@min 1} {@max 32} * @return void * - * @author Brayan Pereyra (Cochalo) - * @copyright Colosa - Bolivia - * - * @url DELETE /:projectUid/trigger/:triggerUid */ public function doDeleteTrigger($projectUid, $triggerUid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php index b86f00e14..cddc8e44b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php @@ -93,6 +93,8 @@ class Variable extends Api /** * @url DELETE /:prj_uid/process-variable/:var_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prj_uid {@min 32}{@max 32} * @param string $var_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php index 06c0f0490..cb5f5a745 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php @@ -111,6 +111,8 @@ class WebEntry extends Api /** * @url DELETE /:prj_uid/web-entry/:we_uid + * @access protected + * @class AccessControl {@permission PM_FACTORY} * * @param string $prj_uid {@min 32}{@max 32} * @param string $we_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php index 7a0402055..2f4dda274 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php @@ -129,6 +129,7 @@ class WebEntryEvent extends Api /** * @url DELETE /:prj_uid/web-entry-event/:wee_uid + * @access protected * @class AccessControl {@permission PM_FACTORY} * * @param string $prj_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Role/User.php b/workflow/engine/src/ProcessMaker/Services/Api/Role/User.php index eb5ba4fad..4c3c8f120 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Role/User.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Role/User.php @@ -72,9 +72,9 @@ class User extends Api } /** + * @url DELETE /:rol_uid/user/:usr_uid * @access protected * @class AccessControl {@permission PM_USERS} - * @url DELETE /:rol_uid/user/:usr_uid * * @param string $rol_uid {@min 32}{@max 32} * @param string $usr_uid {@min 32}{@max 32} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Test2.php b/workflow/engine/src/ProcessMaker/Services/Api/Test2.php deleted file mode 100644 index a6a412cdb..000000000 --- a/workflow/engine/src/ProcessMaker/Services/Api/Test2.php +++ /dev/null @@ -1,31 +0,0 @@ - true); - } -} - From d998ce391f6a51a8940ea08351cf467f5e9b2e12 Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Wed, 18 Oct 2017 10:47:40 -0400 Subject: [PATCH 06/15] HOR-3968 --- .../src/ProcessMaker/Services/Api/Cases.php | 38 +++-- .../Services/Api/Cases/InputDocument.php | 13 +- .../Services/Api/Cases/OutputDocument.php | 15 +- .../Services/Api/Cases/Variable.php | 10 +- .../src/ProcessMaker/Services/Api/Catalog.php | 9 +- .../Services/Api/Consolidated.php | 6 +- .../ProcessMaker/Services/Api/Dashboard.php | 28 +++- .../ProcessMaker/Services/Api/Department.php | 22 ++- .../ProcessMaker/Services/Api/EmailServer.php | 14 +- .../src/ProcessMaker/Services/Api/File.php | 6 +- .../src/ProcessMaker/Services/Api/Group.php | 8 +- .../ProcessMaker/Services/Api/Group/User.php | 18 ++- .../src/ProcessMaker/Services/Api/Light.php | 132 ++++++++++++++---- .../src/ProcessMaker/Services/Api/Process.php | 7 +- .../Api/Project/Activity/Assignee.php | 20 ++- .../Services/Api/Project/Activity/Step.php | 20 ++- .../Api/Project/Activity/Step/Trigger.php | 20 ++- .../Services/Api/Project/CaseScheduler.php | 10 +- .../Api/Project/CaseTrackerObject.php | 10 +- .../Api/Project/DataBaseConnection.php | 18 ++- .../Services/Api/Project/DynaForm.php | 34 +++-- .../Services/Api/Project/EmailEvent.php | 4 +- .../Services/Api/Project/FilesManager.php | 16 ++- .../Services/Api/Project/InputDocument.php | 10 +- .../Api/Project/MessageEventDefinition.php | 10 +- .../Services/Api/Project/MessageType.php | 10 +- .../Api/Project/MessageType/Variable.php | 8 +- .../Services/Api/Project/OutputDocuments.php | 10 +- .../Api/Project/ProcessPermissions.php | 10 +- .../Api/Project/ProcessSupervisors.php | 30 ++-- .../Services/Api/Project/ProjectUsers.php | 8 +- .../Services/Api/Project/ReportTable.php | 10 +- .../Services/Api/Project/ScriptTask.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 | 30 +++- .../Services/Api/Project/WebEntry.php | 10 +- .../Services/Api/Project/WebEntryEvent.php | 10 +- 39 files changed, 498 insertions(+), 176 deletions(-) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php index 9166322e7..b6e1e1a1e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php @@ -756,12 +756,18 @@ class Cases extends Api } /** + * Start a new case and assign the logged-in user to work on the initial task + * in the case. Note that the logged-in user must be in the pool of assigned + * users for the initial task. + * * @url POST - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $pro_uid {@from body} {@min 32}{@max 32} * @param string $tas_uid {@from body} {@min 32}{@max 32} * @param array $variables {@from body} + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPostCase($pro_uid, $tas_uid, $variables = null) { @@ -776,13 +782,23 @@ class Cases extends Api } /** + * Creates a new case. It is similar to POST /cases, but it impersonates the + * session variables, so it is more robust than POST /cases. Note that the + * specified user to work on the case must be assigned to the pool of users + * for the initial task. Also note that the new case's status will be set to + * "DRAFT", not "TO_DO". If wishing to change the new case's status to "TO_DO", + * then create the following trigger in the process and use + * PUT /cases/{app_uid}/execute-trigger/{tri_uid} to execute it. + * * @url POST /impersonate - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $pro_uid {@from body} {@min 32}{@max 32} * @param string $usr_uid {@from body} {@min 32}{@max 32} * @param string $tas_uid {@from body} {@min 32}{@max 32} * @param array $variables {@from body} + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPostCaseImpersonate($pro_uid, $usr_uid, $tas_uid, $variables = null) { @@ -1095,14 +1111,18 @@ class Cases extends Api } /** - * Put Case Variables + * Create a new case note for a given case. Note that only users who are + * currently assigned to work on the case or have Process Permissions to + * access case notes may create a case note. * * @url POST /:app_uid/note - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $app_uid {@min 1}{@max 32} * @param string $note_content {@min 1}{@max 500} * @param int $send_mail {@choice 1,0} + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPostCaseNote($app_uid, $note_content, $send_mail = 0) { @@ -1231,9 +1251,11 @@ class Cases extends Api * Mark a task process as a bookmark * * @url POST /bookmark/:tas_uid + * + * @param string $tas_uid {@min 32}{@max 32} + * * @access protected * @class AccessControl {@permission PM_CASES} - * @param string $tas_uid {@min 32}{@max 32} */ public function doPostBookmarkStartCase($tas_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php index e413e2896..03da8e24b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php @@ -56,8 +56,6 @@ class InputDocument extends Api } /** - * @access protected - * @class AccessControl {@className \ProcessMaker\Services\Api\Cases} * @url GET /:app_uid/input-document/:app_doc_uid/file * * @param string $app_uid {@min 32}{@max 32} @@ -96,13 +94,20 @@ class InputDocument extends Api } /** + * Uploads a new Input Document file to a specified case. Note that the + * logged-in user must either be currently assigned to work on the case or a + * Process Supervisor with permissions to access the Input Document; otherwise, + * this endpoint returns an HTTP status code of 302. + * * @url POST /:app_uid/input-document - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $app_uid { @min 32}{@max 32} * @param string $tas_uid {@min 32}{@max 32} * @param string $app_doc_comment * @param string $inp_doc_uid {@min 32}{@max 32} + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPostInputDocument($app_uid, $tas_uid, $app_doc_comment, $inp_doc_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php index 65bc75ff8..04dfe4296 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php @@ -133,12 +133,23 @@ class OutputDocument extends Api } /** + * Generate a specified Output Document for a given case, meaning that a PDF, + * a DOC or both files (depending on options selected in the definition of the + * Output Document) will be created, inserting any variables in the template. + * If the Output Document already exists, then it will be regenerated. + * If versioning is enabled, then the regenerated files will be given a new + * version number and document index number, but if versioning is NOT enabled, + * then the existing files will be overwritten with the same version number + * and document index number. + * * @url POST /:app_uid/:del_index/output-document/:out_doc_uid - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $app_uid {@min 32}{@max 32} * @param int $del_index {@min 1} * @param string $out_doc_uid {@min 32}{@max 32} + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPostOutputDocument($app_uid, $del_index, $out_doc_uid) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php index 4884aa284..befc33e80 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php @@ -78,14 +78,18 @@ class Variable extends Api } /** + * Create a variable in a case, meaning the variable is instantiated in the case. + * * @url POST /:app_uid/:del_index/variable/:var_name - * @access protected - * @class AccessControl {@permission PM_CASES} + * @status 201 + * * @param string $app_uid {@min 32}{@max 32} * @param int $del_index {@min 1} * @param string $var_name * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPostVariable($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 d445c1a8c..d8776f2fd 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php @@ -38,11 +38,16 @@ class Catalog extends Api } /** + * Deprecated. + * * @url POST + * @status 201 + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} - * @param array $request_data - * @status 201 + * @deprecated The method has been deprecated. */ public function doPost($request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php index bc90f1342..8874eb82e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php @@ -135,14 +135,16 @@ class Consolidated extends Api * * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/:field_grid_val * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/ - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $app_uid {@min 1} {@max 32} * @param string $app_number * @param int $del_index * @param string $field_grid * @param string $field_grid_val * @return array + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPostDerivate($app_uid, $app_number, $del_index, $field_grid, $field_grid_val = '') { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php index 29e65aeb0..45a8a254d 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php @@ -220,11 +220,15 @@ class Dashboard extends Api } /** + * Create dashboard. + * * @url POST + * @status 201 + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} - * @param array $request_data - * @status 201 */ public function doPostDashboard($request_data) { @@ -278,11 +282,15 @@ class Dashboard extends Api } /** + * Create owner + * * @url POST /owner + * @status 201 + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} - * @param array $request_data - * @status 201 */ public function doPostOwner($request_data) { @@ -315,11 +323,15 @@ class Dashboard extends Api } /** + * Create indicator. + * * @url POST /indicator + * @status 201 + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} - * @param array $request_data - * @status 201 */ public function doPostIndicator($request_data) { @@ -374,9 +386,11 @@ class Dashboard extends Api * Post dashboards configuration by userUid * * @url POST /config/ + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} - * @param array $request_data */ public function doPostDashboardConfigByUsrUid($request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Department.php b/workflow/engine/src/ProcessMaker/Services/Api/Department.php index 697130f86..8403388a7 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Department.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Department.php @@ -102,12 +102,18 @@ class Department extends Api } /** + * Assign a user to a specified department in version 3.0 and later. If the + * user is already a member of another department, the user will be transfered + * to the specified department. + * * @url POST /:dep_uid/assign-user - * @access protected - * @class AccessControl {@permission PM_USERS} + * @status 201 + * * @param string $dep_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_USERS} */ public function doPostAssignUser($dep_uid, array $request_data) { @@ -179,13 +185,17 @@ class Department extends Api } /** + * Create a new department. + * * @url POST - * @access protected - * @class AccessControl {@permission PM_USERS} + * @status 201 + * * @param array $request_data * @param string $dep_title {@from body} {@min 1} * @return array - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_USERS} */ public function doPost($request_data, $dep_title) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php index e524bf878..573e97a4e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php @@ -85,10 +85,14 @@ class EmailServer extends Api } /** + * Test connection. + * * @url POST /test-connection + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_SETUP_EMAIL} - * @param array $request_data */ public function doPostTestConnection(array $request_data) { @@ -104,11 +108,15 @@ class EmailServer extends Api } /** + * Create email server. + * * @url POST + * @status 201 + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_SETUP_EMAIL} - * @param array $request_data - * @status 201 */ public function doPost(array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/File.php b/workflow/engine/src/ProcessMaker/Services/Api/File.php index 574f836ff..ca1d1593a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/File.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/File.php @@ -12,10 +12,14 @@ use \Luracast\Restler\RestException; class File extends Api { /** + * Upload file. + * * @url POST /upload + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_FACTORY} - * @param array $request_data */ public function doPostFilesUpload($request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group.php b/workflow/engine/src/ProcessMaker/Services/Api/Group.php index e06c8f7cd..3e7b3bf3a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group.php @@ -73,11 +73,15 @@ class Group extends Api } /** + * Create a new group. + * * @url POST + * @status 201 + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_USERS} - * @param array $request_data - * @status 201 */ public function doPost($request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php b/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php index 837c74dce..a25d45cbf 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php @@ -12,12 +12,16 @@ use \Luracast\Restler\RestException; class User extends Api { /** + * Assign a user to a specified group. + * * @url POST /:grp_uid/user - * @access protected - * @class AccessControl {@permission PM_USERS} + * @status 201 + * * @param string $grp_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_USERS} */ public function doPostUser($grp_uid, $request_data) { @@ -32,11 +36,15 @@ class User extends Api } /** + * Assign a group of users to a specified group or groups. + * * @url POST /batch-users + * @status 201 + * + * @param array $request_data + * * @access protected * @class AccessControl {@permission PM_USERS} - * @param array $request_data - * @status 201 */ public function doPostBatchUsers($request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light.php b/workflow/engine/src/ProcessMaker/Services/Api/Light.php index c6c96b734..f3eb5bf2f 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light.php @@ -968,13 +968,15 @@ class Light extends Api * Execute Trigger case * * @url POST /process/:prj_uid/task/:act_uid/case/:cas_uid/step/:step_uid/execute-trigger/:type - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $prj_uid {@min 1}{@max 32} * @param string $act_uid {@min 1}{@max 32} * @param string $cas_uid {@min 1}{@max 32} * @param string $step_uid {@min 32}{@max 32} * @param string $type {@choice before,after} + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPutExecuteTriggerCase($prj_uid, $act_uid, $cas_uid, $step_uid, $type) { @@ -1132,11 +1134,18 @@ class Light extends Api } /** + * Starts a new case and assigns the logged-in user to work on the initial task + * in the case. Note that the logged-in user must be in the pool of assigned + * users of the initial task. Also note that the new case's status will be + * set to "DRAFT", not "TO_DO". + * * @url POST /process/:pro_uid/task/:task_uid/start-case - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $pro_uid {@min 32}{@max 32} * @param string $task_uid {@min 32}{@max 32} + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function postStartCase($pro_uid, $task_uid) { @@ -1228,12 +1237,17 @@ class Light extends Api } /** + * Generates a Google Maps .jpg image file for a case. This image can be found + * in the Documents section under the Home tab. + * * @url POST /case/:app_uid/upload/location - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $app_uid { @min 32}{@max 32} * @param float $latitude {@min -90}{@max 90} * @param float $longitude {@min -180}{@max 180} + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function postInputDocumentLocation($app_uid, $latitude, $longitude) { @@ -1271,10 +1285,14 @@ class Light extends Api } /** + * Generates a base64 string of a file. + * * @url POST /case/:app_uid/download64 + * + * @param string $app_uid {@min 32}{@max 32} + * * @access protected * @class AccessControl {@permission PM_CASES} - * @param string $app_uid {@min 32}{@max 32} */ public function postDownloadFile($app_uid, $request_data) { @@ -1370,12 +1388,24 @@ class Light extends Api } /** + * Creates new case file record(s) in a specified case. These case files can + * be attached files (used by File controls), Input Document files, or Output Document + * files in version 1.0.1.8 and later. In version 1.0.1.7 and earlier, the case + * files can only be attached files. (Note that case files are known as AppDocuments + * in ProcessMaker). This endpoint adds new record(s) to the APP_DOCUMENT table + * and stores their file name(s) in the CONTENT table in the database. It returns + * the generated case file ID and version number for each file. This information + * can then be used to call the POST /light/case/{app_uid}/upload/{app_doc_uid} + * endpoint to upload each file. + * * @url POST /case/:app_uid/upload - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param $access * @param $refresh * @return mixed + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function uidUploadFiles($app_uid, $request_data) { @@ -1391,12 +1421,24 @@ class Light extends Api } /** + * Creates new case file record(s) in a specified case. These case files can + * be attached files (used by File controls), Input Document files, or Output Document + * files in version 1.0.1.8 and later. In version 1.0.1.7 and earlier, the case + * files can only be attached files. (Note that case files are known as AppDocuments + * in ProcessMaker). This endpoint adds new record(s) to the APP_DOCUMENT table + * and stores their file name(s) in the CONTENT table in the database. It returns + * the generated case file ID and version number for each file. This information + * can then be used to call the POST /light/case/{app_uid}/upload/{app_doc_uid} + * endpoint to upload each file. + * * @url POST /case/:app_uid/upload/:app_doc_uid - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param $access * @param $refresh * @return mixed + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function documentUploadFiles($app_uid, $app_doc_uid, $request_data) { @@ -1412,11 +1454,15 @@ class Light extends Api } /** + * Assigns the user logged-in to an unassigned case. + * * @url POST /case/:app_uid/claim - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param $app_uid {@min 1}{@max 32} * @return mixed + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function claimCaseUser($app_uid) { @@ -1503,15 +1549,18 @@ class Light extends Api } /** - * Post Case Notes + * Creates a new case note for a given case. Note that only users who are + * currently assigned to work on the case or have Process Permissions to access + * case notes may create a case note. * * @url POST /case/:app_uid/note - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $app_uid {@min 1}{@max 32} * @param string $noteContent {@min 1}{@max 500} * @param int $sendMail {@choice 1,0} - * @copyright Colosa - Bolivia + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doPostCaseNote($app_uid, $noteContent, $sendMail = 0) { @@ -1596,13 +1645,18 @@ class Light extends Api } /** + * Reassign a case. + * * @url POST /reassign/:app_uid/user/:to_usr_uid - * @access protected - * @class AccessControl {@permission PM_REASSIGNCASE, PM_REASSIGNCASE_SUPERVISOR} + * * @param string $app_uid {@min 1}{@max 32} * @param string $to_usr_uid {@min 1}{@max 32} + * * @return stdclass * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_REASSIGNCASE, PM_REASSIGNCASE_SUPERVISOR} */ public function reassignCase($app_uid, $to_usr_uid) { @@ -1621,11 +1675,14 @@ class Light extends Api * Paused Case * * @url POST /cases/:app_uid/pause - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $app_uid {@min 1}{@max 32} + * * @return stdclass * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function pauseCase($app_uid, $request_data) { @@ -1645,11 +1702,14 @@ class Light extends Api * Unpaused Case * * @url POST /cases/:app_uid/unpause - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param string $app_uid {@min 1}{@max 32} + * * @return stdclass * @throws RestException + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function unpauseCase($app_uid) { @@ -1667,12 +1727,16 @@ class Light extends Api } /** - * Cancel Case + * Cancels a case assigned to the user logged-in. The case's status is changed + * to "CANCELLED" and it is no longer possible to open or change the case, + * but all the case data will remain in the database. * * @url POST /cases/:app_uid/cancel + * + * @param string $cas_uid {@min 1}{@max 32} + * * @access protected * @class AccessControl {@permission PM_CASES} - * @param string $cas_uid {@min 1}{@max 32} */ public function doPutCancelCase($app_uid) { @@ -1838,12 +1902,19 @@ class Light extends Api } /** - * Get next step + * This endpoint executes the following three actions: + * 1. Executes a trigger before a step: First, it executes any trigger assigned + * before the indicated step. + * 2. Get the Next Step: It obtains the details about the next step of the case. + * 3. Get Variables: Finally, it returns any variable stored or changed by + * actions 1 and 2. * * @url POST /get-next-step/:app_uid + * + * @return array + * * @access protected * @class AccessControl {@permission PM_CASES} - * @return array */ public function doGetStep($app_uid, $request_data) { @@ -1941,11 +2012,14 @@ class Light extends Api * the specified user. * * @url POST /draft/check - * @access protected - * @class AccessControl {@permission PM_CASES} + * * @param array $requestData + * * @return array $response * @throws Exception + * + * @access protected + * @class AccessControl {@permission PM_CASES} */ public function doGetDraftCheck($requestData) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Process.php b/workflow/engine/src/ProcessMaker/Services/Api/Process.php index 29481f6ff..0d912cf66 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Process.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Process.php @@ -64,10 +64,13 @@ class Process extends Api } /** - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * Create process + * * @param array $request_data * @return array + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function post($request_data = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php index f2dcb1403..cce8b1699 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php @@ -92,14 +92,18 @@ class Assignee extends Api } /** + * Assigns a user or group to a task. + * * @url POST /:prjUid/activity/:actUid/assignee - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prjUid {@min 32} {@max 32} * @param string $actUid {@min 32} {@max 32} * @param string $aas_uid {@min 32} {@max 32} * @param string $aas_type {@choice user,group} - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostActivityAssignee($prjUid, $actUid, $aas_uid, $aas_type) { @@ -191,14 +195,18 @@ class Assignee extends Api } /** + * Assigns a user or group to a task on an ad hoc basis. + * * @url POST /:prjUid/activity/:actUid/adhoc-assignee - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prjUid {@min 32} {@max 32} * @param string $actUid {@min 32} {@max 32} * @param string $ada_uid {@min 32} {@max 32} * @param string $ada_type {@choice user,group} - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostActivityAdhocAssignee($prjUid, $actUid, $ada_uid, $ada_type) { 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 ed7252d1f..143d38a1e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php @@ -34,9 +34,11 @@ class Step extends Api } /** + * Assigns a step to a task. + * * @url POST /:prj_uid/activity/:act_uid/step - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $act_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data @@ -45,7 +47,9 @@ 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}{@required true} - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostActivityStep( $act_uid, @@ -218,9 +222,11 @@ class Step extends Api } /** + * Create Steps for a Task. + * * @url POST /:prj_uid/activity/:act_uid/step/all - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $act_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data @@ -229,7 +235,9 @@ 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}{@required true} - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostActivityStepAll( $act_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 81af8c9ef..038e0b3b6 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 @@ -34,14 +34,18 @@ class Trigger extends Api } /** + * Assigns a trigger to a step. + * * @url POST /:prj_uid/activity/:act_uid/step/:step_uid/trigger - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $step_uid * @param string $act_uid * @param string $prj_uid * @param StepTriggerPostStructure $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostActivityStepTrigger($step_uid, $act_uid, $prj_uid, StepTriggerPostStructure $request_data = null) { @@ -122,13 +126,17 @@ class Trigger extends Api } /** + * Assigns a trigger to the "Assignment" or "Routing" step section of an activity. + * * @url POST /:prj_uid/activity/:act_uid/step/trigger - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $act_uid * @param string $prj_uid * @param StepAssignTaskTriggerPostStructure $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostActivityStepAssignTaskTrigger($act_uid, $prj_uid, StepAssignTaskTriggerPostStructure $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 750becc0a..648cb0555 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php @@ -51,12 +51,16 @@ class CaseScheduler extends Api } /** + * Creates a new Case Scheduler. + * * @url POST /:prjUid/case-scheduler - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prjUid {@min 32} {@max 32} * @param CaseSchedulerStructure $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostProjectCaseScheduler($prjUid, CaseSchedulerStructure $request_data = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php index 6d1e4b1b6..0ebcdf384 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php @@ -31,16 +31,20 @@ class CaseTrackerObject extends Api } /** + * Assigns an object (Dynaform, Input Document, Output Document) to a case tracker. + * * @url POST /:prj_uid/case-tracker/object - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * @param string $cto_type_obj {@from body}{@choice DYNAFORM,INPUT_DOCUMENT,OUTPUT_DOCUMENT}{@required true} * @param string $cto_uid_obj {@from body}{@min 32}{@max 32}{@required true} * @param string $cto_condition {@from body} * @param int $cto_position {@from body}{@min 1} - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostCaseTrackerObject( $prj_uid, diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php index 5750556d7..16392eb38 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php @@ -55,9 +55,10 @@ class DataBaseConnection extends Api } /** + * Tests a database connection with the provided settings. + * * @url POST /:prj_uid/database-connection/test - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 1} {@max 32} * @param array $request_data * @param string $dbs_type {@from body} {@required true} @@ -68,6 +69,9 @@ class DataBaseConnection extends Api * @param string $dbs_password {@from body} * @param string $dbs_description {@from body} * @return array + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostTestDataBaseConnection( $prj_uid, @@ -91,9 +95,11 @@ class DataBaseConnection extends Api } /** + * Creates a new database connection. + * * @url POST /:prj_uid/database-connection - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 1} {@max 32} * @param array $request_data * @param string $dbs_type {@from body} {@required true} @@ -104,7 +110,9 @@ class DataBaseConnection extends Api * @param string $dbs_password {@from body} * @param string $dbs_description {@from body} * @return array - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostDataBaseConnection( $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 a59511fca..c5696cba0 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php @@ -38,12 +38,16 @@ class DynaForm extends Api } /** + * Create dynaform. + * * @url POST /:prj_uid/dynaform - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostDynaForm($prj_uid, $request_data) { @@ -137,11 +141,15 @@ class DynaForm extends Api } /** + * Upload language for dynaform. + * * @url POST /:prj_uid/dynaform/:dyn_uid/upload-language - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostDynaFormLanguage($dyn_uid, $prj_uid) { @@ -155,11 +163,15 @@ class DynaForm extends Api } /** + * Delete language for dynaform. + * * @url POST /:prj_uid/dynaform/:dyn_uid/delete-language/:lang - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doDeleteDynaFormLanguage($dyn_uid, $prj_uid, $lang) { @@ -190,12 +202,16 @@ class DynaForm extends Api } /** + * DynaForm History. + * * @url POST /:prj_uid/dynaform/:dyn_uid/history - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doGetDynaFormHistory($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 7efb26b8e..b441a117d 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php @@ -65,9 +65,11 @@ class EmailEvent extends Api /** * @url POST /:prj_uid/email-event + * + * @param string $prj_uid {@min 1} {@max 32} + * * @access protected * @class AccessControl {@permission PM_FACTORY} - * @param string $prj_uid {@min 1} {@max 32} */ public function doPostEmailEvent($prj_uid, array $request_data) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php index 7bd6012f5..823c6c74d 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php @@ -37,12 +37,16 @@ class FilesManager extends Api } /** + * Creates a file in the File Manager. + * * @url POST /:prj_uid/file-manager - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 32} {@max 32} * @param ProcessFilesManagerStructurePost $request_data * @param string $prf_content + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostProcessFilesManager($prj_uid, ProcessFilesManagerStructurePost $request_data, $prf_content=null) { @@ -62,11 +66,15 @@ class FilesManager extends Api } /** + * Uploads a document to the File Manager. + * * @url POST /:prj_uid/file-manager/:prf_uid/upload - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 32} {@max 32} * @param string $prf_uid {@min 32} {@max 32} + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostProcessFilesManagerUpload($prj_uid, $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 d061eca15..b88fb893c 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php @@ -33,12 +33,16 @@ class InputDocument extends Api } /** + * Create a new Input Document in a project. + * * @url POST /:prj_uid/input-document - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostInputDocument($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 3dc3fc5ef..80199cc76 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php @@ -80,12 +80,16 @@ class MessageEventDefinition extends Api } /** + * Create message event definition. + * * @url POST /:prj_uid/message-event-definition - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostMessageEventDefinition($prj_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 84cca6360..f66f26b5e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php @@ -65,12 +65,16 @@ class MessageType extends Api } /** + * Create message type + * * @url POST /:prj_uid/message-type - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostMessageType($prj_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 f75278d8b..5b658adcd 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php @@ -68,12 +68,14 @@ class Variable extends Api /** * @url POST /:prj_uid/message-type/:msgt_uid/variable - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param string $msgt_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostMessageTypeVariable($prj_uid, $msgt_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 184bc27b6..1152a34a1 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php @@ -51,12 +51,16 @@ class OutputDocuments extends Api } /** + * Create a new output document for a project. + * * @url POST /:prjUid/output-document - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prjUid {@min 32} {@max 32} * @param OutputDocumentStructure $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostProjectOutputDocument($prjUid, OutputDocumentStructure $request_data = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php index 9a67ddbd9..394b06e4e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php @@ -58,9 +58,11 @@ class ProcessPermissions extends Api } /** + * Creates a new Process Permission for a project. + * * @url POST /:prj_uid/process-permission/ - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 1} {@max 32} * @param array $request_data * @param string $usr_uid {@from body} {@min 1} {@max 32} @@ -75,7 +77,9 @@ class ProcessPermissions extends Api * @param string $inputs {@from body} * @param string $outputs {@from body} * @return array - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostProcessPermission( $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 a7f9f8ff1..752298385 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php @@ -234,13 +234,17 @@ class ProcessSupervisors extends Api } /** + * Assign a user or group as a process supervisor. + * * @url POST /:prjUid/process-supervisor - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prjUid {@min 32} {@max 32} * @param string $usr_uid {@min 32} {@max 32} * @param string $pu_type {@choice SUPERVISOR,GROUP_SUPERVISOR} - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostProcessSupervisor($prjUid, $usr_uid, $pu_type) { @@ -257,13 +261,17 @@ class ProcessSupervisors extends Api } /** + * Assigns a Dynaform to a Process Supervisor. + * * @url POST /:prjUid/process-supervisor/dynaform - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prjUid {@min 32} {@max 32} * @param string $dyn_uid {@min 32} {@max 32} * @param int $pud_position - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostProcessSupervisorDynaform($prjUid, $dyn_uid, $pud_position = null) { @@ -280,13 +288,17 @@ class ProcessSupervisors extends Api } /** + * Assigns an input document to a Process Supervisor. + * * @url POST /:prjUid/process-supervisor/input-document - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prjUid {@min 32} {@max 32} * @param string $inp_doc_uid {@min 32} {@max 32} * @param int $pui_position - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostProcessSupervisorInputDocument($prjUid, $inp_doc_uid, $pui_position = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php index 72154adda..8512903ba 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php @@ -70,12 +70,16 @@ class ProjectUsers extends Api } /** + * Return the user that can start a task. + * * @url POST /:prj_uid/ws/user/can-start-task - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * * @param string $prj_uid {@min 32} {@max 32} * @param string $act_uid {@min 32} {@max 32} * @param wsUserCanStartTaskStructure $request_data + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostProjectWsUserCanStartTask($prj_uid, $act_uid = null, wsUserCanStartTaskStructure $request_data = null) { diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php index 30e7865e0..d5fbb09ee 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php @@ -95,9 +95,11 @@ class ReportTable extends Api } /** + * Creates a new Report Table. + * * @url POST /:prj_uid/report-table - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 1} {@max 32} * @param array $request_data * @param string $rep_tab_name {@from body} @@ -106,7 +108,9 @@ class ReportTable extends Api * @param string $rep_tab_type {@from body} {@choice NORMAL,GRID} * @param string $rep_tab_grid {@from body} * @return array - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostReportTable( $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 a9b57fc94..0483cfb42 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php @@ -80,12 +80,16 @@ class ScriptTask extends Api } /** + * Create script task for a project. + * * @url POST /:prj_uid/script-task - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostScriptTask($prj_uid, array $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 2a53031c3..85aebb5c6 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php @@ -86,12 +86,16 @@ class TimerEvent extends Api } /** + * Create timer event for a project. + * * @url POST /:prj_uid/timer-event - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostTimerEvent($prj_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 58616ee39..62d407352 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php @@ -55,9 +55,11 @@ class Trigger extends Api } /** + * Create a new trigger in a project. + * * @url POST /:projectUid/trigger - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $projectUid {@min 1} {@max 32} * @param array $request_data * @param string $tri_title {@from body} {@min 1} @@ -66,7 +68,9 @@ class Trigger extends Api * @param string $tri_webbot {@from body} * @param string $tri_param {@from body} * @return array - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostTrigger($projectUid, $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 0735963c2..26933f187 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php @@ -66,14 +66,18 @@ class TriggerWizard extends Api } /** + * Create Trigger for a Process + * * @url POST /:prj_uid/trigger-wizard/:lib_name/:fn_name - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param string $lib_name * @param string $fn_name * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostTriggerWizard($prj_uid, $lib_name, $fn_name, $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 0321079cd..4fa21db77 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php @@ -48,12 +48,16 @@ class Variable extends Api } /** + * Create a process variable. + * * @url POST /:prj_uid/process-variable - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostVariable($prj_uid, $request_data) { @@ -109,12 +113,18 @@ class Variable extends Api } /** + * Executes an SQL query of a dependent field, such as a dropdown box, checkgroup + * or radiogroup, that uses an SQL query with one or more dynamic variables + * to populate its list of options. + * * @url POST /:prj_uid/process-variable/:var_name/execute-query - * @access protected - * @class AccessControl {@permission PM_FACTORY, PM_CASES} + * * @param string $prj_uid {@min 32}{@max 32} * @param string $var_name * @param array $request_data + * + * @access protected + * @class AccessControl {@permission PM_FACTORY, PM_CASES} */ public function doPostVariableExecuteSql($prj_uid, $var_name = '', $request_data = array()) { @@ -132,12 +142,18 @@ class Variable extends Api } /** + * Queries the options in a suggest box, dropdown box, checkgroup or radiogroup, + * which uses an SQL query to populate its list of options (or uses a datasource + * which is "array variable" in version 3.0.1.8 or later). + * * @url POST /:prj_uid/process-variable/:var_name/execute-query-suggest - * @access protected - * @class AccessControl {@permission PM_FACTORY, PM_CASES} + * * @param string $prj_uid {@min 32}{@max 32} * @param string $var_name * @param array $request_data + * + * @access protected + * @class AccessControl {@permission PM_FACTORY, PM_CASES} */ public function doPostVariableExecuteSqlSuggest($prj_uid, $var_name, $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 3dd31a800..203994a96 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php @@ -71,12 +71,16 @@ class WebEntry extends Api } /** + * Creates a new Web Entry using the method "PHP pages with Web Services". + * * @url POST /:prj_uid/web-entry - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostWebEntry($prj_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 29a8cec15..56e032837 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php @@ -88,12 +88,16 @@ class WebEntryEvent extends Api } /** + * Create web entry event for a project. + * * @url POST /:prj_uid/web-entry-event - * @access protected - * @class AccessControl {@permission PM_FACTORY} + * @status 201 + * * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data - * @status 201 + * + * @access protected + * @class AccessControl {@permission PM_FACTORY} */ public function doPostWebEntryEvent($prj_uid, array $request_data) { From 6b8ef940151f26fa21ad5bae24de8ef0718e16b8 Mon Sep 17 00:00:00 2001 From: davidcallizaya Date: Wed, 18 Oct 2017 14:33:38 -0400 Subject: [PATCH 07/15] 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 c93bd3fc6bfe4f9e8a8aba0b56e86b272cd7cc7b Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Wed, 18 Oct 2017 14:53:15 -0400 Subject: [PATCH 08/15] HOR-3968 --- .../src/ProcessMaker/Services/Api/Cases.php | 12 +++++++++ .../Services/Api/Cases/InputDocument.php | 3 +++ .../Services/Api/Cases/OutputDocument.php | 3 +++ .../Services/Api/Cases/Variable.php | 3 +++ .../src/ProcessMaker/Services/Api/Catalog.php | 3 +++ .../Services/Api/Consolidated.php | 2 ++ .../ProcessMaker/Services/Api/Dashboard.php | 12 +++++++++ .../ProcessMaker/Services/Api/Department.php | 5 ++++ .../ProcessMaker/Services/Api/EmailServer.php | 6 +++++ .../src/ProcessMaker/Services/Api/File.php | 6 +++++ .../src/ProcessMaker/Services/Api/Group.php | 3 +++ .../ProcessMaker/Services/Api/Group/User.php | 6 +++++ .../src/ProcessMaker/Services/Api/Light.php | 25 +++++++++++++++++++ .../src/ProcessMaker/Services/Api/Process.php | 2 ++ .../Api/Project/Activity/Assignee.php | 6 +++++ .../Services/Api/Project/Activity/Step.php | 6 +++++ .../Api/Project/Activity/Step/Trigger.php | 6 +++++ .../Services/Api/Project/CaseScheduler.php | 3 +++ .../Api/Project/CaseTrackerObject.php | 3 +++ .../Api/Project/DataBaseConnection.php | 4 +++ .../Services/Api/Project/DynaForm.php | 12 +++++++++ .../Services/Api/Project/EmailEvent.php | 3 +++ .../Services/Api/Project/FilesManager.php | 6 +++++ .../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 | 2 ++ .../Api/Project/ProcessSupervisors.php | 9 +++++++ .../Services/Api/Project/ProjectUsers.php | 3 +++ .../Services/Api/Project/ReportTable.php | 2 ++ .../Services/Api/Project/ScriptTask.php | 3 +++ .../Services/Api/Project/TimerEvent.php | 3 +++ .../Services/Api/Project/Trigger.php | 2 ++ .../Services/Api/Project/TriggerWizard.php | 3 +++ .../Services/Api/Project/Variable.php | 9 +++++++ .../Services/Api/Project/WebEntry.php | 3 +++ .../Services/Api/Project/WebEntryEvent.php | 3 +++ 39 files changed, 197 insertions(+) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php index b6e1e1a1e..7915c2ea6 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php @@ -766,6 +766,9 @@ class Cases extends Api * @param string $tas_uid {@from body} {@min 32}{@max 32} * @param array $variables {@from body} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ @@ -797,6 +800,9 @@ class Cases extends Api * @param string $tas_uid {@from body} {@min 32}{@max 32} * @param array $variables {@from body} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ @@ -1121,6 +1127,9 @@ class Cases extends Api * @param string $note_content {@min 1}{@max 500} * @param int $send_mail {@choice 1,0} * + * @return void + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ @@ -1254,6 +1263,9 @@ class Cases extends Api * * @param string $tas_uid {@min 32}{@max 32} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php index 03da8e24b..29f528db7 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php @@ -106,6 +106,9 @@ class InputDocument extends Api * @param string $app_doc_comment * @param string $inp_doc_uid {@min 32}{@max 32} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php index 04dfe4296..6fa6b917e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php @@ -148,6 +148,9 @@ class OutputDocument extends Api * @param int $del_index {@min 1} * @param string $out_doc_uid {@min 32}{@max 32} * + * @return object + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php index befc33e80..5fa8942ed 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php @@ -88,6 +88,9 @@ class Variable extends Api * @param string $var_name * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php index d8776f2fd..da9154a10 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Catalog.php @@ -45,6 +45,9 @@ class Catalog extends Api * * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} * @deprecated The method has been deprecated. diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php index 8874eb82e..7d490d646 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php @@ -141,7 +141,9 @@ class Consolidated extends Api * @param int $del_index * @param string $field_grid * @param string $field_grid_val + * * @return array + * @throws RestException * * @access protected * @class AccessControl {@permission PM_CASES} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php index 45a8a254d..efad1d0de 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php @@ -227,6 +227,9 @@ class Dashboard extends Api * * @param array $request_data * + * @return id + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} */ @@ -289,6 +292,9 @@ class Dashboard extends Api * * @param array $request_data * + * @return string + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} */ @@ -330,6 +336,9 @@ class Dashboard extends Api * * @param array $request_data * + * @return string + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} */ @@ -389,6 +398,9 @@ class Dashboard extends Api * * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_DASHBOARD} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Department.php b/workflow/engine/src/ProcessMaker/Services/Api/Department.php index 8403388a7..29da20f67 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Department.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Department.php @@ -112,6 +112,9 @@ class Department extends Api * @param string $dep_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_USERS} */ @@ -192,7 +195,9 @@ class Department extends Api * * @param array $request_data * @param string $dep_title {@from body} {@min 1} + * * @return array + * @throws RestException * * @access protected * @class AccessControl {@permission PM_USERS} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php index 573e97a4e..507635894 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php @@ -91,6 +91,9 @@ class EmailServer extends Api * * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_SETUP_EMAIL} */ @@ -115,6 +118,9 @@ class EmailServer extends Api * * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_SETUP_EMAIL} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/File.php b/workflow/engine/src/ProcessMaker/Services/Api/File.php index ca1d1593a..387733ce5 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/File.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/File.php @@ -18,6 +18,12 @@ class File extends Api * * @param array $request_data * + * @return array + * @throws RestException + * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group.php b/workflow/engine/src/ProcessMaker/Services/Api/Group.php index 3e7b3bf3a..6f45b5e9f 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group.php @@ -80,6 +80,9 @@ class Group extends Api * * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_USERS} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php b/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php index a25d45cbf..f58d16ba1 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Group/User.php @@ -20,6 +20,9 @@ class User extends Api * @param string $grp_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_USERS} */ @@ -43,6 +46,9 @@ class User extends Api * * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_USERS} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light.php b/workflow/engine/src/ProcessMaker/Services/Api/Light.php index f3eb5bf2f..59de9feb1 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light.php @@ -975,6 +975,9 @@ class Light extends Api * @param string $step_uid {@min 32}{@max 32} * @param string $type {@choice before,after} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ @@ -1144,6 +1147,9 @@ class Light extends Api * @param string $pro_uid {@min 32}{@max 32} * @param string $task_uid {@min 32}{@max 32} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ @@ -1246,6 +1252,9 @@ class Light extends Api * @param float $latitude {@min -90}{@max 90} * @param float $longitude {@min -180}{@max 180} * + * @return mixed + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ @@ -1291,6 +1300,9 @@ class Light extends Api * * @param string $app_uid {@min 32}{@max 32} * + * @return mixed + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ @@ -1402,7 +1414,9 @@ class Light extends Api * * @param $access * @param $refresh + * * @return mixed + * @throws RestException * * @access protected * @class AccessControl {@permission PM_CASES} @@ -1435,7 +1449,9 @@ class Light extends Api * * @param $access * @param $refresh + * * @return mixed + * @throws RestException * * @access protected * @class AccessControl {@permission PM_CASES} @@ -1459,7 +1475,9 @@ class Light extends Api * @url POST /case/:app_uid/claim * * @param $app_uid {@min 1}{@max 32} + * * @return mixed + * @throws RestException * * @access protected * @class AccessControl {@permission PM_CASES} @@ -1559,6 +1577,9 @@ class Light extends Api * @param string $noteContent {@min 1}{@max 500} * @param int $sendMail {@choice 1,0} * + * @return mixed + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ @@ -1735,6 +1756,9 @@ class Light extends Api * * @param string $cas_uid {@min 1}{@max 32} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_CASES} */ @@ -1912,6 +1936,7 @@ class Light extends Api * @url POST /get-next-step/:app_uid * * @return array + * @throws RestException * * @access protected * @class AccessControl {@permission PM_CASES} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Process.php b/workflow/engine/src/ProcessMaker/Services/Api/Process.php index 0d912cf66..6cfc22751 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Process.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Process.php @@ -67,7 +67,9 @@ class Process extends Api * Create process * * @param array $request_data + * * @return array + * @throws RestException * * @access protected * @class AccessControl {@permission PM_FACTORY} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php index cce8b1699..214cab709 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php @@ -102,6 +102,9 @@ class Assignee extends Api * @param string $aas_uid {@min 32} {@max 32} * @param string $aas_type {@choice user,group} * + * @return void + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -205,6 +208,9 @@ class Assignee extends Api * @param string $ada_uid {@min 32} {@max 32} * @param string $ada_type {@choice user,group} * + * @return void + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ 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 143d38a1e..c9a5cbd1a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php @@ -48,6 +48,9 @@ class Step extends Api * @param int $step_position {@from body}{@min 1} * @param string $step_mode {@from body}{@choice EDIT,VIEW}{@required true} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -236,6 +239,9 @@ class Step extends Api * @param int $step_position {@from body}{@min 1} * @param string $step_mode {@from body}{@choice EDIT,VIEW}{@required true} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ 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 038e0b3b6..935d42390 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 @@ -44,6 +44,9 @@ class Trigger extends Api * @param string $prj_uid * @param StepTriggerPostStructure $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -135,6 +138,9 @@ class Trigger extends Api * @param string $prj_uid * @param StepAssignTaskTriggerPostStructure $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php index 648cb0555..596f00fb9 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php @@ -59,6 +59,9 @@ class CaseScheduler extends Api * @param string $prjUid {@min 32} {@max 32} * @param CaseSchedulerStructure $request_data * + * @return mixed + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php index 0ebcdf384..3205588e7 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php @@ -43,6 +43,9 @@ class CaseTrackerObject extends Api * @param string $cto_condition {@from body} * @param int $cto_position {@from body}{@min 1} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php index 16392eb38..2ce5a2d33 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php @@ -68,7 +68,9 @@ 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 array + * @throws RestException * * @access protected * @class AccessControl {@permission PM_FACTORY} @@ -109,7 +111,9 @@ 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 array + * @throws RestException * * @access protected * @class AccessControl {@permission PM_FACTORY} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php index c5696cba0..36abed826 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php @@ -46,6 +46,9 @@ class DynaForm extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -148,6 +151,9 @@ class DynaForm extends Api * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * + * @return void + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -170,6 +176,9 @@ class DynaForm extends Api * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * + * @return void + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -210,6 +219,9 @@ class DynaForm extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php index b441a117d..ce18f7644 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php @@ -68,6 +68,9 @@ class EmailEvent extends Api * * @param string $prj_uid {@min 1} {@max 32} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php index 823c6c74d..631a63790 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php @@ -45,6 +45,9 @@ class FilesManager extends Api * @param ProcessFilesManagerStructurePost $request_data * @param string $prf_content * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -73,6 +76,9 @@ class FilesManager extends Api * @param string $prj_uid {@min 32} {@max 32} * @param string $prf_uid {@min 32} {@max 32} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php index b88fb893c..07045f527 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php @@ -41,6 +41,9 @@ class InputDocument extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php index 80199cc76..3e97afbdd 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php @@ -88,6 +88,9 @@ class MessageEventDefinition extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php index f66f26b5e..6bef5a55c 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php @@ -73,6 +73,9 @@ class MessageType extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ 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 5b658adcd..6ec5493e7 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php @@ -74,6 +74,9 @@ class Variable extends Api * @param string $msgt_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php index 1152a34a1..4cec83fa1 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php @@ -59,6 +59,9 @@ class OutputDocuments extends Api * @param string $prjUid {@min 32} {@max 32} * @param OutputDocumentStructure $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php index 394b06e4e..474460a41 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php @@ -76,7 +76,9 @@ class ProcessPermissions extends Api * @param string $dynaforms {@from body} * @param string $inputs {@from body} * @param string $outputs {@from body} + * * @return array + * @throws RestException * * @access protected * @class AccessControl {@permission PM_FACTORY} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php index 752298385..677c2386d 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php @@ -243,6 +243,9 @@ class ProcessSupervisors extends Api * @param string $usr_uid {@min 32} {@max 32} * @param string $pu_type {@choice SUPERVISOR,GROUP_SUPERVISOR} * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -270,6 +273,9 @@ class ProcessSupervisors extends Api * @param string $dyn_uid {@min 32} {@max 32} * @param int $pud_position * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -297,6 +303,9 @@ class ProcessSupervisors extends Api * @param string $inp_doc_uid {@min 32} {@max 32} * @param int $pui_position * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php index 8512903ba..f698322e2 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php @@ -78,6 +78,9 @@ class ProjectUsers extends Api * @param string $act_uid {@min 32} {@max 32} * @param wsUserCanStartTaskStructure $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php index d5fbb09ee..dc7a4622c 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php @@ -107,7 +107,9 @@ class ReportTable extends Api * @param string $rep_tab_connection {@from body} * @param string $rep_tab_type {@from body} {@choice NORMAL,GRID} * @param string $rep_tab_grid {@from body} + * * @return array + * @throws RestException * * @access protected * @class AccessControl {@permission PM_FACTORY} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php index 0483cfb42..3e869c296 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php @@ -88,6 +88,9 @@ class ScriptTask extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php index 85aebb5c6..ef82437df 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php @@ -94,6 +94,9 @@ class TimerEvent extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php index 62d407352..749075eed 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php @@ -67,7 +67,9 @@ class Trigger extends Api * @param string $tri_type {@from body} * @param string $tri_webbot {@from body} * @param string $tri_param {@from body} + * * @return array + * @throws RestException * * @access protected * @class AccessControl {@permission PM_FACTORY} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php index 26933f187..55831359b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php @@ -76,6 +76,9 @@ class TriggerWizard extends Api * @param string $fn_name * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php index 4fa21db77..ad761a9ca 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php @@ -56,6 +56,9 @@ class Variable extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ @@ -123,6 +126,9 @@ class Variable extends Api * @param string $var_name * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY, PM_CASES} */ @@ -152,6 +158,9 @@ class Variable extends Api * @param string $var_name * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY, PM_CASES} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php index 203994a96..8ee08e56d 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php @@ -79,6 +79,9 @@ class WebEntry extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php index 56e032837..538e6569e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php @@ -96,6 +96,9 @@ class WebEntryEvent extends Api * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data * + * @return array + * @throws RestException + * * @access protected * @class AccessControl {@permission PM_FACTORY} */ From 17704c37932055d4fb2bf2f785454728761fefb8 Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Wed, 18 Oct 2017 14:59:07 -0400 Subject: [PATCH 09/15] HOR-3968 --- .../ProcessMaker/Services/Api/Project/DataBaseConnection.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php index 2ce5a2d33..c5d2a6f9b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php @@ -55,7 +55,7 @@ class DataBaseConnection extends Api } /** - * Tests a database connection with the provided settings. + * Test a database connection with the provided settings. * * @url POST /:prj_uid/database-connection/test * From 266c9824f36cd3e98565ddd8c143d31ffde7c9ac Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Wed, 18 Oct 2017 15:11:11 -0400 Subject: [PATCH 10/15] HOR-3968 --- .../Services/Api/Project/CaseTrackerObject.php | 2 +- .../src/ProcessMaker/Services/Api/Project/DynaForm.php | 9 +++++---- .../src/ProcessMaker/Services/Api/Project/EmailEvent.php | 3 +++ .../Services/Api/Project/MessageType/Variable.php | 2 ++ .../src/ProcessMaker/Services/Api/Project/Variable.php | 2 +- 5 files changed, 12 insertions(+), 6 deletions(-) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php index 3205588e7..5c3a2cd77 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php @@ -31,7 +31,7 @@ class CaseTrackerObject extends Api } /** - * Assigns an object (Dynaform, Input Document, Output Document) to a case tracker. + * Assign an object (Dynaform, Input Document, Output Document) to a case tracker. * * @url POST /:prj_uid/case-tracker/object * @status 201 diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php index 36abed826..df38f3aa2 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php @@ -38,7 +38,7 @@ class DynaForm extends Api } /** - * Create dynaform. + * Create Dynaform. * * @url POST /:prj_uid/dynaform * @status 201 @@ -144,7 +144,7 @@ class DynaForm extends Api } /** - * Upload language for dynaform. + * Upload language for a Dynaform. * * @url POST /:prj_uid/dynaform/:dyn_uid/upload-language * @@ -169,12 +169,13 @@ class DynaForm extends Api } /** - * Delete language for dynaform. + * Delete language from a Dynaform. * * @url POST /:prj_uid/dynaform/:dyn_uid/delete-language/:lang * * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} + * @param string $lang * * @return void * @throws RestException @@ -211,7 +212,7 @@ class DynaForm extends Api } /** - * DynaForm History. + * Get Dynaform's history. * * @url POST /:prj_uid/dynaform/:dyn_uid/history * diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php index ce18f7644..8bbca7269 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php @@ -64,9 +64,12 @@ class EmailEvent extends Api } /** + * Save Data for email event. + * * @url POST /:prj_uid/email-event * * @param string $prj_uid {@min 1} {@max 32} + * @param array $request_data * * @return array * @throws RestException 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 6ec5493e7..331f44d84 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php @@ -67,6 +67,8 @@ class Variable extends Api } /** + * Return data of the new Message created. + * * @url POST /:prj_uid/message-type/:msgt_uid/variable * @status 201 * diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php index ad761a9ca..09cb9867a 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php @@ -148,7 +148,7 @@ class Variable extends Api } /** - * Queries the options in a suggest box, dropdown box, checkgroup or radiogroup, + * Gets the options in a suggest box, dropdown box, checkgroup or radiogroup, * which uses an SQL query to populate its list of options (or uses a datasource * which is "array variable" in version 3.0.1.8 or later). * From c501c56dd509b6a772bec779c9b107c8f2be6bc6 Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Wed, 18 Oct 2017 15:22:09 -0400 Subject: [PATCH 11/15] HOR-3968 --- .../Services/Api/Project/Activity/Step/Trigger.php | 2 +- .../src/ProcessMaker/Services/Api/Project/DynaForm.php | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) 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 935d42390..262b9261e 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 @@ -129,7 +129,7 @@ class Trigger extends Api } /** - * Assigns a trigger to the "Assignment" or "Routing" step section of an activity. + * Assign a trigger to the "Assignment" or "Routing" step section of an activity. * * @url POST /:prj_uid/activity/:act_uid/step/trigger * @status 201 diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php index df38f3aa2..5d4a986e7 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php @@ -147,7 +147,7 @@ class DynaForm extends Api * Upload language for a Dynaform. * * @url POST /:prj_uid/dynaform/:dyn_uid/upload-language - * + * * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @@ -172,7 +172,7 @@ class DynaForm extends Api * Delete language from a Dynaform. * * @url POST /:prj_uid/dynaform/:dyn_uid/delete-language/:lang - * + * * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param string $lang @@ -215,7 +215,7 @@ class DynaForm extends Api * Get Dynaform's history. * * @url POST /:prj_uid/dynaform/:dyn_uid/history - * + * * @param string $dyn_uid {@min 32}{@max 32} * @param string $prj_uid {@min 32}{@max 32} * @param array $request_data From 4c62c0f41134f21c0647d9e30a558c0a9947deac Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Wed, 18 Oct 2017 15:32:43 -0400 Subject: [PATCH 12/15] HOR-3968 --- .../src/ProcessMaker/Services/Api/Project/Activity/Step.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 c9a5cbd1a..663b72e72 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php @@ -34,7 +34,7 @@ class Step extends Api } /** - * Assigns a step to a task. + * Assign a step to a task. * * @url POST /:prj_uid/activity/:act_uid/step * @status 201 From 0e12d2369d2b135722d9d92b635c4d831ddd1cf3 Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Wed, 18 Oct 2017 16:29:01 -0400 Subject: [PATCH 13/15] HOR-3968 --- .../ProcessMaker/Services/Api/Project/Activity/Assignee.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php index 214cab709..bdea6550b 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php @@ -92,7 +92,7 @@ class Assignee extends Api } /** - * Assigns a user or group to a task. + * Assign an user or group to a task. * * @url POST /:prjUid/activity/:actUid/assignee * @status 201 @@ -198,7 +198,7 @@ class Assignee extends Api } /** - * Assigns a user or group to a task on an ad hoc basis. + * Assign an user or group to a task (Ad-hoc assignment). * * @url POST /:prjUid/activity/:actUid/adhoc-assignee * @status 201 From 519ce808954600d5b93d3f3e4b84d108788e6cad Mon Sep 17 00:00:00 2001 From: Roly Rudy Gutierrez Pinto Date: Thu, 19 Oct 2017 12:43:53 -0400 Subject: [PATCH 14/15] HOR-3968 --- workflow/engine/src/ProcessMaker/Services/Api/Cases.php | 2 +- .../engine/src/ProcessMaker/Services/Api/Dashboard.php | 6 +++--- workflow/engine/src/ProcessMaker/Services/Api/File.php | 5 +---- workflow/engine/src/ProcessMaker/Services/Api/Light.php | 9 ++++++--- .../Services/Api/Project/Activity/Step/Trigger.php | 2 +- .../Services/Api/Project/ProcessSupervisors.php | 4 ++-- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php index 7915c2ea6..d7ad3e7b4 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Cases.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Cases.php @@ -1263,7 +1263,7 @@ class Cases extends Api * * @param string $tas_uid {@min 32}{@max 32} * - * @return array + * @return void * @throws RestException * * @access protected diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php index efad1d0de..d5c8bb8da 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php @@ -227,7 +227,7 @@ class Dashboard extends Api * * @param array $request_data * - * @return id + * @return integer * @throws RestException * * @access protected @@ -292,7 +292,7 @@ class Dashboard extends Api * * @param array $request_data * - * @return string + * @return object * @throws RestException * * @access protected @@ -398,7 +398,7 @@ class Dashboard extends Api * * @param array $request_data * - * @return array + * @return integer * @throws RestException * * @access protected diff --git a/workflow/engine/src/ProcessMaker/Services/Api/File.php b/workflow/engine/src/ProcessMaker/Services/Api/File.php index 387733ce5..bb49a2b45 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/File.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/File.php @@ -19,10 +19,7 @@ class File extends Api * @param array $request_data * * @return array - * @throws RestException - * - * @return array - * @throws RestException + * @throws RestException * * @access protected * @class AccessControl {@permission PM_FACTORY} diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Light.php b/workflow/engine/src/ProcessMaker/Services/Api/Light.php index 59de9feb1..8dd364a61 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Light.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Light.php @@ -1137,7 +1137,7 @@ class Light extends Api } /** - * Starts a new case and assigns the logged-in user to work on the initial task + * Starts a new case and assign the logged-in user to work on the initial task * in the case. Note that the logged-in user must be in the pool of assigned * users of the initial task. Also note that the new case's status will be * set to "DRAFT", not "TO_DO". @@ -1470,7 +1470,7 @@ class Light extends Api } /** - * Assigns the user logged-in to an unassigned case. + * Assign the user logged-in to an unassigned case. * * @url POST /case/:app_uid/claim * @@ -1726,7 +1726,7 @@ class Light extends Api * * @param string $app_uid {@min 1}{@max 32} * - * @return stdclass + * @return array * @throws RestException * * @access protected @@ -1935,6 +1935,9 @@ class Light extends Api * * @url POST /get-next-step/:app_uid * + * @param string $app_uid + * @param array $request_data + * * @return array * @throws RestException * 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 262b9261e..d1928dd1b 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 @@ -34,7 +34,7 @@ class Trigger extends Api } /** - * Assigns a trigger to a step. + * Assign a trigger to a step. * * @url POST /:prj_uid/activity/:act_uid/step/:step_uid/trigger * @status 201 diff --git a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php index 677c2386d..f2949d17e 100644 --- a/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php +++ b/workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php @@ -264,7 +264,7 @@ class ProcessSupervisors extends Api } /** - * Assigns a Dynaform to a Process Supervisor. + * Assign a Dynaform to a Process Supervisor. * * @url POST /:prjUid/process-supervisor/dynaform * @status 201 @@ -294,7 +294,7 @@ class ProcessSupervisors extends Api } /** - * Assigns an input document to a Process Supervisor. + * Assign an input document to a Process Supervisor. * * @url POST /:prjUid/process-supervisor/input-document * @status 201 From d473d9afad42590fb66d982bfd0e406757fade51 Mon Sep 17 00:00:00 2001 From: davidcallizaya Date: Thu, 19 Oct 2017 15:54:11 -0400 Subject: [PATCH 15/15] 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