Skip to content

Commit 98bf978

Browse files
committedJul 20, 2022
Improved documentation for file export
1 parent 1055b37 commit 98bf978

File tree

5 files changed

+71
-55
lines changed

5 files changed

+71
-55
lines changed
 

‎docs-md/UserGuide3.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,22 @@ PHPCap's __RedCapProject__ class provides the following 3 methods for exporting
1212
3. __exportReports__ - method that exports the records produced by a report that
1313
is defined for the project in REDCap.
1414

15-
The detailed documentation for the RedCapProject class can be found in the PHPCap API documentation:
16-
[RedCapProject Class](api/classes/IU-PHPCap-RedCapProject.html)
17-
18-
__Batch Processing__. The methods above return all of their records at once, but
15+
**Batch Processing.** The methods above return all of their records at once, but
1916
the method __getRecordIdBatches__ can be used with the first 2 methods above
2017
to export records in batches. This will cut down on the memory requirements of the export, which
2118
can be useful for exporting the records from very large projects.
2219

20+
**Files.** When records are exported, the contents of any files in those records will
21+
*not* be exported. To export files,
22+
you need to use the
23+
[exportFile](api/classes/IU-PHPCap-RedCapProject.html#method_exportFile)
24+
method. This method can only export a single file, so if you want to
25+
export multiple files, you will need to call the method multiple times.
26+
27+
The detailed documentation for the **RedCapProject** class can be found in the PHPCap API documentation:
28+
[RedCapProject Class](api/classes/IU-PHPCap-RedCapProject.html)
29+
30+
2331
exportRecords
2432
---------------------------
2533
The exportRecords method is a standard PHP method that has 12 parameters that can
@@ -141,3 +149,4 @@ above might return, for example:
141149
```
142150

143151
API documentation: [getRecorIdBatches()](api/classes/IU-PHPCap-RedCapProject.html#method_getRecordIdBatches)
152+

‎docs/UserGuide3.html

+9-3
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,18 @@ <h1>User Guide 3 - Exporting Records</h1>
4747
<li><strong>exportReports</strong> - method that exports the records produced by a report that
4848
is defined for the project in REDCap.</li>
4949
</ol>
50-
<p>The detailed documentation for the RedCapProject class can be found in the PHPCap API documentation:
51-
<a href="api/classes/IU-PHPCap-RedCapProject.html">RedCapProject Class</a></p>
52-
<p><strong>Batch Processing</strong>. The methods above return all of their records at once, but
50+
<p><strong>Batch Processing.</strong> The methods above return all of their records at once, but
5351
the method <strong>getRecordIdBatches</strong> can be used with the first 2 methods above
5452
to export records in batches. This will cut down on the memory requirements of the export, which
5553
can be useful for exporting the records from very large projects.</p>
54+
<p><strong>Files.</strong> When records are exported, the contents of any files in those records will
55+
<em>not</em> be exported. To export files,
56+
you need to use the
57+
<a href="api/classes/IU-PHPCap-RedCapProject.html#method_exportFile">exportFile</a>
58+
method. This method can only export a single file, so if you want to
59+
export multiple files, you will need to call the method multiple times.</p>
60+
<p>The detailed documentation for the <strong>RedCapProject</strong> class can be found in the PHPCap API documentation:
61+
<a href="api/classes/IU-PHPCap-RedCapProject.html">RedCapProject Class</a></p>
5662
<h2 id="exportRecords">exportRecords</h2>
5763
<p>The exportRecords method is a standard PHP method that has 12 parameters that can
5864
be set to modify the records that are exported and their format.</p>

0 commit comments

Comments
 (0)