Helper Class Reference

Inheritance diagram for Helper:

Public Member Functions
	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
	_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 ()

Additional Inherited Members
Protected Attributes inherited from AbstractHelper
	$_modulePrefix
	$_resource

Detailed Description

Definition at line 11 of file Helper.php.

Member Function Documentation

_assembleLimit()

_assembleLimit (   $query,   $limitCount,   $limitOffset,   $columnList = []  )

protected

Parameters

string	$query
int	$limitCount
int	$limitOffset
array	$columnList

Returns

string

Definition at line 153 of file Helper.php.

    {
        if ($limitCount !== null) {
            $limitCount = intval($limitCount);
            if ($limitCount <= 0) {
                //throw new \Exception("LIMIT argument count={$limitCount} is not valid");
            }

            $limitOffset = intval($limitOffset);
            if ($limitOffset < 0) {
                //throw new \Exception("LIMIT argument offset={$limitOffset} is not valid");
            }

            if ($limitOffset + $limitCount != $limitOffset + 1) {
                $columns = [];
                foreach ($columnList as $columnEntry) {
                    $columns[] = $columnEntry[2] ? $columnEntry[2] : $columnEntry[1];
                }
                $query = sprintf('%s LIMIT %s, %s', $query, $limitCount, $limitOffset);
            }
        }

        return $query;
    }

_prepareGroup()

_prepareGroup ( \Magento\Framework\DB\Select  $select,   $autoReset = false  )

protected

Returns quoted group by fields

Parameters

\Magento\Framework\DB\Select	$select
bool	$autoReset

Returns

array

Definition at line 80 of file Helper.php.

    {
        $selectGroups = $select->getPart(\Magento\Framework\DB\Select::GROUP);
        if (!$selectGroups) {
            return [];
        }

        $groups = [];
        foreach ($selectGroups as $term) {
            $groups[] = $this->getConnection()->quoteIdentifier($term, true);
        }

        if ($autoReset) {
            $select->reset(\Magento\Framework\DB\Select::GROUP);
        }

        return $groups;
    }

_prepareHaving()

_prepareHaving ( \Magento\Framework\DB\Select  $select,   $autoReset = false  )

protected

Prepare and returns having array

Parameters

\Magento\Framework\DB\Select	$select
bool	$autoReset

Returns

array

Exceptions

Looking for column expression in the having clause

Replace column expression to column alias in having clause

Definition at line 107 of file Helper.php.

    {
        $selectHavings = $select->getPart(\Magento\Framework\DB\Select::HAVING);
        if (!$selectHavings) {
            return [];
        }

        $havings = [];
        $columns = $select->getPart(\Magento\Framework\DB\Select::COLUMNS);
        foreach ($columns as $columnEntry) {
            $correlationName = (string)$columnEntry[1];
            $column          = $columnEntry[2];
            foreach ($selectHavings as $having) {
                if (strpos($having, $correlationName) !== false) {
                    if (is_string($column)) {
                        $havings[] = str_replace($correlationName, $column, $having);
                    } else {
                        throw new \Zend_Db_Exception(
                            sprintf("Can't prepare expression without column alias: '%s'", $correlationName)
                        );
                    }
                }
            }
        }

        if ($autoReset) {
            $select->reset(\Magento\Framework\DB\Select::HAVING);
        }

        return $havings;
    }

_prepareOrder()

_prepareOrder ( \Magento\Framework\DB\Select  $select,   $autoReset = false  )

protected

Returns array of quoted orders with direction

Parameters

\Magento\Framework\DB\Select	$select
bool	$autoReset

Returns

array

Definition at line 20 of file Helper.php.

    {
        $selectOrders = $select->getPart(\Magento\Framework\DB\Select::ORDER);
        if (!$selectOrders) {
            return [];
        }

        $orders = [];
        foreach ($selectOrders as $term) {
            if (is_array($term)) {
                if (!is_numeric($term[0])) {
                    $orders[] = sprintf('%s %s', $this->getConnection()->quoteIdentifier($term[0], true), $term[1]);
                }
            } else {
                if (!is_numeric($term)) {
                    $orders[] = $this->getConnection()->quoteIdentifier($term, true);
                }
            }
        }

        if ($autoReset) {
            $select->reset(\Magento\Framework\DB\Select::ORDER);
        }

        return $orders;
    }

_truncateAliasName()

_truncateAliasName (   $field,   $reverse = false  )

protected

Truncate alias name from field.

Result string depends from second optional argument $reverse which can be true if you need the first part of the field. Field can be with 'dot' delimiter.

Parameters

string	$field
bool	$reverse	OPTIONAL

Returns

string

Definition at line 58 of file Helper.php.

    {
        $string = $field;
        if (!is_numeric($field) && (strpos($field, '.') !== false)) {
            $size  = strpos($field, '.');
            if ($reverse) {
                $string = substr($field, 0, $size);
            } else {
                $string = substr($field, $size + 1);
            }
        }

        return $string;
    }

addGroupConcatColumn()

addGroupConcatColumn	(		$select,
			$fieldAlias,
			$fields,
			$groupConcatDelimiter = ',',
			$fieldsDelimiter = '',
			$additionalWhere = ''
	)

Add prepared column group_concat expression

Parameters

\Magento\Framework\DB\Select	$select
string	$fieldAlias	Field alias which will be added with column group_concat expression
string	$fields
string	$groupConcatDelimiter
string	$fieldsDelimiter
string	$additionalWhere

Returns

\Magento\Framework\DB\Select

Definition at line 241 of file Helper.php.

      {
        if (is_array($fields)) {
            $fieldExpr = $this->getConnection()->getConcatSql($fields, $fieldsDelimiter);
        } else {
            $fieldExpr = $fields;
        }
        if ($additionalWhere) {
            $fieldExpr = $this->getConnection()->getCheckSql($additionalWhere, $fieldExpr, "''");
        }
        $separator = '';
        if ($groupConcatDelimiter) {
            $separator = sprintf(" SEPARATOR '%s'", $groupConcatDelimiter);
        }
        $select->columns([$fieldAlias => new \Zend_Db_Expr(sprintf('GROUP_CONCAT(%s%s)', $fieldExpr, $separator))]);
        return $select;
    }

addLikeEscape()

addLikeEscape	(		$value,
			$options = []
	)

Escapes and quotes LIKE value. Stating escape symbol in expression is not required, because we use standard MySQL escape symbol. For options and escaping see escapeLikeValue().

Parameters

string	$value
array	$options

Returns

\Zend_Db_Expr

See also

escapeLikeValue()

Definition at line 289 of file Helper.php.

    {
        $value = $this->escapeLikeValue($value, $options);
        return new \Zend_Db_Expr($this->getConnection()->quote($value));
    }

getDateDiff()

getDateDiff	(		$startDate,
			$endDate
	)

Returns expression of days passed from $startDate to $endDate

Parameters

string | \Zend_Db_Expr	$startDate
string | \Zend_Db_Expr	$endDate

Returns

\Zend_Db_Expr

Definition at line 272 of file Helper.php.

    {
        $dateDiff = '(TO_DAYS(' . $endDate . ') - TO_DAYS(' . $startDate . '))';
        return new \Zend_Db_Expr($dateDiff);
    }

prepareColumnsList()

prepareColumnsList	(	\Magento\Framework\DB\Select	$select,
			$groupByCondition = null
	)

Prepare select column list

Parameters

\Magento\Framework\DB\Select	$select
string | null	$groupByCondition	OPTIONAL

Returns

mixed|array

Exceptions

Definition at line 188 of file Helper.php.

    {
        if (!count($select->getPart(\Magento\Framework\DB\Select::FROM))) {
            return $select->getPart(\Magento\Framework\DB\Select::COLUMNS);
        }

        $columns          = $select->getPart(\Magento\Framework\DB\Select::COLUMNS);
        $tables           = $select->getPart(\Magento\Framework\DB\Select::FROM);
        $preparedColumns  = [];

        foreach ($columns as $columnEntry) {
            list($correlationName, $column, $alias) = $columnEntry;
            if ($column instanceof \Zend_Db_Expr) {
                if ($alias !== null) {
                    if (preg_match('/(^|[^a-zA-Z_])^(SELECT)?(SUM|MIN|MAX|AVG|COUNT)\s*\(/i', $column)) {
                        $column = new \Zend_Db_Expr($column);
                    }
                    $preparedColumns[strtoupper($alias)] = [null, $column, $alias];
                } else {
                    throw new \Zend_Db_Exception("Can't prepare expression without alias");
                }
            } else {
                if ($column == \Magento\Framework\DB\Select::SQL_WILDCARD) {
                    if ($tables[$correlationName]['tableName'] instanceof \Zend_Db_Expr) {
                        throw new \Zend_Db_Exception(
                            "Can't prepare expression when tableName is instance of \Zend_Db_Expr"
                        );
                    }
                    $tableColumns = $this->getConnection()->describeTable($tables[$correlationName]['tableName']);
                    foreach (array_keys($tableColumns) as $col) {
                        $preparedColumns[strtoupper($col)] = [$correlationName, $col, null];
                    }
                } else {
                    $columnKey = $alias === null ? $column : $alias;
                    $preparedColumns[strtoupper($columnKey)] = [$correlationName, $column, $alias];
                }
            }
        }

        return $preparedColumns;
    }

---

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

• vendor/magento/framework/DB/Helper.php