/vendor/magento/module-cms/Model/Wysiwyg/Config.php
PHP | 240 lines | 113 code | 27 blank | 100 comment | 5 complexity | b2b74fe5cede0d8314ad4e03a13908e8 MD5 | raw file
- <?php
- /**
- * Copyright © 2016 Magento. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Cms\Model\Wysiwyg;
- /**
- * Wysiwyg Config for Editor HTML Element
- */
- class Config extends \Magento\Framework\DataObject
- {
- /**
- * Wysiwyg status enabled
- */
- const WYSIWYG_ENABLED = 'enabled';
- /**
- * Wysiwyg status configuration path
- */
- const WYSIWYG_STATUS_CONFIG_PATH = 'cms/wysiwyg/enabled';
- /**
- *
- */
- const WYSIWYG_SKIN_IMAGE_PLACEHOLDER_ID = 'Magento_Cms::images/wysiwyg_skin_image.png';
- /**
- * Wysiwyg status hidden
- */
- const WYSIWYG_HIDDEN = 'hidden';
- /**
- * Wysiwyg status disabled
- */
- const WYSIWYG_DISABLED = 'disabled';
- /**
- * Wysiwyg image directory
- */
- const IMAGE_DIRECTORY = 'wysiwyg';
- /**
- * @var \Magento\Framework\AuthorizationInterface
- */
- protected $_authorization;
- /**
- * @var \Magento\Framework\View\Asset\Repository
- */
- protected $_assetRepo;
- /**
- * @var \Magento\Variable\Model\Variable\Config
- */
- protected $_variableConfig;
- /**
- * @var \Magento\Widget\Model\Widget\Config
- */
- protected $_widgetConfig;
- /**
- * Core event manager proxy
- *
- * @var \Magento\Framework\Event\ManagerInterface
- */
- protected $_eventManager;
- /**
- * Core store config
- *
- * @var \Magento\Framework\App\Config\ScopeConfigInterface
- */
- protected $_scopeConfig;
- /**
- * @var array
- */
- protected $_windowSize;
- /**
- * @var \Magento\Backend\Model\UrlInterface
- */
- protected $_backendUrl;
- /**
- * @var \Magento\Store\Model\StoreManagerInterface
- */
- protected $_storeManager;
- /**
- * @param \Magento\Backend\Model\UrlInterface $backendUrl
- * @param \Magento\Framework\Event\ManagerInterface $eventManager
- * @param \Magento\Framework\AuthorizationInterface $authorization
- * @param \Magento\Framework\View\Asset\Repository $assetRepo
- * @param \Magento\Variable\Model\Variable\Config $variableConfig
- * @param \Magento\Widget\Model\Widget\Config $widgetConfig
- * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
- * @param \Magento\Store\Model\StoreManagerInterface $storeManager
- * @param array $windowSize
- * @param array $data
- * @SuppressWarnings(PHPMD.ExcessiveParameterList)
- */
- public function __construct(
- \Magento\Backend\Model\UrlInterface $backendUrl,
- \Magento\Framework\Event\ManagerInterface $eventManager,
- \Magento\Framework\AuthorizationInterface $authorization,
- \Magento\Framework\View\Asset\Repository $assetRepo,
- \Magento\Variable\Model\Variable\Config $variableConfig,
- \Magento\Widget\Model\Widget\Config $widgetConfig,
- \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
- \Magento\Store\Model\StoreManagerInterface $storeManager,
- array $windowSize = [],
- array $data = []
- ) {
- $this->_backendUrl = $backendUrl;
- $this->_eventManager = $eventManager;
- $this->_scopeConfig = $scopeConfig;
- $this->_authorization = $authorization;
- $this->_assetRepo = $assetRepo;
- $this->_variableConfig = $variableConfig;
- $this->_widgetConfig = $widgetConfig;
- $this->_windowSize = $windowSize;
- $this->_storeManager = $storeManager;
- parent::__construct($data);
- }
- /**
- * Return Wysiwyg config as \Magento\Framework\DataObject
- *
- * Config options description:
- *
- * enabled: Enabled Visual Editor or not
- * hidden: Show Visual Editor on page load or not
- * use_container: Wrap Editor contents into div or not
- * no_display: Hide Editor container or not (related to use_container)
- * translator: Helper to translate phrases in lib
- * files_browser_*: Files Browser (media, images) settings
- * encode_directives: Encode template directives with JS or not
- *
- * @param array|\Magento\Framework\DataObject $data Object constructor params to override default config values
- * @return \Magento\Framework\DataObject
- */
- public function getConfig($data = [])
- {
- $config = new \Magento\Framework\DataObject();
- $config->setData(
- [
- 'enabled' => $this->isEnabled(),
- 'hidden' => $this->isHidden(),
- 'use_container' => false,
- 'add_variables' => true,
- 'add_widgets' => true,
- 'no_display' => false,
- 'encode_directives' => true,
- 'directives_url' => $this->_backendUrl->getUrl('cms/wysiwyg/directive'),
- 'popup_css' => $this->_assetRepo->getUrl(
- 'mage/adminhtml/wysiwyg/tiny_mce/themes/advanced/skins/default/dialog.css'
- ),
- 'content_css' => $this->_assetRepo->getUrl(
- 'mage/adminhtml/wysiwyg/tiny_mce/themes/advanced/skins/default/content.css'
- ),
- 'width' => '100%',
- 'plugins' => [],
- ]
- );
- $config->setData('directives_url_quoted', preg_quote($config->getData('directives_url')));
- if ($this->_authorization->isAllowed('Magento_Cms::media_gallery')) {
- $config->addData(
- [
- 'add_images' => true,
- 'files_browser_window_url' => $this->_backendUrl->getUrl('cms/wysiwyg_images/index'),
- 'files_browser_window_width' => $this->_windowSize['width'],
- 'files_browser_window_height' => $this->_windowSize['height'],
- ]
- );
- }
- if (is_array($data)) {
- $config->addData($data);
- }
- if ($config->getData('add_variables')) {
- $settings = $this->_variableConfig->getWysiwygPluginSettings($config);
- $config->addData($settings);
- }
- if ($config->getData('add_widgets')) {
- $settings = $this->_widgetConfig->getPluginSettings($config);
- $config->addData($settings);
- }
- return $config;
- }
- /**
- * Return path for skin images placeholder
- *
- * @return string
- */
- public function getSkinImagePlaceholderPath()
- {
- $staticPath = $this->_storeManager->getStore()->getBaseStaticDir();
- $placeholderPath = $this->_assetRepo->createAsset(self::WYSIWYG_SKIN_IMAGE_PLACEHOLDER_ID)->getPath();
- return $staticPath . '/' . $placeholderPath;
- }
- /**
- * Check whether Wysiwyg is enabled or not
- *
- * @return bool
- */
- public function isEnabled()
- {
- $wysiwygState = $this->_scopeConfig->getValue(
- self::WYSIWYG_STATUS_CONFIG_PATH,
- \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
- $this->getStoreId()
- );
- return in_array($wysiwygState, [self::WYSIWYG_ENABLED, self::WYSIWYG_HIDDEN]);
- }
- /**
- * Check whether Wysiwyg is loaded on demand or not
- *
- * @return bool
- */
- public function isHidden()
- {
- $status = $this->_scopeConfig->getValue(
- self::WYSIWYG_STATUS_CONFIG_PATH,
- \Magento\Store\Model\ScopeInterface::SCOPE_STORE
- );
- return $status == self::WYSIWYG_HIDDEN;
- }
- }