RequiredSanitizerUtil Class Reference

Inheritance diagram for RequiredSanitizerUtil:
SanitizerUtil ContactStateRequiredSanitizerUtil DropDownRequiredSanitizerUtil FullNameRequiredSanitizerUtil ModelIdRequiredSanitizerUtil MultiSelectDropDownRequiredSanitizerUtil LeadStateRequiredSanitizerUtil

Public Member Functions

 analyzeByRow (RedBean_OODBBean $rowBean)
 sanitizeValue ($value)
 shouldSanitizeValue ()

Static Public Member Functions

static getLinkedMappingRuleType ()
static shouldNotSaveModelOnSanitizingValueFailure ()

Detailed Description

Sanitizer for resolving if an attribute is required or not and whether the value is present.

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

Reimplemented in ContactStateRequiredSanitizerUtil, DropDownRequiredSanitizerUtil, FullNameRequiredSanitizerUtil, ModelIdRequiredSanitizerUtil, MultiSelectDropDownRequiredSanitizerUtil, and LeadStateRequiredSanitizerUtil.

Definition at line 42 of file RequiredSanitizerUtil.php.

static shouldNotSaveModelOnSanitizingValueFailure (  )  [static]

If a required value is missing or invalid, then skip the entire row during import.

Reimplemented from SanitizerUtil.

Definition at line 50 of file RequiredSanitizerUtil.php.

analyzeByRow ( RedBean_OODBBean $  rowBean  ) 
Parameters:
RedBean_OODBBean $rowBean

Reimplemented from SanitizerUtil.

Reimplemented in FullNameRequiredSanitizerUtil.

Definition at line 58 of file RequiredSanitizerUtil.php.

sanitizeValue ( value  ) 

Resolves that the value is not null or the value is null and a valid default value is available for the model id. If not, then an InvalidValueToSanitizeException is thrown.

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

Reimplemented from SanitizerUtil.

Reimplemented in ContactStateRequiredSanitizerUtil, DropDownRequiredSanitizerUtil, FullNameRequiredSanitizerUtil, ModelIdRequiredSanitizerUtil, and MultiSelectDropDownRequiredSanitizerUtil.

Definition at line 85 of file RequiredSanitizerUtil.php.


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