ilMailCachedAddressType Class Reference

Class ilMailCachedAddressType. More...

Inheritance diagram for ilMailCachedAddressType:

Collaboration diagram for ilMailCachedAddressType:

Public Member Functions
	__construct (ilMailAddressType $inner, bool $useCache)
	validate (int $senderId)
	Validates the parsed recipients and set errors accordingly. More...
	getErrors ()
	Returns a list of errors determined in the validation process. More...
	getAddress ()
	The address instance used for validation and user id lookup. More...
	resolve ()
	Returns an array of resolved user ids based on an address instance. More...
	resolve ()
	Returns an array of resolved user ids based on an address instance. More...
	validate (int $senderId)
	Validates the parsed recipients and set errors accordingly. More...
	getErrors ()
	Returns a list of errors determined in the validation process. More...
	getAddress ()
	The address instance used for validation and user id lookup. More...

Static Public Member Functions
static	clearCache ()

Protected Attributes
ilMailAddressType	$inner
bool	$useCache = true

Static Protected Attributes
static array	$usrIdsByAddressCache = []
static array	$isValidCache = []

Private Member Functions
	getCacheKey ()

Detailed Description

Class ilMailCachedAddressType.

Definition at line 24 of file class.ilMailCachedAddressType.php.

Constructor & Destructor Documentation

__construct()

ilMailCachedAddressType::__construct	(	ilMailAddressType	$inner,
		bool	$useCache
	)

Definition at line 33 of file class.ilMailCachedAddressType.php.

    {
        $this->inner = $inner;
        $this->useCache = $useCache;
    }

References $inner, and $useCache.

Member Function Documentation

clearCache()

static ilMailCachedAddressType::clearCache ( )

static

Definition at line 39 of file class.ilMailCachedAddressType.php.

                                       : void
    {
        self::$isValidCache = [];
        self::$usrIdsByAddressCache = [];
    }

Referenced by ilMailAddressTypesTest\setUp().

Here is the caller graph for this function:

getAddress()

ilMailCachedAddressType::getAddress

(

)

The address instance used for validation and user id lookup.

Implements ilMailAddressType.

Definition at line 67 of file class.ilMailCachedAddressType.php.

                                : ilMailAddress
    {
        return $this->inner->getAddress();
    }

Referenced by getCacheKey().

Here is the caller graph for this function:

getCacheKey()

ilMailCachedAddressType::getCacheKey ( )

private

Definition at line 45 of file class.ilMailCachedAddressType.php.

                                  : string
    {
        $address = $this->getAddress();
        return (string) $address;
    }

References getAddress().

Referenced by resolve(), and validate().

Here is the call graph for this function:

Here is the caller graph for this function:

getErrors()

ilMailCachedAddressType::getErrors

(

)

Returns a list of errors determined in the validation process.

The errors should be reset everytime the validation is triggered.

Returns

ilMailError[]

See also

ilMailAddressType::validate

Implements ilMailAddressType.

Definition at line 62 of file class.ilMailCachedAddressType.php.

                               : array
    {
        return $this->inner->getErrors();
    }

resolve()

ilMailCachedAddressType::resolve

(

)

Returns an array of resolved user ids based on an address instance.

Returns

int[]

Implements ilMailAddressType.

Definition at line 72 of file class.ilMailCachedAddressType.php.

                             : array
    {
        $cacheKey = $this->getCacheKey();
 
        if (!$this->useCache || !isset(self::$usrIdsByAddressCache[$cacheKey])) {
            self::$usrIdsByAddressCache[$cacheKey] = $this->inner->resolve();
        }
 
        return self::$usrIdsByAddressCache[$cacheKey];
    }

References getCacheKey().

Here is the call graph for this function:

validate()

ilMailCachedAddressType::validate

(

int

$senderId

)

Validates the parsed recipients and set errors accordingly.

Parameters

int

$senderId

The id of the acting ILIAS user, can be used for permission checks etc.

See also

ilMailAddressType::getErrors

Implements ilMailAddressType.

Definition at line 51 of file class.ilMailCachedAddressType.php.

                                           : bool
    {
        $cacheKey = $this->getCacheKey();
 
        if (!$this->useCache || !isset(self::$isValidCache[$cacheKey])) {
            self::$isValidCache[$cacheKey] = $this->inner->validate($senderId);
        }
 
        return self::$isValidCache[$cacheKey];
    }

References getCacheKey().

Here is the call graph for this function:

Field Documentation

$inner

ilMailAddressType ilMailCachedAddressType::$inner

protected

Definition at line 30 of file class.ilMailCachedAddressType.php.

Referenced by __construct().

$isValidCache

array ilMailCachedAddressType::$isValidCache = []

staticprotected

Definition at line 29 of file class.ilMailCachedAddressType.php.

$useCache

bool ilMailCachedAddressType::$useCache = true

protected

Definition at line 31 of file class.ilMailCachedAddressType.php.

Referenced by __construct().

$usrIdsByAddressCache

array ilMailCachedAddressType::$usrIdsByAddressCache = []

staticprotected

Definition at line 27 of file class.ilMailCachedAddressType.php.

---

The documentation for this class was generated from the following file:

• Services/Mail/classes/Address/Type/class.ilMailCachedAddressType.php