class_BaseHelper.php

Go to the documentation of this file.

<?php
class BaseHelper extends BaseFrameworkSystem {
        private $valueInstance = null;

        private $content = "";

        private $groups = array();

        private $subGroups = array();

        private $previousGroupId = "";

        private $previousSubGroupId = "";

        private $totalCounter = 0;

        // Exception constants
        const EXCEPTION_XML_PARSER_ERROR             = 0x1e0;
        const EXCEPTION_XML_NODE_UNKNOWN             = 0x1e1;
        const EXCEPTION_XML_NODE_MISMATCH            = 0x1e2;
        const EXCEPTION_GROUP_NOT_OPENED             = 0x1e3;
        const EXCEPTION_GROUP_ALREADY_FOUND          = 0x1e4;
        const EXCEPTION_SUB_GROUP_ALREADY_FOUND      = 0x1e5;
        const EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED = 0x1e6;
        const EXCEPTION_NO_PREVIOUS_GROUP_OPENED     = 0x1e7;

        protected function __construct ($className) {
                // Call parent constructor
                parent::__construct($className);

                // Clean up a little
                $this->removeNumberFormaters();
                $this->removeSystemArray();
        }

        protected final function addContent ($newContent) {
                $this->content .= (string) trim($newContent)."\n";
        }

        protected function addHeaderContent ($content) {
                // Add the header content
                $this->groups['header']['content'] = (string) trim($content);
        }

        protected function addFooterContent ($content) {
                // Add the footer content
                $this->groups['footer']['content'] = (string) trim($content);
        }

        protected final function addContentToPreviousGroup ($newContent) {
                // Check for sub/group
                if ($this->ifSubGroupOpenedPreviously()) {
                        // Get sub group id
                        $subGroupId = $this->getPreviousSubGroupId();

                        // Add the content
                        $this->subGroups[$subGroupId]['content'] .= $newContent;
                } elseif ($this->ifGroupOpenedPreviously()) {
                        // Get group id
                        $groupId = $this->getPreviousGroupId();

                        // Add the content
                        $this->groups[$groupId]['content'] .= $newContent;
                } else {
                        // Add it directly
                        $this->addContent($newContent);
                }
        }

        protected final function getContent () {
                return $this->content;
        }

        public function assignField ($fieldName) {
                // Get the value from value instance
                $fieldValue = $this->getValueField($fieldName);

                // Assign it with a template variable
                $this->getTemplateInstance()->assignVariable('block_' . $fieldName, $fieldValue);
        }

        public function assignFieldWithFilter ($fieldName, $filterMethod) {
                // Get the value
                $fieldValue = $this->getValueField($fieldName);

                // Now filter it through the value through the filter method
                $filteredValue = call_user_func_array(array($this, 'doFilter' . $this->convertToClassName($filterMethod)), array($fieldValue));

                // Assign it with a template variable
                $this->getTemplateInstance()->assignVariable('block_' . $fieldName, $filteredValue);
        }

        public function prefetchValueInstance ($registryKey, $extraKey = null) {
                // Get the required instance
                $this->valueInstance = Registry::getRegistry()->getInstance($registryKey);

                // Is the value instance valid?
                if (is_null($this->valueInstance)) {
                        // Try to create it "from scratch", by first init extra instance
                        $extraInstance = null;

                        // Shall we get an extra instance?
                        if (!is_null($extraKey)) {
                                // Get the extra instance.
                                $extraInstance = Registry::getRegistry()->getInstance($extraKey);
                        } // END - if

                        // Get the requested instance
                        try {
                                $this->valueInstance = ObjectFactory::createObjectByConfiguredName($registryKey . '_class', array($extraInstance));

                        } catch (FrameworkException $e) {
                                // Okay, nothing found so throw a null pointer exception here
                                throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
                        }
                } // END - if
        }

        protected function openGroupByIdContent ($groupId, $content, $tag) {
                //* DEBUG: */ echo "OPEN:groupId={$groupId},content=<pre>".htmlentities($content)."</pre>\n";
                // Is the group already there?
                if (isset($this->groups[$groupId])) {
                        // Then throw an exception here
                        throw new HelperGroupAlreadyCreatedException(array($this, $groupId), self::EXCEPTION_GROUP_ALREADY_FOUND);
                } // END - if

                // Count one up
                $this->totalCounter++;

                // Add the group to the stack
                $this->groups[$this->totalCounter] = $groupId;
                $this->groups[$groupId]['opened']  = true;
                $this->groups[$groupId]['content'] = sprintf("<!-- group %s opened (length: %s, tag: %s) //-->%s\n", $groupId, strlen($content), $tag, $content);
                $this->groups[$groupId]['tag'] = $tag;

                // Mark this group as previously opened
                $this->setPreviousGroupId($groupId);
        }

        public function closePreviousGroupByContent ($content = "") {
                // Check if any sub group was opened before
                if ($this->ifSubGroupOpenedPreviously()) {
                        // Close it automatically
                        $this->closePreviousSubGroupByContent();
                } // END - if

                // Check if any group was opened before
                if ($this->ifGroupOpenedPreviously() === false) {
                        // Then throw an exception
                        throw new HelperNoPreviousOpenedGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
                } // END - if

                // Get previous group
                $groupId = $this->getPreviousGroupId();

                // Is the content empty?
                if ((empty($content)) && (!empty($this->groups[$groupId]['tag']))) {
                        // Get it from opener
                        $content = sprintf("<!-- group %s auto-closed //--></%s>", $groupId, $this->groups[$groupId]['tag']);
                } // END - if

                // Add content to it and mark it as closed
                $this->groups[$groupId]['content'] .= sprintf("<!-- group %s closed (length: %s, tag: %s) //-->%s\n", $groupId, strlen($content), $this->groups[$groupId]['tag'], $content);
                $this->groups[$groupId]['opened'] = false;

                // Mark previous group as closed
                $this->setPreviousGroupId("");
                //* DEBUG: */ echo "CLOSE:groupId={$groupId}<br />\n";
        }

        protected function openSubGroupByIdContent ($subGroupId, $content, $tag) {
                //* DEBUG: */ echo "OPEN:subGroupId={$subGroupId},content=".htmlentities($content)."<br />\n";
                // Is the group already there?
                if (isset($this->subGroups[$subGroupId])) {
                        // Then throw an exception here
                        throw new HelperSubGroupAlreadyCreatedException(array($this, $subGroupId), self::EXCEPTION_SUB_GROUP_ALREADY_FOUND);
                } // END - if

                // Count one up
                $this->totalCounter++;

                // Add the group to the stack
                $this->subGroups[$this->totalCounter] = $subGroupId;
                $this->subGroups[$subGroupId]['opened']  = true;
                $this->subGroups[$subGroupId]['content'] = sprintf("<!-- sub-group %s opened (length: %s, tag: %s) //-->%s\n", $subGroupId, strlen($content), $tag, $content);
                $this->subGroups[$subGroupId]['tag'] = $tag;

                // Mark this group as previously opened
                $this->setPreviousSubGroupId($subGroupId);
        }

        public function closePreviousSubGroupByContent ($content = "") {
                // Check if any sub group was opened before
                if ($this->ifSubGroupOpenedPreviously() === false) {
                        // Then throw an exception
                        throw new HelperNoPreviousOpenedSubGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
                } // END - if

                // Get previous sub group
                $subGroupId = $this->getPreviousSubGroupId();

                // Is the content empty?
                if ((empty($content)) && (!empty($this->subGroups[$subGroupId]['tag']))) {
                        // Get it from opener
                        $content = sprintf("<!-- sub-group %s auto-closed //--></%s>", $subGroupId, $this->subGroups[$subGroupId]['tag']);
                } // END - if

                // Add content to it and mark it as closed
                $this->subGroups[$subGroupId]['content'] .= sprintf("<!-- sub-group %s closed (length: %s, tag: %s) //-->%s\n", $subGroupId, strlen($content), $this->subGroups[$subGroupId]['tag'], $content);
                $this->subGroups[$subGroupId]['opened'] = false;

                // Mark previous sub group as closed
                $this->setPreviousSubGroupId("");
                //* DEBUG: */ echo "CLOSE:subGroupId={$subGroupId}<br />\n";
        }

        public function renderContent () {
                // Initialize content
                $content = "";

                // Is header content there?
                if (isset($this->groups['header'])) {
                        // Then add it
                        $content .= $this->groups['header']['content']."\n";
                } // END - if

                // Initiate content
                $content .= $this->getContent();

                // Now "walk" through all groups and sub-groups
                for ($idx = 1; $idx <= $this->totalCounter; $idx++) {
                        // Is this a group and is it closed?
                        if ((isset($this->groups[$idx])) && ($this->groups[$this->groups[$idx]]['opened'] === false)) {
                                // Then add it's content
                                $groupContent = trim($this->groups[$this->groups[$idx]]['content']);
                                //* DEBUG: */ echo "group={$this->groups[$idx]},content=<pre>".htmlentities($groupContent)."</pre><br />\n";
                                $content .= $groupContent;
                        } elseif ((isset($this->subGroups[$idx])) && ($this->subGroups[$this->subGroups[$idx]]['opened'] === false)) {
                                // Then add it's content
                                $subGroupContent = $this->subGroups[$this->subGroups[$idx]]['content'];
                                //* DEBUG: */ echo "subgroup={$this->subGroups[$idx]},content=<pre>".htmlentities($subGroupContent)."</pre><br />\n";
                                $content .= trim($subGroupContent);
                        } else {
                                // Something went wrong
                                $this->debugInstance(__METHOD__."(): Something unexpected happened here.");
                        }
                } // END - for

                // Is footer content there?
                if (isset($this->groups['footer'])) {
                        // Then add it
                        $content .= $this->groups['footer']['content']."\n";
                } // END - if

                // Return it
                //* DEBUG: */ echo "content=<pre>".htmlentities($content)."</pre> (".strlen($content).")<br />\n";
                return $content;
        }

        protected function ifGroupIsOpened ($groupId) {
                // Is the group open?
                $isOpened = ((isset($this->groups[$groupId])) && ($this->groups[$groupId]['opened'] === true));

                // Return status
                return $isOpened;
        }

        public function getValueField ($fieldName) {
                // Get the field value
                $fieldValue = call_user_func_array(array($this->valueInstance, 'getField'), array($fieldName));

                // Return it
                return $fieldValue;
        }

        public final function getValueInstance () {
                return $this->valueInstance;
        }

        protected final function ifGroupOpenedPreviously () {
                $groupOpened = (!empty($this->previousGroupId));
                return $groupOpened;
        }

        protected final function ifSubGroupOpenedPreviously () {
                $subGroupOpened = (!empty($this->previousSubGroupId));
                return $subGroupOpened;
        }

        protected final function getPreviousGroupId () {
                return $this->previousGroupId;
        }

        protected final function setPreviousGroupId ($previousGroupId) {
                $this->previousGroupId = (string) $previousGroupId;
        }

        protected final function getPreviousSubGroupId () {
                return $this->previousSubGroupId;
        }

        protected final function setPreviousSubGroupId ($previousSubGroupId) {
                $this->previousSubGroupId = (string) $previousSubGroupId;
        }
}

// [EOF]
?>