RelatedModelNameOrIdValueTypeSanitizerUtil Class Reference

Inheritance diagram for RelatedModelNameOrIdValueTypeSanitizerUtil:
IdValueTypeSanitizerUtil ExternalSystemIdSuppportedSanitizerUtil SanitizerUtil RoleValueTypeSanitizerUtil

Public Member Functions

 analyzeByRow (RedBean_OODBBean $rowBean)
 sanitizeValue ($value)

Static Public Member Functions

static getLinkedMappingRuleType ()
static shouldNotSaveModelOnSanitizingValueFailure ()

Protected Member Functions

 resolveFoundNameByValue (RedBean_OODBBean $rowBean)
 ensureTypeValueIsValid ($type)
 assertMappingRuleDataIsValid ()
 init ()
 resolveForFoundModel ()
 resolveForUnfoundModel (RedBean_OODBBean $rowBean)

Protected Attributes

 $maxNameLength

Detailed Description

Sanitizer to handle attribute values that are possible a model name not just a model id.

Override to accomodate a value type of 'ZURMO_MODEL_NAME'. This would represent a model 'name' attribute value that can be used as a unique identifier to map to existing models. An example is when importing a contact, and the account name is provided. If the name is found, then the contact will be connected to the existing account otherwise a new account is created with the name provided.

Definition at line 46 of file RelatedModelNameOrIdValueTypeSanitizerUtil.php.


Member Function Documentation

static getLinkedMappingRuleType (  )  [static]
Returns:
string - the type of linked mapping rule or null if none available. Some sanitizers and data analyzers need information from a mapping rule form in order to perform their job. This method returns the type of mapping rule form.

Reimplemented from IdValueTypeSanitizerUtil.

Definition at line 50 of file RelatedModelNameOrIdValueTypeSanitizerUtil.php.

static shouldNotSaveModelOnSanitizingValueFailure (  )  [static]

If a model id value is invalid, then continue importing the row

Reimplemented from IdValueTypeSanitizerUtil.

Definition at line 58 of file RelatedModelNameOrIdValueTypeSanitizerUtil.php.

analyzeByRow ( RedBean_OODBBean $  rowBean  ) 
Parameters:
RedBean_OODBBean $rowBean
Exceptions:
NotSupportedException 

Reimplemented from IdValueTypeSanitizerUtil.

Definition at line 67 of file RelatedModelNameOrIdValueTypeSanitizerUtil.php.

sanitizeValue ( value  ) 

Given a value that is either a zurmo id or an external system id, resolve that the value is valid. The value presented can also be a 'name' value. If the name is not found as a model in the system, then a new related model will be created using this name. NOTE - If the related model has other required attributes that have no default values, then there will be a problem saving this new model. This is too be resolved at some point. If the value is not valid then an InvalidValueToSanitizeException is thrown.

Parameters:
mixed $value
Returns:
sanitized value
Exceptions:
InvalidValueToSanitizeException 
NotFoundException 
NotSupportedException 

Reimplemented from SanitizerUtil.

Definition at line 139 of file RelatedModelNameOrIdValueTypeSanitizerUtil.php.

ensureTypeValueIsValid ( type  )  [protected]

Ensure the type is an accepted type.

Parameters:
unknown_type integer

Reimplemented from IdValueTypeSanitizerUtil.

Definition at line 225 of file RelatedModelNameOrIdValueTypeSanitizerUtil.php.

assertMappingRuleDataIsValid (  )  [protected]

Override as needed

Reimplemented from IdValueTypeSanitizerUtil.

Reimplemented in RoleValueTypeSanitizerUtil.

Definition at line 232 of file RelatedModelNameOrIdValueTypeSanitizerUtil.php.

init (  )  [protected]

Override as needed

Reimplemented from IdValueTypeSanitizerUtil.

Reimplemented in RoleValueTypeSanitizerUtil.

Definition at line 239 of file RelatedModelNameOrIdValueTypeSanitizerUtil.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Oct 23 07:10:29 2017