ilBaseMailAddressType Class Reference

Inheritance diagram for ilBaseMailAddressType:

Collaboration diagram for ilBaseMailAddressType:

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

Protected Member Functions
	isValid (int $sender_id)
	pushError (string $language_variable, array $place_holder_values=[])

Private Member Functions
	resetErrors ()

Private Attributes
array	$errors = []

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

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

      {
    }

Member Function Documentation

getAddress()

ilBaseMailAddressType::getAddress

(

)

The address instance used for validation and user id lookup.

Implements ilMailAddressType.

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

                                : ilMailAddress
    {
        return $this->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

list<ilMailError>

See also

ilMailAddressType::validate

Implements ilMailAddressType.

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

                               : array
    {
        return $this->errors;
    }

References $errors.

isValid()

ilBaseMailAddressType::isValid ( int  $sender_id )

abstractprotected

Reimplemented in ilMailGroupAddressType, ilMailLoginOrEmailAddressAddressType, ilMailMailingListAddressType, and ilMailRoleAddressType.

Referenced by validate().

Here is the caller graph for this function:

pushError()

ilBaseMailAddressType::pushError ( string  $language_variable, array  $place_holder_values = []  )

protected

Parameters

list<string>

$place_holder_values

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

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

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

Here is the caller graph for this function:

resetErrors()

ilBaseMailAddressType::resetErrors ( )

private

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

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

Referenced by validate().

Here is the caller graph for this function:

validate()

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

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

References isValid(), and resetErrors().

Referenced by ilMailAddressTypeFactory\getByPrefix().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$errors

array ilBaseMailAddressType::$errors = []

private

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

Referenced by getErrors().

---

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

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