ilBaseMailAddressType Class Reference

Class ilBaseMailAddressType. More...

Inheritance diagram for ilBaseMailAddressType:

Collaboration diagram for ilBaseMailAddressType:

Public Member Functions
	__construct (\ilMailAddressTypeHelper $typeHelper, \ilMailAddress $address, \ilLogger $logger)
	ilBaseMailAddressType constructor. More...
	validate (int $senderId)
	Validates the parsed recipients and set errors accordingly. See also \ilMailAddressType::getErrors Parameters $senderId integer The id of the acting ILIAS user, can be used for permission checks etc. Returns bool More...
	getErrors ()
	Returns a list of errors determined in the validation process.The errors should be reset everytime the validation is triggered. See also \ilMailAddressType::validate Returns \ilMailError More...
	getAddress ()
	The address instance used for validation and user id lookup. Returns \ilMailAddress 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
	$typeHelper
	$address
	$logger

Private Member Functions
	resetErrors ()

Private Attributes
	$errors = []

Detailed Description

Class ilBaseMailAddressType.

Author

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

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

Constructor & Destructor Documentation

__construct()

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

ilBaseMailAddressType constructor.

Parameters

\ilMailAddressTypeHelper	$typeHelper
\ilMailAddress	$address
\ilLogger	$logger

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

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

References $address, $logger, and $typeHelper.

Member Function Documentation

getAddress()

ilBaseMailAddressType::getAddress

(

)

The address instance used for validation and user id lookup.

Returns

\ilMailAddress

Implements ilMailAddressType.

Definition at line 82 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.

See also

\ilMailAddressType::validate

Returns

\ilMailError

Implements ilMailAddressType.

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

                                : array
    {
        return $this->errors;
    }

References $errors.

isValid()

ilBaseMailAddressType::isValid ( int  $senderId )

abstractprotected

Parameters

$senderId

integer

Returns

bool

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

Parameters

string	$languageVariable
array	$placeHolderValues

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

    {
        $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 66 of file class.ilBaseMailAddressType.php.

    {
        $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.

See also

\ilMailAddressType::getErrors

Parameters

$senderId

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

Returns

bool

Implements ilMailAddressType.

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

ilBaseMailAddressType::$address

protected

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

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

$errors

ilBaseMailAddressType::$errors = []

private

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

Referenced by getErrors().

$logger

ilBaseMailAddressType::$logger

protected

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

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

$typeHelper

ilBaseMailAddressType::$typeHelper

protected

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