ExternalSystemIdSuppportedSanitizerUtil Class Reference

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

Static Public Member Functions

static getModelByExternalSystemIdAndModelClassName ($id, $modelClassName)

Protected Member Functions

 resolveFoundIdByValue ($value)
 resolveAttributeModelClassName (RedBeanModel $model, $attributeName)
 resolveForFoundModel ()
 resolveFoundExternalSystemIdByValue ($value)

Protected Attributes

 $externalSystemIdMaxLength = 40
 $attributeModelClassName

Detailed Description

Sanitizers that support the use of external system ids as possible values should extend this class.

Definition at line 40 of file ExternalSystemIdSuppportedSanitizerUtil.php.


Member Function Documentation

static getModelByExternalSystemIdAndModelClassName ( id,
modelClassName 
) [static]

Given an external system id and model class name, try to find the associated model if it exists. If it is not found, a NotFoundException will be thrown. Otherwise the model will be made and returned.

Parameters:
string $id
string $modelClassName
Returns:
RedBeanModel $model
Exceptions:
NotFoundException 

Definition at line 62 of file ExternalSystemIdSuppportedSanitizerUtil.php.

resolveFoundIdByValue ( value  )  [protected]

Tries to find the value in the system. If found, returns true, otherwise false.

Parameters:
string $value
Returns:
boolean

Definition at line 81 of file ExternalSystemIdSuppportedSanitizerUtil.php.

resolveAttributeModelClassName ( RedBeanModel model,
attributeName 
) [protected]

Given a model and an attribute, return the model class name for the attribute.

Parameters:
RedBeanModel $model
string $attributeName
Returns:
string $attributeModelClassName

Reimplemented in ModelDerivedIdValueTypeSanitizerUtil.

Definition at line 114 of file ExternalSystemIdSuppportedSanitizerUtil.php.

resolveFoundExternalSystemIdByValue ( value  )  [protected]

Tries to find the value in the system. If found, returns true, otherwise false.

Parameters:
string $value
Returns:
boolean

Definition at line 135 of file ExternalSystemIdSuppportedSanitizerUtil.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun Mar 26 07:10:24 2017