CustomFieldsInstructionData Class Reference

Public Member Functions

 getMissingValuesToAdd ()
 getMissingValuesToMap ()
 hasDataByColumnName ($columnName)
 getDataByColumnName ($columnName)
 addMissingValuesByColumnName (array $missingCustomFieldValues, $columnName)
 addByInstructionsDataAndColumnName ($instructionsData, $columnName)
 resolveForNewData (CustomFieldsInstructionData $newInstructionsData)

Data Fields

const ADD_MISSING_VALUES = 'Add missing value'
const MAP_MISSING_VALUES = 'Map missing value'

Protected Member Functions

 resolveMissingValueToAdd ($missingCustomFieldValue, $columnName)
 resolveMissingValueToMap ($missingCustomFieldValue, $mapToValue, $columnName)

Protected Attributes

 $missingValuesToAdd = array()
 $missingValuesToMap = array()

Detailed Description

Helper class for working with customFields during import. Organizes which values are missing and should be added and what values are missing and should be mapped.

Definition at line 41 of file CustomFieldsInstructionData.php.


Member Function Documentation

getMissingValuesToAdd (  ) 
Returns:
array

Definition at line 69 of file CustomFieldsInstructionData.php.

getMissingValuesToMap (  ) 
Returns:
array

Definition at line 77 of file CustomFieldsInstructionData.php.

hasDataByColumnName ( columnName  ) 
Parameters:
$columnName 
Returns:
boolean

Definition at line 86 of file CustomFieldsInstructionData.php.

getDataByColumnName ( columnName  ) 
Parameters:
$columnName 
Returns:
array of data specific to the column specified

Definition at line 101 of file CustomFieldsInstructionData.php.

addMissingValuesByColumnName ( array $  missingCustomFieldValues,
columnName 
)
Parameters:
array $missingCustomFieldValues
string $columnName

Definition at line 120 of file CustomFieldsInstructionData.php.

addByInstructionsDataAndColumnName ( instructionsData,
columnName 
)
Parameters:
$instructionsData is the 'customFieldsInstructionData' array element in the mappingData
string $columnName

Definition at line 135 of file CustomFieldsInstructionData.php.

resolveForNewData ( CustomFieldsInstructionData newInstructionsData  ) 

Appends missingValuesToAdd and missingValuesToMap with new data

Parameters:
CustomFieldsInstructionData $newInstructionsData

Definition at line 158 of file CustomFieldsInstructionData.php.

resolveMissingValueToMap ( missingCustomFieldValue,
mapToValue,
columnName 
) [protected]
Parameters:
string $missingCustomFieldValue
string $mapToValue
string $columnName

Definition at line 195 of file CustomFieldsInstructionData.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat Sep 23 07:10:23 2017