Setup Class Reference

Inheritance diagram for Setup:

Public Member Functions
	__construct (\Magento\Framework\App\ResourceConnection $resource, $connectionName=ModuleDataSetupInterface::DEFAULT_SETUP_CONNECTION)
	getConnection ($connectionName=null)
	setTable ($tableName, $realTableName)
	getTablePlaceholder ($tableName)
	getTable ($tableName, $connectionName=ResourceConnection::DEFAULT_CONNECTION)
	tableExists ($table, $connectionName=ResourceConnection::DEFAULT_CONNECTION)
	run ($sql)
	startSetup ()
	endSetup ()
Public Member Functions inherited from SetupInterface
	getConnection ()
	getTable ($tableName)
	tableExists ($table)

Detailed Description

Definition at line 14 of file Setup.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\ResourceConnection	$resource,
			$connectionName = ModuleDataSetupInterface::DEFAULT_SETUP_CONNECTION
	)

Init

Parameters

\Magento\Framework\App\ResourceConnection	$resource
string	$connectionName

Definition at line 50 of file Setup.php.

      {
        $this->resourceModel = $resource;
        $this->connectionName = $connectionName;
    }

Member Function Documentation

endSetup()

endSetup

(

)

Prepare database after install/upgrade

Returns

$this

Implements SetupInterface.

Definition at line 184 of file Setup.php.

    {
        $this->getConnection()->endSetup();
        return $this;
    }

getConnection()

getConnection

(

$connectionName = null

)

Get connection object

Parameters

string | null

$connectionName

Returns

\Magento\Framework\DB\Adapter\AdapterInterface

Definition at line 64 of file Setup.php.

    {
        if ($connectionName !== null) {
            try {
                return $this->resourceModel->getConnectionByName($connectionName);
            } catch (\DomainException $exception) {
                //Fallback to default connection
            }
        }
        return $this->getDefaultConnection();
    }

getTable()

getTable	(		$tableName,
			$connectionName = ResourceConnection::DEFAULT_CONNECTION
	)

Get table name (validated by db adapter) by table placeholder

Parameters

string | array	$tableName
string	$connectionName

Returns

string

Definition at line 120 of file Setup.php.

    {
        $cacheKey = $this->_getTableCacheName($tableName);
        if (!isset($this->tables[$cacheKey])) {
            $this->tables[$cacheKey] = $this->resourceModel->getTableName($tableName, $connectionName);
        }
        return $this->tables[$cacheKey];
    }

getTablePlaceholder()

getTablePlaceholder

(

$tableName

)

Gets table placeholder by table name

Parameters

string

$tableName

Returns

string

Implements SetupInterface.

Definition at line 108 of file Setup.php.

    {
        return $this->resourceModel->getTablePlaceholder($tableName);
    }

run()

run

(

$sql

)

Run plain SQL query(ies)

Parameters

string

$sql

Returns

$this

Implements SetupInterface.

Definition at line 162 of file Setup.php.

    {
        $this->getConnection()->query($sql);
        return $this;
    }

setTable()

setTable	(		$tableName,
			$realTableName
	)

Add table placeholder/table name relation

Parameters

string	$tableName
string	$realTableName

Returns

$this

Implements SetupInterface.

Definition at line 96 of file Setup.php.

    {
        $this->tables[$tableName] = $realTableName;
        return $this;
    }

startSetup()

startSetup

(

)

Prepare database before install/upgrade

Returns

$this

Implements SetupInterface.

Definition at line 173 of file Setup.php.

    {
        $this->getConnection()->startSetup();
        return $this;
    }

tableExists()

tableExists	(		$table,
			$connectionName = ResourceConnection::DEFAULT_CONNECTION
	)

Check is table exists

Parameters

string	$table
string	$connectionName

Returns

bool

Definition at line 150 of file Setup.php.

    {
        $table = $this->getTable($table, $connectionName);
        return $this->getConnection($connectionName)->isTableExists($table);
    }

---

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

• vendor/magento/framework/Module/Setup.php