All Data Structures Functions Variables Pages
Public Member Functions | Protected Member Functions
ModelIdValueTypeSanitizerUtil Class Reference
Inheritance diagram for ModelIdValueTypeSanitizerUtil:
IdValueTypeSanitizerUtil ExternalSystemIdSuppportedSanitizerUtil SanitizerUtil

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

 resolveForFoundModel ()
 
- 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 ()
 

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 ()
 
- Static Protected Member Functions inherited from SanitizerUtil
static resolveMappingRuleData ($columnMappingData)
 
- 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 ids. This would be used if mapping an id for the model that is being imported.

Definition at line 40 of file ModelIdValueTypeSanitizerUtil.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

Definition at line 49 of file ModelIdValueTypeSanitizerUtil.php.

resolveForFoundModel ( )
protected

No message is needed, because it found the model and will relate to it ok.

Definition at line 85 of file ModelIdValueTypeSanitizerUtil.php.


The documentation for this class was generated from the following file:
Generated on Fri Jan 24 2020 07:10:38