ValueProvider Class Reference

Public Member Functions
	__construct (Store $store, GroupRepositoryInterface $groupRepository, SearchCriteriaBuilder $searchCriteriaBuilder, DataObject $objectConverter, \Magento\SalesRule\Model\RuleFactory $salesRuleFactory)
	getMetadataValues (\Magento\SalesRule\Model\Rule $rule)

Protected Attributes
	$store
	$groupRepository
	$searchCriteriaBuilder
	$objectConverter
	$salesRuleFactory

Detailed Description

Metadata provider for sales rule edit form.

Definition at line 18 of file ValueProvider.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Store	$store,
		GroupRepositoryInterface	$groupRepository,
		SearchCriteriaBuilder	$searchCriteriaBuilder,
		DataObject	$objectConverter,
		\Magento\SalesRule\Model\RuleFactory	$salesRuleFactory
	)

Initialize dependencies.

Parameters

Store	$store
GroupRepositoryInterface	$groupRepository
SearchCriteriaBuilder	$searchCriteriaBuilder
DataObject	$objectConverter
\Magento\SalesRule\Model\RuleFactory	$salesRuleFactory

Definition at line 54 of file ValueProvider.php.

      {
        $this->store = $store;
        $this->groupRepository = $groupRepository;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
        $this->objectConverter = $objectConverter;
        $this->salesRuleFactory = $salesRuleFactory;
    }

Member Function Documentation

getMetadataValues()

getMetadataValues

(

\Magento\SalesRule\Model\Rule

$rule

)

Get metadata for sales rule form. It will be merged with form UI component declaration.

Parameters

Rule

$rule

Returns

array @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Definition at line 75 of file ValueProvider.php.

    {
        $customerGroups = $this->groupRepository->getList($this->searchCriteriaBuilder->create())->getItems();
        $applyOptions = [
            ['label' => __('Percent of product price discount'), 'value' =>  Rule::BY_PERCENT_ACTION],
            ['label' => __('Fixed amount discount'), 'value' => Rule::BY_FIXED_ACTION],
            ['label' => __('Fixed amount discount for whole cart'), 'value' => Rule::CART_FIXED_ACTION],
            ['label' => __('Buy X get Y free (discount amount is Y)'), 'value' => Rule::BUY_X_GET_Y_ACTION]
        ];

        $couponTypesOptions = [];
        $couponTypes = $this->salesRuleFactory->create()->getCouponTypes();
        foreach ($couponTypes as $key => $couponType) {
            $couponTypesOptions[] = [
                'label' => $couponType,
                'value' => $key,
            ];
        }

        $labels = $rule->getStoreLabels();

        return [
            'rule_information' => [
                'children' => [
                    'website_ids' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'options' => $this->store->getWebsiteValuesForForm(),
                                ],
                            ],
                        ],
                    ],
                    'is_active' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'options' => [
                                        ['label' => __('Active'), 'value' => '1'],
                                        ['label' => __('Inactive'), 'value' => '0']
                                    ],
                                ],
                            ],
                        ],
                    ],
                    'customer_group_ids' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'options' => $this->objectConverter->toOptionArray($customerGroups, 'id', 'code'),
                                ],
                            ],
                        ],
                    ],
                    'coupon_type' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'options' => $couponTypesOptions,
                                ],
                            ],
                        ],
                    ],
                    'is_rss' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'options' => [
                                        ['label' => __('Yes'), 'value' => '1'],
                                        ['label' => __('No'), 'value' => '0']
                                    ],
                                ],
                            ],
                        ],
                    ],
                ]
            ],
            'actions' => [
                'children' => [
                    'simple_action' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'options' => $applyOptions
                                ],
                            ]
                        ]
                    ],
                    'discount_amount' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'value' => '0',
                                ],
                            ],
                        ],
                    ],
                    'discount_qty' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'value' => '0',
                                ],
                            ],
                        ],
                    ],
                    'apply_to_shipping' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'options' => [
                                        ['label' => __('Yes'), 'value' => '1'],
                                        ['label' => __('No'), 'value' => '0']
                                    ]
                                ],
                            ],
                        ],
                    ],
                    'stop_rules_processing' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'options' => [
                                        ['label' => __('Yes'), 'value' => '1'],
                                        ['label' => __('No'), 'value' => '0'],
                                    ],
                                ],
                            ]
                        ]
                    ],
                ]
            ],
            'labels' => [
                'children' => [
                    'store_labels[0]' => [
                        'arguments' => [
                            'data' => [
                                'config' => [
                                    'value' => isset($labels[0]) ? $labels[0] : '',
                                ],
                            ]
                        ]
                    ]
                ]
            ],
        ];
    }

Field Documentation

$groupRepository

$groupRepository

protected

Definition at line 28 of file ValueProvider.php.

$objectConverter

$objectConverter

protected

Definition at line 38 of file ValueProvider.php.

$salesRuleFactory

$salesRuleFactory

protected

Definition at line 43 of file ValueProvider.php.

$searchCriteriaBuilder

$searchCriteriaBuilder

protected

Definition at line 33 of file ValueProvider.php.

$store

$store

protected

Definition at line 23 of file ValueProvider.php.

---

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

• vendor/magento/module-sales-rule/Model/Rule/Metadata/ValueProvider.php