Add default line-items field type api mappers

core/backend/Module/Service/Fields/LineItems/Mappers/LineItemsApiMapperTrait.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * SuiteCRM is a customer relationship management program developed by SalesAgility Ltd.
+ * Copyright (C) 2024 SalesAgility Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License version 3 as published by the
+ * Free Software Foundation with the addition of the following permission added
+ * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
+ * IN WHICH THE COPYRIGHT IS OWNED BY SALESAGILITY, SALESAGILITY DISCLAIMS THE
+ * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License
+ * version 3, these Appropriate Legal Notices must retain the display of the
+ * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably
+ * feasible for technical reasons, the Appropriate Legal Notices must display
+ * the words "Supercharged by SuiteCRM".
+ */
+
+
+namespace App\Module\Service\Fields\LineItems\Mappers;
+
+use App\Data\Entity\Record;
+use App\Data\Service\LinkedRecords\LinkedRecordsProviderInterface;
+
+trait LineItemsApiMapperTrait
+{
+    /**
+     * @param Record $record
+     * @param string $field
+     * @param LinkedRecordsProviderInterface $linkedRecordsProvider
+     * @return void
+     */
+    protected function injectRelatedRecords(Record $record, string $field, LinkedRecordsProviderInterface $linkedRecordsProvider): void
+    {
+
+        $relatedRecords = $linkedRecordsProvider->getRelatedRecords($record, $field);
+
+        $recordAttributes = $record->getAttributes();
+        $recordAttributes[$field] = [];
+
+        foreach ($relatedRecords as $relatedRecord) {
+            $recordAttributes[$field][] = $relatedRecord->toArray();
+        }
+
+        $record->setAttributes($recordAttributes);
+    }
+}

core/backend/Module/Service/Fields/LineItems/Mappers/LineItemsListApiMapper.php

@@ -0,0 +1,75 @@
+<?php
+/**
+ * SuiteCRM is a customer relationship management program developed by SalesAgility Ltd.
+ * Copyright (C) 2021 SalesAgility Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License version 3 as published by the
+ * Free Software Foundation with the addition of the following permission added
+ * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
+ * IN WHICH THE COPYRIGHT IS OWNED BY SALESAGILITY, SALESAGILITY DISCLAIMS THE
+ * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see http://www.gnu.org/licenses.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License
+ * version 3, these Appropriate Legal Notices must retain the display of the
+ * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably
+ * feasible for technical reasons, the Appropriate Legal Notices must display
+ * the words "Supercharged by SuiteCRM".
+ */
+
+namespace App\Module\Service\Fields\LineItems\Mappers;
+
+use App\Data\Entity\Record;
+use App\Data\Service\Record\ApiRecordMappers\ApiRecordFieldTypeMapperInterface;
+use App\FieldDefinitions\Entity\FieldDefinition;
+use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
+
+#[Autoconfigure(lazy: true)]
+class LineItemsListApiMapper implements ApiRecordFieldTypeMapperInterface
+{
+    public const FIELD_TYPE = 'line-items';
+
+    public function getFieldType(): string
+    {
+        return self::FIELD_TYPE;
+    }
+
+    public function getModule(): string
+    {
+        return 'default';
+    }
+
+    public function getKey(): string
+    {
+        return 'default';
+    }
+
+    public function getModes(): array
+    {
+        return ['list'];
+    }
+
+    public function getOrder(): int
+    {
+        return 0;
+    }
+
+    public function toInternal(Record $record, FieldDefinition $fieldDefinitions, string $field): void
+    {
+    }
+
+    public function toExternal(Record $record, FieldDefinition $fieldDefinitions, string $field): void
+    {
+        $attributes = $record->getAttributes() ?? [];
+        $attributes[$field] = [];
+        $record->setAttributes($attributes);
+    }
+}

core/backend/Module/Service/Fields/LineItems/Mappers/LineItemsRetrieveApiMapper.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * SuiteCRM is a customer relationship management program developed by SalesAgility Ltd.
+ * Copyright (C) 2021 SalesAgility Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License version 3 as published by the
+ * Free Software Foundation with the addition of the following permission added
+ * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
+ * IN WHICH THE COPYRIGHT IS OWNED BY SALESAGILITY, SALESAGILITY DISCLAIMS THE
+ * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see http://www.gnu.org/licenses.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License
+ * version 3, these Appropriate Legal Notices must retain the display of the
+ * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably
+ * feasible for technical reasons, the Appropriate Legal Notices must display
+ * the words "Supercharged by SuiteCRM".
+ */
+
+namespace App\Module\Service\Fields\LineItems\Mappers;
+
+use App\Data\Entity\Record;
+use App\Data\Service\LinkedRecords\LinkedRecordsProviderInterface;
+use App\Data\Service\Record\ApiRecordMappers\ApiRecordFieldTypeMapperInterface;
+use App\FieldDefinitions\Entity\FieldDefinition;
+use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
+
+#[Autoconfigure(lazy: true)]
+class LineItemsRetrieveApiMapper implements ApiRecordFieldTypeMapperInterface
+{
+    use LineItemsApiMapperTrait;
+
+    public const FIELD_TYPE = 'line-items';
+    protected LinkedRecordsProviderInterface $linkedRecordsProvider;
+
+    public function __construct(LinkedRecordsProviderInterface $linkedRecordsProvider)
+    {
+        $this->linkedRecordsProvider = $linkedRecordsProvider;
+    }
+
+    public function getFieldType(): string
+    {
+        return self::FIELD_TYPE;
+    }
+
+    public function getModule(): string
+    {
+        return 'default';
+    }
+
+    public function getKey(): string
+    {
+        return 'default';
+    }
+
+    public function getModes(): array
+    {
+        return ['retrieve'];
+    }
+
+    public function getOrder(): int
+    {
+        return 0;
+    }
+
+    public function toInternal(Record $record, FieldDefinition $fieldDefinitions, string $field): void
+    {
+    }
+
+    public function toExternal(Record $record, FieldDefinition $fieldDefinitions, string $field): void
+    {
+        $this->injectRelatedRecords($record, $field, $this->linkedRecordsProvider);
+    }
+}

core/backend/Module/Service/Fields/LineItems/Mappers/LineItemsSaveApiMapper.php

@@ -0,0 +1,83 @@
+<?php
+/**
+ * SuiteCRM is a customer relationship management program developed by SalesAgility Ltd.
+ * Copyright (C) 2021 SalesAgility Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License version 3 as published by the
+ * Free Software Foundation with the addition of the following permission added
+ * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
+ * IN WHICH THE COPYRIGHT IS OWNED BY SALESAGILITY, SALESAGILITY DISCLAIMS THE
+ * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see http://www.gnu.org/licenses.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License
+ * version 3, these Appropriate Legal Notices must retain the display of the
+ * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably
+ * feasible for technical reasons, the Appropriate Legal Notices must display
+ * the words "Supercharged by SuiteCRM".
+ */
+
+namespace App\Module\Service\Fields\LineItems\Mappers;
+
+use App\Data\Entity\Record;
+use App\Data\Service\LinkedRecords\LinkedRecordsProviderInterface;
+use App\Data\Service\Record\ApiRecordMappers\ApiRecordFieldTypeMapperInterface;
+use App\FieldDefinitions\Entity\FieldDefinition;
+use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
+
+#[Autoconfigure(lazy: true)]
+class LineItemsSaveApiMapper implements ApiRecordFieldTypeMapperInterface
+{
+    use LineItemsApiMapperTrait;
+
+    public const FIELD_TYPE = 'line-items';
+
+    protected LinkedRecordsProviderInterface $linkedRecordsProvider;
+
+    public function __construct(LinkedRecordsProviderInterface $linkedRecordsProvider)
+    {
+        $this->linkedRecordsProvider = $linkedRecordsProvider;
+    }
+
+    public function getFieldType(): string
+    {
+        return self::FIELD_TYPE;
+    }
+
+    public function getModule(): string
+    {
+        return 'default';
+    }
+
+    public function getKey(): string
+    {
+        return 'default';
+    }
+
+    public function getModes(): array
+    {
+        return ['save'];
+    }
+
+    public function getOrder(): int
+    {
+        return 0;
+    }
+
+    public function toInternal(Record $record, FieldDefinition $fieldDefinitions, string $field): void
+    {
+    }
+
+    public function toExternal(Record $record, FieldDefinition $fieldDefinitions, string $field): void
+    {
+        $this->injectRelatedRecords($record, $field, $this->linkedRecordsProvider);
+    }
+}