application/city/interfaces/manager/region/class_ManageableRegionMap.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Manager\RegionMap;
   4
   5 // Import own stuff
   6 use Org\Mxchange\City\Manager\Manageable;
   7
   8 /**
   9  * An interface region map manager
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2015 - 2023 City Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 interface ManageableRegionMap extends Manageable {
  31         /**
  32          * Creates a map, if not found yet, for given result which should contain
  33          * data about the region in question
  34          *
  35          * @param       $resultInstance         Region result instance
  36          * @return      void
  37          */
  38         function createRegionMapByResult (SearchableResult $resultInstance);
  39 }