Skip to content

Commit 15aa96f

Browse files
author
Gabriel Galvao da Gama
committed
Improved php doc blocks
1 parent 3a1a3c7 commit 15aa96f

File tree

4 files changed

+21
-15
lines changed

4 files changed

+21
-15
lines changed

app/code/Magento/MediaContent/Model/GetAssetIdByContentStatus.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
use Magento\MediaContentApi\Model\GetAssetIdByContentStatusInterface;
1212

1313
/**
14-
* Class GetAssetIdByContentStatus
14+
* Class responsible to return Asset id by entity status
1515
*/
1616
class GetAssetIdByContentStatus implements GetAssetIdByContentStatusInterface
1717
{
@@ -48,7 +48,8 @@ class GetAssetIdByContentStatus implements GetAssetIdByContentStatusInterface
4848
private $valueMap;
4949

5050
/**
51-
* GetContentIdByStatus constructor.
51+
* GetAssetIdByContentStatus constructor.
52+
*
5253
* @param ResourceConnection $resource
5354
* @param string $entityType
5455
* @param string $contentTable
@@ -73,8 +74,7 @@ public function __construct(
7374
}
7475

7576
/**
76-
* @param string $value
77-
* @return array
77+
* @inheritDoc
7878
*/
7979
public function execute(string $value): array
8080
{

app/code/Magento/MediaContent/Model/GetAssetIdByContentStatusComposite.php

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
use Magento\MediaContentApi\Model\GetAssetIdByContentStatusInterface;
1111

1212
/**
13-
* Class GetAssetIdByContentStatusComposite
13+
* Class responsible to return Asset ids by content status
1414
*/
1515
class GetAssetIdByContentStatusComposite implements GetAssetIdByContentStatusInterface
1616
{
@@ -21,6 +21,7 @@ class GetAssetIdByContentStatusComposite implements GetAssetIdByContentStatusInt
2121

2222
/**
2323
* GetAssetIdByContentStatusComposite constructor.
24+
*
2425
* @param array $getAssetIdByContentStatusArray
2526
*/
2627
public function __construct($getAssetIdByContentStatusArray = [])
@@ -29,14 +30,16 @@ public function __construct($getAssetIdByContentStatusArray = [])
2930
}
3031

3132
/**
32-
* @param string $value
33+
* Get Asset ids by Content status
34+
*
35+
* @param string $status
3336
* @return array
3437
*/
35-
public function execute(string $value): array
38+
public function execute(string $status): array
3639
{
3740
$ids = [];
3841
foreach ($this->getAssetIdByContentStatusArray as $getAssetIdByContentStatus) {
39-
$ids = array_merge($ids, $getAssetIdByContentStatus->execute($value));
42+
$ids = array_merge($ids, $getAssetIdByContentStatus->execute($status));
4043
}
4144
return array_unique($ids);
4245
}

app/code/Magento/MediaContent/Model/GetAssetIdByEavContentStatus.php

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@
77

88
namespace Magento\MediaContent\Model;
99

10-
use Magento\Eav\Api\Data\AttributeInterface;
1110
use Magento\Eav\Model\Config;
1211
use Magento\Framework\App\ResourceConnection;
1312
use Magento\MediaContentApi\Model\GetAssetIdByContentStatusInterface;
1413

1514
/**
16-
* Class GetAssetIdByEavContentStatus
15+
* Class responsible to return Asset id by eav entity status
1716
*/
1817
class GetAssetIdByEavContentStatus implements GetAssetIdByContentStatusInterface
1918
{
@@ -46,6 +45,7 @@ class GetAssetIdByEavContentStatus implements GetAssetIdByContentStatusInterface
4645

4746
/**
4847
* GetAssetIdByEavContentStatus constructor.
48+
*
4949
* @param ResourceConnection $resource
5050
* @param Config $config
5151
* @param string $attributeCode
@@ -67,11 +67,10 @@ public function __construct(
6767
}
6868

6969
/**
70-
* @param string $value
71-
* @return array
70+
* @inheritDoc
7271
* @throws \Magento\Framework\Exception\LocalizedException
7372
*/
74-
public function execute(string $value): array
73+
public function execute(string $status): array
7574
{
7675
$statusAttribute = $this->config->getAttribute($this->entityType, $this->attributeCode);
7776

@@ -89,7 +88,7 @@ public function execute(string $value): array
8988
[]
9089
)->where(
9190
'entity_eav_type.value = ?',
92-
$this->getValueFromMap($value)
91+
$this->getValueFromMap($status)
9392
);
9493

9594
$result = $this->connection->getConnection()->fetchAll($sql);
@@ -100,6 +99,8 @@ public function execute(string $value): array
10099
}
101100

102101
/**
102+
* Get a value from a value map
103+
*
103104
* @param string $value
104105
* @return string
105106
*/

app/code/Magento/MediaContentApi/Model/GetAssetIdByContentStatusInterface.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88
namespace Magento\MediaContentApi\Model;
99

1010
/**
11-
* Interface used to return Asset id by content status (enabled, disabled).
11+
* Interface used to return Asset id by content status.
1212
*/
1313
interface GetAssetIdByContentStatusInterface
1414
{
1515
/**
16+
* This function returns asset ids by entity status
17+
*
1618
* @param string $status
1719
* @return int[]
1820
*/

0 commit comments

Comments
 (0)