]> git.mxchange.org Git - core.git/commitdiff
Continued:
authorRoland Häder <roland@mxchange.org>
Sun, 22 Nov 2020 15:32:20 +0000 (16:32 +0100)
committerRoland Häder <roland@mxchange.org>
Sun, 22 Nov 2020 15:32:20 +0000 (16:32 +0100)
- added missing $templateInstance with getter/setter
- converted old array() to "new" [] style

Signed-off-by: Roland Häder <roland@mxchange.org>
framework/main/classes/helper/html/class_BaseHtmlHelper.php
framework/main/classes/images/class_BaseImage.php
framework/main/classes/mailer/class_BaseMailer.php
framework/main/classes/menu/class_BaseMenu.php
framework/main/classes/template/menu/class_MenuTemplateEngine.php

index 23862b4e9073f3e593168214f066772e4eee61c2..f2928b9b65c7a2ed5cc10a9f0e37e61a0225ba75 100644 (file)
@@ -4,6 +4,7 @@ namespace Org\Mxchange\CoreFramework\Helper;
 
 // Import framework stuff
 use Org\Mxchange\CoreFramework\Helper\BaseHelper;
+use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
 
 /**
  * A general purpose web helper. You should not instance this like all the other
@@ -29,6 +30,12 @@ use Org\Mxchange\CoreFramework\Helper\BaseHelper;
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 abstract class BaseHtmlHelper extends BaseHelper {
+
+       /**
+        * Template engine instance
+        */
+       private $templateInstance = NULL;
+
        /**
         * Protected constructor
         *
@@ -40,4 +47,23 @@ abstract class BaseHtmlHelper extends BaseHelper {
                parent::__construct($className);
        }
 
+       /**
+        * Setter for template engine instances
+        *
+        * @param       $templateInstance       An instance of a CompileableTemplate class
+        * @return      void
+        */
+       protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
+               $this->templateInstance = $templateInstance;
+       }
+
+       /**
+        * Getter for template engine instances
+        *
+        * @return      $templateInstance       An instance of a CompileableTemplate class
+        */
+       public final function getTemplateInstance () {
+               return $this->templateInstance;
+       }
+
 }
index cb08935a0192d39382e5d17e483f4621d80e16ad..df66bc4d3de8f64a7a57ade9d04c9b73ccb62758 100644 (file)
@@ -5,6 +5,7 @@ namespace Org\Mxchange\CoreFramework\Image;
 // Import framework stuff
 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
 use Org\Mxchange\CoreFramework\Registry\Registerable;
+use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
 
 /**
  * A general image class
@@ -63,20 +64,20 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
        /**
         * Background color in RGB
         */
-       private $backgroundColor = array(
+       private $backgroundColor = [
                'red'   => '',
                'green' => '',
                'blue'  => ''
-       );
+       ];
 
        /**
         * Foreground color in RGB
         */
-       private $foregroundColor = array(
+       private $foregroundColor = [
                'red'   => '',
                'green' => '',
                'blue'  => ''
-       );
+       ];
 
        /**
         * Current choosen color array
@@ -103,6 +104,11 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         */
        private $groupable = 'single';
 
+       /**
+        * Template engine instance
+        */
+       private $templateInstance = NULL;
+
        /**
         * Protected constructor
         *
@@ -121,7 +127,7 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @param       $colorChannel   Red, green or blue channel?
         * @param       $colorValue             Value to set
         */
-       private final function setColor ($colorMode, $colorChannel, $colorValue) {
+       private final function setColor (string $colorMode, string $colorChannel, $colorValue) {
                // Construct the eval() command
                $eval = sprintf("\$this->%s['%s'] = \"%s\";",
                        $colorMode,
@@ -140,7 +146,7 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @param       $width  Width of the image
         * @return      void
         */
-       public final function setWidth ($width) {
+       public final function setWidth (int $width) {
                $this->width = $width;
        }
 
@@ -159,7 +165,7 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @param       $height Height of the image
         * @return      void
         */
-       public final function setHeight ($height) {
+       public final function setHeight (int $height) {
                $this->height = $height;
        }
 
@@ -267,7 +273,7 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @return      void
         * @todo        Find something usefull for this method.
         */
-       public function initImageString ($groupable = 'single') {
+       public function initImageString (string $groupable = 'single') {
                $this->groupable = $groupable;
        }
 
@@ -288,11 +294,8 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @return      void
         */
        public final function setRed ($red) {
-               // Get array name
-               $arrayName = $this->colorMode;
-
                // Set image color
-               $this->setColor($arrayName, 'red', $red);
+               $this->setColor($this->colorMode, 'red', $red);
        }
 
        /**
@@ -302,11 +305,8 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @return      void
         */
        public final function setGreen ($green) {
-               // Get array name
-               $arrayName = $this->colorMode;
-
                // Set image color
-               $this->setColor($arrayName, 'green', $green);
+               $this->setColor($this->colorMode, 'green', $green);
        }
 
        /**
@@ -316,11 +316,8 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @return      void
         */
        public final function setBlue ($blue) {
-               // Get array name
-               $arrayName = $this->colorMode;
-
                // Set image color
-               $this->setColor($arrayName, 'blue', $blue);
+               $this->setColor($this->colorMode, 'blue', $blue);
        }
 
        /**
@@ -348,8 +345,8 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @param       $imageType              Type to set in image
         * @return      void
         */
-       protected final function setImageType ($imageType) {
-               $this->imageType = (string) $imageType;
+       protected final function setImageType (string $imageType) {
+               $this->imageType = $imageType;
        }
 
        /**
@@ -395,7 +392,7 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @param       $x      X coordinate
         * @return      void
         */
-       public final function setX ($x) {
+       public final function setX (int $x) {
                $this->x = $x;
        }
 
@@ -414,7 +411,7 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @param       $y      Y coordinate
         * @return      void
         */
-       public final function setY ($y) {
+       public final function setY (int $y) {
                $this->y = $y;
        }
 
@@ -433,7 +430,7 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @param       $fontSize       Font size for strings
         * @return      void
         */
-       public final function setFontSize ($fontSize) {
+       public final function setFontSize (int $fontSize) {
                $this->fontSize = $fontSize;
        }
 
@@ -452,10 +449,29 @@ abstract class BaseImage extends BaseFrameworkSystem implements Registerable {
         * @param       $stringName             String name to set
         * @return      void
         */
-       public final function setStringName($stringName) {
+       public final function setStringName(string $stringName) {
                $this->stringName = $stringName;
        }
 
+       /**
+        * Setter for template engine instances
+        *
+        * @param       $templateInstance       An instance of a CompileableTemplate class
+        * @return      void
+        */
+       protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
+               $this->templateInstance = $templateInstance;
+       }
+
+       /**
+        * Getter for template engine instances
+        *
+        * @return      $templateInstance       An instance of a CompileableTemplate class
+        */
+       public final function getTemplateInstance () {
+               return $this->templateInstance;
+       }
+
        /**
         * Finish this image by producing it
         *
index 1d675b77ad093d42fdf854542067e9c310ad1611..70c6bcd93a1f97dde6ae062f16a073c273fdaf72 100644 (file)
@@ -7,6 +7,7 @@ use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
 use Org\Mxchange\CoreFramework\Manager\Login\ManageableMember;
 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
+use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
 
 /**
  * A general mailer class for all other mailers
@@ -36,6 +37,11 @@ abstract class BaseMailer extends BaseFrameworkSystem {
         */
        private $templateName = '';
 
+       /**
+        * Template engine instance
+        */
+       private $templateInstance = NULL;
+
        /**
         * Protected constructor
         *
@@ -197,4 +203,23 @@ abstract class BaseMailer extends BaseFrameworkSystem {
                return $this->getGenericArray('recipients');
        }
 
+       /**
+        * Setter for template engine instances
+        *
+        * @param       $templateInstance       An instance of a CompileableTemplate class
+        * @return      void
+        */
+       protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
+               $this->templateInstance = $templateInstance;
+       }
+
+       /**
+        * Getter for template engine instances
+        *
+        * @return      $templateInstance       An instance of a CompileableTemplate class
+        */
+       public final function getTemplateInstance () {
+               return $this->templateInstance;
+       }
+
 }
index faa79d4992ee54b43eed709860defa74d7a1a111..03879712a18bae144e15ff85aa493b692ca677e1 100644 (file)
@@ -33,6 +33,12 @@ use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 abstract class BaseMenu extends BaseFrameworkSystem {
+
+       /**
+        * Template engine instance
+        */
+       private $templateInstance = NULL;
+
        /**
         * Protected constructor
         *
@@ -44,6 +50,25 @@ abstract class BaseMenu extends BaseFrameworkSystem {
                parent::__construct($className);
        }
 
+       /**
+        * Setter for template engine instances
+        *
+        * @param       $templateInstance       An instance of a CompileableTemplate class
+        * @return      void
+        */
+       protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
+               $this->templateInstance = $templateInstance;
+       }
+
+       /**
+        * Getter for template engine instances
+        *
+        * @return      $templateInstance       An instance of a CompileableTemplate class
+        */
+       public final function getTemplateInstance () {
+               return $this->templateInstance;
+       }
+
        /**
         * Renders the menu by loading the base template and a menu-specific
         * template.
index efca88bc19f219a22ffdcdc0dde4904edda913f4..a0f8af2cdc69d92055b2083c8bc4997b7092b007 100644 (file)
@@ -43,14 +43,14 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
        /**
         * Main nodes in the XML tree ('menu' is ignored)
         */
-       private $mainNodes = array(
+       private $mainNodes = [
                'block-list',
-       );
+       ];
 
        /**
         * Sub nodes in the XML tree
         */
-       private $subNodes = array(
+       private $subNodes = [
                'entry-list',
                'entry',
                'entry-id',
@@ -73,12 +73,12 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                'anchor-text',
                'anchor-title',
                'anchor-href',
-       );
+       ];
 
        /**
         * Variables for a menu entry
         */
-       private $menuEntryVariables = array(
+       private $menuEntryVariables = [
                // List entry
                'entry_id',
                // Anchor
@@ -86,12 +86,12 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                'anchor-text',
                'anchor-title',
                'anchor-href',
-       );
+       ];
 
        /**
         * Variables for a menu block
         */
-       private $menuBlockVariables = array(
+       private $menuBlockVariables = [
                // Title
                'title_id',
                'title_class',
@@ -101,33 +101,38 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                'footer_id',
                'footer_class',
                'footer_text',
-       );
+       ];
 
        /**
         * Rendered menu entries
         */
-       private $menuEntries = array();
+       private $menuEntries = [];
 
        /**
         * Rendered menu blocks
         */
-       private $menuBlocks = array();
+       private $menuBlocks = [];
 
        /**
         * Current main node
         */
-       private $curr = array();
+       private $curr = [];
 
        /**
         * Content from dependency
         */
-       private $dependencyContent = array();
+       private $dependencyContent = [];
 
        /**
         * Instance of a menu
         */
        private $menuInstance = NULL;
 
+       /**
+        * Template engine instance
+        */
+       private $templateInstance = NULL;
+
        /**
         * Protected constructor
         *
@@ -218,6 +223,25 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                return $this->menuInstance;
        }
 
+       /**
+        * Setter for template engine instances
+        *
+        * @param       $templateInstance       An instance of a CompileableTemplate class
+        * @return      void
+        */
+       protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
+               $this->templateInstance = $templateInstance;
+       }
+
+       /**
+        * Getter for template engine instances
+        *
+        * @return      $templateInstance       An instance of a CompileableTemplate class
+        */
+       public final function getTemplateInstance () {
+               return $this->templateInstance;
+       }
+
        /**
         * Load a specified menu template into the engine
         *
@@ -862,7 +886,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                array_push($this->menuBlocks, $this->getTemplateInstance()->getRawTemplateData());
 
                // Reset rendered menu entries array
-               $this->menuEntries = array();
+               $this->menuEntries = [];
        }
 
        /**
@@ -875,7 +899,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                $menuContent = implode('', $this->menuBlocks);
 
                // Clean variable
-               $this->menuBlocks = array();
+               $this->menuBlocks = [];
 
                // And return it
                return $menuContent;