Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Reports\Model\ItemFactory $itemFactory)
	getIntervals ($from, $to, $period=self::REPORT_PERIOD_TYPE_DAY)
	prepareIntervalsCollection ($collection, $from, $to, $periodType=self::REPORT_PERIOD_TYPE_DAY)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	REPORT_PERIOD_TYPE_DAY = 'day'
const	REPORT_PERIOD_TYPE_MONTH = 'month'
const	REPORT_PERIOD_TYPE_YEAR = 'year'

Protected Attributes
	$_itemFactory
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Detailed Description

@api

Since

100.0.2

Definition at line 19 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Reports\Model\ItemFactory	$itemFactory
	)

Constructor

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Reports\Model\ItemFactory	$itemFactory

Definition at line 40 of file Data.php.

      {
        parent::__construct($context);
        $this->_itemFactory = $itemFactory;
    }

Member Function Documentation

getIntervals()

getIntervals	(		$from,
			$to,
			$period = self::REPORT_PERIOD_TYPE_DAY
	)

Retrieve array of intervals

Parameters

string	$from
string	$to
string	$period

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 57 of file Data.php.

    {
        $intervals = [];
        if (!$from && !$to) {
            return $intervals;
        }

        $dateStart = new \DateTime($from);
        $dateEnd = new \DateTime($to);
        while ($dateStart->diff($dateEnd)->invert == 0) {
            switch ($period) {
                case self::REPORT_PERIOD_TYPE_DAY:
                    $intervals[] = $dateStart->format('Y-m-d');
                    $dateStart->add(new \DateInterval('P1D'));
                    break;
                case self::REPORT_PERIOD_TYPE_MONTH:
                    $intervals[] = $dateStart->format('Y-m');
                    $dateStart->add(new \DateInterval('P1M'));
                    break;
                case self::REPORT_PERIOD_TYPE_YEAR:
                    $intervals[] = $dateStart->format('Y');
                    $dateStart->add(new \DateInterval('P1Y'));
                    break;
            }
        }
        return $intervals;
    }

prepareIntervalsCollection()

prepareIntervalsCollection	(		$collection,
			$from,
			$to,
			$periodType = self::REPORT_PERIOD_TYPE_DAY
	)

Add items to interval collection

Parameters

Collection	$collection
string	$from
string	$to
string	$periodType

Returns

void

Definition at line 94 of file Data.php.

    {
        $intervals = $this->getIntervals($from, $to, $periodType);

        foreach ($intervals as $interval) {
            $item = $this->_itemFactory->create();
            $item->setPeriod($interval);
            $item->setIsEmpty();
            $collection->addItem($item);
        }
    }

Field Documentation

$_itemFactory

$_itemFactory

protected

Definition at line 32 of file Data.php.

REPORT_PERIOD_TYPE_DAY

const REPORT_PERIOD_TYPE_DAY = 'day'

Definition at line 21 of file Data.php.

REPORT_PERIOD_TYPE_MONTH

const REPORT_PERIOD_TYPE_MONTH = 'month'

Definition at line 23 of file Data.php.

REPORT_PERIOD_TYPE_YEAR

const REPORT_PERIOD_TYPE_YEAR = 'year'

Definition at line 25 of file Data.php.

---

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

• vendor/magento/module-reports/Helper/Data.php