Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/framework/Data/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Data;
use Magento\Framework\Data\Form\Element\AbstractElement;
use Magento\Framework\Data\Form\Element\Collection as ElementCollection;
use Magento\Framework\Data\Form\Element\CollectionFactory as ElementCollectionFactory;
use Magento\Framework\Data\Form\Element\Factory;
use Magento\Framework\Data\Form\Element\Renderer\RendererInterface;
use Magento\Framework\Data\Form\FormKey;
use Magento\Framework\Profiler;
/**
* @api
* @since 100.0.2
*/
class Form extends \Magento\Framework\Data\Form\AbstractForm
{
/**
* All form elements collection
*
* @var ElementCollection
*/
protected $_allElements;
/**
* form elements index
*
* @var array
*/
protected $_elementsIndex;
/**
* @var FormKey
*/
protected $formKey;
/**
* @var RendererInterface
*/
protected static $_defaultElementRenderer;
/**
* @var RendererInterface
*/
protected static $_defaultFieldsetRenderer;
/**
* @var RendererInterface
*/
protected static $_defaultFieldsetElementRenderer;
/**
* @param Factory $factoryElement
* @param ElementCollectionFactory $factoryCollection
* @param FormKey $formKey
* @param array $data
*/
public function __construct(
Factory $factoryElement,
ElementCollectionFactory $factoryCollection,
FormKey $formKey,
$data = []
) {
parent::__construct($factoryElement, $factoryCollection, $data);
$this->_allElements = $this->_factoryCollection->create(['container' => $this]);
$this->formKey = $formKey;
}
/**
* Method to set element renderer.
*
* @param RendererInterface|null $renderer
*
* @return void
*/
public static function setElementRenderer(RendererInterface $renderer = null)
{
self::$_defaultElementRenderer = $renderer;
}
/**
* Method to set fieldset renderer.
*
* @param RendererInterface|null $renderer
*
* @return void
*/
public static function setFieldsetRenderer(RendererInterface $renderer = null)
{
self::$_defaultFieldsetRenderer = $renderer;
}
/**
* Method to set fieldset element renderer.
*
* @param RendererInterface|null $renderer
*
* @return void
*/
public static function setFieldsetElementRenderer(RendererInterface $renderer = null)
{
self::$_defaultFieldsetElementRenderer = $renderer;
}
/**
* Method to get element renderer.
*
* @return RendererInterface
*/
public static function getElementRenderer()
{
return self::$_defaultElementRenderer;
}
/**
* Method to get fieldset renderer.
*
* @return RendererInterface
*/
public static function getFieldsetRenderer()
{
return self::$_defaultFieldsetRenderer;
}
/**
* Method to get fieldset element renderer.
*
* @return RendererInterface
*/
public static function getFieldsetElementRenderer()
{
return self::$_defaultFieldsetElementRenderer;
}
/**
* Return allowed HTML form attributes
*
* @return string[]
*/
public function getHtmlAttributes()
{
return ['id', 'name', 'method', 'action', 'enctype', 'class', 'onsubmit', 'target'];
}
/**
* Add form element
*
* @param AbstractElement $element
* @param bool $after
* @return $this
*/
public function addElement(AbstractElement $element, $after = false)
{
$this->checkElementId($element->getId());
parent::addElement($element, $after);
$this->addElementToCollection($element);
return $this;
}
/**
* Check existing element
*
* @param string $elementId
* @return bool
*/
protected function _elementIdExists($elementId)
{
return isset($this->_elementsIndex[$elementId]);
}
/**
* Method to add element to collection.
*
* @param AbstractElement $element
*
* @return $this
*/
public function addElementToCollection($element)
{
$this->_elementsIndex[$element->getId()] = $element;
$this->_allElements->add($element);
return $this;
}
/**
* Method to check element id.
*
* @param string $elementId
*
* @return bool
* @throws \Exception
*/
public function checkElementId($elementId)
{
if ($this->_elementIdExists($elementId)) {
throw new \InvalidArgumentException(
'An element with a "' . $elementId . '" ID already exists.'
);
}
return true;
}
/**
* Method to get form.
*
* @return $this
*/
public function getForm()
{
return $this;
}
/**
* Retrieve form element by id
*
* @param string $elementId
* @return null|AbstractElement
*/
public function getElement($elementId)
{
if ($this->_elementIdExists($elementId)) {
return $this->_elementsIndex[$elementId];
}
return null;
}
/**
* Method to set values.
*
* @param array $values
*
* @return $this
*/
public function setValues($values)
{
foreach ($this->_allElements as $element) {
if (isset($values[$element->getId()])) {
$element->setValue($values[$element->getId()]);
} else {
$element->setValue(null);
}
}
return $this;
}
/**
* Method to add values.
*
* @param array $values
*
* @return $this
*/
public function addValues($values)
{
if (!is_array($values)) {
return $this;
}
foreach ($values as $elementId => $value) {
$element = $this->getElement($elementId);
if ($element) {
$element->setValue($value);
}
}
return $this;
}
/**
* Add suffix to name of all elements
*
* @param string $suffix
* @return $this
*/
public function addFieldNameSuffix($suffix)
{
foreach ($this->_allElements as $element) {
$name = $element->getName();
if ($name) {
$element->setName($this->addSuffixToName($name, $suffix));
}
}
return $this;
}
/**
* Method to add suffix to name.
*
* @param string $name
* @param string $suffix
*
* @return string
*/
public function addSuffixToName($name, $suffix)
{
if (!$name) {
return $suffix;
}
$vars = explode('[', $name);
$newName = $suffix;
foreach ($vars as $index => $value) {
$newName .= '[' . $value;
if ($index == 0) {
$newName .= ']';
}
}
return $newName;
}
/**
* Method to remove field.
*
* @param string $elementId
*
* @return $this
*/
public function removeField($elementId)
{
if ($this->_elementIdExists($elementId)) {
unset($this->_elementsIndex[$elementId]);
}
return $this;
}
/**
* Method to set field container id prefix.
*
* @param string $prefix
*
* @return $this
*/
public function setFieldContainerIdPrefix($prefix)
{
$this->setData('field_container_id_prefix', $prefix);
return $this;
}
/**
* Method to get field container id prefix.
*
* @return string
*/
public function getFieldContainerIdPrefix()
{
return $this->getData('field_container_id_prefix');
}
/**
* Method to html.
*
* @return string
*/
public function toHtml()
{
Profiler::start('form/toHtml');
$html = '';
$useContainer = $this->getUseContainer();
if ($useContainer) {
$html .= '<form ' . $this->serialize($this->getHtmlAttributes()) . '>';
$html .= '<div>';
$method = is_string($this->getData('method')) ? strtolower($this->getData('method')) : '';
if ($method == 'post') {
$html .= '<input name="form_key" type="hidden" value="' . $this->formKey->getFormKey() . '" />';
}
$html .= '</div>';
}
foreach ($this->getElements() as $element) {
$html .= $element->toHtml();
}
if ($useContainer) {
$html .= '</form>';
}
Profiler::stop('form/toHtml');
return $html;
}
/**
* Method to get Html.
*
* @return string
*/
public function getHtml()
{
return $this->toHtml();
}
}