Helper Class Reference

Inheritance diagram for Helper:

Public Member Functions
	__construct (\Magento\Framework\App\ResourceConnection $resource, $modulePrefix, \Magento\Framework\Stdlib\DateTime\DateTime $coreDate)
	getTableDropSql ($tableName)
	getTableForeignKeysSql ($tableName=null)
	getTableCreateScript ($tableName, $addDropIfExists=false)
	getTableCreateSql ($tableName, $withForeignKeys=false)
	getHeader ()
	getFooter ()
	getTableDataBeforeSql ($tableName)
	getTableDataAfterSql ($tableName)
	getPartInsertSql ($tableName, $count=null, $offset=null)
	getInsertSql ($tableName)
	prepareTransactionIsolationLevel ()
	restoreTransactionIsolationLevel ()
	getTableTriggersSql ($tableName, $addDropIfExists=false, $stripDefiner=true)
Public Member Functions inherited from Helper
	prepareColumnsList (\Magento\Framework\DB\Select $select, $groupByCondition=null)
	addGroupConcatColumn ( $select, $fieldAlias, $fields, $groupConcatDelimiter=',', $fieldsDelimiter='', $additionalWhere='')
	getDateDiff ($startDate, $endDate)
	addLikeEscape ($value, $options=[])
Public Member Functions inherited from AbstractHelper
	__construct (\Magento\Framework\App\ResourceConnection $resource, $modulePrefix)
	escapeLikeValue ($value, $options=[])
	addLikeEscape ($value, $options=[])
	getCILike ($field, $value, $options=[])

Protected Member Functions
	_buildForeignKeysAlterTableSql ($tableName, $foreignKeys)
	_quoteRow ($tableName, array $row)
Protected Member Functions inherited from Helper
	_prepareOrder (\Magento\Framework\DB\Select $select, $autoReset=false)
	_truncateAliasName ($field, $reverse=false)
	_prepareGroup (\Magento\Framework\DB\Select $select, $autoReset=false)
	_prepareHaving (\Magento\Framework\DB\Select $select, $autoReset=false)
	_assembleLimit ($query, $limitCount, $limitOffset, $columnList=[])
Protected Member Functions inherited from AbstractHelper
	getConnection ()

Protected Attributes
	$_foreignKeys = []
	$_coreDate
Protected Attributes inherited from AbstractHelper
	$_modulePrefix
	$_resource

Detailed Description

@api

Since

100.0.2

Definition at line 13 of file Helper.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\ResourceConnection	$resource,
			$modulePrefix,
		\Magento\Framework\Stdlib\DateTime\DateTime	$coreDate
	)

Parameters

\Magento\Framework\App\ResourceConnection	$resource
string	$modulePrefix
\Magento\Framework\Stdlib\DateTime\DateTime	$coreDate

Definition at line 35 of file Helper.php.

      {
        parent::__construct($resource, $modulePrefix);
        $this->_coreDate = $coreDate;
    }

Member Function Documentation

_buildForeignKeysAlterTableSql()

_buildForeignKeysAlterTableSql (   $tableName,   $foreignKeys  )

protected

Build sql that will add foreign keys to it

Parameters

string	$tableName
array	$foreignKeys

Returns

string

Definition at line 86 of file Helper.php.

    {
        if (!is_array($foreignKeys) || empty($foreignKeys)) {
            return '';
        }

        return sprintf(
            "ALTER TABLE %s\n  %s;\n",
            $this->getConnection()->quoteIdentifier($tableName),
            join(",\n  ", $foreignKeys)
        );
    }

_quoteRow()

_quoteRow (   $tableName, array  $row  )

protected

Quote Table Row

Parameters

string	$tableName
array	$row

Returns

string

Definition at line 301 of file Helper.php.

    {
        $connection = $this->getConnection();
        $describe = $connection->describeTable($tableName);
        $dataTypes = ['bigint', 'mediumint', 'smallint', 'tinyint'];
        $rowData = [];
        foreach ($row as $key => $data) {
            if ($data === null) {
                $value = 'NULL';
            } elseif (in_array(strtolower($describe[$key]['DATA_TYPE']), $dataTypes)) {
                $value = $data;
            } else {
                $value = $connection->quoteInto('?', $data);
            }
            $rowData[] = $value;
        }

        return sprintf('(%s)', implode(',', $rowData));
    }

getFooter()

getFooter

(

)

Returns SQL footer data, move from original resource model

Returns

string

Definition at line 207 of file Helper.php.

    {
        $footer = "\n/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;\n" .
            "/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */; \n" .
            "/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;\n" .
            "/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;\n" .
            "/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;\n" .
            "/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;\n" .
            "/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;\n" .
            "\n-- Dump completed on " .
            $this->_coreDate->gmtDate() .
            " GMT";

        return $footer;
    }

getHeader()

getHeader

(

)

Returns SQL header data, move from original resource model

Returns

string

Definition at line 176 of file Helper.php.

    {
        $dbConfig = $this->getConnection()->getConfig();

        $versionRow = $this->getConnection()->fetchRow('SHOW VARIABLES LIKE \'version\'');
        $hostName = !empty($dbConfig['unix_socket'])
            ? $dbConfig['unix_socket']
            : (!empty($dbConfig['host']) ? $dbConfig['host'] : 'localhost');

        $header = "-- Magento DB backup\n" .
            "--\n" .
            "-- Host: {$hostName}    Database: {$dbConfig['dbname']}\n" .
            "-- ------------------------------------------------------\n" .
            "-- Server version: {$versionRow['Value']}\n\n" .
            "/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;\n" .
            "/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;\n" .
            "/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;\n" .
            "/*!40101 SET NAMES utf8 */;\n" .
            "/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;\n" .
            "/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;\n" .
            "/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;\n" .
            "/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;\n";

        return $header;
    }

getInsertSql()

getInsertSql

(

$tableName

)

Return table data SQL insert

Parameters

string

$tableName

Returns

string

Definition at line 289 of file Helper.php.

    {
        return $this->getPartInsertSql($tableName);
    }

getPartInsertSql()

getPartInsertSql	(		$tableName,
			$count = null,
			$offset = null
	)

Return table part data SQL insert

Parameters

string	$tableName
int	$count
int	$offset

Returns

string

Definition at line 259 of file Helper.php.

    {
        $sql = null;
        $connection = $this->getConnection();
        $select = $connection->select()->from($tableName)->limit($count, $offset);
        $query = $connection->query($select);

        while (true == ($row = $query->fetch())) {
            if ($sql === null) {
                $sql = sprintf('INSERT INTO %s VALUES ', $connection->quoteIdentifier($tableName));
            } else {
                $sql .= ',';
            }

            $sql .= $this->_quoteRow($tableName, $row);
        }

        if ($sql !== null) {
            $sql .= ';' . "\n";
        }

        return $sql;
    }

getTableCreateScript()

getTableCreateScript	(		$tableName,
			$addDropIfExists = false
	)

Get create script for table

Parameters

string	$tableName
boolean	$addDropIfExists

Returns

string

Definition at line 106 of file Helper.php.

    {
        $script = '';
        $quotedTableName = $this->getConnection()->quoteIdentifier($tableName);

        if ($addDropIfExists) {
            $script .= 'DROP TABLE IF EXISTS ' . $quotedTableName . ";\n";
        }
        //TODO fix me
        $sql = 'SHOW CREATE TABLE ' . $quotedTableName;
        $data = $this->getConnection()->fetchRow($sql);
        $script .= isset($data['Create Table']) ? $data['Create Table'] . ";\n" : '';

        return $script;
    }

getTableCreateSql()

getTableCreateSql	(		$tableName,
			$withForeignKeys = false
	)

Retrieve SQL fragment for create table

Parameters

string	$tableName
bool	$withForeignKeys

Returns

string @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 130 of file Helper.php.

    {
        $connection = $this->getConnection();
        $quotedTableName = $connection->quoteIdentifier($tableName);
        $query = 'SHOW CREATE TABLE ' . $quotedTableName;
        $row = $connection->fetchRow($query);

        if (!$row || !isset($row['Table']) || !isset($row['Create Table'])) {
            return false;
        }

        $regExp = '/,\s+CONSTRAINT `([^`]*)` FOREIGN KEY \(`([^`]*)`\) ' .
            'REFERENCES `([^`]*)` \(`([^`]*)`\)' .
            '( ON DELETE (RESTRICT|CASCADE|SET NULL|NO ACTION))?' .
            '( ON UPDATE (RESTRICT|CASCADE|SET NULL|NO ACTION))?/';
        $matches = [];
        preg_match_all($regExp, $row['Create Table'], $matches, PREG_SET_ORDER);

        if (is_array($matches)) {
            foreach ($matches as $match) {
                $this->_foreignKeys[$tableName][] = sprintf(
                    'ADD CONSTRAINT %s FOREIGN KEY (%s) REFERENCES %s (%s)%s%s',
                    $connection->quoteIdentifier($match[1]),
                    $connection->quoteIdentifier($match[2]),
                    $connection->quoteIdentifier($match[3]),
                    $connection->quoteIdentifier($match[4]),
                    isset($match[5]) ? $match[5] : '',
                    isset($match[7]) ? $match[7] : ''
                );
            }
        }

        if ($withForeignKeys) {
            $sql = $row['Create Table'];
        } else {
            $sql = preg_replace($regExp, '', $row['Create Table']);
        }

        return $sql . ';';
    }

getTableDataAfterSql()

getTableDataAfterSql

(

$tableName

)

Retrieve after insert data SQL fragment

Parameters

string

$tableName

Returns

string

Definition at line 245 of file Helper.php.

    {
        $quotedTableName = $this->getConnection()->quoteIdentifier($tableName);
        return "/*!40000 ALTER TABLE {$quotedTableName} ENABLE KEYS */;\n" . "UNLOCK TABLES;\n";
    }

getTableDataBeforeSql()

getTableDataBeforeSql

(

$tableName

)

Retrieve before insert data SQL fragment

Parameters

string

$tableName

Returns

string

Definition at line 229 of file Helper.php.

    {
        $quotedTableName = $this->getConnection()->quoteIdentifier($tableName);
        return "\n--\n" .
            "-- Dumping data for table {$quotedTableName}\n" .
            "--\n\n" .
            "LOCK TABLES {$quotedTableName} WRITE;\n" .
            "/*!40000 ALTER TABLE {$quotedTableName} DISABLE KEYS */;\n";
    }

getTableDropSql()

getTableDropSql

(

$tableName

)

Retrieve SQL fragment for drop table

Parameters

string

$tableName

Returns

string

Definition at line 50 of file Helper.php.

    {
        $quotedTableName = $this->getConnection()->quoteIdentifier($tableName);
        return sprintf('DROP TABLE IF EXISTS %s;', $quotedTableName);
    }

getTableForeignKeysSql()

getTableForeignKeysSql

(

$tableName = null

)

Retrieve foreign keys for table(s)

Parameters

string | null

$tableName

Returns

string|bool

Definition at line 62 of file Helper.php.

    {
        $sql = false;

        if ($tableName === null) {
            $sql = '';
            foreach ($this->_foreignKeys as $table => $foreignKeys) {
                $sql .= $this->_buildForeignKeysAlterTableSql($table, $foreignKeys);
            }
        } elseif (isset($this->_foreignKeys[$tableName])) {
            $foreignKeys = $this->_foreignKeys[$tableName];
            $sql = $this->_buildForeignKeysAlterTableSql($tableName, $foreignKeys);
        }

        return $sql;
    }

getTableTriggersSql()

getTableTriggersSql	(		$tableName,
			$addDropIfExists = false,
			$stripDefiner = true
	)

Get create script for triggers.

Parameters

string	$tableName
boolean	$addDropIfExists
boolean	$stripDefiner

Returns

string

Since

100.2.3

Definition at line 350 of file Helper.php.

    {
        $script = "--\n-- Triggers structure for table `{$tableName}`\n--\n";
        $triggers = $this->getConnection()->query('SHOW TRIGGERS LIKE \''. $tableName . '\'')->fetchAll();

        if (!$triggers) {
            return '';
        }
        foreach ($triggers as $trigger) {
            if ($addDropIfExists) {
                $script .= 'DROP TRIGGER IF EXISTS ' . $trigger['Trigger'] . ";\n";
            }
            $script .= "delimiter ;;\n";

            $triggerData = $this->getConnection()->query('SHOW CREATE TRIGGER '. $trigger['Trigger'])->fetch();
            if ($stripDefiner) {
                $cleanedScript = preg_replace('/DEFINER=[^\s]*/', '', $triggerData['SQL Original Statement']);
                $script .= $cleanedScript . "\n";
            } else {
                $script .= $triggerData['SQL Original Statement'] . "\n";
            }
            $script .= ";;\n";
            $script .= "delimiter ;\n";
        }

        return $script;
    }

prepareTransactionIsolationLevel()

prepareTransactionIsolationLevel

(

)

Prepare transaction isolation level for backup process

Returns

void

Definition at line 326 of file Helper.php.

    {
        $this->getConnection()->query('SET SESSION TRANSACTION ISOLATION LEVEL SERIALIZABLE');
    }

restoreTransactionIsolationLevel()

restoreTransactionIsolationLevel

(

)

Restore transaction isolation level after backup

Returns

void

Definition at line 336 of file Helper.php.

    {
        $this->getConnection()->query('SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ');
    }

Field Documentation

$_coreDate

$_coreDate

protected

Definition at line 28 of file Helper.php.

$_foreignKeys

$_foreignKeys = []

protected

Definition at line 21 of file Helper.php.

---

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

• vendor/magento/module-backup/Model/ResourceModel/Helper.php