class_WebBlockHelper.php

Go to the documentation of this file.

<?php
class WebBlockHelper extends BaseWebHelper implements HelpableTemplate {
        private $blockName = "";

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

        public final static function createWebBlockHelper (CompileableTemplate $templateInstance, $blockName) {
                // Get new instance
                $helperInstance = new WebBlockHelper();

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

                // Set block name
                $helperInstance->setBlockName($blockName);

                // Return the prepared instance
                return $helperInstance;
        }

        protected final function setBlockName ($blockName) {
                $this->blockName = (string) $blockName;
        }

        public final function getBlockName () {
                return $this->blockName;
        }

        public function ifIncludeRegistrationStamp () {
                $withRegistration = ($this->getConfigInstance()->readConfig('block_shows_registration') === "Y");
                return $withRegistration;
        }

        public function assignMessageField ($templateVariable, $messageId) {
                // Get message
                $message = $this->getLanguageInstance()->getMessage($messageId);

                // And assign it
                $this->getTemplateInstance()->assignVariable($templateVariable, $message);
        }

        public function assignLinkFieldWithAction ($linkField, $actionValue) {
                $this->getTemplateInstance()->assignVariable($linkField . '_action', $actionValue);
        }

        protected function doFilterUserStatusTranslator ($userStatus) {
                // Generate message id
                $messageId = 'user_status_' . strtolower($userStatus);

                // Get that message
                $translated = $this->getLanguageInstance()->getMessage($messageId);

                // Return it
                return $translated;
        }

        public function flushContent () {
                // Get template instance
                $templateInstance = $this->getTemplateInstance();

                // Get the template named like this block
                $templateInstance->loadCodeTemplate("block_" . $this->getBlockName());

                // Transfer it to the template instance
                $templateInstance->assignVariable($this->getBlockName(), $templateInstance->getRawTemplateData());
        }
}

// [EOF]
?>