modules/Import/sources/ExternalSourceEAPMAdapter.php

Show:

inherited

Classes
- \ExternalSourceEAPMAdapter

Table of Contents

\ExternalSourceEAPMAdapter
jump to top

Package:

Parent(s): \ImportDataSource < ?\Iterator

Properties


                 $_createdCount= '0'

inherited

Count of newly created rows

Inherited from: \ImportDataSource::$$_createdCount

Default value0Details

Type: n/a
Inherited_from: \ImportDataSource::$$_createdCount


                 $_currentRow= 'FALSE'

inherited

Array of the values in the current array we are in

Inherited from: \ImportDataSource::$$_currentRow

Default valueFALSEDetails

Type: n/a
Inherited_from: \ImportDataSource::$$_currentRow


                 $_dataSet= 'array()'

inherited

Stores a subset or entire portion of the data set requested.

Inherited from: \ImportDataSource::$$_dataSet

Default valuearray()Details

Type: n/a
Inherited_from: \ImportDataSource::$$_dataSet


                 $_dupeCount= '0'

inherited

Count of duplicate rows

Inherited from: \ImportDataSource::$$_dupeCount

Default value0Details

Type: n/a
Inherited_from: \ImportDataSource::$$_dupeCount

string
                 $_eapmName= ''Google''

The name of the EAPM object.

Default value'Google'Details

Type: string


                 $_errorCount= '0'

inherited

Count of rows with errors

Inherited from: \ImportDataSource::$$_errorCount

Default value0Details

Type: n/a
Inherited_from: \ImportDataSource::$$_errorCount


                 $_localeSettings= 'array('importlocale_charset' => 'UTF-8',
                                       'importlocale_dateformat' => 'Y-m-d',
                                       'importlocale_timeformat' => 'H:i',
                                       'importlocale_timezone' => '',
                                       'importlocale_currency' => '',
                                       'importlocale_default_currency_significant_digits' => '',
                                       'importlocale_num_grp_sep' => '',
                                       'importlocale_dec_sep' => '',
                                       'importlocale_default_locale_name_format' => '')'

Holds any locale settings needed for import. These can be provided by the user or explicitly set by the user.

Default value

array('importlocale_charset' => 'UTF-8',
                                       'importlocale_dateformat' => 'Y-m-d',
                                       'importlocale_timeformat' => 'H:i',
                                       'importlocale_timezone' => '',
                                       'importlocale_currency' => '',
                                       'importlocale_default_currency_significant_digits' => '',
                                       'importlocale_num_grp_sep' => '',
                                       'importlocale_dec_sep' => '',
                                       'importlocale_default_locale_name_format' => '')

Details

Type: n/a


                 $_offset= '0'

inherited

The current offset the data set should start at

Inherited from: \ImportDataSource::$$_offset

Default value0Details

Type: n/a
Inherited_from: \ImportDataSource::$$_offset

\The
                 $_recordSet= 'array()'

record set loaded from the external source

Default valuearray()Details

Type: \The


                 $_rowCountedForErrors= 'false'

inherited

True if the current row has already had an error it in, so we don't increase the $_errorCount

Inherited from: \ImportDataSource::$$_rowCountedForErrors

Default valuefalseDetails

Type: n/a
Inherited_from: \ImportDataSource::$$_rowCountedForErrors


                 $_rowsCount= '0'

inherited

Count of rows processed

Inherited from: \ImportDataSource::$$_rowsCount

Default value0Details

Type: n/a
Inherited_from: \ImportDataSource::$$_rowsCount


                 $_sourcename= ''

inherited

Sourcename used as an identifier for this import

Inherited from: \ImportDataSource::$$_sourcename

Details

Type: n/a
Inherited_from: \ImportDataSource::$$_sourcename

int
                 $_totalRecordCount= '-1'

Total record count of rows that will be imported

Default value-1Details

Type: int


                 $_updatedCount= '0'

inherited

Count of updated rows

Inherited from: \ImportDataSource::$$_updatedCount

Default value0Details

Type: n/a
Inherited_from: \ImportDataSource::$$_updatedCount

Methods

__construct(
           $eapmName
          )
        
        :
          void

Parameters

Name	Type	Description
$eapmName

__get(
           $var
          )
        
        :
          void

inherited

Inherited from: \ImportDataSource::__get()

Parameters

Name	Type	Description
$var

current(
          
          )
        
        :
          void

formatErrorMessage(
           $error,  $fieldName,  $fieldValue
          )
        
        :
          void

inherited

Inherited from: \ImportDataSource::formatErrorMessage()

Parameters

Name	Type	Description
$error
$fieldName
$fieldValue

getCurrentOffset(
          
          )
        
        :
          int

inherited

Return the current offset

Inherited from: \ImportDataSource::getCurrentOffset()

Returns

Type	Description
int

getDataSet(
          
          )
        
        :
          array

inherited

Return the current data set loaded.

Inherited from: \ImportDataSource::getDataSet()

Returns

Type	Description
array

getHeaderColumns(
          
          )
        
        :
          void

getTotalRecordCount(
          
          )
        
        :
          int

Return the total count of records that will be imported.

Returns

Type	Description
int

loadDataSet(
           $maxResults
              =
              0
          )
        
        :
          array

Return a feed of google contacts using the EAPM and Connectors farmework.

Parameters

Name	Type	Description
$maxResults

Returns

Type	Description
array

Throws

Exception	Description
\Exception

markRowAsDuplicate(
           $field_names
              =
              array()
          )
        
        :
          void

inherited

Writes the row out to the ImportCacheFiles::getDuplicateFileName() file

Inherited from: \ImportDataSource::markRowAsDuplicate()

Parameters

Name	Type	Description
$field_names

markRowAsImported(
          \$createdRecord $createdRecord
              =
              true
          )
        
        :
          void

inherited

Marks whether this row created a new record or not

Inherited from: \ImportDataSource::markRowAsImported()

Parameters

Name	Type	Description
$createdRecord	\$createdRecord	bool true if record is created, false if it is just updated

resetRowErrorCounter(
          
          )
        
        :
          void

inherited

Inherited from: \ImportDataSource::resetRowErrorCounter()

rewind(
          
          )
        
        :
          void

setCurrentOffset(
           $offset
          )
        
        :
          void

inherited

Set the current offset.

Inherited from: \ImportDataSource::setCurrentOffset()

Parameters

Name	Type	Description
$offset

setSourceName(
           $sourceName
              =
              ''
          )
        
        :
          void

Set the source name.

Parameters

Name	Type	Description
$sourceName

writeError(
          \$error $error, \$fieldName $fieldName, \$fieldValue $fieldValue
          )
        
        :
          void

inherited

Writes the row out to the ImportCacheFiles::getErrorFileName() file

Inherited from: \ImportDataSource::writeError()

Parameters

Name	Type	Description
$error	\$error	string
$fieldName	\$fieldName	string
$fieldValue	\$fieldValue	mixed

writeErrorRecord(
           $errorMessage
              =
              ''
          )
        
        :
          void

inherited

Writes the row out to the ImportCacheFiles::getErrorRecordsFileName() file

Inherited from: \ImportDataSource::writeErrorRecord()

Parameters

Name	Type	Description
$errorMessage

writeRowToLastImport(
          string $import_module, string $module, string $id
          )
        
        :
          void

staticinherited

Add this row to the UsersLastImport table

Inherited from: \ImportDataSource::writeRowToLastImport()

Parameters

Name	Type	Description
$import_module	string	name of the module we are doing the import into
$module	string	name of the bean we are creating for this import
$id	string	id of the recorded created in the $module

writeStatus(
          
          )
        
        :
          void

inherited

Writes the totals and filename out to the ImportCacheFiles::getStatusFileName() file

Inherited from: \ImportDataSource::writeStatus()

modules/Import/sources/ExternalSourceEAPMAdapter.php

\ExternalSourceEAPMAdapterjump to top

Properties

Methods

\ExternalSourceEAPMAdapter
jump to top