framework/main/classes/helper/html/class_

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Helper\;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Helper\Template\HelpableTemplate;
   7 use Org\Mxchange\CoreFramework\Middleware\Debug\DebugMiddleware;
   8
   9 /**
  10  *
  11  *
  12  * @author              Roland Haeder <webmaster@ship-simu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.ship-simu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class Html???Helper extends BaseHtmlHelper implements HelpableTemplate {
  32         /**
  33          * Name of the ???
  34          */
  35         private $???Name = "";
  36
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         private function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45
  46                 // Set part description
  47                 $this->setObjectDescription("");
  48         }
  49
  50         /**
  51          * Creates the helper class
  52          *
  53          * @param       $templateInstance       An instance of a template engine
  54          * @param       $???Name                        Name of the ??? we shall generate
  55          * @return      $helperInstance         A prepared instance of this helper
  56          */
  57         public final static function createHtml???Helper (CompileableTemplate $templateInstance, $???Name) {
  58                 // Get new instance
  59                 $helperInstance = new Html???Helper();
  60
  61                 // Set template instance
  62                 $helperInstance->setTemplateInstance($templateInstance);
  63
  64                 // Set ??? name
  65                 $helperInstance->set???Name($???Name);
  66
  67                 // Return the prepared instance
  68                 return $helperInstance;
  69         }
  70
  71         /**
  72          * Flush the content out,e g. to a template variable
  73          *
  74          * @return      void
  75          * @todo        0% done
  76          */
  77         public function flushContent () {
  78                 DebugMiddleware::getSelfInstance()->partialStub("Please implement this method.");
  79         }
  80
  81 }