Skip to content

Commit 1a8aabc

Browse files
authored
ENGCOM-3863: Small PHPDocs fixes [Reports module] #20302
2 parents 9b0147d + c08588d commit 1a8aabc

File tree

9 files changed

+15
-10
lines changed

9 files changed

+15
-10
lines changed

app/code/Magento/Reports/Controller/Adminhtml/Report/Statistics.php

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,19 @@
44
* See COPYING.txt for license details.
55
*/
66

7-
/**
8-
* Report statistics admin controller
9-
*
10-
* @author Magento Core Team <[email protected]>
11-
*/
127
namespace Magento\Reports\Controller\Adminhtml\Report;
138

149
use Magento\Backend\Model\Auth\Session as AuthSession;
1510
use Magento\Backend\Model\Session;
11+
use Magento\Framework\App\Action\HttpGetActionInterface;
1612

1713
/**
14+
* Report statistics admin controller.
15+
*
1816
* @api
1917
* @since 100.0.2
2018
*/
21-
abstract class Statistics extends \Magento\Backend\App\Action
19+
abstract class Statistics extends \Magento\Backend\App\Action implements HttpGetActionInterface
2220
{
2321
/**
2422
* Authorization level of a basic admin session
@@ -49,7 +47,7 @@ abstract class Statistics extends \Magento\Backend\App\Action
4947
/**
5048
* @param \Magento\Backend\App\Action\Context $context
5149
* @param \Magento\Framework\Stdlib\DateTime\Filter\Date $dateFilter
52-
* @param [] $reportTypes
50+
* @param array $reportTypes
5351
*/
5452
public function __construct(
5553
\Magento\Backend\App\Action\Context $context,

app/code/Magento/Reports/Model/ResourceModel/Order/Collection.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ class Collection extends \Magento\Sales\Model\ResourceModel\Order\Collection
8181
* @param \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate
8282
* @param \Magento\Sales\Model\Order\Config $orderConfig
8383
* @param \Magento\Sales\Model\ResourceModel\Report\OrderFactory $reportOrderFactory
84-
* @param null $connection
84+
* @param \Magento\Framework\DB\Adapter\AdapterInterface $connection
8585
* @param \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource
8686
*
8787
* @SuppressWarnings(PHPMD.ExcessiveParameterList)

app/code/Magento/Reports/Observer/CatalogProductCompareClearObserver.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ class CatalogProductCompareClearObserver implements ObserverInterface
2424

2525
/**
2626
* @param \Magento\Reports\Model\Product\Index\ComparedFactory $productCompFactory
27+
* @param \Magento\Reports\Model\ReportStatus $reportStatus
2728
*/
2829
public function __construct(
2930
\Magento\Reports\Model\Product\Index\ComparedFactory $productCompFactory,
@@ -39,7 +40,7 @@ public function __construct(
3940
* Reset count of compared products cache
4041
*
4142
* @param \Magento\Framework\Event\Observer $observer
42-
* @return $this
43+
* @return void
4344
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
4445
*/
4546
public function execute(\Magento\Framework\Event\Observer $observer)

app/code/Magento/Reports/Observer/CatalogProductViewObserver.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
/**
1212
* Reports Event observer model
13+
* @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
1314
*/
1415
class CatalogProductViewObserver implements ObserverInterface
1516
{
@@ -49,6 +50,7 @@ class CatalogProductViewObserver implements ObserverInterface
4950
* @param \Magento\Customer\Model\Session $customerSession
5051
* @param \Magento\Customer\Model\Visitor $customerVisitor
5152
* @param EventSaver $eventSaver
53+
* @param \Magento\Reports\Model\ReportStatus $reportStatus
5254
*/
5355
public function __construct(
5456
\Magento\Store\Model\StoreManagerInterface $storeManager,

app/code/Magento/Reports/Observer/CheckoutCartAddProductObserver.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ class CheckoutCartAddProductObserver implements ObserverInterface
2525

2626
/**
2727
* @param EventSaver $eventSaver
28+
* @param \Magento\Reports\Model\ReportStatus $reportStatus
2829
*/
2930
public function __construct(
3031
EventSaver $eventSaver,

app/code/Magento/Reports/Observer/CustomerLogoutObserver.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public function __construct(
3838
* Customer logout processing
3939
*
4040
* @param \Magento\Framework\Event\Observer $observer
41-
* @return $this
41+
* @return void
4242
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
4343
*/
4444
public function execute(\Magento\Framework\Event\Observer $observer)

app/code/Magento/Reports/Observer/SendfriendProductObserver.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ class SendfriendProductObserver implements ObserverInterface
2525

2626
/**
2727
* @param EventSaver $eventSaver
28+
* @param \Magento\Reports\Model\ReportStatus $reportStatus
2829
*/
2930
public function __construct(
3031
EventSaver $eventSaver,

app/code/Magento/Reports/Observer/WishlistAddProductObserver.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ class WishlistAddProductObserver implements ObserverInterface
2525

2626
/**
2727
* @param EventSaver $eventSaver
28+
* @param \Magento\Reports\Model\ReportStatus $reportStatus
2829
*/
2930
public function __construct(
3031
EventSaver $eventSaver,

app/code/Magento/Reports/Observer/WishlistShareObserver.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ class WishlistShareObserver implements ObserverInterface
2525

2626
/**
2727
* @param EventSaver $eventSaver
28+
* @param \Magento\Reports\Model\ReportStatus $reportStatus
2829
*/
2930
public function __construct(
3031
EventSaver $eventSaver,

0 commit comments

Comments
 (0)