ResourceConnection Class Reference

Data Structures
class	ConnectionFactoryTest

Public Member Functions
	__construct (ResourceConfigInterface $resourceConfig, ConnectionFactoryInterface $connectionFactory, DeploymentConfig $deploymentConfig, $tablePrefix='')
	getConnection ($resourceName=self::DEFAULT_CONNECTION)
	closeConnection ($resourceName=self::DEFAULT_CONNECTION)
	getConnectionByName ($connectionName)
	getTableName ($modelEntity, $connectionName=self::DEFAULT_CONNECTION)
	getTablePlaceholder ($tableName)
	getTriggerName ($tableName, $time, $event)
	setMappedTableName ($tableName, $mappedName)
	getMappedTableName ($tableName)
	getIdxName ( $tableName, $fields, $indexType=\Magento\Framework\DB\Adapter\AdapterInterface::INDEX_TYPE_INDEX)
	getFkName ($priTableName, $priColumnName, $refTableName, $refColumnName)
	getSchemaName ($resourceName)
	getTablePrefix ()

Data Fields
const	AUTO_UPDATE_ONCE = 0
const	AUTO_UPDATE_NEVER = -1
const	AUTO_UPDATE_ALWAYS = 1
const	DEFAULT_CONNECTION = 'default'

Protected Attributes
	$connections = []
	$mappedTableNames
	$config
	$connectionFactory
	$tablePrefix

Detailed Description

Application provides ability to configure multiple connections to persistent storage. This class provides access to all these connections. @api

Since

100.0.2

Definition at line 18 of file ResourceConnection.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceConfigInterface	$resourceConfig,
		ConnectionFactoryInterface	$connectionFactory,
		DeploymentConfig	$deploymentConfig,
			$tablePrefix = ''
	)

Parameters

ResourceConfigInterface	$resourceConfig
ConnectionFactoryInterface	$connectionFactory
DeploymentConfig	$deploymentConfig
string	$tablePrefix

Definition at line 72 of file ResourceConnection.php.

      {
        $this->config = $resourceConfig;
        $this->connectionFactory = $connectionFactory;
        $this->deploymentConfig = $deploymentConfig;
        $this->tablePrefix = $tablePrefix ?: null;
    }

Member Function Documentation

closeConnection()

closeConnection

(

$resourceName = self::DEFAULT_CONNECTION

)

Close connection.

Parameters

string

$resourceName

Returns

void

Since

100.1.3

Definition at line 106 of file ResourceConnection.php.

    {
        if ($resourceName === null) {
            foreach ($this->connections as $processConnection) {
                if ($processConnection !== null) {
                    $processConnection->closeConnection();
                }
            }
            $this->connections = [];
        } else {
            $processConnectionName = $this->getProcessConnectionName($this->config->getConnectionName($resourceName));
            if (isset($this->connections[$processConnectionName])) {
                if ($this->connections[$processConnectionName] !== null) {
                    $this->connections[$processConnectionName]->closeConnection();
                }
                $this->connections[$processConnectionName] = null;
            }
        }
    }

getConnection()

getConnection

(

$resourceName = self::DEFAULT_CONNECTION

)

Retrieve connection to resource specified by $resourceName.

Parameters

string

$resourceName

Returns

\Magento\Framework\DB\Adapter\AdapterInterface

Exceptions

Definition at line 92 of file ResourceConnection.php.

    {
        $connectionName = $this->config->getConnectionName($resourceName);
        $connection = $this->getConnectionByName($connectionName);
        return $connection;
    }

getConnectionByName()

getConnectionByName

(

$connectionName

)

Retrieve connection by $connectionName.

Parameters

string

$connectionName

Returns

\Magento\Framework\DB\Adapter\AdapterInterface

Exceptions

Definition at line 133 of file ResourceConnection.php.

    {
        $processConnectionName = $this->getProcessConnectionName($connectionName);
        if (isset($this->connections[$processConnectionName])) {
            return $this->connections[$processConnectionName];
        }

        $connectionConfig = $this->deploymentConfig->get(
            ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTIONS . '/' . $connectionName
        );

        if ($connectionConfig) {
            $connection = $this->connectionFactory->create($connectionConfig);
        } else {
            throw new \DomainException('Connection "' . $connectionName . '" is not defined');
        }

        $this->connections[$processConnectionName] = $connection;
        return $connection;
    }

getFkName()

getFkName	(		$priTableName,
			$priColumnName,
			$refTableName,
			$refColumnName
	)

Retrieve 32bit UNIQUE HASH for a Table foreign key.

Parameters

string	$priTableName	the target table name
string	$priColumnName	the target table column name
string	$refTableName	the reference table name
string	$refColumnName	the reference table column name

Returns

string

Definition at line 283 of file ResourceConnection.php.

    {
        return $this->getConnection()->getForeignKeyName(
            $this->getTableName($priTableName),
            $priColumnName,
            $this->getTableName($refTableName),
            $refColumnName
        );
    }

getIdxName()

getIdxName	(		$tableName,
			$fields,
			$indexType = \Magento\Framework\DB\Adapter\AdapterInterface::INDEX_TYPE_INDEX
	)

Retrieve 32bit UNIQUE HASH for a Table index.

Parameters

string	$tableName
	string|string[]	$fields
string	$indexType

Returns

string

Definition at line 261 of file ResourceConnection.php.

      {
        return $this->getConnection()
            ->getIndexName(
                $this->getTableName($tableName),
                $fields,
                $indexType
            );
    }

getMappedTableName()

getMappedTableName

(

$tableName

)

Get mapped table name.

Parameters

string

$tableName

Returns

bool|string

Definition at line 244 of file ResourceConnection.php.

    {
        if (isset($this->mappedTableNames[$tableName])) {
            return $this->mappedTableNames[$tableName];
        } else {
            return false;
        }
    }

getSchemaName()

getSchemaName

(

$resourceName

)

Retrieve db name.

That name can be needed, when we do request in information_schema to identify db.

Parameters

string

$resourceName

Returns

string

Definition at line 301 of file ResourceConnection.php.

    {
        return $this->deploymentConfig->get(
            ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTIONS .
            '/' .
            $resourceName .
            '/dbname'
        );
    }

getTableName()

getTableName	(		$modelEntity,
			$connectionName = self::DEFAULT_CONNECTION
	)

Get resource table name, validated by db adapter.

Parameters

	string|string[]	$modelEntity
string	$connectionName

Returns

string @api

Definition at line 173 of file ResourceConnection.php.

    {
        $tableSuffix = null;
        if (is_array($modelEntity)) {
            list($modelEntity, $tableSuffix) = $modelEntity;
        }

        $tableName = $modelEntity;

        $mappedTableName = $this->getMappedTableName($tableName);
        if ($mappedTableName) {
            $tableName = $mappedTableName;
        } else {
            $tablePrefix = $this->getTablePrefix();
            if ($tablePrefix && strpos($tableName, $tablePrefix) !== 0) {
                $tableName = $tablePrefix . $tableName;
            }
        }

        if ($tableSuffix) {
            $tableName .= '_' . $tableSuffix;
        }
        return $this->getConnection($connectionName)->getTableName($tableName);
    }

getTablePlaceholder()

getTablePlaceholder

(

$tableName

)

Gets table placeholder by table name.

Parameters

string

$tableName

Returns

string

Since

100.1.0

Definition at line 205 of file ResourceConnection.php.

    {
        $tableName = preg_replace('/^' . preg_quote($this->getTablePrefix()) . '_/', '', $tableName);
        return $tableName;
    }

getTablePrefix()

getTablePrefix

(

)

Get table prefix.

Returns

string

Definition at line 316 of file ResourceConnection.php.

    {
        if ($this->tablePrefix !== null) {
            return $this->tablePrefix;
        }

        return (string) $this->deploymentConfig->get(
            ConfigOptionsListConstants::CONFIG_PATH_DB_PREFIX
        );
    }

getTriggerName()

getTriggerName	(		$tableName,
			$time,
			$event
	)

Build a trigger name.

Parameters

string	$tableName	The table that is the subject of the trigger
string	$time	Either "before" or "after"
string	$event	The DB level event which activates the trigger, i.e. "update" or "insert"

Returns

string

Definition at line 219 of file ResourceConnection.php.

    {
        return $this->getConnection()->getTriggerName($tableName, $time, $event);
    }

setMappedTableName()

setMappedTableName	(		$tableName,
			$mappedName
	)

Set mapped table name.

Parameters

string	$tableName
string	$mappedName

Returns

$this @codeCoverageIgnore

Definition at line 232 of file ResourceConnection.php.

    {
        $this->mappedTableNames[$tableName] = $mappedName;
        return $this;
    }

Field Documentation

$config

$config

protected

Definition at line 47 of file ResourceConnection.php.

$connectionFactory

$connectionFactory

protected

Definition at line 54 of file ResourceConnection.php.

$connections

$connections = []

protected

Definition at line 33 of file ResourceConnection.php.

$mappedTableNames

$mappedTableNames

protected

Definition at line 40 of file ResourceConnection.php.

$tablePrefix

$tablePrefix

protected

Definition at line 64 of file ResourceConnection.php.

AUTO_UPDATE_ALWAYS

const AUTO_UPDATE_ALWAYS = 1

Definition at line 24 of file ResourceConnection.php.

AUTO_UPDATE_NEVER

const AUTO_UPDATE_NEVER = -1

Definition at line 22 of file ResourceConnection.php.

AUTO_UPDATE_ONCE

const AUTO_UPDATE_ONCE = 0

Definition at line 20 of file ResourceConnection.php.

DEFAULT_CONNECTION

const DEFAULT_CONNECTION = 'default'

Definition at line 26 of file ResourceConnection.php.

---

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

• vendor/magento/framework/App/ResourceConnection.php