framework/main/classes/utils/arrays/class_ArrayUtils.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Utils\Arrays;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
   7 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   8 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
   9
  10 // Import SPL stuff
  11 use \InvalidArgumentException;
  12 use \OutOfBoundsException;
  13
  14 /**
  15  * A number utility class
  16  *
  17  * @author              Roland Haeder <webmaster@ship-simu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.ship-simu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 final class ArrayUtils extends BaseFrameworkSystem {
  37         /**
  38          * Private constructor, no instance needed. If PHP would have a static initializer ...
  39          *
  40          * @return      void
  41          */
  42         private function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Maps numeric array keys to their corresponding associative
  49          * (alpha-numberic) parts.
  50          *
  51          * @param       $numericArray   The array the mapping shall happen on
  52          * @param       $mapping        Numeric array to map all elements from numeric keys to alpha-numeric keys
  53          * @return      $mappedArray    An array with mapped values
  54          * @throws      InvalidArgumentException        If a aparameter is not valid
  55          */
  56         public static function mapNumericKeysToAssociative (array $numericArray, array $mapping) {
  57                 // Validate parameters
  58                 if (count($numericArray) == 0) {
  59                         // Throw IAE
  60                         throw new InvalidArgumentException('Array "numericArray" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
  61                 } elseif (count($mapping) == 0) {
  62                         // Throw it again
  63                         throw new InvalidArgumentException('Array "mapping" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
  64                 } elseif (count($numericArray) != count($mapping)) {
  65                         // Throw it yet again
  66                         throw new InvalidArgumentException(sprintf('numericArray()=%d does not match mapping()=%d', count($numericArray), count($mapping)));
  67                 }
  68
  69                 // Init mapped array
  70                 $mappedArray = [];
  71
  72                 // "Walk" over the mapping array
  73                 foreach ($mapping as $sourceIndex => $targetName) {
  74                         // Is the source index not there?
  75                         if (!array_key_exists($sourceIndex, $numericArray)) {
  76                                 // Should always be there!
  77                                 throw new OutOfBoundsException(sprintf('numericArray[%d] does not exist.', $sourceIndex));
  78                         }
  79
  80                         // "Map" (copy) it to new array
  81                         $mappedArray[$targetName] = $numericArray[$sourceIndex];
  82                 }
  83
  84                 // Return fully mapped array
  85                 return $mappedArray;
  86         }
  87
  88 }