DropDownSanitizerUtil Class Reference

Inheritance diagram for DropDownSanitizerUtil:
SanitizerUtil ImportSanitizerHasCustomFieldValuesInterface MultiSelectDropDownSanitizerUtil

Public Member Functions

 getMissingCustomFieldValues ()
 analyzeByRow (RedBean_OODBBean $rowBean)
 sanitizeValue ($value)

Static Public Member Functions

static supportsSanitizingWithInstructions ()

Protected Member Functions

 assertMappingRuleDataIsValid ()
 getCustomFieldsInstructionDataFromColumnMappingData ()

Protected Attributes

 $missingCustomFieldValues = array()

Detailed Description

Sanitizer for drop down attributes.

Definition at line 40 of file DropDownSanitizerUtil.php.


Member Function Documentation

static supportsSanitizingWithInstructions (  )  [static]

Override to support instructions for drop downs. An example is if there is a missing drop down value, information is provided in the instructions explainnig whether to add the missing drop down, delete the value, or merge the value into an existing drop down.

Definition at line 49 of file DropDownSanitizerUtil.php.

analyzeByRow ( RedBean_OODBBean $  rowBean  ) 
Parameters:
RedBean_OODBBean $rowBean

Reimplemented from SanitizerUtil.

Reimplemented in MultiSelectDropDownSanitizerUtil.

Definition at line 62 of file DropDownSanitizerUtil.php.

sanitizeValue ( value  ) 

Given a value, resolve that the value is a valid custom field data value. If the value does not exist yet, check the import instructions data to determine how to handle the missing value.

Parameters:
mixed $value
Returns:
sanitized value
Exceptions:
InvalidValueToSanitizeException 

Reimplemented from SanitizerUtil.

Reimplemented in MultiSelectDropDownSanitizerUtil.

Definition at line 87 of file DropDownSanitizerUtil.php.

assertMappingRuleDataIsValid (  )  [protected]

Override as needed

Reimplemented from SanitizerUtil.

Definition at line 166 of file DropDownSanitizerUtil.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Aug 16 07:10:24 2017