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