Initial commit

application/Espo/ORM/Value/AttributeExtractor.php

@@ -0,0 +1,47 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * 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 "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Value;
+
+use stdClass;
+
+/**
+ * @template T of object
+ *
+ * Extracts attributes from value object by a given field name.
+ */
+interface AttributeExtractor
+{
+    /**
+     * @param T $value
+     */
+    public function extract(object $value, string $field): stdClass;
+
+    public function extractFromNull(string $field): stdClass;
+}

application/Espo/ORM/Value/AttributeExtractorFactory.php

@@ -0,0 +1,43 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * 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 "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Value;
+
+/**
+ * @template T of object
+ */
+interface AttributeExtractorFactory
+{
+    /**
+     * Create AttributeExtractor.
+     *
+     * @return AttributeExtractor<T>
+     */
+    public function create(string $entityType, string $field): AttributeExtractor;
+}

application/Espo/ORM/Value/GeneralAttributeExtractor.php

@@ -0,0 +1,79 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * 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 "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Value;
+
+use stdClass;
+
+class GeneralAttributeExtractor
+{
+    /** @var AttributeExtractorFactory<object> */
+    private AttributeExtractorFactory $factory;
+
+    /**
+     * @var array<string, AttributeExtractor<object>>
+     */
+    private $cache = [];
+
+    /**
+     * @param AttributeExtractorFactory<object> $factory
+     */
+    public function __construct(AttributeExtractorFactory $factory)
+    {
+        $this->factory = $factory;
+    }
+
+    /**
+     * Extracts attributes from a value object.
+     */
+    public function extract(string $entityType, string $field, ?object $value): stdClass
+    {
+        $extractor = $this->getExtractor($entityType, $field);
+
+        if (is_null($value)) {
+            return $extractor->extractFromNull($field);
+        }
+
+        return $extractor->extract($value, $field);
+    }
+
+    /**
+     * @return AttributeExtractor<object>
+     */
+    private function getExtractor(string $entityType, string $field): AttributeExtractor
+    {
+        $key = $entityType . '_' . $field;
+
+        if (!array_key_exists($key, $this->cache)) {
+            $this->cache[$key] = $this->factory->create($entityType, $field);
+        }
+
+        return $this->cache[$key];
+    }
+}

application/Espo/ORM/Value/GeneralValueFactory.php

@@ -0,0 +1,94 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * 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 "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Value;
+
+use Espo\ORM\Entity;
+
+use RuntimeException;
+
+class GeneralValueFactory
+{
+    /** @var array<string,?ValueFactory> */
+    private array $factoryCache = [];
+
+    public function __construct(private ValueFactoryFactory $valueFactoryFactory)
+    {}
+
+    /**
+     * Whether a field value object can be created from an entity.
+     */
+    public function isCreatableFromEntity(Entity $entity, string $field): bool
+    {
+        $factory = $this->getValueFactory($entity->getEntityType(), $field);
+
+        if (!$factory) {
+            return false;
+        }
+
+        return $factory->isCreatableFromEntity($entity, $field);
+    }
+
+    /**
+     * Create a field value object from an entity.
+     */
+    public function createFromEntity(Entity $entity, string $field): object
+    {
+        $factory = $this->getValueFactory($entity->getEntityType(), $field);
+
+        if (!$factory) {
+            $entityType = $entity->getEntityType();
+
+            throw new RuntimeException("No value-object factory for '{$entityType}.{$field}'.");
+        }
+
+        /** @var ValueFactory */
+        return $factory->createFromEntity($entity, $field);
+    }
+
+    private function getValueFactory(string $entityType, string $field): ?ValueFactory
+    {
+        $key = $entityType . '_' . $field;
+
+        if (!array_key_exists($key, $this->factoryCache)) {
+            $this->factoryCache[$key] = $this->getValueFactoryNoCache($entityType, $field);
+        }
+
+        return $this->factoryCache[$key];
+    }
+
+    private function getValueFactoryNoCache(string $entityType, string $field): ?ValueFactory
+    {
+        if (!$this->valueFactoryFactory->isCreatable($entityType, $field)) {
+            return null;
+        }
+
+        return $this->valueFactoryFactory->create($entityType, $field);
+    }
+}

application/Espo/ORM/Value/ValueAccessor.php

@@ -0,0 +1,71 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * 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 "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Value;
+
+use Espo\ORM\Entity;
+
+class ValueAccessor
+{
+    public function __construct(
+        private Entity $entity,
+        private GeneralValueFactory $valueFactory,
+        private GeneralAttributeExtractor $extractor
+    ) {}
+
+    /**
+     * Get a field value object.
+     */
+    public function get(string $field): ?object
+    {
+        if (!$this->isGettable($field)) {
+            return null;
+        }
+
+        return $this->valueFactory->createFromEntity($this->entity, $field);
+    }
+
+    /**
+     * Whether a field value object can be gotten.
+     */
+    public function isGettable(string $field): bool
+    {
+        return $this->valueFactory->isCreatableFromEntity($this->entity, $field);
+    }
+
+    /**
+     * Set a field value object.
+     */
+    public function set(string $field, ?object $value): void
+    {
+        $attributeValueMap = $this->extractor->extract($this->entity->getEntityType(), $field, $value);
+
+        $this->entity->set($attributeValueMap);
+    }
+}

application/Espo/ORM/Value/ValueAccessorFactory.php

@@ -0,0 +1,88 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * 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 "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Value;
+
+use Espo\ORM\Entity;
+use Espo\ORM\EventDispatcher;
+
+class ValueAccessorFactory
+{
+    private ?GeneralValueFactory $generalValueFactory = null;
+    private ?GeneralAttributeExtractor $generalAttributeExtractor = null;
+
+    /**
+     * @param AttributeExtractorFactory<object> $attributeExtractorFactory
+     */
+    public function __construct(
+        private ValueFactoryFactory $valueFactoryFactory,
+        private AttributeExtractorFactory $attributeExtractorFactory,
+        private EventDispatcher $eventDispatcher
+    ) {
+
+        $this->subscribeToMetadataUpdate();
+    }
+
+    public function create(Entity $entity): ValueAccessor
+    {
+        return new ValueAccessor(
+            $entity,
+            $this->getGeneralValueFactory(),
+            $this->getGeneralAttributeExtractor()
+        );
+    }
+
+    private function getGeneralValueFactory(): GeneralValueFactory
+    {
+        if (!$this->generalValueFactory) {
+            $this->generalValueFactory = new GeneralValueFactory($this->valueFactoryFactory);
+        }
+
+        return $this->generalValueFactory;
+    }
+
+    private function getGeneralAttributeExtractor(): GeneralAttributeExtractor
+    {
+        if (!$this->generalAttributeExtractor) {
+            $this->generalAttributeExtractor = new GeneralAttributeExtractor($this->attributeExtractorFactory);
+        }
+
+        return $this->generalAttributeExtractor;
+    }
+
+    private function subscribeToMetadataUpdate(): void
+    {
+        $this->eventDispatcher->subscribeToMetadataUpdate(
+            function () {
+                $this->generalValueFactory = null;
+                $this->generalAttributeExtractor = null;
+            }
+        );
+    }
+}

application/Espo/ORM/Value/ValueFactory.php

@@ -0,0 +1,47 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * 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 "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Value;
+
+use Espo\ORM\Entity;
+
+interface ValueFactory
+{
+    /**
+     * Whether a field value can be created from an entity.
+     */
+    public function isCreatableFromEntity(Entity $entity, string $field): bool;
+
+    /**
+     * Create a field value from an entity.
+     *
+     * @return object|null A value object or NULL if it can't be created.
+     */
+    public function createFromEntity(Entity $entity, string $field): ?object;
+}

application/Espo/ORM/Value/ValueFactoryFactory.php

@@ -0,0 +1,43 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * 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 "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Value;
+
+interface ValueFactoryFactory
+{
+    /**
+     * Whether can create a factory.
+     */
+    public function isCreatable(string $entityType, string $field): bool;
+
+    /**
+     * Create ValueFactory.
+     */
+    public function create(string $entityType, string $field): ValueFactory;
+}