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 * Setter for link name
73 * @param $linkName Name of the link we shall generate
76 protected final function setLinkName ($linkName) {
77 $this->linkName = (string) $linkName;
81 * Getter for link name
83 * @return $linkName Name of the link we shall generate
85 public final function getLinkName () {
86 return $this->linkName;
90 * Setter for link base
92 * @param $linkBase Base of the link we shall generate
95 protected final function setLinkBase ($linkBase) {
96 $this->linkBase = (string) $linkBase;
100 * Getter for link base
102 * @return $linkBase Base of the link we shall generate
104 public final function getLinkBase () {
105 return $this->linkBase;
109 * Flush the content out,e g. to a template variable
112 * @todo Completely unimplemented
114 public function flushContent () {
115 // Needed to be implemented!
119 * Adds a link group (like the form group is) with some raw language to the
122 * @param $groupId Id string of the group
123 * @param $groupText Text for this group to add
126 public function addLinkGroup ($groupId, $groupText) {
127 // Is a group with that name open?
128 if ($this->ifGroupIsOpened($groupId)) {
129 // Then close it here
130 $this->closeGroupById($groupId);
132 // Open the new group
133 $this->openGroupByIdContent($groupId, $groupText);
138 * Adds text (note) to the previously opened group or throws an exception
139 * if no previous group was opened.
141 * @param $groupNote Note to be added to a group
143 * @throws NoGroupOpenedException If no previous group was opened
144 * @todo Implement adding the note to the previously opened group or sub group
146 public function addLinkNote ($groupNote) {
147 // Check if a previous group was opened
148 if (!$this->ifGroupOpenedPreviously()) {
149 // No group was opened before!
150 throw new NoGroupOpenedException(array($this, $groupNote), self::EXCEPTION_GROUP_NOT_OPENED);
153 // Not fully implemented!
154 $this->partialStub();