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