ContactStateRequiredSanitizerUtil Class Reference

Inheritance diagram for ContactStateRequiredSanitizerUtil:
RequiredSanitizerUtil SanitizerUtil LeadStateRequiredSanitizerUtil

Public Member Functions

 sanitizeValue ($value)

Static Public Member Functions

static getLinkedMappingRuleType ()

Protected Member Functions

 assertMappingRuleDataIsValid ()

Detailed Description

Sanitizer for handling contact state. These are states that are the starting state or after. Manages if the state is required and the value is present.

Definition at line 41 of file ContactStateRequiredSanitizerUtil.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 RequiredSanitizerUtil.

Reimplemented in LeadStateRequiredSanitizerUtil.

Definition at line 43 of file ContactStateRequiredSanitizerUtil.php.

sanitizeValue ( value  ) 

Contact state is required. If the value provided is null then the sanitizer will attempt use a default value if provided. If this is missing then a InvalidValueToSanitizeException will be thrown.

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

Reimplemented from RequiredSanitizerUtil.

Definition at line 55 of file ContactStateRequiredSanitizerUtil.php.

assertMappingRuleDataIsValid (  )  [protected]

Override as needed

Reimplemented from SanitizerUtil.

Definition at line 85 of file ContactStateRequiredSanitizerUtil.php.


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