exportabletrait.class.php

<?php
/**
 * ---------------------------------------------------------------------
 * Formcreator is a plugin which allows creation of custom forms of
 * easy access.
 * ---------------------------------------------------------------------
 * LICENSE
 *
 * This file is part of Formcreator.
 *
 * Formcreator 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 2 of the License, or
 * (at your option) any later version.
 *
 * Formcreator 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 Formcreator. If not, see <http://www.gnu.org/licenses/>.
 * ---------------------------------------------------------------------
 * @copyright Copyright © 2011 - 2021 Teclib'
 * @license   http://www.gnu.org/licenses/gpl.txt GPLv3+
 * @link      https://github.com/pluginsGLPI/formcreator/
 * @link      https://pluginsglpi.github.io/formcreator/
 * @link      http://plugins.glpi-project.org/#/plugin/formcreator
 * ---------------------------------------------------------------------
 */

if (!defined('GLPI_ROOT')) {
   die("Sorry. You can't access this file directly");
}

trait PluginFormcreatorExportableTrait
{

    protected $useAutomaticOrdering = true;

    /**
     * Insert the export of sub items in the export
     *
     * @param array $subItems key/value pair list of sub items
     * @param array $export the export of the object
     * @param bool $remove_uuid
     * @return array
     */
   public function exportChildrenObjects(array $subItems, array $export, bool $remove_uuid = false) : array {
       global $DB;

      foreach ($subItems as $key => $itemtypes) {
         if (!is_array($itemtypes)) {
            $itemtypes = [$itemtypes];
         }
         $export[$key] = [];
         foreach ($itemtypes as $itemtype) {
            $criteria = $itemtype::getSQLCriteriaToSearchForItem($this->getType(), $this->getID());

            // Add ORDER BY clause if the itemtype has an 'order' field
            // This ensures sections and other ordered items are exported in the correct order
            $subItem = new $itemtype();
            if ($subItem->isField('order')) {
               $criteria['ORDER'] = ['order ASC'];
            }
            $allSubItems = $DB->request($criteria);
            $list = [];
            foreach ($allSubItems as $row) {
               $subItem->getFromDB($row['id']);
               $list[] = $subItem->export($remove_uuid);
            }
            if (!is_array($subItems[$key])) {
               $export[$key] = $list;
            } else {
               $export[$key][$itemtype] = $list;
            }
         }
      }

       return $export;
   }

    /**
     * Import children objects
     *
     * @param PluginFormcreatorExportableInterface $item
     * @param PluginFormcreatorLinker $linker
     * @param array $subItems
     * @param array $input
     * @return void
     */
   public function importChildrenObjects(PluginFormcreatorExportableInterface $parent, PluginFormcreatorLinker $linker, array $subItems, array $input) : void {
      /** @var CommonDBTM $parent */
      $itemId = $parent->getID();
      foreach ($subItems as $key => $itemtypes) {
         if (!is_array($itemtypes)) {
            if (!isset($input[$key])) {
                $input[$key] = [];
            }
            $input[$key] = [$itemtypes => $input[$key]];
            $itemtypes = [$itemtypes];
         }
         foreach ($itemtypes as $itemtype) {
            $importedItems = [];
            if (!isset($input[$key][$itemtype])) {
               continue;
            }
            foreach ($input[$key][$itemtype] as $subInput) {
               $importedItem = $itemtype::import(
                  $linker,
                  $subInput,
                  $itemId
               );

               // If $importedItem === false the item import is postponed
               if ($importedItem !== false) {
                  $importedItems[] = $importedItem;
               }
            }
            // Delete all other restrictions
            /** @var PluginFormcreatorExportableInterface $subItem */
            $subItem = new $itemtype();
            $subItem->deleteObsoleteItems($parent, $importedItems);
         }
      }
   }

    /**
     * Count sub items
     *
     * @param array $input
     * @param array $subItems
     * @return int
     */
   public static function countChildren(array $input, array $subItems = []) : int {
      if (count($subItems) < 1) {
          return 1;
      }

      $count = 0;
      foreach ($subItems as $key => $itemtypes) {
         if (isset($input[$key])) {
            // force array of itemtypes
            if (!is_array($itemtypes)) {
               if (!isset($input[$key])) {
                   $input[$key] = [];
               }
               $input[$key] = [$itemtypes => $input[$key]];
               $itemtypes = [$itemtypes];
            }

            foreach ($itemtypes as $itemtype) {
               if (!isset($input[$key][$itemtype])) {
                   continue;
               }
               foreach ($input[$key][$itemtype] as $subInput) {
                   $count += $itemtype::countItemsToImport($subInput);
               }
            }
         }
      }

       return $count;
   }
}