support for asset's native alt field

Author: i-just

src/base/Field.php

@@ -143,16 +143,47 @@ public function fetchValue(): mixed
     // =========================================================================
 
     /**
-     * @param $elementIds
-     * @param null $nodeKey
+     * Save native field data on the elements.
+     *
+     * @param array $elementIds
+     * @param string|null $nodeKey
+     * @return void
+     * @throws Throwable
+     * @throws ElementNotFoundException
+     * @throws Exception
+     */
+    protected function populateNativeFields(array $elementIds, string $nodeKey = null): void
+    {
+        $this->populateFields($elementIds, $nodeKey, 'native');
+    }
+
+    /**
+     * @param array $elementIds
+     * @param string|null $nodeKey
+     * @return void
      * @throws Throwable
      * @throws ElementNotFoundException
      * @throws Exception
      */
-    protected function populateElementFields($elementIds, $nodeKey = null): void
+    protected function populateElementFields(array $elementIds, string $nodeKey = null): void
+    {
+        $this->populateFields($elementIds, $nodeKey);
+    }
+
+    /**
+     * @param array $elementIds Array of elementIds to populate.
+     * @param string|null $nodeKey
+     * @param string $fieldType Type of field to populate, can be `custom` or `native`.
+     * @return void
+     * @throws Throwable
+     * @throws ElementNotFoundException
+     * @throws Exception
+     */
+    private function populateFields(array $elementIds, string $nodeKey = null, string $fieldType = 'custom'): void
     {
         $elementsService = Craft::$app->getElements();
-        $fields = Hash::get($this->fieldInfo, 'fields');
+        $fieldTypeKey = $fieldType === 'custom' ? 'fields' : 'nativeFields';
+        $fields = Hash::get($this->fieldInfo, $fieldTypeKey);
 
         $fieldData = [];
 
@@ -180,7 +211,11 @@ protected function populateElementFields($elementIds, $nodeKey = null): void
         foreach ($fieldData as $elementId => $fieldContent) {
             $element = $elementsService->getElementById($elementId, null, Hash::get($this->feed, 'siteId'));
 
-            $element->setFieldValues($fieldContent);
+            if ($fieldType === 'native') {
+                $element->setAttributes($fieldContent);
+            } else {
+                $element->setFieldValues($fieldContent);
+            }
 
             Plugin::debug([
                 $this->fieldHandle => [

src/fields/Assets.php

@@ -87,6 +87,7 @@ public function parseField(): mixed
         $upload = Hash::get($this->fieldInfo, 'options.upload');
         $conflict = Hash::get($this->fieldInfo, 'options.conflict');
         $fields = Hash::get($this->fieldInfo, 'fields');
+        $nativeFields = Hash::get($this->fieldInfo, 'nativeFields');
         $node = Hash::get($this->fieldInfo, 'node');
         $nodeKey = null;
 
@@ -252,6 +253,10 @@ public function parseField(): mixed
             $this->populateElementFields($foundElements, $nodeKey);
         }
 
+        if ($nativeFields) {
+            $this->populateNativeFields($foundElements, $nodeKey);
+        }
+
         $foundElements = array_unique($foundElements);
 
         // Protect against sending an empty array - removing any existing elements

src/templates/_includes/elements/assets/map.html

@@ -86,14 +86,26 @@ <h2>{{ tab.name }} Fields</h2>
                 <th>{{ 'Default Value'|t('feed-me') }}</th>
             </thead>
             <tbody>
-                {% for layoutField in tab.getElements()|filter(e => e is instance of('craft\\fieldlayoutelements\\CustomField')) %}
-                    {% set field = layoutField.getField() %}
-                    {% set fieldClass = craft.feedme.fields.getRegisteredField(className(field)) %}
-                    {% set template = fieldClass.getMappingTemplate() %}
-
-                    {% set variables = { name: field.name, handle: field.handle, feed: feed, feedData: feedData, field: field, fieldClass: fieldClass } %}
-
-                    {% include template ignore missing with variables only %}
+                {% for layoutField in tab.getElements()|filter(e => e is instance of('craft\\fieldlayoutelements\\CustomField') or e is instance of('craft\\fieldlayoutelements\\assets\\AltField')) %}
+                    {% if layoutField is instance of('craft\\fieldlayoutelements\\assets\\AltField') %}
+                        {% set variables = {
+                            name: 'Alternative Text'|t('feed-me'),
+                            handle: 'alt',
+                            feed: feed,
+                            feedData: feedData,
+                            attribute: true,
+                        } %}
+
+                        {% include 'feed-me/_includes/fields/default' ignore missing with variables only %}
+                    {% else %}
+                        {% set field = layoutField.getField() %}
+                        {% set fieldClass = craft.feedme.fields.getRegisteredField(className(field)) %}
+                        {% set template = fieldClass.getMappingTemplate() %}
+
+                        {% set variables = { name: field.name, handle: field.handle, feed: feed, feedData: feedData, field: field, fieldClass: fieldClass } %}
+
+                        {% include template ignore missing with variables only %}
+                    {% endif %}
                 {% endfor %}
             </tbody>
         </table>

src/templates/_includes/fields/_base.html

@@ -199,18 +199,25 @@
         {% for elementField in elementFields %}
             {% set fieldClass = craft.feedme.fields.getRegisteredField(className(elementField)) %}
             {% set template = fieldClass.getMappingTemplate() %}
-
-            {% if parentPath is defined %}
-                {% set path = parentPath|merge([ 'fields', elementField.handle ]) %}
+            {% set attribute = elementField['attribute'] ?? null %}
+            {% set elementFieldHandle = elementField['handle'] ?? attribute ?? '' %}
+
+            {% if parentPath is defined and attribute %}
+                {% set path = parentPath|merge([ 'nativeFields', elementFieldHandle ]) %}
+            {% elseif parentPath is defined %}
+                {% set path = parentPath|merge([ 'fields', elementFieldHandle ]) %}
+            {% elseif attribute %}
+                {% set path = [ handle, 'nativeFields', attribute ] %}
             {% else %}
-                {% set path = [ handle, 'fields', elementField.handle ] %}
+                {% set path = [ handle, 'fields', elementFieldHandle ] %}
             {% endif %}
 
             {# Be smart about what we include to child field templates #}
             {% include template ignore missing with {
-                name: elementField.name,
-                handle: elementField.handle,
-                instructionHandle: elementField.handle,
+                name: elementField['name'] ?? elementField['label'] ?? '',
+                attribute: elementField['attribute'] ?? null,
+                handle: elementFieldHandle,
+                instructionHandle: elementFieldHandle,
                 isSubElementField: true,
                 path: path,
 

src/web/twig/variables/FeedMeVariable.php

@@ -5,6 +5,7 @@
 use Craft;
 use craft\elements\User as UserElement;
 use craft\feedme\Plugin;
+use craft\fieldlayoutelements\assets\AltField;
 use craft\fields\Checkboxes;
 use craft\fields\Color;
 use craft\fields\Date;
@@ -16,6 +17,7 @@
 use craft\fields\PlainText;
 use craft\fields\RadioButtons;
 use craft\fields\Url;
+use craft\helpers\ArrayHelper;
 use craft\helpers\DateTimeHelper;
 use craft\helpers\Html;
 use craft\helpers\UrlHelper;
@@ -240,7 +242,7 @@ public function getElementLayoutByField($type, $field): ?array
         }
 
         if (($fieldLayout = Craft::$app->getFields()->getLayoutById($source->fieldLayoutId)) !== null) {
-            return $fieldLayout->getCustomFields();
+            return ArrayHelper::merge($fieldLayout->getCustomFields(), $fieldLayout->getAvailableNativeFields());
         }
 
         return null;
@@ -352,6 +354,7 @@ public function supportedSubField($class): bool
             RadioButtons::class,
             'craft\ckeditor\Field',
             'craft\redactor\Field',
+            AltField::class,
         ];
 
         return in_array($class, $supportedSubFields, true);