3 * A helper for web links
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007 - 2009 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 WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
28 private $linkName = '';
33 private $linkBase = '';
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Creates the helper class
48 * @param $templateInstance An instance of a template engine
49 * @param $linkName Name of the link we shall generate
50 * @param $linkBase Link base for all generated links
51 * @return $helperInstance A prepared instance of this helper
53 public final static function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName, $linkBase) {
55 $helperInstance = new WebLinkHelper();
57 // Set template instance
58 $helperInstance->setTemplateInstance($templateInstance);
61 $helperInstance->setLinkName($linkName);
64 $helperInstance->setLinkBase($linkBase);
67 $helperInstance->openGroupByIdContent('main', '', '');
69 // Return the prepared instance
70 return $helperInstance;
74 * Renders the link content (HTML code) with given link text and optional
77 * @param $linkText Link text to set in link
78 * @param $linkTitle Link title to set in link
79 * @param $extraContent Optional extra HTML content
80 * @return $linkContent Rendered text link content
82 private function renderLinkContentWithTextExtraContent ($linkText, $linkTitle, $extraContent='') {
83 // Construct link content
84 $linkContent = sprintf("<a href=\"%s%s\" title=\"%s\">%s</a>",
96 * Setter for link name
98 * @param $linkName Name of the link we shall generate
101 protected final function setLinkName ($linkName) {
102 $this->linkName = (string) $linkName;
106 * Getter for link name
108 * @return $linkName Name of the link we shall generate
110 public final function getLinkName () {
111 return $this->linkName;
115 * Setter for link base
117 * @param $linkBase Base of the link we shall generate
120 protected final function setLinkBase ($linkBase) {
121 $this->linkBase = (string) $linkBase;
125 * Getter for link base
127 * @return $linkBase Base of the link we shall generate
129 public final function getLinkBase () {
130 return $this->linkBase;
134 * Flush the content out,e g. to a template variable
137 * @todo Completely unimplemented
139 public function flushContent () {
140 // Is a previous opened group still open?
141 if ($this->ifGroupOpenedPreviously()) {
143 $this->closePreviousGroupByContent('');
147 $content = $this->renderContent();
149 // Get template engine
150 $templateInstance = $this->getTemplateInstance();
152 // Add content to variable
153 $templateInstance->assignVariable($this->getLinkName(), $content);
157 * Adds a link group (like the form group is) with some raw language to the
160 * @param $groupId Id string of the group
161 * @param $groupText Text for this group to add
162 * @param $groupCode Code to open and close groups
165 public function addLinkGroup ($groupId, $groupText, $groupCode = "div") {
166 // Is a group with that name open?
167 if ($this->ifGroupOpenedPreviously()) {
168 // Then close it here
169 $this->closePreviousGroupByContent('');
172 // Generate the group content
173 $content = sprintf("<{$groupCode} id=\"group_%s_%s\">%s",
174 $this->getLinkName(),
179 // Open the new group
180 $this->openGroupByIdContent($groupId, $content, $groupCode);
184 * Adds text (note) to the previously opened group or throws an exception
185 * if no previous group was opened.
187 * @param $groupId Group id to set
188 * @param $groupNote Note to be added to a group
189 * @param $groupCode Code to open and close groups
191 * @throws NoGroupOpenedException If no previous group was opened
193 public function addLinkNote ($groupId, $groupNote, $groupCode = "div") {
194 // Check if a previous group was opened
195 if ($this->ifGroupOpenedPreviously() === false) {
196 // No group was opened before!
197 throw new NoGroupOpenedException(array($this, $groupNote), self::EXCEPTION_GROUP_NOT_OPENED);
200 // Is a previous sub group open?
201 if ($this->ifSubGroupOpenedPreviously()) {
203 $this->closePreviousSubGroupByContent("</{$groupCode}>");
206 // Generate the group content
207 $content = sprintf("<{$groupCode} id=\"subgroup_%s_%s\">%s",
208 $this->getLinkName(),
213 // Open the sub group
214 $this->openSubGroupByIdContent($groupId, $content, $groupCode);
218 * Adds a link to the previously opened group or throws an exception if no group has been opened
220 * @param $linkAction Action (action=xxx) value for the link
221 * @param $linkText Link text and title (title="xxx") for the link
223 * @throws NoGroupOpenedException If no previous group was opened
225 protected function addActionLink ($linkAction, $linkText, $linkTitle) {
226 // Check if a previous group was opened
227 if ($this->ifGroupOpenedPreviously() === false) {
228 // No group was opened before!
229 throw new NoGroupOpenedException(array($this, $linkAction."(".$linkText.")"), self::EXCEPTION_GROUP_NOT_OPENED);
232 // Default parameter seperator is &
233 $seperator = "&";
235 // Is there a question mark in?
236 $linkArray = explode("?", $this->getLinkBase());
237 if (count($linkArray) == 0) {
243 $action = sprintf("%saction=%s",
248 // Renders the link content
249 $linkContent = $this->renderLinkContentWithTextExtraContent($linkText, $linkTitle, $action);
251 // Add the content to the previous group
252 $this->addContentToPreviousGroup($linkContent);
256 * Adds a link to the previously opened group with a text from language system
258 * @param $linkAction Action (action=xxx) value for the link
259 * @param $languageId Language id string to use
262 public function addActionLinkById ($linkAction, $languageId) {
263 // Resolve the language string
264 $languageResolvedText = $this->getLanguageInstance()->getMessage("link_" . $languageId . "_text");
266 // Resolve the language string
267 $languageResolvedTitle = $this->getLanguageInstance()->getMessage("link_" . $languageId . "_title");
269 // Add the action link
270 $this->addActionLink($linkAction, $languageResolvedText, $languageResolvedTitle);
274 * Adds a default link (no extra parameters) to the content with specified
275 * language id string.
277 * @param $languageId Language id string to use
280 public function addLinkWithTextById ($languageId) {
281 // Resolve the language string
282 $languageResolvedText = $this->getLanguageInstance()->getMessage("link_" . $languageId . "_text");
284 // Resolve the language string
285 $languageResolvedTitle = $this->getLanguageInstance()->getMessage("link_" . $languageId . "_title");
288 $linkContent = $this->renderLinkContentWithTextExtraContent($languageResolvedText, $languageResolvedTitle);
290 // Add the content to the previous group
291 $this->addContentToPreviousGroup($linkContent);