Register active custom asset definitions as orderable itemtypes (GLPI 11)

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [unreleased]
 
+### Added
+- Add an `Orderable` capacity for GLPI 11 custom asset definitions.
+
 ### Fixed
 
 - Fix generate associated item massive action

inc/orderablecapacity.class.php

@@ -0,0 +1,104 @@
+<?php
+
+/**
+ * -------------------------------------------------------------------------
+ * Order plugin for GLPI
+ * -------------------------------------------------------------------------
+ *
+ * LICENSE
+ *
+ * This file is part of Order.
+ *
+ * Order is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Order 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Order. If not, see <http://www.gnu.org/licenses/>.
+ * -------------------------------------------------------------------------
+ * @copyright Copyright (C) 2009-2023 by Order plugin team.
+ * @license   GPLv3 https://www.gnu.org/licenses/gpl-3.0.html
+ * @link      https://github.com/pluginsGLPI/order
+ * -------------------------------------------------------------------------
+ */
+
+use Glpi\Asset\Capacity\AbstractCapacity;
+use Glpi\Asset\CapacityConfig;
+
+/**
+ * Capacity that flags a GLPI 11 custom asset definition as orderable
+ * through the Order plugin. When enabled on an asset definition (Setup ->
+ * Asset definitions -> {your asset} -> Capacities), the corresponding
+ * generated asset class is appended to $ORDER_TYPES and becomes selectable
+ * as an Item type when creating a Product reference.
+ */
+class PluginOrderOrderableCapacity extends AbstractCapacity
+{
+    public function getLabel(): string
+    {
+        return __('Orderable', 'order');
+    }
+
+    public function getIcon(): string
+    {
+        return 'ti ti-shopping-cart';
+    }
+
+    public function getDescription(): string
+    {
+        return __(
+            'Allow this asset to be referenced as a Product reference and '
+            . 'generated from the Generate item massive action.',
+            'order',
+        );
+    }
+
+    public function getCapacityUsageDescription(string $classname): string
+    {
+        $count = 0;
+        if (class_exists('PluginOrderReference')) {
+            $count = countElementsInTable(
+                PluginOrderReference::getTable(),
+                ['itemtype' => $classname],
+            );
+        }
+
+        return sprintf(
+            _n('Used by %d order reference', 'Used by %d order references', $count, 'order'),
+            $count,
+        );
+    }
+
+    /**
+     * Clean up plugin data linked to the asset class when the capacity is
+     * disabled on its definition: remove order line items first (parent
+     * Product references refuse deletion via pre_deleteItem() while still
+     * referenced by orders_items), then remove the references themselves.
+     * Free-form references are intentionally left untouched, as they are
+     * standalone records that do not reference any itemtype.
+     */
+    public function onCapacityDisabled(string $classname, CapacityConfig $config): void
+    {
+        if (class_exists('PluginOrderOrder_Item')) {
+            (new PluginOrderOrder_Item())->deleteByCriteria(
+                ['itemtype' => $classname],
+                force: true,
+                history: false,
+            );
+        }
+
+        if (class_exists('PluginOrderReference')) {
+            (new PluginOrderReference())->deleteByCriteria(
+                ['itemtype' => $classname],
+                force: true,
+                history: false,
+            );
+        }
+    }
+}

setup.php

@@ -28,6 +28,8 @@
  * -------------------------------------------------------------------------
  */
 
+use Glpi\Asset\AssetDefinitionManager;
+
 use function Safe\define;
 
 define('PLUGIN_ORDER_VERSION', '2.12.6');
@@ -125,6 +127,30 @@ function plugin_init_order()
             'Pdu',
         ];
 
+
+        // Register the Orderable capacity for GLPI 11 custom assets and append
+        // any custom asset class that has it enabled to $ORDER_TYPES, provided
+        // the current user is allowed to view it.
+        if (class_exists(AssetDefinitionManager::class)) {
+            $asset_manager = AssetDefinitionManager::getInstance();
+            $orderable_capacity = new PluginOrderOrderableCapacity();
+            $asset_manager->registerCapacity($orderable_capacity);
+            $asset_manager->bootDefinitions();
+            foreach ($asset_manager->getDefinitions(true) as $definition) {
+                if (!$definition->hasCapacityEnabled($orderable_capacity)) {
+                    continue;
+                }
+
+                $custom_asset_class = $definition->getAssetClassName();
+                if (
+                    !in_array($custom_asset_class, $ORDER_TYPES, true)
+                    && $custom_asset_class::canView()
+                ) {
+                    $ORDER_TYPES[] = $custom_asset_class;
+                }
+            }
+        }
+
         $CFG_GLPI['plugin_order_types'] = $ORDER_TYPES;
 
         $PLUGIN_HOOKS['pre_item_purge']['order'] = [