ilMailCachedAddressType Class Reference

Inheritance diagram for ilMailCachedAddressType:

Collaboration diagram for ilMailCachedAddressType:

Public Member Functions
	__construct (protected ilMailAddressType $inner, protected bool $use_cache)
	validate (int $sender_id)
	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 $sender_id)
	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 ()

Static Protected Attributes
static array	$usr_ids_by_address_cache = []
static array	$is_valid_cache = []

Private Member Functions
	getCacheKey ()

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailCachedAddressType::__construct	(	protected ilMailAddressType	$inner,
		protected bool	$use_cache
	)

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

    {
    }

Member Function Documentation

clearCache()

static ilMailCachedAddressType::clearCache ( )

static

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

                                       : void
    {
        self::$is_valid_cache = [];
        self::$usr_ids_by_address_cache = [];
    }

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 59 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 38 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

list<ilMailError>

See also

ilMailAddressType::validate

Implements ilMailAddressType.

Definition at line 54 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

list<int>

Implements ilMailAddressType.

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

                             : array
    {
        $cache_key = $this->getCacheKey();
        if (!$this->use_cache || !isset(self::$usr_ids_by_address_cache[$cache_key])) {
            self::$usr_ids_by_address_cache[$cache_key] = $this->inner->resolve();
        }
 
        return self::$usr_ids_by_address_cache[$cache_key];
    }

References getCacheKey().

Here is the call graph for this function:

validate()

ilMailCachedAddressType::validate

(

int

$sender_id

)

Validates the parsed recipients and set errors accordingly.

Parameters

int

$sender_id

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

See also

ilMailAddressType::getErrors

Implements ilMailAddressType.

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

                                            : bool
    {
        $cache_key = $this->getCacheKey();
        if (!$this->use_cache || !isset(self::$is_valid_cache[$cache_key])) {
            self::$is_valid_cache[$cache_key] = $this->inner->validate($sender_id);
        }
 
        return self::$is_valid_cache[$cache_key];
    }

References getCacheKey().

Here is the call graph for this function:

Field Documentation

$is_valid_cache

array ilMailCachedAddressType::$is_valid_cache = []

staticprotected

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

$usr_ids_by_address_cache

array ilMailCachedAddressType::$usr_ids_by_address_cache = []

staticprotected

Definition at line 24 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