newsletter.php

Go to the documentation of this file.

<?php
namespace YAWK\WIDGETS\NEWSLETTER\SUBSCRIBE
{
    /**
     * @details<b>Let your users subscribe to a newsletter database.</b>
     *
     * <p>With this widget, you are able to collect email addresses to build up your newsletter database.
     * The user can enter his email address and (or) his/hers name. The form will be processed via ajax
     * which means the page will not refresh by clicking on submit. Data will be entered in the newsletter
     * database, which other plugins and widgets can access easily. In future releases, it is planned to
     * implement a newsletter plugin, where admins can manage and send newsletters within the backend.</p>
     *
     *
     * @author     Daniel Retzl <[email protected]>
     * @copyright  2018 Daniel Retzl
     * @version    1.0.0
     * @brief Embed any YouTube Video on your pages.
     */
    class newsletter
    {
        /** @param object global widget object data */
        public $widget = '';
        /** @param string Title Text */
        public $newsletterTitle = 'Newsletter';
        /** @param string Thank You Subtext */
        public $newsletterSubtext = 'subscribe';
        /** @param string Thank You Title Text */
        public $newsletterThankYouTitle = 'Thank You';
        /** @param string Thank You SubText */
        public $newsletterThankYouSubtext = 'for subscribing to our newsletter!';
        /** @param string Button Text */
        public $newsletterBtnText = 'Subscribe Newsletter';
        /** @param string Button CSS Class */
        public $newsletterBtnClass = 'btn btn-success';
        /** @param string Name Field Placeholder */
        public $newsletterNamePlaceholder = 'Name';
        /** @param string Email Field Placeholder */
        public $newsletterEmailPlaceholder = 'Email';
        /** @param string Button Button Margin Top */
        public $newsletterBtnMarginTop = '5px';
        /** @param string Button Button Alignment */
        public $newsletterBtnAlign = 'text-center';
        /** @param string Hide Form Labels? */
        public $newsletterHideLabels = 'false';
        /** @param string Newsletter Icon (eg. font awesome or glyphicons) */
        public $newsletterIcon = 'fa fa-envelope-o';
        /** @param string Font size of icon, heading and subtext */
        public $newsletterFontSize = 'h2';
        /** @param string Width of the form elements */
        public $newsletterWidth = '';
        /** @param string Btn Margin HTML Markup */
        public $markupBtnMarginTop = '';
        /** @param string Btn Class HTML Markup */
        public $markupBtnClass = '';
        /** @param string Btn Alignment HTML Markup */
        public $markupBtnAlign = '';
        /** @param string Name Label HTML Markup */
        public $markupNameLabel = '';
        /** @param string Email Label HTML Markup */
        public $markupEmailLabel = '';
        /** @param string Icon HTML Markup */
        public $markupIcon = '';
        /** @param string Font Size (H1-H6) HTML Markup Start */
        public $markupFontSizeStart = '<H2>';
        /** @param string Font Size (H1-H6) HTML Markup End */
        public $markupFontSizeEnd = '</H2>';
        /** @param string Form width HTML Markup */
        public $markupFormWidth = '';
 
        /**
         * @brief Load all widget settings from database and fill object params
         * @param object $db Database Object
         * @brief Load all widget settings on object init.
         */
        public function __construct($db)
        {
            // load this widget settings from db
            $this->widget = new \YAWK\widget();
            $settings = $this->widget->getWidgetSettingsArray($db);
            foreach ($settings as $property => $value) {
                $this->$property = $value;
            }
        }
 
        /**
         * @brief Print all object data
         * @brief (for development and testing purpose)
         */
        public function printObject()
        {
            echo "<pre>";
            print_r($this);
            echo "</pre>";
        }
 
        /**
         * @brief Init Function: Loads the required JS, set properties and draw the form
         * @brief This method does the setup and embed job
         */
        public function init()
        {
            // load required javascript files
            $this->includeJS();
            // prepare properties and settings
            $this->setProperties();
            // lets start - draw newsletter form
            $this->drawForm();
        }
 
        /**
         * @brief Load all required javascript files
         * @brief include required javascript assets (validade, messages and ajax js file)
         */
        public function includeJS()
        {
            // load validate js
            echo "<script type=\"text/javascript\" src=\"system/engines/jquery/jquery.validate.min.js\"></script>";
            // if current language is german
            if (\YAWK\language::getCurrentLanguageStatic() == "de-DE")
            {   // load german language file
                echo "<script type=\"text/javascript\" src=\"system/engines/jquery/messages_de.min.js\"></script>";
            }
            // load ajax file
            echo "<script type=\"text/javascript\" src=\"system/widgets/newsletter/js/nl.js\"></script>";
        }
 
        /**
         * @brief Set all object properties and html markup codes depending on current widget settings
         * @brief Set object properties and html markup
         */
        public function setProperties()
        {
            // check if btn margin top is set
            if (isset($this->newsletterBtnMarginTop) && (!empty($this->newsletterBtnMarginTop)))
            {   // set markup
                $this->markupBtnMarginTop = " style=\"margin-top:$this->newsletterBtnMarginTop\"";
            }
            else
            {   // no btn margin set, leave markup empty
                $this->markupBtnMarginTop = '';
            }
 
            // check btn class and alignment
            if (isset($this->newsletterBtnClass) && (!empty($this->newsletterBtnClass)))
            {   // set markup
                $this->markupBtnClass = "$this->newsletterBtnClass";
            }
            else
            {   // no btn margin set, leave markup empty
                $this->markupBtnClass = '';
            }
 
            // check button alignment
            if (isset($this->newsletterBtnAlign) && (!empty($this->newsletterBtnAlign)))
            {   // set btn align markup
                $this->markupBtnAlign = " class=\"$this->newsletterBtnAlign\"";
            }
            else
            {   // no markup needed, leave empty
                $this->markupBtnAlign = '';
            }
 
            // check if labels should be hidden
            if (isset($this->newsletterHideLabels) && ($this->newsletterHideLabels == "false"))
            {   // label html markup code
                $this->markupNameLabel = "<label for=\"name\">$this->newsletterNamePlaceholder</label>";
                $this->markupEmailLabel = "<br><label for=\"email\">$this->newsletterEmailPlaceholder</label>";
            }
            else
            {   // no labels
                $this->markupNameLabel = '';
                $this->markupEmailLabel = '';
            }
 
            // check if icon is set
            if (isset($this->newsletterIcon) && (!empty($this->newsletterIcon)))
            {   // icon html markup
                $this->markupIcon = "<i class=\"$this->newsletterIcon\"></i>&nbsp;";
            }
            else
            {   // no icon, no markup
                $this->markupIcon = '';
            }
 
            // check which font size is set
            if (isset($this->newsletterFontSize) && (!empty($this->newsletterFontSize)))
            {   // set markup for h tags
                $this->markupFontSizeStart = "<$this->newsletterFontSize>";
                $this->markupFontSizeEnd = "</$this->newsletterFontSize>";
            }
            else
            {   // if font size is not set, use default:
                $this->markupFontSizeStart = "<H2>";
                $this->markupFontSizeEnd = "</H2>";
            }
 
            // check if form width is set
            if (isset($this->newsletterWidth) && (!empty($this->newsletterWidth)))
            {   // check if user appended a % sign
                if (substr($this->newsletterWidth, -1) != "%")
                {   // if not, append it for the user
                    $this->newsletterWidth = $this->newsletterWidth."%";
                }
                // set html markup
                $this->markupFormWidth = " style=\"width: $this->newsletterWidth;\"";
            }
            else
                {   // no width requested, leave empty
                    $this->markupFormWidth = '';
                }
        }
 
        /**
         * @brief Draw the newsletter html form
         *
         */
        public function drawForm()
        {
            echo"
            <div class=\"container-fluid\">
            <div class=\"row\">
            <div class=\"col-md-12\">
            <div id=\"formWrapper\">
            <div id=\"newsletterTitle\">$this->markupFontSizeStart$this->markupIcon$this->newsletterTitle <small>$this->newsletterSubtext</small>$this->markupFontSizeEnd</div>
            <form class=\"form-horizontal\" id=\"form\" method=\"post\">
                $this->markupNameLabel
                <input type=\"text\" name=\"name\" id=\"name\" class=\"form-control\" placeholder=\"$this->newsletterNamePlaceholder\"$this->markupFormWidth>
                $this->markupEmailLabel
                <input type=\"text\" name=\"email\" id=\"email\" class=\"form-control\" placeholder=\"$this->newsletterEmailPlaceholder\"$this->markupFormWidth>
                <input type=\"hidden\" name=\"thankYouTitle\" id=\"thankYouTitle\" value=\"$this->newsletterThankYouTitle\">
                <input type=\"hidden\" name=\"thankYouSubtext\" id=\"thankYouSubtext\" value=\"$this->newsletterThankYouSubtext\">
                <div$this->markupBtnAlign$this->markupFormWidth>
                    <input type=\"button\" class=\"$this->markupBtnClass\" id=\"submit\" name=\"submit\" value=\"$this->newsletterBtnText\"$this->markupBtnMarginTop>
                </div>
            </form>
            </div>
            <div id=\"thankYouMessage\"></div>
            </div>
            </div>
            </div>";
        }
    }
}