Skip to content

Commit 7af71a5

Browse files
committed
Improved documentation for getRepeatingInstrumentsAndEvents method
1 parent 53893de commit 7af71a5

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/RedCapProject.php

+8
Original file line numberDiff line numberDiff line change
@@ -1397,6 +1397,14 @@ public function deleteRecords($recordIds, $arm = null)
13971397
* <li> 'xml' - string of XML encoded data</li>
13981398
* <li> 'odm' - string with CDISC ODM XML format, specifically ODM version 1.3.1</li>
13991399
* </ul>
1400+
*
1401+
* @return mixed an array will be returned for the 'php' format, and a string for
1402+
* all other formats. For classic (non-longitudinal) studies, the
1403+
* 'form name' and 'custom form label' will be returned for each
1404+
* repeating form. Longitudinal studies additionally return the
1405+
* 'event name'. For repeating events in longitudinal studies, a blank
1406+
* value will be returned for the form_name. In all cases, a blank
1407+
* value will be returned for the 'custom form label' if it is not defined.
14001408
*/
14011409
public function exportRepeatingInstrumentsAndEvents($format = 'php')
14021410
{

0 commit comments

Comments
 (0)