Source for file RecAnalystConfig.php

Documentation is available at RecAnalystConfig.php

  1. <?php
  2. /**
  3.  * Defines RecAnalystConfig class.
  4.  *
  5.  * @package recAnalyst
  6.  * @version $Id: RecAnalystConfig.php 20 2009-05-11 12:48:30Z biegleux $
  7.  * @author biegleux <biegleux[at]gmail[dot]com>
  8.  * @copyright copyright (c) 2008-2009 biegleux
  9.  * @license http://www.opensource.org/licenses/gpl-3.0.html GNU General Public License version 3 (GPLv3)
  10.  * @link http://recanalyst.sourceforge.net/
  11.  * @filesource
  12.  */
  13.  
  14. /**
  15.  * Class RecAnalystConfig.
  16.  *
  17.  * Configuration singleton class.
  18.  * RecAnalystConfig implements configuration constants used for RecAnalyst.
  19.  *
  20.  * @package recAnalyst
  21.  */
  22. class RecAnalystConfig
  23. {
  24.     /**
  25.      * Instance holder of this class.
  26.      *
  27.      * @var RecAnalystConfig 
  28.      * @static
  29.      */
  30.     private static $instance = null;
  31.  
  32.     /**
  33.      * Defines a path (absolute or relative) to directory where we wish to save generated maps.
  34.      * Write permission is required.
  35.      *
  36.      * @var string 
  37.      */
  38.     public $mapsDir;
  39.  
  40.     /**
  41.      * Defines a path (absolute or relative) to directory where we wish to save generated research timelines.
  42.      * Write permission is required.
  43.      *
  44.      * @var string 
  45.      */
  46.     public $researchesDir;
  47.  
  48.     /**
  49.      * Defines a path (absolute or relative) to directory where we store resources required for generating research timelines.
  50.      *
  51.      * @var string 
  52.      */
  53.     public $resourcesDir;
  54.  
  55.     /**
  56.      * Defines a width of the map image we wish to generate.
  57.      *
  58.      * @var int 
  59.      */
  60.     public $mapWidth;
  61.  
  62.     /**
  63.      * Defines a height of the map image we wish to generate.
  64.      *
  65.      * @var int 
  66.      */
  67.     public $mapHeight;
  68.  
  69.     /* following two configuration constants are applied for research timelines image */
  70.  
  71.     /**
  72.      * Defines width and height of one research tile in research timelines image.
  73.      *
  74.      * @var int 
  75.      */
  76.     public $researchTileSize;
  77.  
  78.     /**
  79.      * Defines vertical spacing between players in research timelines image.
  80.      *
  81.      * @var int 
  82.      */
  83.     public $researchVSpacing;
  84.  
  85.     /**
  86.      * Defines background image for research timelines image.
  87.      *
  88.      * @var string 
  89.      */
  90.     public $researchBackgroundImage;
  91.  
  92.     /**
  93.      * Defines color for Dark Age in the research timelines image.
  94.      * Array consist of red, green, blue color and alpha.
  95.      *
  96.      * @var array 
  97.      */
  98.     public $researchDAColor;
  99.  
  100.     /**
  101.      * Defines color for Dark Age in the research timelines image.
  102.      *
  103.      * @var array 
  104.      * @see $researchDAColor
  105.      */
  106.     public $researchFAColor;
  107.  
  108.     /**
  109.      * Defines color for Dark Age in the research timelines image.
  110.      *
  111.      * @var array 
  112.      * @see $researchDAColor
  113.      */
  114.     public $researchCAColor;
  115.  
  116.     /**
  117.      * Defines color for Dark Age in the research timelines image.
  118.      *
  119.      * @var array 
  120.      * @see $researchDAColor
  121.      */
  122.     public $researchIAColor;
  123.  
  124.     /**
  125.      * Determines if to show players positions on the map.
  126.      *
  127.      * @var bool true if it is desirable to show players positions, false otherwise
  128.      */
  129.     public $showPositions;
  130.  
  131.     /**
  132.      * Determines if to use snow colors for terrain instead of game's default ones.
  133.      *
  134.      * @var bool true if it is desirable to use snow colors, false otherwise
  135.      */
  136.     public $useSnowColors;
  137.  
  138.     /**
  139.      * Private class constructor.
  140.      *
  141.      */
  142.     private function __construct ()
  143.     {
  144.         $this->mapsDir = '/www/htdocs/.../';
  145.         $this->researchesDir = '/www/htdocs/.../';
  146.         $this->resourcesDir = '/www/htdocs/.../';
  147.         $this->mapWidth = 204;
  148.         $this->mapHeight = 102;
  149.         $this->researchTileSize = 19;
  150.         $this->researchVSpacing = 8;
  151.         $this->researchBackgroundImage = $this->resourcesDir . 'researches' . DIRECTORY_SEPARATOR . 'background.jpg';
  152.         $this->researchDAColor = array (0xff, 0x00, 0x00, 0x50);
  153.         $this->researchFAColor = array (0x00, 0xff, 0x00, 0x50);
  154.         $this->researchCAColor = array (0x00, 0x00, 0xff, 0x50);
  155.         $this->researchIAColor = array (0x99, 0x66, 0x00, 0x50);
  156.         $this->showPositions = true;
  157.         $this->useSnowColors = true;
  158.     }
  159.  
  160.     /**
  161.      * Disallow cloning.
  162.      *
  163.      */
  164.     private function __clone ()
  165.     {
  166.     }
  167.  
  168.     /**
  169.      * Retrieves the singleton instance of this class.
  170.      *
  171.      * @return RecAnalystConfig A RecAnalystConfig implementation instance.
  172.      */
  173.     public static function getInstance ()
  174.     {
  175.         if (!isset (self::$instance))
  176.         {
  177.             self::$instance = new self ();
  178.         }
  179.  
  180.         return self::$instance;
  181.     }
  182. }
  183. ?>

Documentation generated on Mon, 11 May 2009 16:43:51 +0200 by phpDocumentor 1.4.1