|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * Copyright © Magento, Inc. All rights reserved. |
| 4 | + * See COPYING.txt for license details. |
| 5 | + */ |
| 6 | + |
| 7 | +declare(strict_types=1); |
| 8 | + |
| 9 | +namespace Magento\Catalog\Model\Attribute\Backend; |
| 10 | + |
| 11 | +use Magento\Eav\Model\Entity\Attribute\Backend\AbstractBackend; |
| 12 | +use Magento\Framework\Exception\LocalizedException; |
| 13 | +use Magento\Catalog\Model\AbstractModel; |
| 14 | + |
| 15 | +/** |
| 16 | + * Custom layout file attribute. |
| 17 | + */ |
| 18 | +abstract class AbstractLayoutUpdate extends AbstractBackend |
| 19 | +{ |
| 20 | + public const VALUE_USE_UPDATE_XML = '__existing__'; |
| 21 | + |
| 22 | + public const VALUE_NO_UPDATE = '__no_update__'; |
| 23 | + |
| 24 | + /** |
| 25 | + * Extract attribute value. |
| 26 | + * |
| 27 | + * @param AbstractModel $model |
| 28 | + * @return mixed |
| 29 | + */ |
| 30 | + private function extractAttributeValue(AbstractModel $model) |
| 31 | + { |
| 32 | + $code = $this->getAttribute()->getAttributeCode(); |
| 33 | + |
| 34 | + return $model->getData($code); |
| 35 | + } |
| 36 | + |
| 37 | + /** |
| 38 | + * Compose list of available files (layout handles) for given entity. |
| 39 | + * |
| 40 | + * @param AbstractModel $forModel |
| 41 | + * @return string[] |
| 42 | + */ |
| 43 | + abstract protected function listAvailableValues(AbstractModel $forModel): array; |
| 44 | + |
| 45 | + /** |
| 46 | + * Extracts prepare attribute value to be saved. |
| 47 | + * |
| 48 | + * @throws LocalizedException |
| 49 | + * @param AbstractModel $model |
| 50 | + * @return string|null |
| 51 | + */ |
| 52 | + private function prepareValue(AbstractModel $model): ?string |
| 53 | + { |
| 54 | + $value = $this->extractAttributeValue($model); |
| 55 | + if (!is_string($value)) { |
| 56 | + $value = null; |
| 57 | + } |
| 58 | + if ($value |
| 59 | + && $value !== self::VALUE_USE_UPDATE_XML |
| 60 | + && $value !== self::VALUE_NO_UPDATE |
| 61 | + && !in_array($value, $this->listAvailableValues($model), true) |
| 62 | + ) { |
| 63 | + throw new LocalizedException(__('Selected layout update is not available')); |
| 64 | + } |
| 65 | + |
| 66 | + return $value; |
| 67 | + } |
| 68 | + |
| 69 | + /** |
| 70 | + * Set value for the object. |
| 71 | + * |
| 72 | + * @param string|null $value |
| 73 | + * @param AbstractModel $forObject |
| 74 | + * @param string|null $attrCode |
| 75 | + * @return void |
| 76 | + */ |
| 77 | + private function setAttributeValue(?string $value, AbstractModel $forObject, ?string $attrCode = null): void |
| 78 | + { |
| 79 | + $attrCode = $attrCode ?? $this->getAttribute()->getAttributeCode(); |
| 80 | + if ($forObject->hasData(AbstractModel::CUSTOM_ATTRIBUTES)) { |
| 81 | + $forObject->setCustomAttribute($attrCode, $value); |
| 82 | + } |
| 83 | + $forObject->setData($attrCode, $value); |
| 84 | + } |
| 85 | + |
| 86 | + /** |
| 87 | + * @inheritDoc |
| 88 | + * |
| 89 | + * @param AbstractModel $object |
| 90 | + */ |
| 91 | + public function validate($object) |
| 92 | + { |
| 93 | + $valid = parent::validate($object); |
| 94 | + if ($valid) { |
| 95 | + $this->prepareValue($object); |
| 96 | + } |
| 97 | + |
| 98 | + return $valid; |
| 99 | + } |
| 100 | + |
| 101 | + /** |
| 102 | + * @inheritDoc |
| 103 | + * @param AbstractModel $object |
| 104 | + * @throws LocalizedException |
| 105 | + */ |
| 106 | + public function beforeSave($object) |
| 107 | + { |
| 108 | + $value = $this->prepareValue($object); |
| 109 | + if ($value && ($value === self::VALUE_NO_UPDATE || $value !== self::VALUE_USE_UPDATE_XML)) { |
| 110 | + $this->setAttributeValue(null, $object, 'custom_layout_update'); |
| 111 | + } |
| 112 | + if (!$value || $value === self::VALUE_USE_UPDATE_XML || $value === self::VALUE_NO_UPDATE) { |
| 113 | + $value = null; |
| 114 | + } |
| 115 | + $this->setAttributeValue($value, $object); |
| 116 | + |
| 117 | + return $this; |
| 118 | + } |
| 119 | +} |
0 commit comments