Inheritance diagram for Form:

Public Member Functions
	__construct (\Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Eav\Model\Config $eavConfig, \Magento\Framework\Module\Dir\Reader $modulesReader, \Magento\Eav\Model\AttributeDataFactory $attrDataFactory, \Magento\Framework\Validator\UniversalFactory $universalFactory, RequestInterface $httpRequest, \Magento\Framework\Validator\ConfigFactory $validatorConfigFactory)

	setStore ($store)

	setEntity (\Magento\Framework\Model\AbstractModel $entity)

	setEntityType ($entityType)

	setFormCode ($formCode)

	getStore ()

	getFormCode ()

	getEntityType ()

	getEntity ()

	getAttribute ($attributeCode)

	getUserAttributes ()

	getSystemAttributes ()

	getAllowedAttributes ()

	prepareRequest (array $data)

	validateData (array $data)

	setIsAjaxRequest ($flag=true)

	getIsAjaxRequest ()

	ignoreInvisible ($setValue=null)

Protected Member Functions
	_getFormAttributeCollection ()

	_getFilteredFormAttributeCollection ()

	_getAttributeDataModel (\Magento\Eav\Model\Entity\Attribute $attribute)

	_isAttributeOmitted ($attribute)

Protected Attributes
	$_moduleName = ''

	$_entityTypeCode = ''

	$_store

	$_entityType

	$_entity

	$_formCode

	$_attributes

	$_systemAttributes

	$_userAttributes

	$_allowedAttributes = null

	$_isAjax = false

	$_ignoreInvisible = true

	$_validator = null

	$_storeManager

	$_eavConfig

	$_modulesReader

	$_attrDataFactory

	$_universalFactory

	$_httpRequest

	$_validatorConfigFactory

Detailed Description

EAV Entity Form Model

@api @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 18 of file Form.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Eav\Model\Config	$eavConfig,
		\Magento\Framework\Module\Dir\Reader	$modulesReader,
		\Magento\Eav\Model\AttributeDataFactory	$attrDataFactory,
		\Magento\Framework\Validator\UniversalFactory	$universalFactory,
		RequestInterface	$httpRequest,
		\Magento\Framework\Validator\ConfigFactory	$validatorConfigFactory
	)

Parameters

\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Eav\Model\Config	$eavConfig
\Magento\Framework\Module\Dir\Reader	$modulesReader
\Magento\Eav\Model\AttributeDataFactory	$attrDataFactory
\Magento\Framework\Validator\UniversalFactory	$universalFactory
RequestInterface	$httpRequest
\Magento\Framework\Validator\ConfigFactory	$validatorConfigFactory

Exceptions

Definition at line 155 of file Form.php.

       {
         if (empty($this->_moduleName)) {
             throw new \Magento\Framework\Exception\LocalizedException(__('The current module pathname is undefined.'));
         }
         if (empty($this->_entityTypeCode)) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('The current module EAV entity is undefined.')
             );
         }
         $this->_storeManager = $storeManager;
         $this->_eavConfig = $eavConfig;
         $this->_modulesReader = $modulesReader;
         $this->_attrDataFactory = $attrDataFactory;
         $this->_universalFactory = $universalFactory;
         $this->_httpRequest = $httpRequest;
         $this->_validatorConfigFactory = $validatorConfigFactory;
     }

Member Function Documentation

◆ _getAttributeDataModel()

_getAttributeDataModel ( \Magento\Eav\Model\Entity\Attribute $attribute )

protected

Return attribute data model by attribute

Parameters

\Magento\Eav\Model\Entity\Attribute $attribute

Returns: \Magento\Eav\Model\Attribute\Data\AbstractData

Definition at line 405 of file Form.php.

     {
         $dataModel = $this->_attrDataFactory->create($attribute, $this->getEntity());
         $dataModel->setIsAjaxRequest($this->getIsAjaxRequest());
 
         return $dataModel;
     }

◆ _getFilteredFormAttributeCollection()

_getFilteredFormAttributeCollection ( )

protected

Get EAV Entity Form Attribute Collection with applied filters

Returns: \Magento\Eav\Model\ResourceModel\Form\Attribute\Collection

Definition at line 198 of file Form.php.

     {
         return $this->_getFormAttributeCollection()->setStore(
             $this->getStore()
         )->setEntityType(
             $this->getEntityType()
         )->addFormCodeFilter(
             $this->getFormCode()
         )->setSortOrder();
     }

◆ _getFormAttributeCollection()

_getFormAttributeCollection ( )

protected

Get EAV Entity Form Attribute Collection

Returns: mixed

Definition at line 186 of file Form.php.

     {
         return $this->_universalFactory->create(
             str_replace('_', '\\', $this->_moduleName) . '\\Model\\ResourceModel\\Form\\Attribute\\Collection'
         );
     }

◆ _isAttributeOmitted()

_isAttributeOmitted ( $attribute )

protected

Whether the specified attribute needs to skip rendering/validation

Parameters

\Magento\Eav\Model\Attribute $attribute

Returns: bool

Definition at line 631 of file Form.php.

     {
         if ($this->_ignoreInvisible && !$attribute->getIsVisible()) {
             return true;
         }
         return false;
     }

◆ getAllowedAttributes()

getAllowedAttributes ( )

Get not omitted attributes

Returns: array

Definition at line 390 of file Form.php.

     {
         if ($this->_allowedAttributes === null) {
             // load attributes
             $this->getAttributes();
         }
         return $this->_allowedAttributes;
     }

◆ getAttribute()

getAttribute ( $attributeCode )

Return attribute instance by code or false

Parameters

string $attributeCode

Returns: \Magento\Eav\Model\Entity\Attribute|bool

Definition at line 348 of file Form.php.

     {
         $attributes = $this->getAttributes();
         if (isset($attributes[$attributeCode])) {
             return $attributes[$attributeCode];
         }
         return false;
     }

◆ getEntity()

getEntity ( )

Return current entity instance

Exceptions

Definition at line 308 of file Form.php.

     {
         if ($this->_entity === null) {
             throw new \Magento\Framework\Exception\LocalizedException(__('The entity instance is not defined.'));
         }
         return $this->_entity;
     }

◆ getEntityType()

getEntityType ( )

Return entity type instance Return EAV entity type if entity type is not defined

Returns: \Magento\Eav\Model\Entity\Type

Definition at line 294 of file Form.php.

     {
         if ($this->_entityType === null) {
             $this->setEntityType($this->_entityTypeCode);
         }
         return $this->_entityType;
     }

◆ getFormCode()

getFormCode ( )

Return current form code

Exceptions

Definition at line 280 of file Form.php.

     {
         if (empty($this->_formCode)) {
             throw new \Magento\Framework\Exception\LocalizedException(__('The form code is not defined.'));
         }
         return $this->_formCode;
     }

◆ getIsAjaxRequest()

getIsAjaxRequest ( )

Return is AJAX Request

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 586 of file Form.php.

     {
         return $this->_isAjax;
     }

◆ getStore()

getStore ( )

Return current store instance

Returns: \Magento\Store\Model\Store

Definition at line 266 of file Form.php.

     {
         if ($this->_store === null) {
             $this->_store = $this->_storeManager->getStore();
         }
         return $this->_store;
     }

◆ getSystemAttributes()

getSystemAttributes ( )

Return array of form system attributes

Returns: array

Definition at line 376 of file Form.php.

     {
         if ($this->_systemAttributes === null) {
             // load attributes
             $this->getAttributes();
         }
         return $this->_systemAttributes;
     }

◆ getUserAttributes()

getUserAttributes ( )

Return array of form user defined attributes

Returns: array

Definition at line 362 of file Form.php.

     {
         if ($this->_userAttributes === null) {
             // load attributes
             $this->getAttributes();
         }
         return $this->_userAttributes;
     }

◆ ignoreInvisible()

ignoreInvisible ( $setValue = null )

Combined getter/setter whether to omit invisible attributes during rendering/validation

Parameters

mixed $setValue

Returns: bool|$this

Definition at line 616 of file Form.php.

     {
         if (null !== $setValue) {
             $this->_ignoreInvisible = (bool)$setValue;
             return $this;
         }
         return $this->_ignoreInvisible;
     }

◆ prepareRequest()

prepareRequest ( array $data )

Prepare request with data and returns it

Parameters

array $data

Returns: RequestInterface

Definition at line 419 of file Form.php.

     {
         $request = clone $this->_httpRequest;
         $request->clearParams();
         $request->setParams($data);
         return $request;
     }

◆ setEntity()

setEntity ( \Magento\Framework\Model\AbstractModel $entity )

Set entity instance

Parameters

\Magento\Framework\Model\AbstractModel $entity

Returns: $this

Definition at line 228 of file Form.php.

     {
         $this->_entity = $entity;
         if ($entity->getEntityTypeId()) {
             $this->setEntityType($entity->getEntityTypeId());
         }
         return $this;
     }

◆ setEntityType()

setEntityType ( $entityType )

Set entity type instance

Parameters

\Magento\Eav\Model\Entity\Type | string | int $entityType

Returns: $this

Definition at line 243 of file Form.php.

     {
         $this->_entityType = $this->_eavConfig->getEntityType($entityType);
         return $this;
     }

◆ setFormCode()

setFormCode ( $formCode )

Set form code

Parameters

string $formCode

Returns: $this

Definition at line 255 of file Form.php.

     {
         $this->_formCode = $formCode;
         return $this;
     }

◆ setIsAjaxRequest()

setIsAjaxRequest ( $flag = true )

Set is AJAX Request flag

Parameters

bool $flag

Returns: $this

Definition at line 574 of file Form.php.

     {
         $this->_isAjax = (bool)$flag;
         return $this;
     }

◆ setStore()

setStore ( $store )

Set current store

Parameters

\Magento\Store\Model\Store | string | int $store

Returns: $this @codeCoverageIgnore

Definition at line 216 of file Form.php.

     {
         $this->_store = $this->_storeManager->getStore($store);
         return $this;
     }

◆ validateData()

validateData ( array $data )

Validate data array and return true or array of errors

Parameters

array $data

Returns: bool|array

Definition at line 481 of file Form.php.

     {
         $validator = $this->_getValidator($data);
         if (!$validator->isValid($this->getEntity())) {
             $messages = [];
             foreach ($validator->getMessages() as $errorMessages) {
                 $messages = array_merge($messages, (array)$errorMessages);
             }
             return $messages;
         }
         return true;
     }

Field Documentation

◆ $_allowedAttributes

$_allowedAttributes = null

protected

Definition at line 88 of file Form.php.

◆ $_attrDataFactory

$_attrDataFactory

protected

Definition at line 127 of file Form.php.

◆ $_attributes

$_attributes

protected

Definition at line 67 of file Form.php.

◆ $_eavConfig

$_eavConfig

protected

Definition at line 117 of file Form.php.

◆ $_entity

$_entity

protected

Definition at line 53 of file Form.php.

◆ $_entityType

$_entityType

protected

Definition at line 46 of file Form.php.

◆ $_entityTypeCode

$_entityTypeCode = ''

protected

Definition at line 32 of file Form.php.

◆ $_formCode

$_formCode

protected

Definition at line 60 of file Form.php.

◆ $_httpRequest

$_httpRequest

protected

Definition at line 137 of file Form.php.

◆ $_ignoreInvisible

$_ignoreInvisible = true

protected

Definition at line 102 of file Form.php.

◆ $_isAjax

$_isAjax = false

protected

Definition at line 95 of file Form.php.

◆ $_moduleName

$_moduleName = ''

protected

Definition at line 25 of file Form.php.

◆ $_modulesReader

$_modulesReader

protected

Definition at line 122 of file Form.php.

◆ $_store

$_store

protected

Definition at line 39 of file Form.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 112 of file Form.php.

◆ $_systemAttributes

$_systemAttributes

protected

Definition at line 74 of file Form.php.

◆ $_universalFactory

$_universalFactory

protected

Definition at line 132 of file Form.php.

◆ $_userAttributes

$_userAttributes

protected

Definition at line 81 of file Form.php.

◆ $_validator

$_validator = null

protected

Definition at line 107 of file Form.php.

◆ $_validatorConfigFactory

$_validatorConfigFactory

protected

Definition at line 142 of file Form.php.

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

vendor/magento/module-eav/Model/Form.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getAttributeDataModel()

◆ _getFilteredFormAttributeCollection()

◆ _getFormAttributeCollection()

◆ _isAttributeOmitted()

◆ getAllowedAttributes()

◆ getAttribute()

◆ getEntity()

◆ getEntityType()

◆ getFormCode()

◆ getIsAjaxRequest()

◆ getStore()

◆ getSystemAttributes()

◆ getUserAttributes()

◆ ignoreInvisible()

◆ prepareRequest()

◆ setEntity()

◆ setEntityType()

◆ setFormCode()

◆ setIsAjaxRequest()

◆ setStore()

◆ validateData()

Field Documentation

◆ $_allowedAttributes

◆ $_attrDataFactory

◆ $_attributes

◆ $_eavConfig

◆ $_entity

◆ $_entityType

◆ $_entityTypeCode

◆ $_formCode

◆ $_httpRequest

◆ $_ignoreInvisible

◆ $_isAjax

◆ $_moduleName

◆ $_modulesReader

◆ $_store

◆ $_storeManager

◆ $_systemAttributes

◆ $_universalFactory

◆ $_userAttributes

◆ $_validator

◆ $_validatorConfigFactory