WebApiApplication Class Reference

Inheritance diagram for WebApiApplication:

Public Member Functions
	run ()
	install ($cleanup)
Public Member Functions inherited from Application
	__construct (\Magento\Framework\Shell $shell, $installDir, $installConfigFile, $globalConfigFile, $globalConfigDir, $appMode, AutoloaderInterface $autoloadWrapper, $loadTestExtensionAttributes=false)
	getDbInstance ()
	getTempDir ()
	getInitParams ()
	isInstalled ()
	reinitialize (array $overriddenParams=[])
	createInstallDir ()
	cleanup ()
	install ($cleanup)
	_customizeParams ($params)
	getArea ()
	loadArea ($areaCode)

Protected Member Functions
	getCustomDirs ()
Protected Member Functions inherited from Application
	getInstallConfig ()
	_ensureDirExists ($dir)
	getCustomDirs ()

Additional Inherited Members
Data Fields inherited from Application
const	DEFAULT_APP_AREA = 'global'
Protected Attributes inherited from Application
	$_db
	$_shell
	$installConfig
	$_globalConfigDir
	$installDir
	$_configDir
	$_initParams = []
	$_appMode
	$_appArea = null
	$_primaryConfigData = []
	$_factory
	$dirList
	$dumpDb = true
	$canLoadArea = true
	$canInstallSequence = true

Detailed Description

Provides access to the application for the tests

Allows installation and uninstallation

Definition at line 13 of file WebApiApplication.php.

Member Function Documentation

getCustomDirs()

getCustomDirs ( )

protected

Use the application as is

{}

Definition at line 62 of file WebApiApplication.php.

    {
        return [];
    }

install()

install

(

$cleanup

)

{}

Definition at line 29 of file WebApiApplication.php.

    {
        if ($cleanup) {
            $this->cleanup();
        }

        $installOptions = $this->getInstallConfig();

        /* Install application */
        if ($installOptions) {
            $installCmd = 'php -f ' . BP . '/bin/magento setup:install -vvv';
            $installArgs = [];
            foreach ($installOptions as $optionName => $optionValue) {
                if (is_bool($optionValue)) {
                    if (true === $optionValue) {
                        $installCmd .= " --$optionName";
                    }
                    continue;
                }
                if (!empty($optionValue)) {
                    $installCmd .= " --$optionName=%s";
                    $installArgs[] = $optionValue;
                }
            }
            $this->_shell->execute($installCmd, $installArgs);
        }
    }

run()

run

(

)

{}

Definition at line 18 of file WebApiApplication.php.

    {
        throw new \Exception(
            "Can't start application: purpose of Web API Application is to use classes and models from the application"
            . " and don't run it"
        );
    }

---

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

• vendor/magento/magento2-base/dev/tests/api-functional/framework/Magento/TestFramework/WebApiApplication.php