Setup.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Module;

use Magento\Framework\App\ResourceConnection;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\SetupInterface;

class Setup implements SetupInterface
{
    private $connection = null;

    private $tables = [];

    private $resourceModel;

    private $connectionName;

    public function __construct(
        \Magento\Framework\App\ResourceConnection $resource,
        $connectionName = ModuleDataSetupInterface::DEFAULT_SETUP_CONNECTION
    ) {
        $this->resourceModel = $resource;
        $this->connectionName = $connectionName;
    }

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

    private function getDefaultConnection()
    {
        if (null === $this->connection) {
            $this->connection = $this->resourceModel->getConnection($this->connectionName);
        }
        return $this->connection;
    }

    public function setTable($tableName, $realTableName)
    {
        $this->tables[$tableName] = $realTableName;
        return $this;
    }

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

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

    private function _getTableCacheName($tableName)
    {
        if (is_array($tableName)) {
            return join('_', $tableName);
        }
        return $tableName;
    }

    public function tableExists($table, $connectionName = ResourceConnection::DEFAULT_CONNECTION)
    {
        $table = $this->getTable($table, $connectionName);
        return $this->getConnection($connectionName)->isTableExists($table);
    }

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

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

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