class_WebLinkHelper.php

Go to the documentation of this file.

<?php
class WebLinkHelper extends BaseWebHelper implements HelpableTemplate {
        private $linkName = "";

        private $linkBase = "";

        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
        }

        public final static function createWebLinkHelper (CompileableTemplate $templateInstance, $linkName, $linkBase) {
                // Get new instance
                $helperInstance = new WebLinkHelper();

                // Set template instance
                $helperInstance->setTemplateInstance($templateInstance);

                // Set link name
                $helperInstance->setLinkName($linkName);

                // Set link base
                $helperInstance->setLinkBase($linkBase);

                // Add default group
                $helperInstance->openGroupByIdContent('main', "", "");

                // Return the prepared instance
                return $helperInstance;
        }

        private function renderLinkContentWithTextExtraContent ($linkText, $linkTitle, $extraContent="") {
                // Construct link content
                $linkContent = sprintf("<a href=\"%s%s\" title=\"%s\">%s</a>",
                        $this->getLinkBase(),
                        $extraContent,
                        $linkTitle,
                        $linkText
                );

                // Return it
                return $linkContent;
        }

        protected final function setLinkName ($linkName) {
                $this->linkName = (string) $linkName;
        }

        public final function getLinkName () {
                return $this->linkName;
        }

        protected final function setLinkBase ($linkBase) {
                $this->linkBase = (string) $linkBase;
        }

        public final function getLinkBase () {
                return $this->linkBase;
        }

        public function flushContent () {
                // Is a previous opened group still open?
                if ($this->ifGroupOpenedPreviously()) {
                        // Then close it
                        $this->closePreviousGroupByContent("");
                } // END - if

                // Get the content
                $content = $this->renderContent();

                // Get template engine
                $templateInstance = $this->getTemplateInstance();

                // Add content to variable
                $templateInstance->assignVariable($this->getLinkName(), $content);
        }

        public function addLinkGroup ($groupId, $groupText, $groupCode = "div") {
                // Is a group with that name open?
                if ($this->ifGroupOpenedPreviously()) {
                        // Then close it here
                        $this->closePreviousGroupByContent("");
                } // END - if

                // Generate the group content
                $content = sprintf("<{$groupCode} id=\"group_%s_%s\">%s",
                        $this->getLinkName(),
                        $groupId,
                        $groupText
                );

                // Open the new group
                $this->openGroupByIdContent($groupId, $content, $groupCode);
        }

        public function addLinkNote ($groupId, $groupNote, $groupCode = "div") {
                // Check if a previous group was opened
                if ($this->ifGroupOpenedPreviously() === false) {
                        // No group was opened before!
                        throw new NoGroupOpenedException(array($this, $groupNote), self::EXCEPTION_GROUP_NOT_OPENED);
                } // END - if

                // Is a previous sub group open?
                if ($this->ifSubGroupOpenedPreviously()) {
                        // Then close it
                        $this->closePreviousSubGroupByContent("</{$groupCode}>");
                } // END - if

                // Generate the group content
                $content = sprintf("<{$groupCode} id=\"subgroup_%s_%s\">%s",
                        $this->getLinkName(),
                        $groupId,
                        $groupNote
                );

                // Open the sub group
                $this->openSubGroupByIdContent($groupId, $content, $groupCode);
        }

        protected function addActionLink ($linkAction, $linkText, $linkTitle) {
                // Check if a previous group was opened
                if ($this->ifGroupOpenedPreviously() === false) {
                        // No group was opened before!
                        throw new NoGroupOpenedException(array($this, $linkAction."(".$linkText.")"), self::EXCEPTION_GROUP_NOT_OPENED);
                } // END - if

                // Default parameter seperator is &amp;
                $seperator = "&amp;";

                // Is there a question mark in?
                $linkArray = explode("?", $this->getLinkBase());
                if (count($linkArray) == 0) {
                        // No question mark
                        $seperator = "?";
                } // END - if

                // Prepare action
                $action = sprintf("%saction=%s",
                        $seperator,
                        $linkAction
                );

                // Renders the link content
                $linkContent = $this->renderLinkContentWithTextExtraContent($linkText, $linkTitle, $action);

                // Add the content to the previous group
                $this->addContentToPreviousGroup($linkContent);
        }

        public function addActionLinkById ($linkAction, $languageId) {
                // Resolve the language string
                $languageResolvedText = $this->getLanguageInstance()->getMessage("link_" . $languageId . "_text");

                // Resolve the language string
                $languageResolvedTitle = $this->getLanguageInstance()->getMessage("link_" . $languageId . "_title");

                // Add the action link
                $this->addActionLink($linkAction, $languageResolvedText, $languageResolvedTitle);
        }

        public function addLinkWithTextById ($languageId) {
                // Resolve the language string
                $languageResolvedText = $this->getLanguageInstance()->getMessage("link_" . $languageId . "_text");

                // Resolve the language string
                $languageResolvedTitle = $this->getLanguageInstance()->getMessage("link_" . $languageId . "_title");

                // Now add the link
                $linkContent = $this->renderLinkContentWithTextExtraContent($languageResolvedText, $languageResolvedTitle);

                // Add the content to the previous group
                $this->addContentToPreviousGroup($linkContent);
        }
}

// [EOF]
?>