Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes
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 StageModifiedDateTimeAttributeImportRules TextAreaAttributeImportRules TextAttributeImportRules UrlAttributeImportRules UsernameAttributeImportRules

Public Member Functions

 __construct ($model, $explicitReadWriteModelPermissions=null)
 
 getModelClassName ()
 
 getExplicitReadWriteModelPermissions ()
 
 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
 
 $explicitReadWriteModelPermissions = null
 

Detailed Description

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

Definition at line 40 of file AttributeImportRules.php.

Constructor & Destructor Documentation

__construct (   $model,
  $explicitReadWriteModelPermissions = null 
)
Parameters
$model
null|| ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions

Definition at line 50 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 60 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
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 95 of file AttributeImportRules.php.

static getAllModelAttributeMappingRuleFormTypesAndElementTypes ( )
staticprotected

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.

Definition at line 117 of file AttributeImportRules.php.

static getExtraColumnOnlyModelAttributeMappingRuleFormTypesAndElementTypes ( )
staticprotected

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

Definition at line 125 of file AttributeImportRules.php.

static getImportColumnOnlyModelAttributeMappingRuleFormTypesAndElementTypes ( )
staticprotected

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

Definition at line 133 of file AttributeImportRules.php.

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.

Definition at line 142 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 152 of file AttributeImportRules.php.


The documentation for this class was generated from the following file:
Generated on Sat Aug 8 2020 07:10:39
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.