UserValueTypeSanitizerUtil Class Reference

Inheritance diagram for UserValueTypeSanitizerUtil:
ExternalSystemIdSuppportedSanitizerUtil SanitizerUtil

Public Member Functions

 analyzeByRow (RedBean_OODBBean $rowBean)
 sanitizeValue ($value)

Static Public Member Functions

static getLinkedMappingRuleType ()
static getUsernames ()
static getUserIds ()
static getUserExternalSystemIds ()

Protected Member Functions

 getAcceptableValues ()
 assertMappingRuleDataIsValid ()

Detailed Description

Sanitizer that is for attributes that are user models.

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

Definition at line 42 of file UserValueTypeSanitizerUtil.php.

analyzeByRow ( RedBean_OODBBean $  rowBean  ) 
Parameters:
RedBean_OODBBean $rowBean

Reimplemented from SanitizerUtil.

Definition at line 71 of file UserValueTypeSanitizerUtil.php.

sanitizeValue ( value  ) 

Given a value that is either a zurmo user id, a username, or an external system user 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 

Reimplemented from SanitizerUtil.

Definition at line 95 of file UserValueTypeSanitizerUtil.php.

assertMappingRuleDataIsValid (  )  [protected]

Override as needed

Reimplemented from SanitizerUtil.

Definition at line 157 of file UserValueTypeSanitizerUtil.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Tue Sep 26 07:10:30 2017