AOOSModule.php

   1 <?php
   2
   3 /**
   4  * AOOSModule
   5  *
   6  * Base module for all modules
   7  *
   8  * @author Sebastian Skejø
   9  */
  10
  11
  12 class AOOSModule
  13 {
  14     private $_core = null;
  15     private $_toModel = null;
  16
  17     /**
  18      * Default constructor. Redefined constructors must take $core as first argument and call $this->_init($core)
  19      * @param AOOSCore $core A reference to the core object
  20      * @param bool $toModel If this is set to 'true' module must implement the public function: AOOSModel toModel();
  21      */
  22     public function __construct(&$core, $toModel = false)
  23     {
  24         $this->_init($core, $toModel);
  25     }
  26
  27     /**
  28      * Must be called when redefining constructor. Takes core object as first argument.
  29      * @param AOOSCore $core A reference to the core object
  30      */
  31     private function _init($core, $toModel)
  32     {
  33         if (!$core instanceof AOOSCore || !isset($core))
  34         {
  35             return false;
  36         }
  37
  38         if (!is_bool($toModel))
  39         {
  40             return false;
  41         }
  42
  43         $this->_core    = $core;
  44
  45         $this->core()->log(__class__." instantiated");
  46 //        $this->_toModel = $_toModel;
  47     }
  48
  49     /**
  50      * Translates a given string to language selected in settings
  51      * @param string $stringID The unique ID of the string to translate
  52      */
  53     public function tr($stringID)
  54     {
  55         $string = $stringID;
  56         try
  57         {
  58             $string = $this->core()->getTranslatedString($stringID);
  59         }
  60         catch (AOOSException $e)
  61         {
  62         }
  63         return $string;
  64     }
  65
  66     /**
  67      * Returns the current core
  68      * @return AOOSCore
  69      */
  70     public function core()
  71     {
  72         return $this->_core;
  73     }
  74 }
  75 ?>