Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Member Functions | Protected Attributes
Rule Class Reference
Inheritance diagram for Rule:
AbstractReport AbstractDb AbstractResource

Public Member Functions

 __construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Reports\Model\FlagFactory $reportsFlagFactory, \Magento\Framework\Stdlib\DateTime\Timezone\Validator $timezoneValidator, \Magento\Framework\Stdlib\DateTime\DateTime $dateTime, \Magento\SalesRule\Model\ResourceModel\Report\Rule\CreatedatFactory $createdatFactory, \Magento\SalesRule\Model\ResourceModel\Report\Rule\UpdatedatFactory $updatedatFactory, $connectionName=null)
 
 aggregate ($from=null, $to=null)
 
 getUniqRulesNamesList ()
 
- Public Member Functions inherited from AbstractReport
 __construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Reports\Model\FlagFactory $reportsFlagFactory, \Magento\Framework\Stdlib\DateTime\Timezone\Validator $timezoneValidator, \Magento\Framework\Stdlib\DateTime\DateTime $dateTime, $connectionName=null)
 
 getStoreTZOffsetQuery ( $table, $column, $from=null, $to=null, $store=null, $connection=null)
 
- Public Member Functions inherited from AbstractDb
 __construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, $connectionName=null)
 
 __sleep ()
 
 __wakeup ()
 
 getIdFieldName ()
 
 getMainTable ()
 
 getTable ($tableName)
 
 getConnection ()
 
 load (\Magento\Framework\Model\AbstractModel $object, $value, $field=null)
 
 save (\Magento\Framework\Model\AbstractModel $object)
 
 delete (\Magento\Framework\Model\AbstractModel $object)
 
 addUniqueField ($field)
 
 resetUniqueField ()
 
 unserializeFields (\Magento\Framework\Model\AbstractModel $object)
 
 getUniqueFields ()
 
 hasDataChanged ($object)
 
 getChecksum ($table)
 
 afterLoad (\Magento\Framework\DataObject $object)
 
 beforeSave (\Magento\Framework\DataObject $object)
 
 afterSave (\Magento\Framework\DataObject $object)
 
 beforeDelete (\Magento\Framework\DataObject $object)
 
 afterDelete (\Magento\Framework\DataObject $object)
 
 serializeFields (\Magento\Framework\Model\AbstractModel $object)
 
- Public Member Functions inherited from AbstractResource
 __construct ()
 
 getConnection ()
 
 beginTransaction ()
 
 addCommitCallback ($callback)
 
 commit ()
 
 rollBack ()
 
 getValidationRulesBeforeSave ()
 

Protected Member Functions

 _construct ()
 
- Protected Member Functions inherited from AbstractReport
 _getFlag ()
 
 _setFlagData ($code, $value=null)
 
 _getFlagData ($code)
 
 _truncateTable ($table)
 
 _clearTableByDateRange ( $table, $from=null, $to=null, $subSelect=null, $doNotUseTruncate=false, $connection=null)
 
 _getTableDateRangeSelect ( $table, $column, $whereColumn, $from=null, $to=null, $additionalWhere=[], $alias='date_range_table')
 
 _makeConditionFromDateRangeSelect ($select, $periodColumn, $connection=null)
 
 _getTableDateRangeRelatedSelect ( $table, $relatedTable, $joinCondition, $column, $whereColumn, $from=null, $to=null, $additionalWhere=[], $alias='date_range_table', $relatedAlias='related_date_range_table')
 
 _getTZOffsetTransitions ($timezone, $from=null, $to=null)
 
- Protected Member Functions inherited from AbstractDb
 _init ($mainTable, $idFieldName)
 
 _setResource ($connections, $tables=null)
 
 _setMainTable ($mainTable, $idFieldName=null)
 
 _getConnection ($resourceName)
 
 _getLoadSelect ($field, $value, $object)
 
 _initUniqueFields ()
 
 _prepareDataForSave (\Magento\Framework\Model\AbstractModel $object)
 
 _prepareValueForSave ($value, $type)
 
 _checkUnique (\Magento\Framework\Model\AbstractModel $object)
 
 _afterLoad (\Magento\Framework\Model\AbstractModel $object)
 
 _beforeSave (\Magento\Framework\Model\AbstractModel $object)
 
 _afterSave (\Magento\Framework\Model\AbstractModel $object)
 
 _beforeDelete (\Magento\Framework\Model\AbstractModel $object)
 
 _afterDelete (\Magento\Framework\Model\AbstractModel $object)
 
 _serializeFields (\Magento\Framework\Model\AbstractModel $object)
 
 prepareDataForUpdate ($object)
 
 isObjectNotNew (\Magento\Framework\Model\AbstractModel $object)
 
 saveNewObject (\Magento\Framework\Model\AbstractModel $object)
 
 updateObject (\Magento\Framework\Model\AbstractModel $object)
 
 processAfterSaves (\Magento\Framework\Model\AbstractModel $object)
 
 isModified (\Magento\Framework\Model\AbstractModel $object)
 
 processNotModifiedSave (\Magento\Framework\Model\AbstractModel $object)
 
- Protected Member Functions inherited from AbstractResource
 _construct ()
 
 _serializeField (DataObject $object, $field, $defaultValue=null, $unsetEmpty=false)
 
 _unserializeField (DataObject $object, $field, $defaultValue=null)
 
 _prepareDataForTable (DataObject $object, $table)
 
 _prepareTableValueForSave ($value, $type)
 
 _getColumnsForEntityLoad (\Magento\Framework\Model\AbstractModel $object, $tableName)
 
 getSerializer ()
 

Protected Attributes

 $_createdatFactory
 
 $_updatedatFactory
 
- Protected Attributes inherited from AbstractReport
 $_flag = null
 
 $_logger
 
 $_localeDate
 
 $_reportsFlagFactory
 
 $dateTime
 
- Protected Attributes inherited from AbstractDb
 $_resources
 
 $connectionName = \Magento\Framework\App\ResourceConnection::DEFAULT_CONNECTION
 
 $_connections = []
 
 $_resourceModel
 
 $_tables = []
 
 $_mainTable
 
 $_idFieldName
 
 $_isPkAutoIncrement = true
 
 $_useIsObjectNew = false
 
 $_mainTableFields
 
 $_uniqueFields = null
 
 $_serializableFields = []
 
 $transactionManager
 
 $objectRelationProcessor
 
- Protected Attributes inherited from AbstractResource
 $serializer
 
 $_logger
 

Detailed Description

Rule report resource model

Author
Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 13 of file Rule.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \Magento\Framework\Model\ResourceModel\Db\Context  $context,
\Psr\Log\LoggerInterface  $logger,
\Magento\Framework\Stdlib\DateTime\TimezoneInterface  $localeDate,
\Magento\Reports\Model\FlagFactory  $reportsFlagFactory,
\Magento\Framework\Stdlib\DateTime\Timezone\Validator  $timezoneValidator,
\Magento\Framework\Stdlib\DateTime\DateTime  $dateTime,
\Magento\SalesRule\Model\ResourceModel\Report\Rule\CreatedatFactory  $createdatFactory,
\Magento\SalesRule\Model\ResourceModel\Report\Rule\UpdatedatFactory  $updatedatFactory,
  $connectionName = null 
)
Parameters
\Magento\Framework\Model\ResourceModel\Db\Context$context
\Psr\Log\LoggerInterface$logger
\Magento\Framework\Stdlib\DateTime\TimezoneInterface$localeDate
\Magento\Reports\Model\FlagFactory$reportsFlagFactory
\Magento\Framework\Stdlib\DateTime\Timezone\Validator$timezoneValidator
\Magento\Framework\Stdlib\DateTime\DateTime$dateTime
\Magento\SalesRule\Model\ResourceModel\Report\Rule\CreatedatFactory$createdatFactory
\Magento\SalesRule\Model\ResourceModel\Report\Rule\UpdatedatFactory$updatedatFactory
string$connectionName

Definition at line 36 of file Rule.php.

46  {
47  parent::__construct(
48  $context,
49  $logger,
50  $localeDate,
51  $reportsFlagFactory,
52  $timezoneValidator,
53  $dateTime,
55  );
56  $this->_createdatFactory = $createdatFactory;
57  $this->_updatedatFactory = $updatedatFactory;
58  }
$logger

Member Function Documentation

◆ _construct()

_construct ( )
protected

Resource Report Rule constructor

Returns
void

Definition at line 65 of file Rule.php.

66  {
67  $this->_setResource('salesrule');
68  }

◆ aggregate()

aggregate (   $from = null,
  $to = null 
)

Aggregate Coupons data

Parameters
mixed | null$from
mixed | null$to
Returns
$this

Definition at line 77 of file Rule.php.

78  {
79  $this->_createdatFactory->create()->aggregate($from, $to);
80  $this->_updatedatFactory->create()->aggregate($from, $to);
81  $this->_setFlagData(\Magento\Reports\Model\Flag::REPORT_COUPONS_FLAG_CODE);
82 
83  return $this;
84  }

◆ getUniqRulesNamesList()

getUniqRulesNamesList ( )

Get all unique Rule Names from aggregated coupons usage data

Returns
array

Definition at line 91 of file Rule.php.

92  {
93  $connection = $this->getConnection();
94  $tableName = $this->getTable('salesrule_coupon_aggregated');
95  $select = $connection->select()->from(
96  $tableName,
97  new \Zend_Db_Expr('DISTINCT rule_name')
98  )->where(
99  'rule_name IS NOT NULL'
100  )->where(
101  'rule_name <> ?',
102  ''
103  )->order(
104  'rule_name ASC'
105  );
106 
107  $rulesNames = $connection->fetchAll($select);
108 
109  $result = [];
110 
111  foreach ($rulesNames as $row) {
112  $result[] = $row['rule_name'];
113  }
114 
115  return $result;
116  }
$tableName
Definition: trigger.php:13
$connection
Definition: bulk.php:13

Field Documentation

◆ $_createdatFactory

$_createdatFactory
protected

Definition at line 18 of file Rule.php.

◆ $_updatedatFactory

$_updatedatFactory
protected

Definition at line 23 of file Rule.php.


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