ilGroupNameAsMailValidator Class Reference

Class ilGroupNameAsMailValidator. More...

Collaboration diagram for ilGroupNameAsMailValidator:

Public Member Functions
	__construct (string $host, callable $groupNameCheckCallable=null)
	validate (\ilMailAddress $address)
	Validates if the given address contains a valid group name to send an email. More...

Protected Attributes
	$host
	$groupNameCheckCallable

Private Member Functions
	isHostValid (string $host)
	Checks if the given host is valid in the email context. More...

Detailed Description

Class ilGroupNameAsMailValidator.

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

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

Definition at line 9 of file class.ilGroupNameAsMailValidator.php.

Constructor & Destructor Documentation

__construct()

ilGroupNameAsMailValidator::__construct	(	string	$host,
		callable	$groupNameCheckCallable = null
	)

Parameters

string	$host
callable | null	$groupNameCheckCallable

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

References $groupNameCheckCallable, and $host.

    {
        $this->host = $host;

        if (null === $groupNameCheckCallable) {
            $groupNameCheckCallable = function (string $groupName) {
                return \ilUtil::groupNameExists($groupName);
            };
        }

        $this->groupNameCheckCallable = $groupNameCheckCallable;
    }

Member Function Documentation

isHostValid()

ilGroupNameAsMailValidator::isHostValid ( string  $host )

private

Checks if the given host is valid in the email context.

Parameters

string

$host

Returns

bool

Definition at line 56 of file class.ilGroupNameAsMailValidator.php.

Referenced by validate().

                                               : bool
    {
        return ($host == $this->host || 0 === strlen($host));
    }

Here is the caller graph for this function:

validate()

ilGroupNameAsMailValidator::validate

(

\ilMailAddress

$address

)

Validates if the given address contains a valid group name to send an email.

Parameters

\ilMailAddress

$address

Returns

bool

Definition at line 39 of file class.ilGroupNameAsMailValidator.php.

References $groupNameCheckCallable, ilMailAddress\getHost(), ilMailAddress\getMailbox(), and isHostValid().

                                                      : bool
    {
        $groupName = substr($address->getMailbox(), 1);

        $func = $this->groupNameCheckCallable;
        if ($func($groupName) && $this->isHostValid($address->getHost())) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

Field Documentation

$groupNameCheckCallable

ilGroupNameAsMailValidator::$groupNameCheckCallable

protected

Definition at line 15 of file class.ilGroupNameAsMailValidator.php.

Referenced by __construct(), and validate().

$host

ilGroupNameAsMailValidator::$host

protected

Definition at line 12 of file class.ilGroupNameAsMailValidator.php.

Referenced by __construct().

---

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

• Services/Mail/classes/Address/Validator/class.ilGroupNameAsMailValidator.php