ilTermsOfServiceUserHasCountryCriterion Class Reference

Class ilTermsOfServiceUserHasCountryCriterion. More...

Inheritance diagram for ilTermsOfServiceUserHasCountryCriterion:

Collaboration diagram for ilTermsOfServiceUserHasCountryCriterion:

Public Member Functions
	__construct (array $countryCodes)
	ilTermsOfServiceUserHasCountryCriterion constructor. More...
	getTypeIdent ()
	Returns a unique id of the criterion type. Returns string More...
	hasUniqueNature ()
	Returns whether or not a criterion is unique by it's nature.Example: "User Language". A user account can only have one profile language . Returns bool More...
	evaluate (ilObjUser $user, ilTermsOfServiceCriterionConfig $config)
	Parameters ilObjUser $user ilTermsOfServiceCriterionConfig $config Returns bool More...
	ui (ilLanguage $lng)
	Parameters ilLanguage $lng Returns ilTermsOfServiceCriterionTypeGUI More...

Protected Attributes
	$countryCodes = []

Detailed Description

Class ilTermsOfServiceUserHasCountryCriterion.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilTermsOfServiceUserHasCountryCriterion::__construct

(

array

$countryCodes

)

ilTermsOfServiceUserHasCountryCriterion constructor.

Parameters

string[]

$countryCodes

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

References $countryCodes.

    {
        $this->countryCodes = $countryCodes;
    }

Member Function Documentation

evaluate()

ilTermsOfServiceUserHasCountryCriterion::evaluate	(	ilObjUser	$user,
		ilTermsOfServiceCriterionConfig	$config
	)

Parameters

ilObjUser	$user
ilTermsOfServiceCriterionConfig	$config

Returns

bool

Implements ilTermsOfServiceCriterionType.

Definition at line 41 of file class.ilTermsOfServiceUserHasCountryCriterion.php.

References $result, and ilObjUser\getSelectedCountry().

Referenced by ilTermsOfServiceUserHasCountryCriterionTest\testEvaluationFailsIfUserCountryDoesNotMatchDefinedLanguage(), and ilTermsOfServiceUserHasCountryCriterionTest\testEvaluationSucceedsIfUserCountryDoesMatchDefinedLanguage().

                                                                                       : bool
    {
        $country = $config['country'] ?? '';

        if (!is_string($country) || 2 !== strlen($country) || !is_string($user->getSelectedCountry())) {
            return false;
        }

        $result = strtolower($country) === strtolower($user->getSelectedCountry());

        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTypeIdent()

ilTermsOfServiceUserHasCountryCriterion::getTypeIdent

(

)

Returns a unique id of the criterion type.

Returns

string

Implements ilTermsOfServiceCriterionType.

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

Referenced by ilTermsOfServiceUserHasCountryCriterionTest\testFormUserInterfaceElementsAreProperlyBuilt(), and ilTermsOfServiceUserHasCountryCriterionTest\testValuesFromFormUserInterfaceElementsCanBeRetrieved().

                                   : string
    {
        return 'usr_country';
    }

Here is the caller graph for this function:

hasUniqueNature()

ilTermsOfServiceUserHasCountryCriterion::hasUniqueNature

(

)

Returns whether or not a criterion is unique by it's nature.Example: "User Language". A user account can only have one profile language .

Returns

bool

Implements ilTermsOfServiceCriterionType.

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

                                      : bool
    {
        return true;
    }

ui()

ilTermsOfServiceUserHasCountryCriterion::ui

(

ilLanguage

$lng

)

Parameters

ilLanguage

$lng

Returns

ilTermsOfServiceCriterionTypeGUI

Implements ilTermsOfServiceCriterionType.

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

Referenced by ilTermsOfServiceUserHasCountryCriterionTest\testFormUserInterfaceElementsAreProperlyBuilt(), ilTermsOfServiceUserHasCountryCriterionTest\testTypeIdentPresentationIsANonEmptyString(), and ilTermsOfServiceUserHasCountryCriterionTest\testValuesFromFormUserInterfaceElementsCanBeRetrieved().

                                        : ilTermsOfServiceCriterionTypeGUI
    {
        return new ilTermsOfServiceUserHasCountryCriterionGUI($this, $lng, $this->countryCodes);
    }

Here is the caller graph for this function:

Field Documentation

$countryCodes

ilTermsOfServiceUserHasCountryCriterion::$countryCodes = []

protected

Definition at line 11 of file class.ilTermsOfServiceUserHasCountryCriterion.php.

Referenced by __construct().

---

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

• Services/TermsOfService/classes/Criteria/class.ilTermsOfServiceUserHasCountryCriterion.php