inc/classes/main/helper/class_BaseHelper.php

   1 <?php
   2 /**
   3  * A generic helper class with generic methods
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class BaseHelper extends BaseFrameworkSystem {
  25         /**
  26          * Instance to the class which provides field values
  27          */
  28         private $valueInstance = null;
  29
  30         /**
  31          * Rendered content created by the helper class
  32          */
  33         private $content = '';
  34
  35         /**
  36          * Array with groups
  37          */
  38         private $groups = array();
  39
  40         /**
  41          * Array with sub group
  42          */
  43         private $subGroups = array();
  44
  45         /**
  46          * Previously opened group
  47          */
  48         private $previousGroupId = '';
  49
  50         /**
  51          * Previously opened sub group
  52          */
  53         private $previousSubGroupId = '';
  54
  55         /**
  56          * Total counter for groups and sub groups
  57          */
  58         private $totalCounter = 0;
  59
  60         // Exception constants
  61         const EXCEPTION_XML_PARSER_ERROR             = 0x1e0;
  62         const EXCEPTION_XML_NODE_UNKNOWN             = 0x1e1;
  63         const EXCEPTION_XML_NODE_MISMATCH            = 0x1e2;
  64         const EXCEPTION_GROUP_NOT_OPENED             = 0x1e3;
  65         const EXCEPTION_GROUP_ALREADY_FOUND          = 0x1e4;
  66         const EXCEPTION_SUB_GROUP_ALREADY_FOUND      = 0x1e5;
  67         const EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED = 0x1e6;
  68         const EXCEPTION_NO_PREVIOUS_GROUP_OPENED     = 0x1e7;
  69
  70         /**
  71          * Protected constructor
  72          *
  73          * @param       $className      Real name of the class
  74          * @return      void
  75          */
  76         protected function __construct ($className) {
  77                 // Call parent constructor
  78                 parent::__construct($className);
  79         }
  80
  81         /**
  82          * Adds content directly
  83          *
  84          * @param       $newContent             New content to add
  85          * @return      void
  86          */
  87         protected final function addContent ($newContent) {
  88                 $this->content .= (string) trim($newContent) . "\n";
  89         }
  90
  91         /**
  92          * Add header content to the helper
  93          *
  94          * @param       $content        Content to to the base
  95          * @return      void
  96          */
  97         protected function addHeaderContent ($content) {
  98                 // Add the header content
  99                 $this->groups['header']['content'] = (string) trim($content);
 100         }
 101
 102         /**
 103          * Add footer content to the helper
 104          *
 105          * @param       $content        Content to to the base
 106          * @return      void
 107          */
 108         protected function addFooterContent ($content) {
 109                 // Add the footer content
 110                 $this->groups['footer']['content'] = (string) trim($content);
 111         }
 112
 113         /**
 114          * Adds content to the previously opened group or sub group. If a sub group
 115          * was found it will be taken. If no group/sub group is opened at the moment
 116          * the code will be passed to addContent().
 117          *
 118          * @param       $newContent             New content to add
 119          * @return      void
 120          */
 121         protected final function addContentToPreviousGroup ($newContent) {
 122                 // Check for sub/group
 123                 if ($this->ifSubGroupOpenedPreviously()) {
 124                         // Get sub group id
 125                         $subGroupId = $this->getPreviousSubGroupId();
 126
 127                         // Add the content
 128                         $this->subGroups[$subGroupId]['content'] .= $newContent;
 129                 } elseif ($this->ifGroupOpenedPreviously()) {
 130                         // Get group id
 131                         $groupId = $this->getPreviousGroupId();
 132
 133                         // Add the content
 134                         $this->groups[$groupId]['content'] .= $newContent;
 135                 } else {
 136                         // Add it directly
 137                         $this->addContent($newContent);
 138                 }
 139         }
 140
 141         /**
 142          * Getter for content
 143          *
 144          * @return      $content        The rendered content by this helper
 145          */
 146         protected final function getContent () {
 147                 return $this->content;
 148         }
 149
 150         /**
 151          *  Assigns a field from the value instance with a template variable
 152          *
 153          * @param       $fieldName      Name of the field to assign
 154          * @return      void
 155          */
 156         public function assignField ($fieldName) {
 157                 // Get the value from value instance
 158                 $fieldValue = $this->getValueField($fieldName);
 159
 160                 // Assign it with a template variable
 161                 $this->getTemplateInstance()->assignVariable('block_' . $fieldName, $fieldValue);
 162         }
 163
 164         /**
 165          * Assigns a field from the value instance with a template variable but
 166          * parses its content through a given filter method of the value instance
 167          *
 168          * @param       $fieldName              Name of the field to assign
 169          * @param       $filterMethod   Method name to call of the value instance
 170          * @return      void
 171          * @todo        Rewrite this method using a helper class for filtering data
 172          */
 173         public function assignFieldWithFilter ($fieldName, $filterMethod) {
 174                 // Get the value
 175                 $fieldValue = $this->getValueField($fieldName);
 176
 177                 // Now filter it through the value through the filter method
 178                 $filteredValue = call_user_func_array(array($this, 'doFilter' . $this->convertToClassName($filterMethod)), array($fieldValue));
 179
 180                 // Assign it with a template variable
 181                 $this->getTemplateInstance()->assignVariable('block_' . $fieldName, $filteredValue);
 182         }
 183
 184         /**
 185          * Pre-fetches field default values from the given registry key instance into this class
 186          *
 187          * @param       $registryKey    Registry key which holds an object with values
 188          * @param       $extraKey               Extra value instance key used if registryKey is null
 189          * @return      void
 190          * @throws      NullPointerException    If recovery of requested value instance failed
 191          */
 192         public function prefetchValueInstance ($registryKey, $extraKey = null) {
 193                 try {
 194                         // Get the required instance
 195                         $this->valueInstance = Registry::getRegistry()->getInstance($registryKey);
 196                 } catch (NullPointerException $e) {
 197                         // Not set in registry
 198                         // @TODO Try to log it here
 199                 }
 200
 201                 // Is the value instance valid?
 202                 if (is_null($this->valueInstance)) {
 203                         // Try to create it "from scratch", by first init extra instance
 204                         $extraInstance = null;
 205
 206                         // Shall we get an extra instance?
 207                         if (!is_null($extraKey)) {
 208                                 // Get the extra instance.
 209                                 $extraInstance = Registry::getRegistry()->getInstance($extraKey);
 210                         } // END - if
 211
 212                         try {
 213                                 // Get the requested instance
 214                                 $this->valueInstance = ObjectFactory::createObjectByConfiguredName($registryKey . '_class', array($extraInstance));
 215                         } catch (FrameworkException $e) {
 216                                 // Okay, nothing found so throw a null pointer exception here
 217                                 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 218                         }
 219                 } // END - if
 220         }
 221
 222         /**
 223          * Opens a helper group with given group id and content or throws an
 224          * exception if that group is already found regardless if it is open or
 225          * closed.
 226          *
 227          * @param       $groupId        Group id to open
 228          * @param       $content        Initial content to add to the group
 229          * @param       $tag            HTML tag used to open this group
 230          * @return      void
 231          * @throws      HelperGroupAlreadyCreatedException      If the group was already created before
 232          */
 233         protected function openGroupByIdContent ($groupId, $content, $tag) {
 234                 //* DEBUG: */ echo "OPEN:groupId={$groupId},content=<pre>".htmlentities($content)."</pre>\n";
 235                 // Is the group already there?
 236                 if (isset($this->groups[$groupId])) {
 237                         // Then throw an exception here
 238                         throw new HelperGroupAlreadyCreatedException(array($this, $groupId), self::EXCEPTION_GROUP_ALREADY_FOUND);
 239                 } // END - if
 240
 241                 // Count one up
 242                 $this->totalCounter++;
 243
 244                 // Add the group to the stack
 245                 $this->groups[$this->totalCounter] = $groupId;
 246                 $this->groups[$groupId]['opened']  = true;
 247                 $this->groups[$groupId]['content'] = sprintf(
 248                         "<!-- group %s opened (length: %s, tag: %s) //-->%s\n",
 249                         $groupId,
 250                         strlen($content),
 251                         $tag,
 252                         $content
 253                 );
 254                 $this->groups[$groupId]['tag'] = $tag;
 255
 256                 // Mark this group as previously opened
 257                 $this->setPreviousGroupId($groupId);
 258         }
 259
 260         /**
 261          * Closes the previously opened group by added given content to it or
 262          * throws an exception if no previous group was opened
 263          *
 264          * @param       $content        Content for previously opened group, or empty to use tag of opener
 265          * @return      void
 266          * @throws      HelperNoPreviousOpenedGroupException    If no previously opened group was found
 267          */
 268         public function closePreviousGroupByContent ($content = '') {
 269                 // Check if any sub group was opened before
 270                 if ($this->ifSubGroupOpenedPreviously()) {
 271                         // Close it automatically
 272                         $this->closePreviousSubGroupByContent();
 273                 } // END - if
 274
 275                 // Check if any group was opened before
 276                 if ($this->ifGroupOpenedPreviously() === false) {
 277                         // Then throw an exception
 278                         throw new HelperNoPreviousOpenedGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
 279                 } // END - if
 280
 281                 // Get previous group
 282                 $groupId = $this->getPreviousGroupId();
 283
 284                 // Is the content empty?
 285                 if ((empty($content)) && (!empty($this->groups[$groupId]['tag']))) {
 286                         // Get it from opener
 287                         $content = sprintf(
 288                                 "<!-- group %s auto-closed //--></%s>",
 289                                 $groupId,
 290                                 $this->groups[$groupId]['tag']
 291                         );
 292                 } // END - if
 293
 294                 // Add content to it and mark it as closed
 295                 $this->groups[$groupId]['content'] .= sprintf(
 296                         "<!-- group %s closed (length: %s, tag: %s) //-->%s\n",
 297                         $groupId,
 298                         strlen($content),
 299                         $this->groups[$groupId]['tag'],
 300                         $content
 301                 );
 302                 $this->groups[$groupId]['opened'] = false;
 303
 304                 // Mark previous group as closed
 305                 $this->setPreviousGroupId('');
 306                 //* DEBUG: */ echo "CLOSE:groupId={$groupId}<br />\n";
 307         }
 308
 309         /**
 310          * Opens a helper sub group with given group id and content or throws an
 311          * exception if that sub group is already found regardless if it is open or
 312          * closed.
 313          *
 314          * @param       $subGroupId             Sub group id to open
 315          * @param       $content                Initial content to add to the sub group
 316          * @param       $tag                    HTML tag used to open this group
 317          * @return      void
 318          * @throws      HelperSubGroupAlreadyCreatedException   If the sub group was already created before
 319          */
 320         protected function openSubGroupByIdContent ($subGroupId, $content, $tag) {
 321                 //* DEBUG: */ echo "OPEN:subGroupId={$subGroupId},content=".htmlentities($content)."<br />\n";
 322                 // Is the group already there?
 323                 if (isset($this->subGroups[$subGroupId])) {
 324                         // Then throw an exception here
 325                         throw new HelperSubGroupAlreadyCreatedException(array($this, $subGroupId), self::EXCEPTION_SUB_GROUP_ALREADY_FOUND);
 326                 } // END - if
 327
 328                 // Count one up
 329                 $this->totalCounter++;
 330
 331                 // Add the group to the stack
 332                 $this->subGroups[$this->totalCounter] = $subGroupId;
 333                 $this->subGroups[$subGroupId]['opened']  = true;
 334                 $this->subGroups[$subGroupId]['content'] = sprintf("<!-- sub-group %s opened (length: %s, tag: %s) //-->%s\n", $subGroupId, strlen($content), $tag, $content);
 335                 $this->subGroups[$subGroupId]['tag'] = $tag;
 336
 337                 // Mark this group as previously opened
 338                 $this->setPreviousSubGroupId($subGroupId);
 339         }
 340
 341         /**
 342          * Closes the previously opened sub group by added given content to it or
 343          * throws an exception if no previous sub group was opened
 344          *
 345          * @param       $content        Content for previously opened sub group, or leave empty to use div/span of openener
 346          * @return      void
 347          * @throws      HelperNoPreviousOpenedSubGroupException If no previously opened sub group was found
 348          */
 349         public function closePreviousSubGroupByContent ($content = '') {
 350                 // Check if any sub group was opened before
 351                 if ($this->ifSubGroupOpenedPreviously() === false) {
 352                         // Then throw an exception
 353                         throw new HelperNoPreviousOpenedSubGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
 354                 } // END - if
 355
 356                 // Get previous sub group
 357                 $subGroupId = $this->getPreviousSubGroupId();
 358
 359                 // Is the content empty?
 360                 if ((empty($content)) && (!empty($this->subGroups[$subGroupId]['tag']))) {
 361                         // Get it from opener
 362                         $content = sprintf("<!-- sub-group %s auto-closed //--></%s>", $subGroupId, $this->subGroups[$subGroupId]['tag']);
 363                 } // END - if
 364
 365                 // Add content to it and mark it as closed
 366                 $this->subGroups[$subGroupId]['content'] .= sprintf("<!-- sub-group %s closed (length: %s, tag: %s) //-->%s\n", $subGroupId, strlen($content), $this->subGroups[$subGroupId]['tag'], $content);
 367                 $this->subGroups[$subGroupId]['opened'] = false;
 368
 369                 // Mark previous sub group as closed
 370                 $this->setPreviousSubGroupId('');
 371                 //* DEBUG: */ echo "CLOSE:subGroupId={$subGroupId}<br />\n";
 372         }
 373
 374         /**
 375          * Renders all group and sub group in their order
 376          *
 377          * @return      $content        Rendered HTML content
 378          */
 379         public function renderContent () {
 380                 // Initialize content
 381                 $content = '';
 382
 383                 // Is header content there?
 384                 if (isset($this->groups['header'])) {
 385                         // Then add it
 386                         $content .= $this->groups['header']['content'] . "\n";
 387                 } // END - if
 388
 389                 // Initiate content
 390                 $content .= $this->getContent();
 391
 392                 // Now "walk" through all groups and sub-groups
 393                 for ($idx = 1; $idx <= $this->totalCounter; $idx++) {
 394                         // Is this a group and is it closed?
 395                         if ((isset($this->groups[$idx])) && ($this->groups[$this->groups[$idx]]['opened'] === false)) {
 396                                 // Then add it's content
 397                                 $groupContent = trim($this->groups[$this->groups[$idx]]['content']);
 398                                 //* DEBUG: */ echo "group={$this->groups[$idx]},content=<pre>".htmlentities($groupContent)."</pre><br />\n";
 399                                 $content .= $groupContent;
 400                         } elseif ((isset($this->subGroups[$idx])) && ($this->subGroups[$this->subGroups[$idx]]['opened'] === false)) {
 401                                 // Then add it's content
 402                                 $subGroupContent = $this->subGroups[$this->subGroups[$idx]]['content'];
 403                                 //* DEBUG: */ echo "subgroup={$this->subGroups[$idx]},content=<pre>".htmlentities($subGroupContent)."</pre><br />\n";
 404                                 $content .= trim($subGroupContent);
 405                         } else {
 406                                 // Something went wrong
 407                                 $this->debugInstance(__METHOD__."(): Something unexpected happened here.");
 408                         }
 409                 } // END - for
 410
 411                 // Is footer content there?
 412                 if (isset($this->groups['footer'])) {
 413                         // Then add it
 414                         $content .= $this->groups['footer']['content'] . "\n";
 415                 } // END - if
 416
 417                 // Return it
 418                 //* DEBUG: */ echo "content=<pre>".htmlentities($content)."</pre> (".strlen($content).")<br />\n";
 419                 return $content;
 420         }
 421
 422         /**
 423          * Checks wether the specified group is opened
 424          *
 425          * @param       $groupId        Id of group to check
 426          * @return      $isOpened       Wether the specified group is open
 427          */
 428         protected function ifGroupIsOpened ($groupId) {
 429                 // Is the group open?
 430                 $isOpened = ((isset($this->groups[$groupId])) && ($this->groups[$groupId]['opened'] === true));
 431
 432                 // Return status
 433                 return $isOpened;
 434         }
 435
 436         /**
 437          * Getter for direct field values
 438          *
 439          * @param       $fieldName              Name of the field we shall fetch
 440          * @return      $fieldValue             Value from field
 441          */
 442         public function getValueField ($fieldName) {
 443                 // Get the field value
 444                 $fieldValue = call_user_func($this->valueInstance->__toString() . '::getField', array($fieldName));
 445
 446                 // Return it
 447                 return $fieldValue;
 448         }
 449
 450         /**
 451          * Getter for value instance
 452          *
 453          * @return      $valueInstance  Instance of the class holding our values
 454          */
 455         public final function getValueInstance () {
 456                 return $this->valueInstance;
 457         }
 458
 459         /**
 460          * Check wether a group was opened previously
 461          *
 462          * @return      $groupOpened    Wether any group was opened before
 463          */
 464         protected final function ifGroupOpenedPreviously () {
 465                 $groupOpened = (!empty($this->previousGroupId));
 466                 return $groupOpened;
 467         }
 468
 469         /**
 470          * Check wether a group was opened previously
 471          *
 472          * @return      $subGroupOpened         Wether any group was opened before
 473          */
 474         protected final function ifSubGroupOpenedPreviously () {
 475                 $subGroupOpened = (!empty($this->previousSubGroupId));
 476                 return $subGroupOpened;
 477         }
 478
 479         /**
 480          * Getter for previous group id
 481          *
 482          * @return      $previousGroupId        Id of previously opened group
 483          */
 484         protected final function getPreviousGroupId () {
 485                 return $this->previousGroupId;
 486         }
 487
 488         /**
 489          * Setter for previous group id
 490          *
 491          * @param       $previousGroupId        Id of previously opened group
 492          * @return      void
 493          */
 494         protected final function setPreviousGroupId ($previousGroupId) {
 495                 $this->previousGroupId = (string) $previousGroupId;
 496         }
 497
 498         /**
 499          * Getter for previous sub group id
 500          *
 501          * @return      $previousSubGroupId             Id of previously opened sub group
 502          */
 503         protected final function getPreviousSubGroupId () {
 504                 return $this->previousSubGroupId;
 505         }
 506
 507         /**
 508          * Setter for previous sub group id
 509          *
 510          * @param       $previousSubGroupId             Id of previously opened sub group
 511          * @return      void
 512          */
 513         protected final function setPreviousSubGroupId ($previousSubGroupId) {
 514                 $this->previousSubGroupId = (string) $previousSubGroupId;
 515         }
 516 }
 517
 518 // [EOF]
 519 ?>