Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve openDialog method initialization #27566

Merged
merged 28 commits into from
Apr 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
c839ecc
magento/adobe-stock-integration#935 : Loader stays over the media gal…
Apr 6, 2020
e5e23a8
magento/adobe-stock-integration#935 : Loader stays over the media gal…
Apr 6, 2020
7ba5410
magento/magento2#27566: Do not re-load the gallery app, just content
Apr 7, 2020
f8730c9
Refactor to change targetElementId dynamically
Nazar65 Apr 9, 2020
dba6863
cover new behavior with unit tests, static test fix
Nazar65 Apr 9, 2020
2da1025
corectly bind this
Nazar65 Apr 9, 2020
9b21471
update unit test
Nazar65 Apr 9, 2020
610cd62
use modalLoaded per review comments
Nazar65 Apr 9, 2020
26e4df5
correct unit tests
Nazar65 Apr 9, 2020
8a5def7
Merge branch '2.4-develop' into support-new-media-gallery
slavvka Apr 14, 2020
2c74e2f
Merge branch '2.4-develop' into support-new-media-gallery
slavvka Apr 15, 2020
67c2c0c
Improve opendialogurl configuration to be extensible
Nazar65 Apr 15, 2020
25e5df1
refactor pre review comments static test fix
Nazar65 Apr 15, 2020
e4cdee3
resolve dependency
Nazar65 Apr 15, 2020
d6fabe2
remove wrong added dependency
Nazar65 Apr 15, 2020
6f3cc44
Add openDialogConfig to all instance initialization
Nazar65 Apr 15, 2020
cbb1f4a
remove redundant dependency
Nazar65 Apr 15, 2020
b0afe12
Merge branch '2.4-develop' into support-new-media-gallery
slavvka Apr 15, 2020
8f338a9
Merge branch '2.4-develop' into improve-opendialogurl-config
slavvka Apr 15, 2020
9b75b8d
Merge branch '2.4-develop' into improve-opendialogurl-config
slavvka Apr 16, 2020
15a1861
Merge branch '2.4-develop' into support-new-media-gallery
slavvka Apr 16, 2020
cdcf858
Add DataObject as configuration param, to be more extesible
Nazar65 Apr 16, 2020
c94a81c
Merge branch 'improve-opendialogurl-config' of https://github.com/Naz…
Nazar65 Apr 16, 2020
edf4017
correct event listener to reload media gallery
Nazar65 Apr 16, 2020
0abc548
Merge branch 'support-new-media-gallery' of https://github.com/Nazar6…
Nazar65 Apr 16, 2020
9387809
Merge branch '2.4-develop' of https://github.com/magento/magento2 int…
Nazar65 Apr 16, 2020
aa82c97
Merge remote-tracking branch 'origin/improve-opendialogurl-config' in…
Nazar65 Apr 16, 2020
41f7115
Merge branch '2.4-develop' into support-new-media-gallery
lenaorobei Apr 17, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@

namespace Magento\Cms\Model\Wysiwyg\Gallery;

use Magento\Ui\Component\Form\Element\DataType\Media\OpenDialogUrl;

/**
* @inheritdoc
*/
class DefaultConfigProvider implements \Magento\Framework\Data\Wysiwyg\ConfigProviderInterface
{
/**
Expand All @@ -30,26 +35,34 @@ class DefaultConfigProvider implements \Magento\Framework\Data\Wysiwyg\ConfigPro
*/
private $currentTreePath;

/**
* @var OpednDialogUrl
*/
private $openDialogUrl;

/**
* @param \Magento\Backend\Model\UrlInterface $backendUrl
* @param \Magento\Cms\Helper\Wysiwyg\Images $imagesHelper
* @param OpenDialogUrl $openDialogUrl
* @param array $windowSize
* @param string|null $currentTreePath
*/
public function __construct(
\Magento\Backend\Model\UrlInterface $backendUrl,
\Magento\Cms\Helper\Wysiwyg\Images $imagesHelper,
OpenDialogUrl $openDialogUrl,
array $windowSize = [],
$currentTreePath = null
) {
$this->backendUrl = $backendUrl;
$this->imagesHelper = $imagesHelper;
$this->openDialogUrl = $openDialogUrl;
$this->windowSize = $windowSize;
$this->currentTreePath = $currentTreePath;
}

/**
* {@inheritdoc}
* @inheritdoc
*/
public function getConfig(\Magento\Framework\DataObject $config) : \Magento\Framework\DataObject
{
Expand All @@ -72,7 +85,7 @@ public function getConfig(\Magento\Framework\DataObject $config) : \Magento\Fram
[
'add_images' => true,
'files_browser_window_url' => $this->backendUrl->getUrl(
'cms/wysiwyg_images/index',
$this->openDialogUrl->get(),
$fileBrowserUrlParams
),
'files_browser_window_width' => $this->windowSize['width'],
Expand Down
14 changes: 12 additions & 2 deletions app/code/Magento/Tinymce3/Model/Config/Gallery/Config.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

namespace Magento\Tinymce3\Model\Config\Gallery;

use Magento\Ui\Component\Form\Element\DataType\Media\OpenDialogUrl;

/**
* Class Config adds information about required configurations to display media gallery of tinymce3 editor
*
Expand All @@ -19,13 +21,21 @@ class Config implements \Magento\Framework\Data\Wysiwyg\ConfigProviderInterface
*/
private $backendUrl;

/**
* @var OpednDialogUrl
*/
private $openDialogUrl;

/**
* @param \Magento\Backend\Model\UrlInterface $backendUrl
* @param OpenDialogUrl $openDialogUrl
*/
public function __construct(
\Magento\Backend\Model\UrlInterface $backendUrl
\Magento\Backend\Model\UrlInterface $backendUrl,
OpenDialogUrl $openDialogUrl
) {
$this->backendUrl = $backendUrl;
$this->openDialogUrl = $openDialogUrl;
}

/**
Expand All @@ -39,7 +49,7 @@ public function getConfig(\Magento\Framework\DataObject $config) : \Magento\Fram
$config->addData(
[
'add_images' => true,
'files_browser_window_url' => $this->backendUrl->getUrl('cms/wysiwyg_images/index'),
'files_browser_window_url' => $this->backendUrl->getUrl($this->openDialogUrl->get()),
]
);

Expand Down
3 changes: 1 addition & 2 deletions app/code/Magento/Tinymce3/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
"magento/module-backend": "*",
"magento/module-ui": "*",
"magento/module-variable": "*",
"magento/module-widget": "*",
"magento/module-cms": "*"
"magento/module-widget": "*"

},
"suggest": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,35 +31,43 @@ class Image extends Media
*/
private $fileSize;

/**
* @var OpednDialogUrl
*/
private $openDialogUrl;

/**
* @param ContextInterface $context
* @param StoreManagerInterface $storeManager
* @param Size $fileSize
* @param OpenDialogUrl $openDialogUrl
* @param UiComponentInterface[] $components
* @param array $data
*/
public function __construct(
ContextInterface $context,
StoreManagerInterface $storeManager,
Size $fileSize,
OpenDialogUrl $openDialogUrl,
array $components = [],
array $data = []
) {
$this->storeManager = $storeManager;
$this->fileSize = $fileSize;
$this->openDialogUrl = $openDialogUrl;
parent::__construct($context, $components, $data);
}

/**
* {@inheritdoc}
* @inheritdoc
*/
public function getComponentName()
{
return static::NAME;
}

/**
* {@inheritdoc}
* @inheritdoc
*/
public function prepare()
{
Expand All @@ -75,7 +83,10 @@ public function prepare()
'config' => [
'maxFileSize' => $maxFileSize,
'mediaGallery' => [
'openDialogUrl' => $this->getContext()->getUrl('cms/wysiwyg_images/index', ['_secure' => true]),
'openDialogUrl' => $this->getContext()->getUrl(
$this->openDialogUrl->get(),
['_secure' => true]
),
'openDialogTitle' => $this->getConfiguration()['openDialogTitle'] ?? __('Insert Images...'),
'initialOpenSubpath' => $this->getConfiguration()['initialMediaGalleryOpenSubpath'],
'storeId' => $this->storeManager->getStore()->getId(),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\Ui\Component\Form\Element\DataType\Media;

use Magento\Framework\DataObject;

/**
* Basic configuration for OdenDialogUrl
*/
class OpenDialogUrl
{
private const DEFAULT_OPEN_DIALOG_URL = 'cms/wysiwyg_images/index';

/**
* @var string
*/
private $openDialogUrl;

/**
* @param DataObject $url
*/
public function __construct(DataObject $url = null)
{
$this->openDialogUrl = $url;
}

/**
* Returns open dialog url for media browser
*
* @return string
*/
public function get(): string
{
if ($this->openDialogUrl) {
return $this->openDialogUrl->getUrl();
}
return self::DEFAULT_OPEN_DIALOG_URL;
}
}
3 changes: 1 addition & 2 deletions app/code/Magento/Ui/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
"magento/module-backend": "*",
"magento/module-eav": "*",
"magento/module-store": "*",
"magento/module-user": "*",
"magento/module-cms": "*"
"magento/module-user": "*"
},
"suggest": {
"magento/module-config": "*"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,15 @@ define([
openDialogUrl += '&current_tree_path=' + Base64.mageEncode(this.mediaGallery.initialOpenSubpath);
}

browser.openDialog(openDialogUrl, null, null, this.mediaGallery.openDialogTitle);
browser.openDialog(
openDialogUrl,
null,
null,
this.mediaGallery.openDialogTitle,
{
targetElementId: $buttonEl.attr('id')
}
);
},

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,10 @@ define([
'?isAjax=true&current_tree_path=d3lzaXd5Zw,,',
null,
null,
'Hello world'
'Hello world',
{
targetElementId: 'theTargetId'
}
);
});
});
Expand Down
5 changes: 3 additions & 2 deletions dev/tests/js/jasmine/tests/lib/mage/browser.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ define([
*/
done: function () {
obj.targetElementId = 1;
obj.modalLoaded = true;
}
};
});
Expand All @@ -58,8 +59,8 @@ define([
}
};
});
obj.openDialog('instance/url', 100, 100, 'title', undefined);
obj.openDialog('instance/url', 100, 100, 'title', undefined);
obj.openDialog('instance/url/target_element_id/YDW2424/', 100, 100, 'title', undefined);
obj.openDialog('instance/target_element_id/Y45GDRg/', 100, 100, 'title', undefined);
expect($.ajax.calls.count()).toBe(1);
});
});
Expand Down
26 changes: 15 additions & 11 deletions lib/internal/Magento/Framework/Data/Form/Element/Editor.php
Original file line number Diff line number Diff line change
Expand Up @@ -286,15 +286,19 @@ protected function _getPluginButtonsHtml($visible = true)

// Button to media images insertion window
if ($this->getConfig('add_images')) {
$htmlId = $this->getHtmlId();
$url = $this->getConfig('files_browser_window_url')
. 'target_element_id/'
. $htmlId
. '/'
. (null !== $this->getConfig('store_id')
? 'store/' . $this->getConfig('store_id') . '/"'
: '');
$buttonsHtml .= $this->_getButtonHtml(
[
'title' => $this->translate('Insert Image...'),
'onclick' => "MediabrowserUtility.openDialog('"
. $this->getConfig('files_browser_window_url')
. "target_element_id/" . $this->getHtmlId() . "/"
. (null !== $this->getConfig('store_id') ? 'store/'
. $this->getConfig('store_id') . '/' : '')
. "')",
'onclick' => 'MediabrowserUtility.openDialog(\'' . $url
. '\', null, null, null, { \'targetElementId\': \'' . $htmlId . '\' })',
'class' => 'action-add-image plugin',
'style' => $visible ? '' : 'display:none',
]
Expand Down Expand Up @@ -496,13 +500,13 @@ protected function getInlineJs($jsSetupObject, $forceLoad)
$jsString = '
<script type="text/javascript">
//<![CDATA[
window.tinyMCE_GZ = window.tinyMCE_GZ || {};
window.tinyMCE_GZ = window.tinyMCE_GZ || {};
window.tinyMCE_GZ.loaded = true;
require([
"jquery",
"mage/translate",
"mage/adminhtml/events",
"mage/adminhtml/wysiwyg/tiny_mce/setup",
"jquery",
"mage/translate",
"mage/adminhtml/events",
"mage/adminhtml/wysiwyg/tiny_mce/setup",
"mage/adminhtml/wysiwyg/widget"
], function(jQuery){' .
"\n" .
Expand Down
Loading