inc/classes/main/helper/web/blocks/class_WebBlockHelper.php

   1 <?php
   2 /**
   3  * A helper for generating blocks (div or span) on web pages
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class WebBlockHelper extends BaseWebHelper implements HelpableTemplate {
  25         /**
  26          * Name of the block
  27          */
  28         private $blockName = "";
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set part description
  40                 $this->setObjectDescription("A helper for generating web blocks");
  41         }
  42
  43         /**
  44          * Creates the helper class
  45          *
  46          * @param       $templateInstance       An instance of a template engine
  47          * @param       $blockName                      Name of the block we shall generate
  48          * @return      $helperInstance         A prepared instance of this helper
  49          */
  50         public final static function createWebBlockHelper (CompileableTemplate $templateInstance, $blockName) {
  51                 // Get new instance
  52                 $helperInstance = new WebBlockHelper();
  53
  54                 // Set template instance
  55                 $helperInstance->setTemplateInstance($templateInstance);
  56
  57                 // Set block name
  58                 $helperInstance->setBlockName($blockName);
  59
  60                 // Return the prepared instance
  61                 return $helperInstance;
  62         }
  63
  64         /**
  65          * Setter for block name
  66          *
  67          * @param       $blockName      Name of the block we shall generate
  68          * @return      void
  69          */
  70         protected final function setBlockName ($blockName) {
  71                 $this->blockName = (string) $blockName;
  72         }
  73
  74         /**
  75          * Getter for block name
  76          *
  77          * @return      $blockName      Name of the block we shall generate
  78          */
  79         public final function getBlockName () {
  80                 return $this->blockName;
  81         }
  82
  83         /**
  84          * Checks wether include registration date in this block
  85          *
  86          * @return      $withRegistration       Wether with registration date
  87          */
  88         public function ifIncludeRegistrationStamp () {
  89                 $withRegistration = ($this->getConfigInstance()->readConfig('block_shows_registration') === "Y");
  90                 return $withRegistration;
  91         }
  92
  93         /**
  94          * Assignes a template variable with a message from a given message id
  95          *
  96          * @param       $templateVariable       Template variable to assign
  97          * @param       $messageId                      Message id to load an assign
  98          * @return      void
  99          */
 100         public function assignMessageField ($templateVariable, $messageId) {
 101                 // Get message
 102                 $message = $this->getLanguageInstance()->getMessage($messageId);
 103
 104                 // And assign it
 105                 $this->getTemplateInstance()->assignVariable($templateVariable, $message);
 106         }
 107
 108         /**
 109          * Assigns a link field with a given value
 110          *
 111          * @param       $linkField              "Link field" (variable) to assign
 112          * @param       $actionValue    Action value to assign
 113          * @return      void
 114          */
 115         public function assignLinkFieldWithAction ($linkField, $actionValue) {
 116                 $this->getTemplateInstance()->assignVariable($linkField . '_action', $actionValue);
 117         }
 118
 119         /**
 120          * "Filter" method for translating the raw user status into something human-readable
 121          *
 122          * @param       $userStatus             Raw user status from database layer
 123          * @return      $translated             Translated user status
 124          */
 125         protected function doFilterUserStatusTranslator ($userStatus) {
 126                 // Generate message id
 127                 $messageId = 'user_status_' . strtolower($userStatus);
 128
 129                 // Get that message
 130                 $translated = $this->getLanguageInstance()->getMessage($messageId);
 131
 132                 // Return it
 133                 return $translated;
 134         }
 135
 136         /**
 137          * Flush the content out,e g. to a template variable
 138          *
 139          * @return      void
 140          */
 141         public function flushContent () {
 142                 // Get template instance
 143                 $templateInstance = $this->getTemplateInstance();
 144
 145                 // Get the template named like this block
 146                 $templateInstance->loadCodeTemplate("block_" . $this->getBlockName());
 147
 148                 // Transfer it to the template instance
 149                 $templateInstance->assignVariable($this->getBlockName(), $templateInstance->getRawTemplateData());
 150         }
 151 }
 152
 153 // [EOF]
 154 ?>