SuiteDataArrayBuilder Class Reference

Public Member Functions
	withName ($name)
	includeTests ($tests)
	excludeTests ($tests)
	includeGroups ($groups)
	excludeGroups ($groups)
	includeModules ($modules)
	excludeModules ($modules)
	withAfterHook ($afterHook=null)
	withBeforeHook ($beforeHook=null)
	build ()

Data Fields
	$testActionType = 'testAction'

Detailed Description

Definition at line 12 of file SuiteDataArrayBuilder.php.

Member Function Documentation

build()

build

(

)

Function which takes all class properties set and generates an array representing suite data as parsed from xml.

Returns

array

Definition at line 222 of file SuiteDataArrayBuilder.php.

    {
        return ['suites' => [
            $this->name => [
                SuiteObjectExtractor::NAME => $this->name,
                TestObjectExtractor::TEST_BEFORE_HOOK => $this->beforeHook,
                TestObjectExtractor::TEST_AFTER_HOOK => $this->afterHook,
                SuiteObjectExtractor::INCLUDE_TAG_NAME => $this->includes,
                SuiteObjectExtractor::EXCLUDE_TAG_NAME => $this->excludes
            ]
        ]];
    }

excludeGroups()

excludeGroups

(

$groups

)

Function which takes an array of group names and formats them as excluded raw suite data

Parameters

array

$groups

Returns

$this

Definition at line 124 of file SuiteDataArrayBuilder.php.

    {
        $this->excludes = $this->appendEntriesToSuiteContents($this->excludes, 'groups', $groups);
        return $this;
    }

excludeModules()

excludeModules

(

$modules

)

Function which takes an array of group names and formats them as excluded raw suite data

Parameters

array

$modules

Returns

$this

Definition at line 148 of file SuiteDataArrayBuilder.php.

    {
        $this->excludes = $this->appendEntriesToSuiteContents($this->excludes, 'module', $modules);
        return $this;
    }

excludeTests()

excludeTests

(

$tests

)

Function which takes an array of test names and formats them as excluded raw suite data

Parameters

array

$tests

Returns

$this

Definition at line 100 of file SuiteDataArrayBuilder.php.

    {
        $this->excludes = $this->appendEntriesToSuiteContents($this->excludes, 'test', $tests);
        return $this;
    }

includeGroups()

includeGroups

(

$groups

)

Function which takes an array of group names and formats them as included raw suite data

Parameters

array

$groups

Returns

$this

Definition at line 112 of file SuiteDataArrayBuilder.php.

    {
        $this->includes = $this->appendEntriesToSuiteContents($this->includes, 'group', $groups);
        return $this;
    }

includeModules()

includeModules

(

$modules

)

Function which takes an array of module names and formats them as included raw suite data

Parameters

array

$modules

Returns

$this

Definition at line 136 of file SuiteDataArrayBuilder.php.

    {
        $this->includes = $this->appendEntriesToSuiteContents($this->includes, 'module', $modules);
        return $this;
    }

includeTests()

includeTests

(

$tests

)

Function which takes an array of test names and formats them as included raw suite data

Parameters

array

$tests

Returns

$this

Definition at line 88 of file SuiteDataArrayBuilder.php.

    {
        $this->includes = $this->appendEntriesToSuiteContents($this->includes, 'test', $tests);
        return $this;
    }

withAfterHook()

withAfterHook

(

$afterHook = null

)

Add an after hook passed in by arg (or default if no arg)

Parameters

null

$afterHook

Returns

$this

Definition at line 182 of file SuiteDataArrayBuilder.php.

    {
        if ($afterHook == null) {
            $this->afterHook = [$this->testActionAfterName => [
                ActionObjectExtractor::NODE_NAME => $this->testActionType,
                ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionAfterName

            ]];
        } else {
            $this->afterHook = $afterHook;
        }

        return $this;
    }

withBeforeHook()

withBeforeHook

(

$beforeHook = null

)

Add a before hook passed in by arg (or default if no arg)

Parameters

null

$beforeHook

Returns

$this

Definition at line 203 of file SuiteDataArrayBuilder.php.

    {
        if ($beforeHook == null) {
            $this->beforeHook = [$this->testActionBeforeName => [
                ActionObjectExtractor::NODE_NAME => $this->testActionType,
                ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionBeforeName
            ]];
        } else {
            $this->beforeHook = $beforeHook;
        }

        return $this;
    }

withName()

withName

(

$name

)

Function which sets the name of the mock suite array

Parameters

string

$name

Returns

$this

Definition at line 76 of file SuiteDataArrayBuilder.php.

    {
        $this->name = $name;
        return $this;
    }

Field Documentation

$testActionType

$testActionType = 'testAction'

Definition at line 68 of file SuiteDataArrayBuilder.php.

---

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

• vendor/magento/magento2-functional-testing-framework/dev/tests/unit/Util/SuiteDataArrayBuilder.php