Skip to content

Commit bd6bf8a

Browse files
mullen2mullen2
committed
Updated html version of documentation
1 parent b4d72f9 commit bd6bf8a

File tree

2 files changed

+45
-30
lines changed

2 files changed

+45
-30
lines changed

‎docs/api/classes/IU-PHPCap-RedCapProject.html‎

Lines changed: 43 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1171,15 +1171,15 @@ <h4 class="phpdocumentor-element__name" id="method_deleteRecords">
11711171
<aside class="phpdocumentor-element-found-in">
11721172
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
11731173
:
1174-
<span class="phpdocumentor-element-found-in__line">1960</span>
1174+
<span class="phpdocumentor-element-found-in__line">1967</span>
11751175

11761176
</aside>
11771177

11781178
<p class="phpdocumentor-summary">Deletes the specified records from the project.</p>
11791179

11801180
<code class="phpdocumentor-code phpdocumentor-signature ">
11811181
<span class="phpdocumentor-signature__visibility">public</span>
1182-
<span class="phpdocumentor-signature__name">deleteRecords</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$recordIds</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$arm</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$form</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$event</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$repeatInstance</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
1182+
<span class="phpdocumentor-signature__name">deleteRecords</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$recordIds</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$arm</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$form</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$event</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$repeatInstance</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$deleteLogging</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
11831183

11841184

11851185
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
@@ -1231,6 +1231,21 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
12311231
<dd class="phpdocumentor-argument-list__definition">
12321232
<section class="phpdocumentor-description"><p>for repeating events and forms, the instance for
12331233
which fields should be deleted.</p>
1234+
</section>
1235+
1236+
</dd>
1237+
<dt class="phpdocumentor-argument-list__entry">
1238+
<span class="phpdocumentor-signature__argument__name">$deleteLogging</span>
1239+
: <span class="phpdocumentor-signature__argument__return-type">int</span>
1240+
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
1241+
<dd class="phpdocumentor-argument-list__definition">
1242+
<section class="phpdocumentor-description"><p>flag that indicates if the logging associated
1243+
with the records being deleted should also be deleted. This is only applicable
1244+
for projects where the setting to delete logging for deleted records
1245+
has been enabled by an admin.
1246+
For these projects, set $deleteLogging to 1 (or leave it unset) to delete the
1247+
logging for the deleted records,
1248+
and set $deleteLogging to 0 to keep the logging for the deleted records.</p>
12341249
</section>
12351250

12361251
</dd>
@@ -1273,7 +1288,7 @@ <h4 class="phpdocumentor-element__name" id="method_deleteUserRoles">
12731288
<aside class="phpdocumentor-element-found-in">
12741289
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
12751290
:
1276-
<span class="phpdocumentor-element-found-in__line">2590</span>
1291+
<span class="phpdocumentor-element-found-in__line">2607</span>
12771292

12781293
</aside>
12791294

@@ -1320,7 +1335,7 @@ <h4 class="phpdocumentor-element__name" id="method_deleteUsers">
13201335
<aside class="phpdocumentor-element-found-in">
13211336
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
13221337
:
1323-
<span class="phpdocumentor-element-found-in__line">2469</span>
1338+
<span class="phpdocumentor-element-found-in__line">2486</span>
13241339

13251340
</aside>
13261341

@@ -2906,7 +2921,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportRedcapVersion">
29062921
<aside class="phpdocumentor-element-found-in">
29072922
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
29082923
:
2909-
<span class="phpdocumentor-element-found-in__line">2113</span>
2924+
<span class="phpdocumentor-element-found-in__line">2130</span>
29102925

29112926
</aside>
29122927

@@ -2941,7 +2956,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportRepeatingInstrumentsAnd
29412956
<aside class="phpdocumentor-element-found-in">
29422957
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
29432958
:
2944-
<span class="phpdocumentor-element-found-in__line">2039</span>
2959+
<span class="phpdocumentor-element-found-in__line">2056</span>
29452960

29462961
</aside>
29472962

@@ -3001,7 +3016,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportReports">
30013016
<aside class="phpdocumentor-element-found-in">
30023017
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
30033018
:
3004-
<span class="phpdocumentor-element-found-in__line">2180</span>
3019+
<span class="phpdocumentor-element-found-in__line">2197</span>
30053020

30063021
</aside>
30073022

@@ -3141,7 +3156,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportSurveyLink">
31413156
<aside class="phpdocumentor-element-found-in">
31423157
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
31433158
:
3144-
<span class="phpdocumentor-element-found-in__line">2232</span>
3159+
<span class="phpdocumentor-element-found-in__line">2249</span>
31453160

31463161
</aside>
31473162

@@ -3216,7 +3231,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportSurveyParticipants">
32163231
<aside class="phpdocumentor-element-found-in">
32173232
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
32183233
:
3219-
<span class="phpdocumentor-element-found-in__line">2273</span>
3234+
<span class="phpdocumentor-element-found-in__line">2290</span>
32203235

32213236
</aside>
32223237

@@ -3291,7 +3306,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportSurveyQueueLink">
32913306
<aside class="phpdocumentor-element-found-in">
32923307
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
32933308
:
3294-
<span class="phpdocumentor-element-found-in__line">2302</span>
3309+
<span class="phpdocumentor-element-found-in__line">2319</span>
32953310

32963311
</aside>
32973312

@@ -3338,7 +3353,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportSurveyReturnCode">
33383353
<aside class="phpdocumentor-element-found-in">
33393354
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
33403355
:
3341-
<span class="phpdocumentor-element-found-in__line">2331</span>
3356+
<span class="phpdocumentor-element-found-in__line">2348</span>
33423357

33433358
</aside>
33443359

@@ -3470,7 +3485,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportUserRoleAssignments">
34703485
<aside class="phpdocumentor-element-found-in">
34713486
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
34723487
:
3473-
<span class="phpdocumentor-element-found-in__line">2623</span>
3488+
<span class="phpdocumentor-element-found-in__line">2640</span>
34743489

34753490
</aside>
34763491

@@ -3527,7 +3542,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportUserRoles">
35273542
<aside class="phpdocumentor-element-found-in">
35283543
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
35293544
:
3530-
<span class="phpdocumentor-element-found-in__line">2501</span>
3545+
<span class="phpdocumentor-element-found-in__line">2518</span>
35313546

35323547
</aside>
35333548

@@ -3583,7 +3598,7 @@ <h4 class="phpdocumentor-element__name" id="method_exportUsers">
35833598
<aside class="phpdocumentor-element-found-in">
35843599
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
35853600
:
3586-
<span class="phpdocumentor-element-found-in__line">2370</span>
3601+
<span class="phpdocumentor-element-found-in__line">2387</span>
35873602

35883603
</aside>
35893604

@@ -3679,7 +3694,7 @@ <h4 class="phpdocumentor-element__name" id="method_getApiToken">
36793694
<aside class="phpdocumentor-element-found-in">
36803695
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
36813696
:
3682-
<span class="phpdocumentor-element-found-in__line">2807</span>
3697+
<span class="phpdocumentor-element-found-in__line">2824</span>
36833698

36843699
</aside>
36853700

@@ -3714,7 +3729,7 @@ <h4 class="phpdocumentor-element__name" id="method_getApiUrl">
37143729
<aside class="phpdocumentor-element-found-in">
37153730
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
37163731
:
3717-
<span class="phpdocumentor-element-found-in__line">2797</span>
3732+
<span class="phpdocumentor-element-found-in__line">2814</span>
37183733

37193734
</aside>
37203735

@@ -3749,7 +3764,7 @@ <h4 class="phpdocumentor-element__name" id="method_getConnection">
37493764
<aside class="phpdocumentor-element-found-in">
37503765
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
37513766
:
3752-
<span class="phpdocumentor-element-found-in__line">2821</span>
3767+
<span class="phpdocumentor-element-found-in__line">2838</span>
37533768

37543769
</aside>
37553770

@@ -3788,7 +3803,7 @@ <h4 class="phpdocumentor-element__name" id="method_getErrorHandler">
37883803
<aside class="phpdocumentor-element-found-in">
37893804
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
37903805
:
3791-
<span class="phpdocumentor-element-found-in__line">2842</span>
3806+
<span class="phpdocumentor-element-found-in__line">2859</span>
37923807

37933808
</aside>
37943809

@@ -3823,7 +3838,7 @@ <h4 class="phpdocumentor-element__name" id="method_getPhpCapVersion">
38233838
<aside class="phpdocumentor-element-found-in">
38243839
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
38253840
:
3826-
<span class="phpdocumentor-element-found-in__line">2698</span>
3841+
<span class="phpdocumentor-element-found-in__line">2715</span>
38273842

38283843
</aside>
38293844

@@ -3856,7 +3871,7 @@ <h4 class="phpdocumentor-element__name" id="method_getRecordIdBatches">
38563871
<aside class="phpdocumentor-element-found-in">
38573872
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
38583873
:
3859-
<span class="phpdocumentor-element-found-in__line">2735</span>
3874+
<span class="phpdocumentor-element-found-in__line">2752</span>
38603875

38613876
</aside>
38623877

@@ -3945,7 +3960,7 @@ <h4 class="phpdocumentor-element__name" id="method_getRecordIdFieldName">
39453960
<aside class="phpdocumentor-element-found-in">
39463961
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
39473962
:
3948-
<span class="phpdocumentor-element-found-in__line">2785</span>
3963+
<span class="phpdocumentor-element-found-in__line">2802</span>
39493964

39503965
</aside>
39513966

@@ -4840,7 +4855,7 @@ <h4 class="phpdocumentor-element__name" id="method_importRepeatingInstrumentsAnd
48404855
<aside class="phpdocumentor-element-found-in">
48414856
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
48424857
:
4843-
<span class="phpdocumentor-element-found-in__line">2078</span>
4858+
<span class="phpdocumentor-element-found-in__line">2095</span>
48444859

48454860
</aside>
48464861

@@ -4991,7 +5006,7 @@ <h4 class="phpdocumentor-element__name" id="method_importUserRoleAssignments">
49915006
<aside class="phpdocumentor-element-found-in">
49925007
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
49935008
:
4994-
<span class="phpdocumentor-element-found-in__line">2669</span>
5009+
<span class="phpdocumentor-element-found-in__line">2686</span>
49955010

49965011
</aside>
49975012

@@ -5062,7 +5077,7 @@ <h4 class="phpdocumentor-element__name" id="method_importUserRoles">
50625077
<aside class="phpdocumentor-element-found-in">
50635078
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
50645079
:
5065-
<span class="phpdocumentor-element-found-in__line">2559</span>
5080+
<span class="phpdocumentor-element-found-in__line">2576</span>
50665081

50675082
</aside>
50685083

@@ -5145,7 +5160,7 @@ <h4 class="phpdocumentor-element__name" id="method_importUsers">
51455160
<aside class="phpdocumentor-element-found-in">
51465161
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
51475162
:
5148-
<span class="phpdocumentor-element-found-in__line">2437</span>
5163+
<span class="phpdocumentor-element-found-in__line">2454</span>
51495164

51505165
</aside>
51515166

@@ -5237,7 +5252,7 @@ <h4 class="phpdocumentor-element__name" id="method_renameRecord">
52375252
<aside class="phpdocumentor-element-found-in">
52385253
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
52395254
:
5240-
<span class="phpdocumentor-element-found-in__line">1995</span>
5255+
<span class="phpdocumentor-element-found-in__line">2012</span>
52415256

52425257
</aside>
52435258

@@ -5303,7 +5318,7 @@ <h4 class="phpdocumentor-element__name" id="method_setConnection">
53035318
<aside class="phpdocumentor-element-found-in">
53045319
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
53055320
:
5306-
<span class="phpdocumentor-element-found-in__line">2832</span>
5321+
<span class="phpdocumentor-element-found-in__line">2849</span>
53075322

53085323
</aside>
53095324

@@ -5349,7 +5364,7 @@ <h4 class="phpdocumentor-element__name" id="method_setErrorHandler">
53495364
<aside class="phpdocumentor-element-found-in">
53505365
<abbr class="phpdocumentor-element-found-in__file" title="src/RedCapProject.php"><a href="files/src-redcapproject.html"><abbr title="src/RedCapProject.php">RedCapProject.php</abbr></a></abbr>
53515366
:
5352-
<span class="phpdocumentor-element-found-in__line">2852</span>
5367+
<span class="phpdocumentor-element-found-in__line">2869</span>
53535368

53545369
</aside>
53555370

‎docs/api/classes/IU-PHPCap-Version.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ <h3 id="toc">
134134
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
135135
<a href="classes/IU-PHPCap-Version.html#constant_RELEASE_NUMBER">RELEASE_NUMBER</a>
136136
<span>
137-
&nbsp;= &quot;1.4.2&quot; </span>
137+
&nbsp;= &quot;1.5.0&quot; </span>
138138
</dt>
139139
<dd></dd>
140140

@@ -166,7 +166,7 @@ <h4 class="phpdocumentor-element__name" id="constant_RELEASE_NUMBER">
166166
<span class="phpdocumentor-signature__visibility">public</span>
167167
<span class="phpdocumentor-signature__type">mixed</span>
168168
<span class="phpdocumentor-signature__name">RELEASE_NUMBER</span>
169-
= <span class="phpdocumentor-signature__default-value">&quot;1.4.2&quot;</span>
169+
= <span class="phpdocumentor-signature__default-value">&quot;1.5.0&quot;</span>
170170
</code>
171171

172172

0 commit comments

Comments
 (0)