ilMailCachedAddressType Class Reference

Class ilMailCachedAddressType. More...

Inheritance diagram for ilMailCachedAddressType:

Collaboration diagram for ilMailCachedAddressType:

Public Member Functions
	__construct (protected ilMailAddressType $inner, protected 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...

Static Public Member Functions
static	clearCache ()

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	(	protected ilMailAddressType	$inner,
		protected bool	$useCache
	)

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

    {
    }

Member Function Documentation

clearCache()

static ilMailCachedAddressType::clearCache ( )

static

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

Referenced by ilMailAddressTypesTest\setUp().

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

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 63 of file class.ilMailCachedAddressType.php.

Referenced by getCacheKey().

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

Here is the caller graph for this function:

getCacheKey()

ilMailCachedAddressType::getCacheKey ( )

private

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

References getAddress().

Referenced by resolve(), and validate().

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

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 58 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 68 of file class.ilMailCachedAddressType.php.

References getCacheKey().

                             : array
    {
        $cacheKey = $this->getCacheKey();

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

        return self::$usrIdsByAddressCache[$cacheKey];
    }

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 47 of file class.ilMailCachedAddressType.php.

References getCacheKey().

                                           : bool
    {
        $cacheKey = $this->getCacheKey();

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

        return self::$isValidCache[$cacheKey];
    }

Here is the call graph for this function:

Field Documentation

$isValidCache

array ilMailCachedAddressType::$isValidCache = []

staticprotected

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

$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:

• components/ILIAS/Mail/classes/Address/Type/class.ilMailCachedAddressType.php