3 * A helper for generating blocks (div or span) on web pages
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class WebBlockHelper extends BaseWebHelper implements HelpableTemplate {
28 private $blockName = "";
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
39 // Set part description
40 $this->setObjectDescription("A helper for generating web blocks");
44 * Creates the helper class
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
50 public final static function createWebBlockHelper (CompileableTemplate $templateInstance, $blockName) {
52 $helperInstance = new WebBlockHelper();
54 // Set template instance
55 $helperInstance->setTemplateInstance($templateInstance);
58 $helperInstance->setBlockName($blockName);
60 // Return the prepared instance
61 return $helperInstance;
65 * Setter for block name
67 * @param $blockName Name of the block we shall generate
70 protected final function setBlockName ($blockName) {
71 $this->blockName = (string) $blockName;
75 * Getter for block name
77 * @return $blockName Name of the block we shall generate
79 public final function getBlockName () {
80 return $this->blockName;
84 * Checks wether include registration date in this block
86 * @return $withRegistration Wether with registration date
88 public function ifIncludeRegistrationStamp () {
89 $withRegistration = ($this->getConfigInstance()->readConfig('block_shows_registration') === "Y");
90 return $withRegistration;
94 * Assignes a template variable with a message from a given message id
96 * @param $templateVariable Template variable to assign
97 * @param $messageId Message id to load an assign
100 public function assignMessageField ($templateVariable, $messageId) {
102 $message = $this->getLanguageInstance()->getMessage($messageId);
105 $this->getTemplateInstance()->assignVariable($templateVariable, $message);
109 * Assigns a link field with a given value
111 * @param $linkField "Link field" (variable) to assign
112 * @param $actionValue Action value to assign
115 public function assignLinkFieldWithAction ($linkField, $actionValue) {
116 $this->getTemplateInstance()->assignVariable($linkField . '_action', $actionValue);
120 * Flush the content out,e g. to a template variable
124 public function flushContent () {
125 // Get template instance
126 $templateInstance = $this->getTemplateInstance();
128 // Get the template named like this block
129 $templateInstance->loadCodeTemplate("block_" . $this->getBlockName());
131 // Transfer it to the template instance
132 $templateInstance->assignVariable($this->getBlockName(), $templateInstance->getRawTemplateData());