Wysiwyg Class Reference

Inheritance diagram for Wysiwyg:

Public Member Functions
	__construct (ContextInterface $context, FormFactory $formFactory, ConfigInterface $wysiwygConfig, array $components=[], array $data=[], array $config=[])
	getComponentName ()
Public Member Functions inherited from AbstractElement
	getHtmlId ()
	getValue ()
	getFormInputName ()
	isReadonly ()
	getCssClasses ()
Public Member Functions inherited from AbstractComponent
	__construct (ContextInterface $context, array $components=[], array $data=[])
	getContext ()
	getName ()
	prepare ()
	toHtml ()
	render ()
	addComponent ($name, UiComponentInterface $component)
	getComponent ($name)
	getChildComponents ()
	renderChildComponent ($name)
	getTemplate ()
	getConfiguration ()
	getJsConfig (UiComponentInterface $component)
	setData ($key, $value=null)
	getData ($key='', $index=null)
	prepareDataSource (array $dataSource)
	getDataSourceData ()
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)

Data Fields
const	NAME = 'wysiwyg'

Protected Attributes
	$form
	$editor
Protected Attributes inherited from AbstractComponent
	$context
	$components
	$componentData = []
	$dataSources = []
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Protected Member Functions inherited from AbstractComponent
	prepareChildComponent (UiComponentInterface $component)
	initObservers (array & $data=[])
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

WYSIWYG form element

@api

Since

100.1.0

Definition at line 21 of file Wysiwyg.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ContextInterface	$context,
		FormFactory	$formFactory,
		ConfigInterface	$wysiwygConfig,
		array	$components = [],
		array	$data = [],
		array	$config = []
	)

Parameters

ContextInterface	$context
FormFactory	$formFactory
ConfigInterface	$wysiwygConfig
array	$components
array	$data
array	$config

Definition at line 45 of file Wysiwyg.php.

      {
        $wysiwygConfigData = isset($config['wysiwygConfigData']) ? $config['wysiwygConfigData'] : [];
        $this->form = $formFactory->create();
        $wysiwygId = $context->getNamespace() . '_' . $data['name'];
        $this->editor = $this->form->addField(
            $wysiwygId,
            \Magento\Framework\Data\Form\Element\Editor::class,
            [
                'force_load' => true,
                'rows' => isset($config['rows']) ? $config['rows'] : 20,
                'name' => $data['name'],
                'config' => $wysiwygConfig->getConfig($wysiwygConfigData),
                'wysiwyg' => isset($config['wysiwyg']) ? $config['wysiwyg'] : null,
            ]
        );
        $data['config']['content'] = $this->editor->getElementHtml();
        $data['config']['wysiwygId'] = $wysiwygId;

        parent::__construct($context, $components, $data);
    }

Member Function Documentation

getComponentName()

getComponentName

(

)

Get component name

Returns

string

Since

100.1.0

Implements UiComponentInterface.

Definition at line 79 of file Wysiwyg.php.

    {
        return static::NAME;
    }

Field Documentation

$editor

$editor

protected

Definition at line 35 of file Wysiwyg.php.

$form

$form

protected

Definition at line 29 of file Wysiwyg.php.

NAME

const NAME = 'wysiwyg'

Definition at line 23 of file Wysiwyg.php.

---

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

• vendor/magento/module-ui/Component/Form/Element/Wysiwyg.php