Repository navigation
Expand file tree
/
Copy pathapi.php
More file actions
1708 lines (1706 loc) · 48.4 KB
/
Copy pathapi.php
File metadata and controls
1708 lines (1706 loc) · 48.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
namespace JobRouter\Log { if(false) {
trait LogTrait
{
/**
* Set the name of the log file. You can also specify the format for the filename.
*
* Default: processName_version_YYYYMMDD.log
*
* @param string $filename Name of the log file.
* @param string $format Filename format.<br/>The following variables can be used in the format string: {filename}, {date}.
* @param string $dateFormat Date format for date part of filename.<br/>Only considered when {date} is used in filename format.
*/
final public function setLogFilename($filename, $format = '{filename}_{date}', $dateFormat = 'Ymd'): void
{
}
/**
* Set the full path of the log file.
*
* Default: JobRouter output/log directory
*
* @param string $filePath
*/
final public function setLogFilePath($filePath): void
{
}
/**
* Set the log channel.
*
* Default: incidentNumber.stepNumber.functionClassName
*
* @param string $channel
*/
final public function setLogChannel($channel): void
{
}
/**
* Set the minimum importance for log messages to be actually recorded.
*
* Default: CONST_LOG_LEVEL_FILE<br/>
*
* Possible values: DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY
*
* @param string $level
*/
final public function setLogLevel($level): void
{
}
/**
* Set the output format for log messages.
*
* Default: %datetime% %channel%.%level_name%: %message% %context% %extra%<br/>
*
* The following variables can be used in the format string:
* %datetime%, %channel%, %level_name%, %message%, %context%, %extra%
*
* @param string $format
*/
final public function setLogMessageFormat($format): void
{
}
/**
* Disables the output formatting for log messages. Log messages are written as-is to log file.
*/
final public function rawLog(): void
{
}
/**
* Writes a parsable string representation of the parameter to the log file.
*/
final public function dump(mixed $var): void
{
}
/**
* System is unusable.
*/
final public function emergency(string|\Stringable $message, array $context = []): void
{
}
/**
* Action must be taken immediately.
*
* Example: External database unavailable.
*/
final public function alert(string|\Stringable $message, array $context = []): void
{
}
/**
* Critical conditions.
*
* Example: Unexpected exception.
*/
final public function critical(string|\Stringable $message, array $context = []): void
{
}
/**
* Runtime errors that do not require immediate action but should typically be logged and monitored.
*/
final public function error(string|\Stringable $message, array $context = []): void
{
}
/**
* \Exceptional occurrences that are not errors.
*
* Example: Undesirable things that are not necessarily wrong.
*/
final public function warning(string|\Stringable $message, array $context = []): void
{
}
/**
* Normal but significant events.
*/
final public function notice(string|\Stringable $message, array $context = []): void
{
}
/**
* Interesting events.
*
* Example: SQL logs.
*/
final public function info(string|\Stringable $message, array $context = []): void
{
}
/**
* Detailed debug information.
*/
final public function debug(string|\Stringable $message, array $context = []): void
{
}
/**
* Logs with an arbitrary level.
*
* Possible values for level: DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY
*/
final public function log(mixed $level, string|\Stringable $message, array $context = []): void
{
}
}
}}
namespace JobRouter\Engine\Runtime\PhpFunction { if(false) {
abstract class AbstractFunction
{
use \JobRouter\Log\LogTrait;
/**
* Returns the name of the PHP function.
*
* @return string
*/
final public function getName()
{
}
/**
* Returns the JobRouter DB connection.
*
* @throws \JobRouterException
*/
final public function getJobDB(): \JobRouter\Common\Database\ConnectionInterface
{
}
/**
* Generates and returns a globally unique identifier (GUID).
*
* @return string Globally unique identifier (GUID)
*/
final public function getGUID()
{
}
/**
* Returns date in YYYY-MM-DD HH:II:SS format.
*
* @param int $dateFormat Format id of input date format (possible values: 1 - 4)
* @param string $date Date value
* @param bool $includeTime Flag indicating if time should be appended to date
*
* @return string Date in YYYY-MM-DD HH:II:SS format
*/
final public function getUnformattedDate($dateFormat, $date, $includeTime = false)
{
}
/**
* Returns formatted date according to requested date format.
*
* @param int $id ID of output date format (possible values: 1 - 4)
* @param mixed $date Date value (false, if current date should be used)
* @param bool $isTimestamp Flag indicating that date value is a timestamp
* @param bool $fullDateTime Flag indicating if time should be appended to date
* @param string $timezone Target timezone
*
* @return string Date in requested format
*/
final public function getFormattedDate($id, $date = false, $isTimestamp = false, $fullDateTime = false, $timezone = '')
{
}
/**
* Removes the given directory including all subdirectories and files.
*
* @param string $path Path of directory to delete
*
* @return bool true on success, false on error
*/
final public function removeDir($path)
{
}
/**
* Returns a UNIX timestamp for a given date.
*
* @param string $date Date in YYYY-MM-DD HH:II:SS format
*
* @return int Date as UNIX timestamp
*/
final public function getTimestamp($date)
{
}
/**
* Returns full path of file in data folder.
*
* @param string $path Relative path or filename
* @param string $processName Process name
* @param string $processVersion Process version
*
* @return string Full path of file in data folder
*/
final public function getFullDataPath($path = '', $processName = '', $processVersion = '')
{
}
/**
* Returns full path of file in functions folder.
*
* @param string $path Relative path or filename
* @param string $processName Process name
* @param string $processVersion Process version
*
* @return string Full path of file in functions folder
*/
final public function getFullFunctionsPath($path = '', $processName = '', $processVersion = '')
{
}
/**
* Returns full path of output folder.
*
* @return string Full path of output folder
*/
final public function getFullOutputPath()
{
}
/**
* Returns full path of temp folder.
*
* @return string Full path of temp folder
*/
final public function getFullTempPath()
{
}
/**
* Returns full path of attached file.
*
* @param string $path Relative path (i.e. value from processtable)
*
* @return string Full path of attached file
*/
final public function getFullUploadPath($path = '')
{
}
/**
* Returns the complete URL for opening the step with the given workflowid by the given user.
*
* @param string $workflowId Workflowid of the step
* @param string $userName Username
*
* @return string Complete URL for opening the step
*/
final public function getStepUrl($workflowId, $userName = '')
{
}
/**
* Returns the complete URL for opening the incident history with the given processid by the given user.
*
* @param string $processId Processid of the incident
* @param string $userName Username
*
* @return string Complete URL for opening the incident history
*/
final public function getIncidentUrl($processId, $userName = '')
{
}
/**
* Returns the JobRouter default timezone.
*
* @return string Default timezone
*
* @throws \JobRouterException
*/
final public function getDefaultTimezone()
{
}
/**
* Returns the timezone of the given user.
*
* @param string $userName Username
*
* @return string User timezone
*
* @throws \JobRouterException
*/
final public function getUserTimezone($userName)
{
}
/**
* Converts the given date value from user timezone to default timezone.
*
* @param string $dateTimeValueInUserTimezone Date in YYYY-MM-DD HH:II:SS format
* @param string $userTimezone User timezone
*
* @return string Date value converted to default timezone in YYYY-MM-DD HH:II:SS format
*
* @throws \JobRouterException
*/
final public function convertToDefaultTimezone($dateTimeValueInUserTimezone, $userTimezone)
{
}
/**
* Converts the given date value from default timezone to user timezone.
*
* @param string $dateTimeValueInDefaultTimezone Date in YYYY-MM-DD HH:II:SS format
* @param string $userTimezone User timezone
*
* @return string Date value converted to user timezone in YYYY-MM-DD HH:II:SS format
*
* @throws \JobRouterException
*/
final public function convertToUserTimezone($dateTimeValueInDefaultTimezone, $userTimezone)
{
}
/**
* Creates a password hash.
*
* @param string $password
*
* @return string
*/
final public function hashPassword($password)
{
}
/**
* Checks if the given hash matches the given password.
*
* @param string $password
* @param string $hash
*
* @return bool
*/
final public function verifyPassword($password, $hash)
{
}
/**
* Returns an object which can be used to create URLs for accessing
* the given JobArchive result list from external applications.
*
* @param int $resultListId
*
* @return \JobArchive_ResultListUrlBuilder
*/
final public function getJobArchiveResultListUrlBuilder($resultListId)
{
}
/**
* Returns the filename converted with the current platform encoding
*
* @param string $filename Filename to convert
*/
public function getFilesystemFilename($filename): string
{
}
}
abstract class AbstractStepFunction extends \JobRouter\Engine\Runtime\PhpFunction\AbstractFunction
{
/**
* Returns the current process name.
*
* @return string Process name
*/
final public function getProcessName()
{
}
/**
* Returns the current process version.
*
* @return string Process version
*/
final public function getVersion()
{
}
/**
* Returns the number of the current step.
*
* @return int Step number
*/
final public function getStep()
{
}
/**
* Returns the jobfunction of the current step.
*
* @return string Jobfunction
*/
final public function getJobFunction()
{
}
/**
* Returns the username of the current step.
*
* @return string Username
*/
final public function getUsername()
{
}
/**
* Returns the current username.
*
* @return string current username
*/
final public function getCurrentUsername()
{
}
/**
* Returns the initiator of the current incident.
*
* @return string Initiator username
*/
final public function getInitiator()
{
}
/**
* Returns the number of the current incident.
*
* @return int Incident number
*/
final public function getIncident()
{
}
/**
* Returns the label of the current step.
*
* @return string Step label
*
* @throws \JobRouterException
*/
final public function getStepLabel()
{
}
/**
* Returns the Process Id of the current incident.
*
* @return string Process Id
*/
final public function getProcessId()
{
}
/**
* Returns the Workflow Id of the current step.
*
* @return string Workflow Id
*/
final public function getWorkflowId()
{
}
/**
* Returns the Process Step Id of the current step.
*
* @return string Process Step Id
*/
final public function getStepId()
{
}
/**
* Returns the start date of the current incident.
*
* @return int Incident start date
*/
final public function getStartDate()
{
}
/**
* Returns the escalation date of the current incident.
*
* @return int Incident escalation date
*/
final public function getIncidentEscalationDate()
{
}
/**
* Returns the indate of the current step.
*
* @return int Step indate
*/
final public function getInDate()
{
}
/**
* Returns the escalation date of the current step.
*
* @return int Step escalation date
*/
final public function getStepEscalationDate()
{
}
/**
* Returns the value of an attribute of the current step or incident.
*
* @param string $attributeName Attribute name
*
* @return mixed Incident or step attribute value
*
* @throws \JobRouterException
*/
final public function getIncidentValue($attributeName)
{
}
/**
* Checks if simulation mode is active for the current incident.
*
* @return bool true, if incident is in simulation mode, otherwise false
*/
final public function isSimulation()
{
}
/**
* Returns a process message.
*
* @param string $messageName Message name
* @param string $languageName Language name
* @param array $replacements Associative array with values for variables contained in process message
*
* @return string Process message
*
* @throws \JobRouterException
*/
final public function getMessage($messageName, $languageName = '', ?array $replacements = null)
{
}
/**
* Returns a configuration value.
*
* @param string $configurationName Configuration name
*
* @return string Configuration value
*
* @throws \JobRouterException
*/
final public function getConfiguration($configurationName)
{
}
/**
* Returns a dialog element value.
*
* @param string $dialogElementName Dialog element name
*
* @return string Value of the dialog element
*
* @throws \JobRouterException
*/
public function getDialogValue($dialogElementName)
{
}
/**
* Returns a process table field value.
*
* @param string $fieldName Field name
* @param bool $rawValue Flag indicating that value should be returned "raw"
*
* @return mixed Value of the process table field
*
* @throws \JobRouterException
*/
final public function getTableValue($fieldName, $rawValue = false)
{
}
/**
* Sets a process table field value.
*
* @param string $fieldName Field name
* @param mixed $fieldValue New value
*
* @return void
*
* @throws \JobRouterException
*/
final public function setTableValue($fieldName, $fieldValue)
{
}
/**
* Returns a previous process table field value (i.e. the value of a process table field from the previous step).
*
* @param string $fieldName Field name
* @param bool $rawValue Flag indicating that value should be returned "raw"
*
* @return mixed Value of the process table field
*
* @throws \JobRouterException
*/
final public function getOldTableValue($fieldName, $rawValue = false)
{
}
/**
* Returns a subtable field value.
*
* @param string $subtable Subtable name
* @param int $row Row id
* @param string $fieldName Field name
* @param bool $rawValue Flag indicating that value should be returned "raw"
*
* @return mixed Value of the subtable field
*
* @throws \JobRouterException
*/
final public function getSubtableValue($subtable, $row, $fieldName, $rawValue = false)
{
}
/**
* Sets a subtable field value.
*
* @param string $subtable Subtable name
* @param int $row Row id
* @param string $fieldName Field name
* @param mixed $value New value
*
* @return void
*
* @throws \JobRouterException
*/
final public function setSubtableValue($subtable, $row, $fieldName, $value)
{
}
/**
* Returns the number of rows for the given subtable.
*
* @param string $subtable Subtable Name
*
* @return int Number of rows
*
* @throws \JobRouterException
*/
final public function getSubtableCount($subtable)
{
}
/**
* Return the row ids of the rows of a given subtable for the current step.
*
* @param string $subtable Subtable name
*
* @return array Subtable row ids
*
* @throws \JobRouterException
*/
final public function getSubtableRowIds($subtable)
{
}
/**
* Deletes a subtable row.
*
* @param string $subtable Subtable name
* @param int $row Row Id
*
* @return void
*
* @throws \JobRouterException
*/
final public function deleteSubtableRow($subtable, $row)
{
}
/**
* Inserts a subtable row.
*
* @param string $subtable Subtable name
* @param int $row Row Id
* @param array $rowData Row data (associative array with subtable field names and field values)
*
* @return void
*
* @throws \JobRouterException
*/
final public function insertSubtableRow($subtable, $row, ?array $rowData = null)
{
}
/**
* Deletes all entries from a subtable.
*
* @param string $subtable Subtable name
* @param bool $deleteAttachedFiles Flag, if true then all attached files in the subtable will also be deleted physically
*
* @return void
*
* @throws \JobRouterException
*/
final public function clearSubtable($subtable, $deleteAttachedFiles = false)
{
}
/**
* Returns a database connection.
*
* @param string $connectionName Connection name
*
* @throws \JobRouterException
*/
final public function getDBConnection($connectionName): \JobDB
{
}
/**
* Returns the user language for current step.
*
* @return string User language (default process language, if no user step)
*
* @throws \JobRouterException
*/
final public function getLanguage()
{
}
/**
* Attaches a file to the process table or a subtable.
*
* @param string $filepath
* @param string $fieldname
* @param int $row
* @param string $subtable
*
* @throws \JobRouterException
*/
final public function attachFile($filepath, $fieldname, $row = 0, $subtable = '')
{
}
/**
* Deletes a file from the process table or a subtable.
*
* @param string $fieldname
* @param int $row
* @param string $subtable
*
* @throws \JobRouterException
*/
final public function deleteFile($fieldname, $row = 0, $subtable = '')
{
}
/**
* Returns the original filename of an attachment.
*
* @param string $fieldname Field name
* @param int $row Subtable row id
* @param string $subtable Subtable name
* @param bool $includeFolder Flag indicating if folder should be included
*
* @return string original filename, optionally including folder
*
* @throws \JobRouterException
*/
final public function getOriginalFilename($fieldname, $row = 0, $subtable = '', $includeFolder = false)
{
}
/**
* Checks if the current step is a request.
*
* @return bool true, if step is a request, otherwise false
*/
final public function isRequest()
{
}
/**
* Checks if the current step is an answer for a request.
*
* @return bool true, if step is an answer, otherwise false
*/
final public function isAnswer()
{
}
/**
* Returns the backlink of the current step.
*
* @return string backlink
*/
final public function getBacklink()
{
}
/**
* Returns the notice of the current step.
*
* @return string Notice
*/
final public function getNotice()
{
}
/**
* Returns the 2nd notice of the current step.
*
* @return string 2nd notice
*/
final public function getNotice2()
{
}
/**
* Returns the priority of the current step.
*
* @return int Priority
*/
final public function getPriority()
{
}
/**
* Sets the priority of the current step.
*
* @param int $priority Priority
*
* @return void
*/
final public function setPriority($priority)
{
}
/**
* Returns the current subtable name during rule execution.
*
* @return string Current subtable name
*/
final public function getCurrentSubtable()
{
}
/**
* Returns the current subtable row id during rule execution.
*
* @return int Current subtable row id
*/
final public function getCurrentSubtableRowId()
{
}
/**
* Returns the input parameter value with the given name.
*
* @param string $parameterName Name of the input parameter
*
* @return mixed Input parameter value
*
* @throws \JobRouterException
*/
final public function getInputParameter($parameterName)
{
}
abstract public function execute($rowId = null);
}
abstract class BoxActionFunction extends \JobRouter\Engine\Runtime\PhpFunction\AbstractFunction
{
/**
* Returns the id of the process box.
*
* @return int Process box id
*/
final public function getBoxId()
{
}
/**
* Returns the selected box action.
*
* @return int Selected box action
*/
final public function getBoxAction()
{
}
/**
* Returns the label of the selected box action.
*
* @return string Label of the selected box action
*/
final public function getBoxActionLabel()
{
}
/**
* Returns the workflowids of the selected steps.
*
* @return array Workflowids of the selected steps
*/
final public function getWorkflowIds()
{
}
/**
* Returns the username of the user who triggered the box action.
*
* @return string Username of the user who triggered the box action
*/
final public function getUserName()
{
}
/**
* Returns the unique id for the execution of the box action.
*
* @return string Unique id for the execution of the box action
*/
final public function getCurrentGUID()
{
}
/**
* Removes the given workflow id from the list of workflow ids of the steps to be sent after execution of the box action.
*
* @param string $workflowId
*/
final public function removeWorkflowId($workflowId)
{
}
/**
* Returns a step instance for the given workflow id.
*
* @param string $workflowId
*
* @return \JobRouter\Engine\Runtime\Step\Step
*
* @throws \JobRouterException
*/
final public function getStepByWorkflowId($workflowId)
{
}
/**
* Returns a configuration value.
*
* @param string $configurationName Configuration name
*
* @return string Configuration value
*
* @throws \JobRouterException
*/
final public function getConfiguration($configurationName)
{
}
/**
* Returns the process step ids for the selected steps.
*
* @return array Process step ids of the selected steps
*
* @throws \JobRouterException
*/
final public function getStepIds()
{
}
/**
* Adds a message to be shown to the user after execution of the box action.
*
* @param array|string $messageText Message text
* @param int $messageType Message type (0 = Success, 1 = Info, 2 = Warning, 3 = Error)
*
* @throws \JobRouterException
*/
final public function addMessage(array|string $messageText, int $messageType = 1): void
{
}
/**
* Returns the current username.
*
* @return string current username
*/
final public function getCurrentUsername()
{
}
/**
* Get the value of the given process message in the given language.
* If no language given, the current user language or the process default language will be used.
*
* @param string $messageName Message name
* @param string|null $languageName Language name
* @param array|null $replacements Associative array with values for variables contained in process message
*
* @return string Process message
*
* @throws \JobRouterException
*/
final public function getMessage(string $messageName, ?string $languageName = '', ?array $replacements = null): string
{
}
/**
* Returns the current language. This is the user language or the default process language, if the user language is not available in the process.
*
* @return string Language name
*
* @throws \JobRouterException
*/
final public function getLanguage(): string
{
}
abstract public function execute();
}
abstract class DialogFunction extends \JobRouter\Engine\Runtime\PhpFunction\AbstractStepFunction
{
/**
* Saves the current step
*
* @throws \JobRouterException
*/
final public function save()
{
}
/**
* Returns the value for a userdefined parameter, which was defined in the jr_execute_dialog_function call
*
* @param $parameterName
*