Wysiwyg Class Reference

Inheritance diagram for Wysiwyg:

Public Member Functions
	__construct (\Magento\Framework\Data\Form\Element\Factory $factoryElement, \Magento\Framework\Data\Form\Element\CollectionFactory $factoryCollection, \Magento\Framework\Escaper $escaper, \Magento\Cms\Model\Wysiwyg\Config $wysiwygConfig, \Magento\Framework\View\LayoutInterface $layout, \Magento\Framework\Module\Manager $moduleManager, \Magento\Backend\Helper\Data $backendData, array $data=[])
	getAfterElementHtml ()
	getIsWysiwygEnabled ()
Public Member Functions inherited from Textarea
	__construct (Factory $factoryElement, CollectionFactory $factoryCollection, Escaper $escaper, $data=[])
	getHtmlAttributes ()
	getElementHtml ()
Public Member Functions inherited from AbstractElement
	__construct (Factory $factoryElement, CollectionFactory $factoryCollection, Escaper $escaper, $data=[])
	addElement (AbstractElement $element, $after=false)
	isAdvanced ()
	setAdvanced ($advanced)
	getId ()
	getType ()
	getForm ()
	setId ($id)
	getHtmlId ()
	getName ()
	setType ($type)
	setForm ($form)
	removeField ($elementId)
	getHtmlAttributes ()
	addClass ($class)
	removeClass ($class)
	getEscapedValue ($index=null)
	setRenderer (RendererInterface $renderer)
	getRenderer ()
	getElementHtml ()
	getBeforeElementHtml ()
	getAfterElementHtml ()
	getAfterElementJs ()
	getLabelHtml ($idSuffix='', $scopeLabel='')
	getDefaultHtml ()
	getHtml ()
	toHtml ()
	serialize ($attributes=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	getReadonly ()
	getHtmlContainerId ()
	addElementValues ($values, $overwrite=false)
	lock ()
	isLocked ()
Public Member Functions inherited from AbstractForm
	__construct (Factory $factoryElement, CollectionFactory $factoryCollection, $data=[])
	addType ($type, $className)
	getElements ()
	setReadonly ($readonly, $useDisabled=false)
	addElement (AbstractElement $element, $after=null)
	addField ($elementId, $type, $config, $after=false)
	removeField ($elementId)
	addFieldset ($elementId, $config, $after=false, $isAdvanced=false)
	addColumn ($elementId, $config)
	convertToArray (array $arrAttributes=[])
	addCustomAttribute ($key, $value)
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Protected Attributes
	$_backendData = null
	$_moduleManager = null
	$_wysiwygConfig
	$_layout
Protected Attributes inherited from AbstractElement
	$_id
	$_type
	$_form
	$_elements
	$_renderer
	$_advanced = false
	$_escaper
Protected Attributes inherited from AbstractForm
	$_elements
	$_types = []
	$_factoryElement
	$_factoryCollection
	$customAttributes = []
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Data Fields inherited from Textarea
const	DEFAULT_ROWS = 2
const	DEFAULT_COLS = 15
Protected Member Functions inherited from AbstractElement
	_escape ($string)
	_getUiId ($suffix=null)
Protected Member Functions inherited from AbstractForm
	_construct ()
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Definition at line 14 of file Wysiwyg.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Data\Form\Element\Factory	$factoryElement,
		\Magento\Framework\Data\Form\Element\CollectionFactory	$factoryCollection,
		\Magento\Framework\Escaper	$escaper,
		\Magento\Cms\Model\Wysiwyg\Config	$wysiwygConfig,
		\Magento\Framework\View\LayoutInterface	$layout,
		\Magento\Framework\Module\Manager	$moduleManager,
		\Magento\Backend\Helper\Data	$backendData,
		array	$data = []
	)

Parameters

\Magento\Framework\Data\Form\Element\Factory	$factoryElement
\Magento\Framework\Data\Form\Element\CollectionFactory	$factoryCollection
\Magento\Framework\Escaper	$escaper
\Magento\Cms\Model\Wysiwyg\Config	$wysiwygConfig
\Magento\Framework\View\LayoutInterface	$layout
\Magento\Framework\Module\Manager	$moduleManager
\Magento\Backend\Helper\Data	$backendData
array	$data

Definition at line 50 of file Wysiwyg.php.

      {
        $this->_wysiwygConfig = $wysiwygConfig;
        $this->_layout = $layout;
        $this->_moduleManager = $moduleManager;
        $this->_backendData = $backendData;
        parent::__construct($factoryElement, $factoryCollection, $escaper, $data);
    }

Member Function Documentation

getAfterElementHtml()

getAfterElementHtml

(

)

Retrieve additional html and put it at the end of element html

Returns

string

Definition at line 72 of file Wysiwyg.php.

    {
        $config = $this->_wysiwygConfig->getConfig();
        $config = json_encode($config->getData());

        $html = parent::getAfterElementHtml();
        if ($this->getIsWysiwygEnabled()) {
            $disabled = $this->getDisabled() || $this->getReadonly();
            $html .= $this->_layout->createBlock(
                \Magento\Backend\Block\Widget\Button::class,
                '',
                [
                    'data' => [
                        'label' => __('WYSIWYG Editor'),
                        'type' => 'button',
                        'disabled' => $disabled,
                        'class' => 'action-wysiwyg',
                        'onclick' => 'catalogWysiwygEditor.open(\'' . $this->_backendData->getUrl(
                            'catalog/product/wysiwyg'
                        ) . '\', \'' . $this->getHtmlId() . '\')',
                    ]
                ]
            )->toHtml();
            $html .= <<<HTML
<script>
require([
    'jquery',
    'mage/adminhtml/wysiwyg/tiny_mce/setup'
], function(jQuery){

var config = $config,
    editor;

editor = new wysiwygSetup(
    '{$this->getHtmlId()}',
    config
);

editor.turnOn();

jQuery('#{$this->getHtmlId()}')
    .addClass('wysiwyg-editor')
    .data(
        'wysiwygEditor',
        editor
    );
});
</script>
HTML;
        }
        return $html;
    }

getIsWysiwygEnabled()

getIsWysiwygEnabled

(

)

Check whether wysiwyg enabled or not

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 131 of file Wysiwyg.php.

    {
        if ($this->_moduleManager->isEnabled('Magento_Cms')) {
            return (bool)($this->_wysiwygConfig->isEnabled() && $this->getEntityAttribute()->getIsWysiwygEnabled());
        }

        return false;
    }

Field Documentation

$_backendData

$_backendData = null

protected

Definition at line 21 of file Wysiwyg.php.

$_layout

$_layout

protected

Definition at line 38 of file Wysiwyg.php.

$_moduleManager

$_moduleManager = null

protected

Definition at line 28 of file Wysiwyg.php.

$_wysiwygConfig

$_wysiwygConfig

protected

Definition at line 33 of file Wysiwyg.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-catalog/Block/Adminhtml/Helper/Form/Wysiwyg.php