Merge pull request #18 from deanblackborough/v0.65

V0.65

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Full changelog for Zend Framework 3 view helpers library.
 
+## v0.65.0 - Base class - 2017-10-11
+
+* Additional tests for Bootstrap 4 Progress bar view helper.
+* Added a base class for Bootstrap 4 view helpers, Progress bar now extends it for base functionality.
+* Minor changes to method names.
+
 ## v0.64.0 - Tests and Jumbotron - 2017-10-11
 
 * Added tests for Bootstrap 4 Jumbotron view helper.

README.md

@@ -18,7 +18,7 @@ A collection of Zend Framework 3 view helpers, primarily focused on Bootstrap 3
 * Bootstrap 4 Card component
 * Bootstrap 4 Jumbotron component - [26 tests]
 * Bootstrap 4 Navbar component (lite)
-* Bootstrap 4 Progress bar component - [17 tests]
+* Bootstrap 4 Progress bar component - [27 tests]
 * Bootstrap 4 Multiple progress bar component
 
 ### Bootstrap 3
@@ -151,7 +151,7 @@ echo $this->bootstrap4NavbarLite()->
 
 ### Bootstrap 4 progress bar
 
-Create a progress bar
+Create a progress bar component.
 
 ##### Public methods 
 
@@ -177,9 +177,10 @@ Create a progress bar with multiple bars
 ##### Public methods 
 
 * animate() - Animate the striped background style
-* colors() - Set the background colors for the progress bar
-* height() - Set the height of the progress bar
-* label() - Set the label for the progress bar
+* setBgStyle() - Set the background colour utility class
+* setHeight() - Set the height of the progress bar
+* setLabel() - Set the label to display in the progress bar
+* setTextStyle() - Set the text colour utility class
 * striped() - Enable the striped style for the progress bar background
 
 #### Example

src/Bootstrap4Helper.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DBlackborough\Zf3ViewHelpers;
+
+use Zend\View\Helper\AbstractHelper;
+
+/**
+ * Generate a Bootstrap 4 progress bar
+ *
+ * @package DBlackborough\Zf3ViewHelpers
+ * @author Dean Blackborough <dean@g3d-development.com>
+ * @copyright Dean Blackborough
+ * @license https://github.com/deanblackborough/zf3-view-helpers/blob/master/LICENSE
+ */
+abstract class Bootstrap4Helper extends AbstractHelper
+{
+    /**
+     * @var array Bootstrap styles
+     */
+    protected $supported_bg_styles = [
+        'primary',
+        'secondary',
+        'success',
+        'danger',
+        'warning',
+        'info',
+        'light',
+        'dark',
+        'white'
+    ];
+
+    /**
+     * @var array Bootstrap styles
+     */
+    protected $supported_text_styles = [
+        'primary',
+        'secondary',
+        'success',
+        'danger',
+        'warning',
+        'info',
+        'light',
+        'dark'
+    ];
+
+    /**
+     * @var string Assign an alternate background colour for the component
+     */
+    protected $bg_color;
+
+    /**
+     * @var string Assign an alternate text colour for the component
+     */
+    protected $text_color;
+
+    /**
+     * Override the __toString() method to allow echo/print of the view helper directly,
+     * saves a call to render()
+     *
+     * @return string
+     */
+    public function __toString() : string
+    {
+        return $this->render();
+    }
+
+    /**
+     * Validate and assign the background colour, needs to be one of the following, primary, secondary, success,
+     * danger, warning, info, light, dark or white, if an incorrect style is passed in we don't apply the class.
+     *
+     * @param string $color
+     */
+    protected function assignBgStyle(string $color)
+    {
+        if (in_array($color, $this->supported_bg_styles) === true) {
+            $this->bg_color = $color;
+        }
+    }
+
+    /**
+     * Validate and assign the text colour, need to be one of the following, primary, secondary, success, danger,
+     * warning, info, light or dark, if an incorrect style is passed in we don't apply the class.
+     *
+     * @param string $color
+     */
+    protected function assignTextStyle(string $color)
+    {
+        if (in_array($color, $this->supported_text_styles) === true) {
+            $this->text_color = $color;
+        }
+    }
+
+    /**
+     * Worker method for the view helper, generates the HTML, the method is protected, called by __toString when
+     * echo or print are called on the view helper
+     *
+     * @return string
+     */
+    protected function render() : string
+    {
+        return $this->__toString();
+    }
+}