inc/classes/main/helper/web/links/class_WebLinkHelper.php

   1 <?php
   2 /**
   3  * A helper for web links
   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 WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
  25         /**
  26          * Name of the link
  27          */
  28         private $linkName = "";
  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 links");
  41         }
  42
  43         /**
  44          * Creates the helper class
  45          *
  46          * @param       $templateInstance       An instance of a template engine
  47          * @param       $linkName                       Name of the link we shall generate
  48          * @return      $helperInstance         A prepared instance of this helper
  49          */
  50         public final static function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName) {
  51                 // Get new instance
  52                 $helperInstance = new WebLinkHelper();
  53
  54                 // Set template instance
  55                 $helperInstance->setTemplateInstance($templateInstance);
  56
  57                 // Set Link name
  58                 $helperInstance->setLinkName($linkName);
  59
  60                 // Return the prepared instance
  61                 return $helperInstance;
  62         }
  63
  64         /**
  65          * Setter for link name
  66          *
  67          * @param       $linkName       Name of the link we shall generate
  68          * @return      void
  69          */
  70         protected final function setLinkName ($linkName) {
  71                 $this->linkName = (string) $linkName;
  72         }
  73
  74         /**
  75          * Getter for link name
  76          *
  77          * @return      $linkName       Name of the link we shall generate
  78          */
  79         public final function getLinkName () {
  80                 return $this->linkName;
  81         }
  82
  83         /**
  84          * Flush the content out,e g. to a template variable
  85          *
  86          * @return      void
  87          */
  88         public function flushContent () {
  89                 $this->partialStub("Please implement this method.");
  90         }
  91 }
  92
  93 // [EOF]
  94 ?>