Skip to content

Commit 9e5a1b2

Browse files
author
Yevhen Miroshnychenko
committed
MAGETWO-63216: [TD] Fix PHPDoc comments that was delivered in Sprint 4
1 parent 7b35864 commit 9e5a1b2

File tree

4 files changed

+21
-8
lines changed

4 files changed

+21
-8
lines changed

app/code/Magento/Deploy/Console/Command/App/SensitiveConfigSet/CollectorFactory.php

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,8 @@ class CollectorFactory
3232

3333
/**
3434
* @param ObjectManagerInterface $objectManager
35-
* @param array $types array of collector types that are available for creation, for example
36-
* ```php
37-
* array ('type' => 'collector class name ')
38-
* ```
35+
* @param array $types list of collector class names this factory can create.
36+
* Every class should implement \Magento\Deploy\Console\Command\App\SensitiveConfigSet\CollectorInterface
3937
*/
4038
public function __construct(
4139
ObjectManagerInterface $objectManager,

lib/internal/Magento/Framework/Module/Manager.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@
1010
*
1111
* Usage:
1212
* ```php
13-
* //...
1413
* $manager->isEnabled('Vendor_Module');
15-
* //...
1614
* ```
1715
*/
1816
class Manager
@@ -21,6 +19,8 @@ class Manager
2119
* The checker of output modules.
2220
*
2321
* @var Output\ConfigInterface the config checker of output modules.
22+
* @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version.
23+
* The property can be removed in a future major release
2424
*/
2525
private $outputConfig;
2626

@@ -35,6 +35,8 @@ class Manager
3535
* The list of config paths to ignore.
3636
*
3737
* @var array the list of config paths to ignore.
38+
* @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version.
39+
* The property can be removed in a future major release
3840
*/
3941
private $outputConfigPaths;
4042

lib/internal/Magento/Framework/Module/Output/Config.php

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,19 @@ class Config implements \Magento\Framework\Module\Output\ConfigInterface
1616
{
1717
/**
1818
* XPath in the configuration where module statuses are stored
19+
* @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
1920
*/
2021
const XML_PATH_MODULE_OUTPUT_STATUS = 'advanced/modules_disable_output/%s';
2122

2223
/**
2324
* @var \Magento\Framework\App\Config\ScopeConfigInterface
25+
* @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
2426
*/
2527
protected $_scopeConfig;
2628

2729
/**
2830
* @var string
31+
* @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
2932
*/
3033
protected $_storeType;
3134

@@ -42,15 +45,23 @@ public function __construct(
4245
}
4346

4447
/**
45-
* @inheritdoc
48+
* Whether a module is enabled in the configuration or not
49+
*
50+
* @param string $moduleName Fully-qualified module name
51+
* @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
52+
* @return boolean
4653
*/
4754
public function isEnabled($moduleName)
4855
{
4956
return false;
5057
}
5158

5259
/**
53-
* @inheritdoc
60+
* Retrieve module enabled specific path
61+
*
62+
* @param string $path Fully-qualified config path
63+
* @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
64+
* @return boolean
5465
*/
5566
public function isSetFlag($path)
5667
{

lib/internal/Magento/Framework/Module/Output/ConfigInterface.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ interface ConfigInterface
1616
* Whether a module is enabled in the configuration or not
1717
*
1818
* @param string $moduleName Fully-qualified module name
19+
* @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
1920
* @return boolean
2021
*/
2122
public function isEnabled($moduleName);
@@ -24,6 +25,7 @@ public function isEnabled($moduleName);
2425
* Retrieve module enabled specific path
2526
*
2627
* @param string $path Fully-qualified config path
28+
* @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
2729
* @return boolean
2830
*/
2931
public function isSetFlag($path);

0 commit comments

Comments
 (0)