Skip to content

Commit 2b5975c

Browse files
committed
#27536: Improved interfaces comments and introduced MediaContentCms sequence
1 parent d5cdd0b commit 2b5975c

File tree

8 files changed

+16
-13
lines changed

8 files changed

+16
-13
lines changed

app/code/Magento/Cms/etc/module.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
<module name="Magento_Store"/>
1212
<module name="Magento_Theme"/>
1313
<module name="Magento_Variable"/>
14+
<module name="Magento_MediaContentCms"/>
1415
</sequence>
1516
</module>
1617
</config>

app/code/Magento/MediaContentApi/Api/AssignAssetsInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
use Magento\MediaContentApi\Api\Data\ContentIdentityInterface;
1212

1313
/**
14-
* Saving data represents relation between the media asset and media content
14+
* Assign a media asset to the piece of content. Should be executed when media assets is added to the content
1515
* @api
1616
*/
1717
interface AssignAssetsInterface
1818
{
1919
/**
20-
* Save relation between media asset and media content.
20+
* Assign a media asset to the piece of content. Should be executed when media assets is added to the content
2121
*
2222
* @param ContentIdentityInterface $contentIdentity
2323
* @param int[] $assetIds

app/code/Magento/MediaContentApi/Api/ExtractAssetsFromContentInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
use Magento\MediaGalleryApi\Api\Data\AssetInterface;
1111

1212
/**
13-
* Used for extracting media asset list from a media content by the search pattern.
13+
* Parse the content string for references to media assets and return the list of identified media assets
1414
* @api
1515
*/
1616
interface ExtractAssetsFromContentInterface
1717
{
1818
/**
19-
* Search for the media asset in content and extract it providing a list of media assets.
19+
* Parse the content string for references to media assets and return the list of identified media assets
2020
*
2121
* @param string $content
2222
* @return AssetInterface[]

app/code/Magento/MediaContentApi/Api/GetAssetIdsUsedInContentInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
use Magento\MediaContentApi\Api\Data\ContentIdentityInterface;
1212

1313
/**
14-
* Get media asset ids used in the content
14+
* Get media asset ids that are used in the piece of content identified by the specified content identity
1515
* @api
1616
*/
1717
interface GetAssetIdsUsedInContentInterface
1818
{
1919
/**
20-
* Get media asset ids used in the content
20+
* Get media asset ids that are used in the piece of content identified by the specified content identity
2121
*
2222
* @param ContentIdentityInterface $contentIdentity
2323
* @return int[]

app/code/Magento/MediaContentApi/Api/GetContentWithAssetsInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
use Magento\MediaContentApi\Api\Data\ContentIdentityInterface;
1212

1313
/**
14-
* Get media content list which is used with the specified media asset
14+
* Get list of content identifiers for pieces of content that include the specified media asset
1515
* @api
1616
*/
1717
interface GetContentWithAssetsInterface
1818
{
1919
/**
20-
* Get media asset to content relations by media asset id.
20+
* Get list of content identifiers for pieces of content that include the specified media asset
2121
*
2222
* @param int[] $assetIds
2323
* @return ContentIdentityInterface[]

app/code/Magento/MediaContentApi/Api/UnassignAssetsInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
use Magento\MediaContentApi\Api\Data\ContentIdentityInterface;
1212

1313
/**
14-
* Unassign relation between the media asset and media content where the media asset is used
14+
* Remove the relation between media asset and the piece of content. I.e media asset no longer part of the content
1515
* @api
1616
*/
1717
interface UnassignAssetsInterface
1818
{
1919
/**
20-
* Remove relation between the media asset and media content.
20+
* Remove relation between the media asset and the content. I.e media asset no longer part of the content
2121
*
2222
* @param int[] $assetIds
2323
* @param ContentIdentityInterface $contentIdentity

app/code/Magento/MediaContentApi/Api/UpdateRelationsInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
use Magento\MediaContentApi\Api\Data\ContentIdentityInterface;
1111

1212
/**
13-
* Process relation managing between media asset and content: assign or unassign relation if exists.
13+
* Update the media assets to content relations. Assign new media assets and unassign media assets no longer used
1414
*/
1515
interface UpdateRelationsInterface
1616
{
1717
/**
18-
* Create new relation between media asset and content or updated existing
18+
* Update the media assets to content relations. Assign new media assets and unassign media assets no longer used
1919
*
2020
* @param ContentIdentityInterface $contentIdentity
2121
* @param string $content

app/code/Magento/MediaContentCms/etc/module.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,7 @@
66
*/
77
-->
88
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
9-
<module name="Magento_MediaContentCms" />
9+
<module name="Magento_MediaContentCms">
10+
<module name="Magento_MediaContent"/>
11+
</module>
1012
</config>

0 commit comments

Comments
 (0)