include/export_utils.php

Show:

inherited

Table of Contents

Functions

export(
          string $type, array $records
              =
              null,  $members
              =
              false,  $sample
              =
              false
          )
        
        :
          string

builds up a delimited string for export

Parameters

Name	Type	Description
$type	string	type the bean-type to export
$records	array	records an array of records if coming directly from a query
$members
$sample

Returns

Type	Description
string	delimited string for export

exportSample(
          string $type
          )
        
        :
          string

calls export method to build up a delimited string and some sample instructional text on how to use this file

Parameters

Name	Type	Description
$type	string	type the bean-type to export

Returns

Type	Description
string	delimited string for export with some tutorial text

generateSearchWhere(
           $module,  $query
          )
        
        :
          void

Parameters

Name	Type	Description
$module
$query

getDelimiter(
          
          )
        
        :
          string

gets the system default delimiter or an user-preference based override

Returns

Type	Description
string	the delimiter

get_field_order_mapping(
           $name
              =
              '',  $reorderArr
              =
              '',  $exclude
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$reorderArr
$exclude

returnFakeDataRow(
           $focus,  $field_array,  $rowsToReturn
              =
              5
          )
        
        :
          void

Parameters

Name	Type	Description
$focus
$field_array
$rowsToReturn

translateForExport(
           $field_db_name,  $focus
          )
        
        :
          void

Parameters

Name	Type	Description
$field_db_name
$focus