Query Class Reference

Inheritance diagram for Query:

Public Member Functions
	__construct (\Magento\Framework\DB\Select $select, \Magento\Framework\Api\CriteriaInterface $criteria, \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource, \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy)
	getCriteria ()
	getAllIds ()
	addBindParam ($name, $value)
	getSize ()
	getSelectSql ($stringMode=false)
	reset ()
	fetchAll ()
	fetchItem ()
	getIdFieldName ()
	getConnection ()
	getResource ()
	addCountSqlSkipPart ($name, $toSkip=true)

Protected Member Functions
	getSelectCountSql ()
	getCountSqlSkipParts ()
	getSelect ()

Protected Attributes
	$select
	$criteria
	$resource
	$fetchStmt = null
	$logger
	$bindParams = []
	$totalRecords
	$data
	$countSqlSkipParts

Detailed Description

Class Query

Definition at line 13 of file Query.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\DB\Select	$select,
		\Magento\Framework\Api\CriteriaInterface	$criteria,
		\Magento\Framework\Model\ResourceModel\Db\AbstractDb	$resource,
		\Magento\Framework\Data\Collection\Db\FetchStrategyInterface	$fetchStrategy
	)

Parameters

\Magento\Framework\DB\Select	$select
\Magento\Framework\Api\CriteriaInterface	$criteria
\Magento\Framework\Model\ResourceModel\Db\AbstractDb	$resource
\Magento\Framework\Data\Collection\Db\FetchStrategyInterface	$fetchStrategy

Definition at line 84 of file Query.php.

      {
        $this->select = $select;
        $this->criteria = $criteria;
        $this->resource = $resource;
        $this->fetchStrategy = $fetchStrategy;
    }

Member Function Documentation

addBindParam()

addBindParam	(		$name,
			$value
	)

Add variable to bind list

Parameters

string	$name
mixed	$value

Returns

void

Implements QueryInterface.

Definition at line 129 of file Query.php.

    {
        $this->bindParams[$name] = $value;
    }

addCountSqlSkipPart()

addCountSqlSkipPart	(		$name,
			$toSkip = true
	)

Add Select Part to skip from count query

Parameters

string	$name
bool	$toSkip

Returns

void

Implements QueryInterface.

Definition at line 241 of file Query.php.

    {
        $this->countSqlSkipParts[$name] = $toSkip;
    }

fetchAll()

fetchAll

(

)

Fetch all statement

Returns

array

Implements QueryInterface.

Definition at line 178 of file Query.php.

    {
        if ($this->data === null) {
            $select = $this->getSelect();
            $this->data = $this->fetchStrategy->fetchAll($select, $this->bindParams);
        }
        return $this->data;
    }

fetchItem()

fetchItem

(

)

Fetch statement

Returns

mixed

Implements QueryInterface.

Definition at line 192 of file Query.php.

    {
        if (null === $this->fetchStmt) {
            $this->fetchStmt = $this->getConnection()->query($this->getSelect(), $this->bindParams);
        }
        $data = $this->fetchStmt->fetch();
        if (!$data) {
            $data = [];
        }
        return $data;
    }

getAllIds()

getAllIds

(

)

Retrieve all ids for query

Returns

array

Implements QueryInterface.

Definition at line 111 of file Query.php.

    {
        $idsSelect = clone $this->getSelect();
        $idsSelect->reset(\Magento\Framework\DB\Select::ORDER);
        $idsSelect->reset(\Magento\Framework\DB\Select::LIMIT_COUNT);
        $idsSelect->reset(\Magento\Framework\DB\Select::LIMIT_OFFSET);
        $idsSelect->reset(\Magento\Framework\DB\Select::COLUMNS);
        $idsSelect->columns($this->getResource()->getIdFieldName(), 'main_table');
        return $this->getConnection()->fetchCol($idsSelect, $this->bindParams);
    }

getConnection()

getConnection

(

)

Retrieve connection object

Returns

\Magento\Framework\DB\Adapter\AdapterInterface

Implements QueryInterface.

Definition at line 219 of file Query.php.

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

getCountSqlSkipParts()

getCountSqlSkipParts ( )

protected

Returned count SQL skip parts

Returns

array

Definition at line 269 of file Query.php.

    {
        return $this->countSqlSkipParts;
    }

getCriteria()

getCriteria

(

)

Retrieve source Criteria object

Returns

\Magento\Framework\Api\CriteriaInterface

Implements QueryInterface.

Definition at line 101 of file Query.php.

    {
        return $this->criteria;
    }

getIdFieldName()

getIdFieldName

(

)

Get Identity Field Name

Returns

string

Implements QueryInterface.

Definition at line 209 of file Query.php.

    {
        return $this->getResource()->getIdFieldName();
    }

getResource()

getResource

(

)

Get resource instance

Returns

\Magento\Framework\Model\ResourceModel\Db\AbstractDb

Implements QueryInterface.

Definition at line 229 of file Query.php.

    {
        return $this->resource;
    }

getSelect()

getSelect ( )

protected

Get \Magento\Framework\DB\Select object instance

Returns

Select

Definition at line 279 of file Query.php.

    {
        return $this->select;
    }

getSelectCountSql()

getSelectCountSql ( )

protected

Get SQL for get record count

Returns

Select

Definition at line 251 of file Query.php.

    {
        $countSelect = clone $this->getSelect();
        foreach ($this->getCountSqlSkipParts() as $part => $toSkip) {
            if ($toSkip) {
                $countSelect->reset($part);
            }
        }
        $countSelect->columns('COUNT(*)');

        return $countSelect;
    }

getSelectSql()

getSelectSql

(

$stringMode = false

)

Get sql select string or object

Parameters

bool

$stringMode

Returns

string || Select

Implements QueryInterface.

Definition at line 154 of file Query.php.

    {
        if ($stringMode) {
            return $this->select->__toString();
        }
        return $this->select;
    }

getSize()

getSize

(

)

Get collection size

Returns

int

Implements QueryInterface.

Definition at line 139 of file Query.php.

    {
        if ($this->totalRecords === null) {
            $sql = $this->getSelectCountSql();
            $this->totalRecords = $this->getConnection()->fetchOne($sql, $this->bindParams);
        }
        return intval($this->totalRecords);
    }

reset()

reset

(

)

Reset Statement object

Returns

void

Implements QueryInterface.

Definition at line 167 of file Query.php.

    {
        $this->fetchStmt = null;
        $this->data = null;
    }

Field Documentation

$bindParams

$bindParams = []

protected

Definition at line 54 of file Query.php.

$countSqlSkipParts

$countSqlSkipParts

protected

Initial value:

= [
        \Magento\Framework\DB\Select::ORDER => true,
        \Magento\Framework\DB\Select::LIMIT_COUNT => true,
        \Magento\Framework\DB\Select::LIMIT_OFFSET => true,
        \Magento\Framework\DB\Select::COLUMNS => true,
    ]

Definition at line 71 of file Query.php.

$criteria

$criteria

protected

Definition at line 25 of file Query.php.

$data

$data

protected

Definition at line 64 of file Query.php.

$fetchStmt

$fetchStmt = null

protected

Definition at line 39 of file Query.php.

$logger

$logger

protected

Definition at line 44 of file Query.php.

$resource

$resource

protected

Definition at line 32 of file Query.php.

$select

$select

protected

Definition at line 20 of file Query.php.

$totalRecords

$totalRecords

protected

Definition at line 59 of file Query.php.

---

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

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