ilBaseMailAddressType Class Reference

Class ilBaseMailAddressType. More...

Inheritance diagram for ilBaseMailAddressType:

Collaboration diagram for ilBaseMailAddressType:

Public Member Functions
	__construct (ilMailAddressTypeHelper $typeHelper, ilMailAddress $address, ilLogger $logger)
	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...
Public Member Functions inherited from ilMailAddressType
	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...

Protected Member Functions
	isValid (int $senderId)
	pushError (string $languageVariable, array $placeHolderValues=[])

Protected Attributes
ilMailAddressTypeHelper	$typeHelper
ilMailAddress	$address
ilLogger	$logger

Private Member Functions
	resetErrors ()

Private Attributes
array	$errors = []

Detailed Description

Class ilBaseMailAddressType.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 25 of file class.ilBaseMailAddressType.php.

Constructor & Destructor Documentation

__construct()

ilBaseMailAddressType::__construct	(	ilMailAddressTypeHelper	$typeHelper,
		ilMailAddress	$address,
		ilLogger	$logger
	)

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

      {
        $this->address = $address;
        $this->typeHelper = $typeHelper;
        $this->logger = $logger;
    }

References $address, $logger, $typeHelper, and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

getAddress()

ilBaseMailAddressType::getAddress

(

)

The address instance used for validation and user id lookup.

Implements ilMailAddressType.

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

                                : ilMailAddress
    {
        return $this->address;
    }

References $address.

getErrors()

ilBaseMailAddressType::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.ilBaseMailAddressType.php.

                               : array
    {
        return $this->errors;
    }

References $errors.

isValid()

ilBaseMailAddressType::isValid ( int  $senderId )

abstractprotected

Reimplemented in ilMailGroupAddressType, ilMailLoginOrEmailAddressAddressType, ilMailMailingListAddressType, and ilMailRoleAddressType.

Referenced by validate().

Here is the caller graph for this function:

pushError()

ilBaseMailAddressType::pushError ( string  $languageVariable, array  $placeHolderValues = []  )

protected

Definition at line 52 of file class.ilBaseMailAddressType.php.

                                                                                         : void
    {
        $this->errors[] = new ilMailError($languageVariable, $placeHolderValues);
    }

Referenced by ilMailLoginOrEmailAddressAddressType\isValid(), ilMailMailingListAddressType\isValid(), and ilMailRoleAddressType\isValid().

Here is the caller graph for this function:

resetErrors()

ilBaseMailAddressType::resetErrors ( )

private

Definition at line 57 of file class.ilBaseMailAddressType.php.

                                  : void
    {
        $this->errors = [];
    }

Referenced by validate().

Here is the caller graph for this function:

validate()

ilBaseMailAddressType::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 45 of file class.ilBaseMailAddressType.php.

                                           : bool
    {
        $this->resetErrors();
 
        return $this->isValid($senderId);
    }

References isValid(), and resetErrors().

Here is the call graph for this function:

Field Documentation

$address

ilMailAddress ilBaseMailAddressType::$address

protected

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

Referenced by __construct(), ilMailMailingListAddressType\__construct(), ilMailLoginOrEmailAddressAddressType\__construct(), ilMailRoleAddressType\__construct(), getAddress(), ilMailRoleAddressType\getRoleIdsByAddress(), and ilMailLoginOrEmailAddressAddressType\resolve().

$errors

array ilBaseMailAddressType::$errors = []

private

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

Referenced by getErrors().

$logger

ilLogger ilBaseMailAddressType::$logger

protected

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

Referenced by __construct(), ilMailMailingListAddressType\__construct(), ilMailLoginOrEmailAddressAddressType\__construct(), and ilMailRoleAddressType\__construct().

$typeHelper

ilMailAddressTypeHelper ilBaseMailAddressType::$typeHelper

protected

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

Referenced by __construct(), ilMailMailingListAddressType\__construct(), ilMailLoginOrEmailAddressAddressType\__construct(), and ilMailRoleAddressType\__construct().

---

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

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