Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-backend/Model/Widget/Grid/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Backend\Model\Widget\Grid;
/**
* @api
* @since 100.0.2
*/
abstract class AbstractTotals implements \Magento\Backend\Model\Widget\Grid\TotalsInterface
{
/**
* List of columns should be proceed with expression
* 'key' => column index
* 'value' => column expression
*
* @var array
*/
protected $_columns = [];
/**
* Array of totals based on columns index
* 'key' => column index
* 'value' => counted total
*
* @var array
*/
protected $_totals = [];
/**
* Factory model
*
* @var \Magento\Framework\DataObject\Factory
*/
protected $_factory;
/**
* Parser for expressions like operand operation operand
*
* @var \Magento\Backend\Model\Widget\Grid\Parser
*/
protected $_parser;
/**
* @param \Magento\Framework\DataObject\Factory $factory
* @param \Magento\Backend\Model\Widget\Grid\Parser $parser
*/
public function __construct(
\Magento\Framework\DataObject\Factory $factory,
\Magento\Backend\Model\Widget\Grid\Parser $parser
) {
$this->_factory = $factory;
$this->_parser = $parser;
}
/**
* Count collection column sum based on column index
*
* @param string $index
* @param \Magento\Framework\Data\Collection $collection
* @return float|int
* @abstract
*/
abstract protected function _countSum($index, $collection);
/**
* Count collection column average based on column index
*
* @param string $index
* @param \Magento\Framework\Data\Collection $collection
* @return float|int
* @abstract
*/
abstract protected function _countAverage($index, $collection);
/**
* Count collection column sum based on column index and expression
*
* @param string $index
* @param string $expr
* @param \Magento\Framework\Data\Collection $collection
* @return float|int
*/
protected function _count($index, $expr, $collection)
{
switch ($expr) {
case 'sum':
$result = $this->_countSum($index, $collection);
break;
case 'avg':
$result = $this->_countAverage($index, $collection);
break;
default:
$result = $this->_countExpr($expr, $collection);
break;
}
$this->_totals[$index] = $result;
return $result;
}
/**
* Return counted expression accorded parsed string
*
* @param string $expr
* @param \Magento\Framework\Data\Collection $collection
* @return float|int
*/
protected function _countExpr($expr, $collection)
{
$parsedExpression = $this->_parser->parseExpression($expr);
$result = $tmpResult = 0;
$firstOperand = $secondOperand = null;
foreach ($parsedExpression as $operand) {
if ($this->_parser->isOperation($operand)) {
$this->_checkOperandsSet($firstOperand, $secondOperand, $tmpResult, $result);
$result = $this->_operate($firstOperand, $secondOperand, $operand);
$firstOperand = $secondOperand = null;
} else {
if (null === $firstOperand) {
$firstOperand = $this->_checkOperand($operand, $collection);
} elseif (null === $secondOperand) {
$secondOperand = $this->_checkOperand($operand, $collection);
}
}
}
return $result;
}
/**
* Check if operands in not null and set operands values if they are empty
*
* @param float|int $firstOperand
* @param float|int $secondOperand
* @param float|int $tmpResult
* @param float|int $result
* @return void
*/
protected function _checkOperandsSet(&$firstOperand, &$secondOperand, &$tmpResult, $result)
{
if (null === $firstOperand && null === $secondOperand) {
$firstOperand = $tmpResult;
$secondOperand = $result;
} elseif (null !== $firstOperand && null === $secondOperand) {
$secondOperand = $result;
} elseif (null !== $firstOperand && null !== $secondOperand) {
$tmpResult = $result;
}
}
/**
* Get result of operation
*
* @param float|int $firstOperand
* @param float|int $secondOperand
* @param string $operation
* @return float|int
*/
protected function _operate($firstOperand, $secondOperand, $operation)
{
$result = 0;
switch ($operation) {
case '+':
$result = $firstOperand + $secondOperand;
break;
case '-':
$result = $firstOperand - $secondOperand;
break;
case '*':
$result = $firstOperand * $secondOperand;
break;
case '/':
$result = $secondOperand ? $firstOperand / $secondOperand : $secondOperand;
break;
}
return $result;
}
/**
* Check operand is numeric or has already counted
*
* @param string $operand
* @param \Magento\Framework\Data\Collection $collection
* @return float|int
*/
protected function _checkOperand($operand, $collection)
{
if (!is_numeric($operand)) {
if (isset($this->_totals[$operand])) {
$operand = $this->_totals[$operand];
} else {
$operand = $this->_count($operand, $this->_columns[$operand], $collection);
}
} else {
$operand *= 1;
}
return $operand;
}
/**
* Fill columns
*
* @param string $index
* @param string $totalExpr
* @return $this
*/
public function setColumn($index, $totalExpr)
{
$this->_columns[$index] = $totalExpr;
return $this;
}
/**
* Return columns set
*
* @return array
*/
public function getColumns()
{
return $this->_columns;
}
/**
* Count totals for all columns set
*
* @param \Magento\Framework\Data\Collection $collection
* @return \Magento\Framework\DataObject
*/
public function countTotals($collection)
{
foreach ($this->_columns as $index => $expr) {
$this->_count($index, $expr, $collection);
}
return $this->getTotals();
}
/**
* Get totals as object
*
* @return \Magento\Framework\DataObject
*/
public function getTotals()
{
return $this->_factory->create($this->_totals);
}
/**
* Reset totals and columns set
*
* @param bool $isFullReset
* @return void
*/
public function reset($isFullReset = false)
{
if ($isFullReset) {
$this->_columns = [];
}
$this->_totals = [];
}
}