application/city/classes/tasks/class_BaseCityTask.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Task;
   4
   5 // Import application-specific stuff
   6 use Org\Mxchange\City\Helper\CityHelper;
   7
   8 // Import framework stuff
   9 use Org\Mxchange\CoreFramework\Task\BaseTask;
  10
  11 /**
  12  * A general CityTask class
  13  *
  14  * @author              Roland Haeder <webmaster@ship-simu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2015 - 2023 City Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.ship-simu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 abstract class BaseCityTask extends BaseTask {
  34         /**
  35          * An instance of a city
  36          */
  37         private $cityInstance = NULL;
  38
  39         /**
  40          * Protected constructor
  41          *
  42          * @param       $className      Name of the class
  43          * @return      void
  44          */
  45         protected function __construct (string $className) {
  46                 // Call parent constructor
  47                 parent::__construct($className);
  48         }
  49
  50         /**
  51          * Getter for city instance
  52          *
  53          * @return      $cityInstance   An instance of a city city
  54          */
  55         public final function getCityInstance () {
  56                 return $this->cityInstance;
  57         }
  58
  59         /**
  60          * Setter for city instance
  61          *
  62          * @param       $cityInstance   An instance of a city city
  63          * @return      void
  64          */
  65         protected final function setCityInstance (CityHelper $cityInstance) {
  66                 $this->cityInstance = $cityInstance;
  67         }
  68 }