3 * A helper for web links
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 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);
66 // Return the prepared instance
67 return $helperInstance;
71 * Renders the link content (HTML code) with given link text and optional
74 * @param $linkText Link text to set in link
75 * @param $extraContent Optional extra HTML content
76 * @return $linkContent Rendered text link content
78 private function renderLinkContentWithTextExtraContent ($linkText, $extraContent="") {
79 // Construct link content
80 $linkContent = sprintf("<a href=\"%s%s\" title=\"%s\">%s</a>",
92 * Setter for link name
94 * @param $linkName Name of the link we shall generate
97 protected final function setLinkName ($linkName) {
98 $this->linkName = (string) $linkName;
102 * Getter for link name
104 * @return $linkName Name of the link we shall generate
106 public final function getLinkName () {
107 return $this->linkName;
111 * Setter for link base
113 * @param $linkBase Base of the link we shall generate
116 protected final function setLinkBase ($linkBase) {
117 $this->linkBase = (string) $linkBase;
121 * Getter for link base
123 * @return $linkBase Base of the link we shall generate
125 public final function getLinkBase () {
126 return $this->linkBase;
130 * Flush the content out,e g. to a template variable
133 * @todo Completely unimplemented
135 public function flushContent () {
136 // Is a previous opened group still open?
137 if ($this->ifGroupOpenedPreviously()) {
139 $this->closePreviousGroupByContent("</div>");
143 $content = $this->renderContent();
145 // Get template engine
146 $templateInstance = $this->getTemplateInstance();
148 // Add content to variable
149 $templateInstance->assignVariable($this->getLinkName(), $content);
153 * Adds a link group (like the form group is) with some raw language to the
156 * @param $groupId Id string of the group
157 * @param $groupText Text for this group to add
160 public function addLinkGroup ($groupId, $groupText) {
161 // Is a group with that name open?
162 if ($this->ifGroupIsOpened($groupId)) {
163 // Then close it here
164 $this->closePreviousGroupByContent("</div>");
166 // Is a previous opened group still open?
167 if ($this->ifGroupOpenedPreviously()) {
169 $this->closePreviousGroupByContent("</div>");
172 // Generate the group content
173 $content = sprintf("<div id=\"group_%s_%s\">%s",
174 $this->getLinkName(),
179 // Open the new group
180 $this->openGroupByIdContent($groupId, $content);
185 * Adds text (note) to the previously opened group or throws an exception
186 * if no previous group was opened.
188 * @param $groupNote Note to be added to a group
190 * @throws NoGroupOpenedException If no previous group was opened
192 public function addLinkNote ($groupNote) {
193 // Check if a previous group was opened
194 if (!$this->ifGroupOpenedPreviously()) {
195 // No group was opened before!
196 throw new NoGroupOpenedException(array($this, $groupNote), self::EXCEPTION_GROUP_NOT_OPENED);
199 // Add the content to the previous group
200 $this->addContentToPreviousGroup($groupNote);
204 * Adds a link to the previously opened group or throws an exception if no group has been opened
206 * @param $linkAction Action (action=xxx) value for the link
207 * @param $linkText Link text and title (title="xxx") for the link
209 * @throws NoGroupOpenedException If no previous group was opened
211 public function addActionLink ($linkAction, $linkText) {
212 // Check if a previous group was opened
213 if (!$this->ifGroupOpenedPreviously()) {
214 // No group was opened before!
215 throw new NoGroupOpenedException(array($this, $linkAction."(".$linkText.")"), self::EXCEPTION_GROUP_NOT_OPENED);
218 // Default parameter seperator is &
219 $seperator = "&";
221 // Is there a question mark in?
222 $linkArray = explode("?", $this->getLinkBase());
223 if (count($linkArray) == 0) {
229 $action = sprintf("%saction=%s",
234 // Renders the link content
235 $linkContent = $this->renderLinkContentWithTextExtraContent($linkText, $action);
237 // Add the content to the previous group
238 $this->addContentToPreviousGroup($linkContent);
242 * Adds a default link (no extra parameters) to the content with specified
243 * language id string.
245 * @param $languageId Language id string to use
248 public function addLinkWithTextById ($languageId) {
249 // Resolve the language string
250 $languageResolved = $this->getLanguageInstance()->getMessage($languageId);
253 $linkContent = $this->renderLinkContentWithTextExtraContent($languageResolved);
255 // Add the content to the previous group
256 $this->addContentToPreviousGroup($linkContent);