public function exportInstrumentEventMappings($format = 'php', $arms = [])
    {
        $data = array(
                'token'        => $this->apiToken,
                'content'      => 'formEventMapping',
                'format'       => 'json',
                'returnFormat' => 'json'
        );
        
        #------------------------------------------
        # Process arguments
        #------------------------------------------
        $legalFormats = array('csv', 'json', 'php', 'xml');
        $data['format'] = $this->processFormatArgument($format, $legalFormats);
        $data['arms']   = $this->processArmsArgument($arms);
        
        #---------------------------------------------
        # Get and process instrument-event mappings
        #---------------------------------------------
        $instrumentEventMappings = $this->connection->callWithArray($data);
        $instrumentEventMappings = $this->processExportResult($instrumentEventMappings, $format);
        
        return $instrumentEventMappings;
    }
public function exportInstrumentEventMappings($format = 'php', $arms = [])
    {
        $data = array(
                'token'        => $this->apiToken,
                'content'      => 'formEventMapping',
                'format'       => 'json',
                'returnFormat' => 'json'
        );
        
        #------------------------------------------
        # Process arguments
        #------------------------------------------
        $legalFormats = array('csv', 'json', 'php', 'xml');
        $data['format'] = $this->processFormatArgument($format, $legalFormats);
        $data['arms']   = $this->processArmsArgument($arms);
        
        #---------------------------------------------
        # Get and process instrument-event mappings
        #---------------------------------------------
        $instrumentEventMappings = $this->connection->callWithArray($data);
        $instrumentEventMappings = $this->processExportResult($instrumentEventMappings, $format);
        
        return $instrumentEventMappings;
    }
public function exportInstrumentEventMappings ( $ format = 'php' , $ arms = [ ] ) { $ data = array ( 'token' => $ this -> apiToken , 'content' => 'formEventMapping' , 'format' => 'json' , 'returnFormat' => 'json' ) ; #------------------------------------------ # Process arguments #------------------------------------------ $ legalFormats = array ( 'csv' , 'json' , 'php' , 'xml' ) ; $ data [ 'format' ] = $ this -> processFormatArgument ( $ format , $ legalFormats ) ; $ data [ 'arms' ] = $ this -> processArmsArgument ( $ arms ) ; #--------------------------------------------- # Get and process instrument-event mappings #--------------------------------------------- $ instrumentEventMappings = $ this -> connection -> callWithArray ( $ data ) ; $ instrumentEventMappings = $ this -> processExportResult ( $ instrumentEventMappings , $ format ) ; return $ instrumentEventMappings ; }
Gets the instrument to event mapping for the project.

For example, the following code:
<code>
$map = $project->exportInstrumentEventMappings();
print_r($map[0]); # print first element of map
</code>
might generate the following output:
<pre>
Array
(
[arm_num] => 1
[unique_event_name] => enrollment_arm_1
[form] => demographics
)
</pre>

@param string $format the format in which to export the records:
<ul>
<li> 'php' - [default] array of maps of values</li>
<li> 'csv' - string of CSV (comma-separated values)</li>
<li> 'json' - string of JSON encoded values</li>
<li> 'xml' - string of XML encoded data</li>
</ul>
@param array $arms array of integers or numeric strings that are the numbers of the arms
for which instrument/event mapping infomation should be exported.
If no arms are specified, then information for all arms will be exported.

@return arrray an array of arrays that have the following keys:
<ul>
<li>'arm_num'</li>
<li>'unique_event_name'</li>
<li>'form'</li>
</ul>
Gets the instrument to event mapping for the project .