IdValueTypeSanitizerUtil Class Reference

Inheritance diagram for IdValueTypeSanitizerUtil:
ExternalSystemIdSuppportedSanitizerUtil SanitizerUtil ModelDerivedIdValueTypeSanitizerUtil ModelIdValueTypeSanitizerUtil RelatedModelNameOrIdValueTypeSanitizerUtil SelfIdValueTypeSanitizerUtil AccountDerivedIdValueTypeSanitizerUtil ContactDerivedIdValueTypeSanitizerUtil ImportModelTestItem3DerivedIdValueTypeSanitizerUtil OpportunityDerivedIdValueTypeSanitizerUtil RoleValueTypeSanitizerUtil

Public Member Functions

 analyzeByRow (RedBean_OODBBean $rowBean)

Static Public Member Functions

static getLinkedMappingRuleType ()
static shouldNotSaveModelOnSanitizingValueFailure ()

Protected Member Functions

 resolveFindingModelDuringAnalysis ($found, RedBean_OODBBean $rowBean)
 resolveExternalSystemIdValueIsTooLong (RedBean_OODBBean $rowBean)
 resolveForUnfoundModel (RedBean_OODBBean $rowBean)
 ensureTypeValueIsValid ($type)
 assertMappingRuleDataIsValid ()
 resolveMappingRuleDataType ()
 init ()

Protected Attributes

 $type

Detailed Description

Sanitizer for attributes that are models, and handling the values that represent the ids of those models. If you are importing a related account on a contact, this would be used for the account id, not the contact id. To sanitize for the contact id in this example, you would use

See also:
SelfIdValueTypeSanitizerUtil

Data analyzer for columns mapped to attributes that are either ids or relation ids. For importing ids, there are several approved value types including a zurmo model id as well as an external system id that can be used to maintain key integerity during the entirety of a data import.

Definition at line 46 of file IdValueTypeSanitizerUtil.php.


Member Function Documentation

static getLinkedMappingRuleType (  )  [static]
Returns:
string - the type of linked mapping rule or null if none available. Some sanitizers and data analyzers need information from a mapping rule form in order to perform their job. This method returns the type of mapping rule form.

Reimplemented from SanitizerUtil.

Reimplemented in RelatedModelNameOrIdValueTypeSanitizerUtil, and SelfIdValueTypeSanitizerUtil.

Definition at line 55 of file IdValueTypeSanitizerUtil.php.

static shouldNotSaveModelOnSanitizingValueFailure (  )  [static]

If a model id value is invalid, then skip the entire row during import.

Reimplemented from SanitizerUtil.

Reimplemented in RelatedModelNameOrIdValueTypeSanitizerUtil.

Definition at line 63 of file IdValueTypeSanitizerUtil.php.

analyzeByRow ( RedBean_OODBBean $  rowBean  ) 
Parameters:
RedBean_OODBBean $rowBean

Reimplemented from SanitizerUtil.

Reimplemented in RelatedModelNameOrIdValueTypeSanitizerUtil.

Definition at line 71 of file IdValueTypeSanitizerUtil.php.

ensureTypeValueIsValid ( type  )  [protected]

Ensure the type is an accepted type.

Parameters:
unknown_type integer

Reimplemented in RelatedModelNameOrIdValueTypeSanitizerUtil.

Definition at line 129 of file IdValueTypeSanitizerUtil.php.

assertMappingRuleDataIsValid (  )  [protected]

Override as needed

Reimplemented from SanitizerUtil.

Reimplemented in RelatedModelNameOrIdValueTypeSanitizerUtil, and RoleValueTypeSanitizerUtil.

Definition at line 135 of file IdValueTypeSanitizerUtil.php.

init (  )  [protected]

Override as needed

Reimplemented from SanitizerUtil.

Reimplemented in RelatedModelNameOrIdValueTypeSanitizerUtil, and RoleValueTypeSanitizerUtil.

Definition at line 149 of file IdValueTypeSanitizerUtil.php.


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