AttributeImportRules Class Reference

Inheritance diagram for AttributeImportRules:
DerivedAttributeImportRules NonDerivedAttributeImportRules AfterSaveActionDerivedAttributeImportRules ContactStateAttributeImportRules FullNameAttributeImportRules ModelDerivedAttributeImportRules PasswordAttributeImportRules AfterSaveActionNonDerivedAttributeImportRules CheckBoxAttributeImportRules CreatedByUserAttributeImportRules CreatedDateTimeAttributeImportRules CurrencyValueAttributeImportRules DateAttributeImportRules DateTimeAttributeImportRules DecimalAttributeImportRules DropDownAttributeImportRules EmailAttributeImportRules IdAttributeImportRules ImportModelTestItem2AttributeImportRules IntegerAttributeImportRules LatestActivityDateTimeAttributeImportRules ModelAttributeImportRules ModifiedByUserAttributeImportRules ModifiedDateTimeAttributeImportRules MultiSelectDropDownAttributeImportRules PhoneAttributeImportRules TextAreaAttributeImportRules TextAttributeImportRules UrlAttributeImportRules UsernameAttributeImportRules

Public Member Functions

 __construct ($model)
 getModelClassName ()
 getRealModelAttributeNames ()
 getDisplayLabelByAttributeName ($attributeName)

Static Public Member Functions

static getType ()
static getModelAttributeMappingRuleFormTypesAndElementTypes ($type)
static getSanitizerUtilTypesInProcessingOrder ()
static getExtraColumnUsableCountOfModelAttributeMappingRuleFormTypesAndElementTypes ()

Static Protected Member Functions

static getAllModelAttributeMappingRuleFormTypesAndElementTypes ()
static getExtraColumnOnlyModelAttributeMappingRuleFormTypesAndElementTypes ()
static getImportColumnOnlyModelAttributeMappingRuleFormTypesAndElementTypes ()

Protected Attributes

 $model

Detailed Description

Base class for defining an attribute or derived attribute's import rules.

Definition at line 40 of file AttributeImportRules.php.


Member Function Documentation

static getType (  )  [static]
Returns:
string - If the class name is TestAttributeImportRules, then 'Test' will be returned.

Definition at line 53 of file AttributeImportRules.php.

getRealModelAttributeNames (  )  [abstract]

Since the attributes can be derived or real, this method provides a uniform api that can be called regardless of whether the attribute is derived or not, and will produce the real model attribute names if available.

Returns:
array

Reimplemented in ContactStateAttributeImportRules, DerivedAttributeImportRules, FullNameAttributeImportRules, ModelDerivedAttributeImportRules, NonDerivedAttributeImportRules, PasswordAttributeImportRules, and UserStatusAttributeImportRules.

static getModelAttributeMappingRuleFormTypesAndElementTypes ( type  )  [static]

Returns mapping rule form and the associated element to use. Override to specify as many pairings as needed.

Returns:
array of MappingRuleForm/Element pairings.

Definition at line 83 of file AttributeImportRules.php.

static getAllModelAttributeMappingRuleFormTypesAndElementTypes (  )  [static, protected]

Returns mapping rule form and the associated element to use. Override to specify as many pairings as needed. This method is used for mapping rule form/element pairings that are available for both types of columns.

Returns:
array of MappingRuleForm/Element pairings.

Reimplemented in AccountAttributeImportRules, ContactAttributeImportRules, ContactStateAttributeImportRules, CheckBoxAttributeImportRules, CurrencyValueAttributeImportRules, DateAttributeImportRules, DateTimeAttributeImportRules, DecimalAttributeImportRules, DropDownAttributeImportRules, EmailAttributeImportRules, FullNameAttributeImportRules, IntegerAttributeImportRules, ModelAttributeImportRules, ModelDerivedAttributeImportRules, MultiSelectDropDownAttributeImportRules, NameAttributeImportRules, PhoneAttributeImportRules, TextAreaAttributeImportRules, TextAttributeImportRules, UrlAttributeImportRules, ImportModelTestItem2AttributeImportRules, LeadStateAttributeImportRules, ProductTemplatePriceFrequencyDropDownAttributeImportRules, ProductTemplateStatusDropDownAttributeImportRules, ProductTemplateTypeDropDownAttributeImportRules, SellPriceFormulaTypeDropDownAttributeImportRules, ProjectStatusDropDownAttributeImportRules, TaskStatusDropDownAttributeImportRules, CurrencyDropDownAttributeImportRules, LanguageStaticDropDownAttributeImportRules, LocaleStaticDropDownAttributeImportRules, PasswordAttributeImportRules, TimeZoneStaticDropDownAttributeImportRules, UserAttributeImportRules, UserStatusAttributeImportRules, and RoleAttributeImportRules.

Definition at line 105 of file AttributeImportRules.php.

static getExtraColumnOnlyModelAttributeMappingRuleFormTypesAndElementTypes (  )  [static, protected]

Override to place mapping rule forms / elements that are only for mapping extra columns.

Definition at line 113 of file AttributeImportRules.php.

static getImportColumnOnlyModelAttributeMappingRuleFormTypesAndElementTypes (  )  [static, protected]
static getSanitizerUtilTypesInProcessingOrder (  )  [static]
Returns:
array of sanitizer util names. The sanitizer utils in the array are in the order that they will be processed during the import.

Reimplemented in AccountAttributeImportRules, AccountDerivedAttributeImportRules, ContactAttributeImportRules, ContactDerivedAttributeImportRules, ContactStateAttributeImportRules, CheckBoxAttributeImportRules, CreatedByUserAttributeImportRules, CreatedDateTimeAttributeImportRules, CurrencyValueAttributeImportRules, DateAttributeImportRules, DateTimeAttributeImportRules, DecimalAttributeImportRules, DropDownAttributeImportRules, EmailAttributeImportRules, FullNameAttributeImportRules, IdAttributeImportRules, IntegerAttributeImportRules, LatestActivityDateTimeAttributeImportRules, ModelAttributeImportRules, ModelDerivedAttributeImportRules, ModifiedByUserAttributeImportRules, ModifiedDateTimeAttributeImportRules, MultiSelectDropDownAttributeImportRules, NameAttributeImportRules, PhoneAttributeImportRules, TextAreaAttributeImportRules, TextAttributeImportRules, UrlAttributeImportRules, ImportModelTestItem2AttributeImportRules, ImportModelTestItem3DerivedAttributeImportRules, LeadStateAttributeImportRules, OpportunityDerivedAttributeImportRules, ProductTemplatePriceFrequencyDropDownAttributeImportRules, ProductTemplateStatusDropDownAttributeImportRules, ProductTemplateTypeDropDownAttributeImportRules, SellPriceFormulaTypeDropDownAttributeImportRules, ProjectStatusDropDownAttributeImportRules, TaskStatusDropDownAttributeImportRules, CurrencyDropDownAttributeImportRules, LanguageStaticDropDownAttributeImportRules, LocaleStaticDropDownAttributeImportRules, PasswordAttributeImportRules, TimeZoneStaticDropDownAttributeImportRules, UserAttributeImportRules, UsernameAttributeImportRules, UserStatusAttributeImportRules, and RoleAttributeImportRules.

Definition at line 130 of file AttributeImportRules.php.

static getExtraColumnUsableCountOfModelAttributeMappingRuleFormTypesAndElementTypes (  )  [static]
Returns:
count of usable mapping rule form types. This count is different than for import columns because some mapping rules only show for import columns and not extra columns. This is the columnType in the mapping data.

Definition at line 140 of file AttributeImportRules.php.


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