TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config Class Reference

Inheritance diagram for TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config:

Public Member Functions
array string null	grabConfig (string $parameter=null)
array string null	grabModuleConfig (string $moduleName, string $parameter=null)

Private Member Functions
array string null	grab (string $parameter=null, string $moduleName=null)

Detailed Description

Helper to expose params of Codeception suites to tests.

Example 1 "Retrieve configuration param of other module"

suite.yml:

modules: enabled:

• ‪WebDriver: browser: chrome

ConfigCest.php

$webDriverUrl = $I->grabModuleConfig('WebDriver', 'browser');

Example 2 "Expose arbitrary configuration params to tests"

suite.yml:

modules: config:

• ‪TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config: myCustomParam: myCustomValue

ConfigCest.php

$myCustomName = $I->grabConfig('myCustomParam');

Definition at line 53 of file Config.php.

Member Function Documentation

grab()

array string null TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config::grab ( string  $parameter = null, string  $moduleName = null  )

private

Retrieves configuration of a module.

Parameters

string | null	$parameter
string | null	$moduleName

Returns

‪array|string|null

Exceptions

Definition at line 87 of file Config.php.

Referenced by TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config\grabConfig(), and TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config\grabModuleConfig().

grabConfig()

array string null TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config::grabConfig

(

string

$parameter = null

)

Retrieves configuration of this module.

Parameters

string | null

$parameter

Returns

‪array|string|null

Exceptions

Definition at line 62 of file Config.php.

References TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config\grab().

grabModuleConfig()

array string null TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config::grabModuleConfig	(	string	$moduleName,
		string	$parameter = null
	)

Retrieves configuration of a different module.

Parameters

string | null

$parameter

Returns

‪array|string|null

Exceptions

Definition at line 74 of file Config.php.

References TYPO3\CMS\Core\Tests\Acceptance\Support\Helper\Config\grab().