All Data Structures Functions Variables Pages
Public Member Functions | Protected Member Functions | Static Protected Member Functions
ModelDerivedIdValueTypeSanitizerUtil Class Reference
Inheritance diagram for ModelDerivedIdValueTypeSanitizerUtil:
IdValueTypeSanitizerUtil ExternalSystemIdSuppportedSanitizerUtil SanitizerUtil AccountDerivedIdValueTypeSanitizerUtil ContactDerivedIdValueTypeSanitizerUtil ImportModelTestItem3DerivedIdValueTypeSanitizerUtil OpportunityDerivedIdValueTypeSanitizerUtil

Public Member Functions

 sanitizeValue ($value)
 
- Public Member Functions inherited from IdValueTypeSanitizerUtil
 analyzeByRow (RedBean_OODBBean $rowBean)
 
- Public Member Functions inherited from SanitizerUtil
 sanitizeValue ($value)
 
 analyzeByRow (RedBean_OODBBean $rowBean)
 
 __construct ($modelClassName, $attributeName, $columnName, array $columnMappingData, ImportSanitizeResultsUtil $importSanitizeResultsUtil=null, $penultimateModelClassName, $penultimateAttributeName, $explicitReadWriteModelPermissions=null)
 
 shouldSanitizeValue ()
 
 getAnalysisMessages ()
 
 getShouldSkipRow ()
 

Protected Member Functions

 resolveAttributeModelClassName (RedBeanModel $model, $attributeName)
 
- Protected Member Functions inherited from IdValueTypeSanitizerUtil
 resolveFindingModelDuringAnalysis ($found, RedBean_OODBBean $rowBean)
 
 resolveExternalSystemIdValueIsTooLong (RedBean_OODBBean $rowBean)
 
 resolveForUnfoundModel (RedBean_OODBBean $rowBean)
 
 ensureTypeValueIsValid ($type)
 
 assertMappingRuleDataIsValid ()
 
 resolveMappingRuleDataType ()
 
 init ()
 
- Protected Member Functions inherited from ExternalSystemIdSuppportedSanitizerUtil
 resolveFoundIdByValue ($value)
 
 resolveAttributeModelClassName (RedBeanModel $model, $attributeName)
 
 resolveForFoundModel ()
 
 resolveFoundExternalSystemIdByValue ($value)
 
- Protected Member Functions inherited from SanitizerUtil
 init ()
 
 assertMappingRuleDataIsValid ()
 

Static Protected Member Functions

static getDerivedModelClassName ()
 
- Static Protected Member Functions inherited from SanitizerUtil
static resolveMappingRuleData ($columnMappingData)
 

Additional Inherited Members

- Static Public Member Functions inherited from IdValueTypeSanitizerUtil
static getLinkedMappingRuleType ()
 
static shouldNotSaveModelOnSanitizingValueFailure ()
 
- Static Public Member Functions inherited from ExternalSystemIdSuppportedSanitizerUtil
static getModelByExternalSystemIdAndModelClassName ($id, $modelClassName)
 
- Static Public Member Functions inherited from SanitizerUtil
static getType ()
 
static getLinkedMappingRuleType ()
 
static shouldNotSaveModelOnSanitizingValueFailure ()
 
- Protected Attributes inherited from IdValueTypeSanitizerUtil
 $type
 
- Protected Attributes inherited from ExternalSystemIdSuppportedSanitizerUtil
 $externalSystemIdMaxLength = 40
 
 $attributeModelClassName
 
- Protected Attributes inherited from SanitizerUtil
 $modelClassName
 
 $attributeName
 
 $analysisMessages = array()
 
 $shouldSkipRow = false
 
 $columnName
 
 $columnMappingData = array()
 
 $mappingRuleData = array()
 
 $importSanitizeResultsUtil
 
 $penultimateModelClassName
 
 $penultimateAttributeName
 
 $explicitReadWriteModelPermissions = null
 

Detailed Description

Sanitizer for attributes that are derived model types. This means the specific relation is not on the model, but typically this is a casted down version of the actual relation on the model.

Definition at line 41 of file ModelDerivedIdValueTypeSanitizerUtil.php.

Member Function Documentation

sanitizeValue (   $value)

Given a value that is either a zurmo id or an external system id, resolve that the value is valid. If the value is not valid then an InvalidValueToSanitizeException is thrown.

Parameters
mixed$value
Returns
sanitized value
Exceptions
InvalidValueToSanitizeException
NotFoundException

Definition at line 56 of file ModelDerivedIdValueTypeSanitizerUtil.php.

resolveAttributeModelClassName ( RedBeanModel  $model,
  $attributeName 
)
protected

Override since the effective attribute is always 'id'

Parameters
RedBeanModel$model
string$attributeName
Returns
string $attributeModelClassName

Definition at line 106 of file ModelDerivedIdValueTypeSanitizerUtil.php.


The documentation for this class was generated from the following file:
Generated on Wed Jun 3 2020 07:10:54