Add documentation

srenon · srenon · commit a6ed3e828373 · 2019-06-17T10:08:26.000-04:00
diff --git a/Block/Adminhtml/System/Config/Form/Composer/Version.php b/Block/Adminhtml/System/Config/Form/Composer/Version.php
@@ -96,16 +96,6 @@ public function getVersion()
         return $this->getComposerVersion($this->getModuleName());
     }
 
-    /**
-     * @return string
-     */
-    public function getModuleName()
-    {
-        $classArray = explode('\\', get_class($this));
-
-        return count($classArray) > 2 ? "{$classArray[0]}_{$classArray[1]}" : '';
-    }
-
     /**
      * Get module composer version
      *
diff --git a/Block/Adminhtml/System/Config/Form/Field/MiscScript.php b/Block/Adminhtml/System/Config/Form/Field/MiscScript.php
@@ -13,7 +13,6 @@
 use Magento\Framework\View\Element\AbstractBlock;
 use MagePal\CheckoutSuccessMiscScript\Helper\Data;
 
-
 /**
  * Class MiscScript
  * @package MagePal\CheckoutSuccessMiscScript\Block\Adminhtml\System\Config\Form\Field
diff --git a/Block/Adminhtml/System/Config/Form/Module/Version.php b/Block/Adminhtml/System/Config/Form/Module/Version.php
@@ -44,7 +44,6 @@ public function __construct(
      *
      * @param  AbstractElement $element
      * @return string
-     * @throws LocalizedException
      */
     public function render(AbstractElement $element)
     {
@@ -75,14 +74,4 @@ public function getVersion()
         $moduleInfo = $this->_moduleList->getOne($this->getModuleName());
         return $moduleInfo['setup_version'];
     }
-
-    /**
-     * @return string
-     */
-    public function getModuleName()
-    {
-        $classArray = explode('\\', get_class($this));
-
-        return count($classArray) > 2 ? "{$classArray[0]}_{$classArray[1]}" : '';
-    }
 }
diff --git a/Helper/Data.php b/Helper/Data.php
@@ -9,7 +9,7 @@
 
 use Magento\Framework\App\Helper\AbstractHelper;
 use Magento\Framework\App\Helper\Context;
-use Magento\Framework\ObjectManagerInterface;
+use Magento\Framework\Json\Helper\Data as JsonHelper;
 use Magento\Store\Model\ScopeInterface;
 
 /**
@@ -34,17 +34,17 @@ class Data extends AbstractHelper
     const TEMPLATE_END = '}}';
 
     /**
-     * @var \Magento\Framework\Json\Helper\Data
+     * @var JsonHelper
      */
     protected $jsonHelper;
 
     /**
      * @param Context $context
-     * @param ObjectManagerInterface
+     * @param JsonHelper $jsonHelper
      */
     public function __construct(
         Context $context,
-        \Magento\Framework\Json\Helper\Data $jsonHelper
+        JsonHelper $jsonHelper
     ) {
         parent::__construct($context);
         $this->jsonHelper = $jsonHelper;
diff --git a/README.md b/README.md
@@ -21,30 +21,18 @@ Design beautiful order confirmation page with our new [Enhanced Success Page](ht
 - Coupon Code
 - Discount
 
-## Installation
+## Documentation
 
-#### Step 1
-##### Using Composer (recommended)
+ - [How to Installing Order Confirmation Miscellaneous HTML and Scripts](https://www.magepal.com/help/docs/success-page-miscellaneous-scripts-magento-2/#installation)
+
+ - [How to Configure Add Miscellaneous HTML and Scripts to Checkout Success Page](https://www.magepal.com/help/docs/success-page-miscellaneous-scripts-magento-2/#configuration)
+
+## Installation using Composer (recommended)
 
 ```
 composer require magepal/magento2-checkout-success-misc-script
 ```
 
-##### Manually
- * Download the extension
- * Unzip the file
- * Create a folder {Magento 2 root}/app/code/MagePal/CheckoutSuccessMiscScript
- * Copy the content from the unzip folder
-
-
-#### Step 2 - Enable extension (from {Magento root} folder)
- * php -f bin/magento module:enable --clear-static-content MagePal_CheckoutSuccessMiscScript
- * php -f bin/magento setup:upgrade
-
-#### Step 3 - Configure Checkout Success Miscellaneous Scripts
-
-Log into your Magento 2 Admin, then goto Stores -> Configuration -> MagePal -> Checkout
-
 Contribution
 ---
 Want to contribute to this extension? The quickest way is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).
@@ -55,9 +43,23 @@ If you encounter any problems or bugs, please open an issue on [GitHub](https://
 
 Need help setting up or want to customize this extension to meet your business needs? Please email support@magepal.com and if we like your idea we will add this feature for free or at a discounted rate.
 
-Top Magento 2 Extensions
+Magento 2 Extensions
 ---
-[Custom SMTP](https://www.magepal.com/magento2/extensions/custom-smtp.html) | [Google Tag Manager](https://www.magepal.com/magento2/extensions/google-tag-manager.html) | [Enhanced E-commerce](https://www.magepal.com/magento2/extensions/enhanced-ecommerce-for-google-tag-manager.html) | [Reindex](https://www.magepal.com/magento2/extensions/reindex.html) | [Custom Shipping Method](https://www.magepal.com/magento2/extensions/custom-shipping-rates-for-magento-2.html) | [Preview Order Confirmation](https://www.magepal.com/magento2/extensions/preview-order-confirmation-page-for-magento-2.html) | [Guest to Customer](https://www.magepal.com/magento2/extensions/guest-to-customer.html) | [Admin Form Fields Manager](https://www.magepal.com/magento2/extensions/admin-form-fields-manager-for-magento-2.html) | [Customer Dashboard Links Manager](https://www.magepal.com/magento2/extensions/customer-dashboard-links-manager-for-magento-2.html) | [Lazy Loader](https://www.magepal.com/magento2/extensions/lazy-load.html) | [Order Confirmation Page Miscellaneous Scripts](https://www.magepal.com/magento2/extensions/order-confirmation-miscellaneous-scripts-for-magento-2.html)
+- [Custom SMTP](https://www.magepal.com/magento2/extensions/custom-smtp.html)
+- [Catalog Hover Image for Magento](https://www.magepal.com/magento2/extensions/catalog-hover-image-for-magento.html)
+- [Enhanced Success Page for Magento 2](https://www.magepal.com/magento2/extensions/enhanced-success-page.html)
+- [Enhanced Transactional Emails for Magento 2](https://www.magepal.com/magento2/extensions/enhanced-transactional-emails.html)
+- [Google Tag Manager](https://www.magepal.com/magento2/extensions/google-tag-manager.html) 
+- [Enhanced E-commerce](https://www.magepal.com/magento2/extensions/enhanced-ecommerce-for-google-tag-manager.html) 
+- [Reindex](https://www.magepal.com/magento2/extensions/reindex.html) 
+- [Custom Shipping Method](https://www.magepal.com/magento2/extensions/custom-shipping-rates-for-magento-2.html) 
+- [Preview Order Confirmation](https://www.magepal.com/magento2/extensions/preview-order-confirmation-page-for-magento-2.html)
+- [Guest to Customer](https://www.magepal.com/magento2/extensions/guest-to-customer.html) 
+- [Admin Form Fields Manager](https://www.magepal.com/magento2/extensions/admin-form-fields-manager-for-magento-2.html) 
+- [Customer Dashboard Links Manager](https://www.magepal.com/magento2/extensions/customer-dashboard-links-manager-for-magento-2.html) 
+- [Lazy Loader](https://www.magepal.com/magento2/extensions/lazy-load.html) 
+- [Order Confirmation Page Miscellaneous Scripts](https://www.magepal.com/magento2/extensions/order-confirmation-miscellaneous-scripts-for-magento-2.html)
+- [HTML Minifier for Magento2](https://www.magepal.com/magento2/extensions/html-minifier.html)
 
 © MagePal LLC. | [www.magepal.com](http:/www.magepal.com)
 
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "magepal/magento2-checkout-success-misc-script",
-    "description": "Add Miscellaneous HTML and JavaScript codes to Magento2 checkout conformation page",
+    "description": "Add Miscellaneous HTML and JavaScript codes to Magento2 checkout confirmation page",
     "keywords": [
         "magento 2",
         "checkout tags",
@@ -21,7 +21,7 @@
         "magepal/magento2-preview-checkout-success-page":"Preview checkout success page from admin"
     },
     "type": "magento2-module",
-    "version": "1.1.7",
+    "version": "1.1.8",
     "license": [
         "proprietary"
     ],
diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
@@ -20,10 +20,39 @@
                 <attribute type="expanded">1</attribute>
                 <comment>
                     <![CDATA[
-                    <strong>Copyright © 2019 <a href="http://www.magepal.com" target="_blank">www.magepal.com</a> / <a href="mailto:support@magepal.com">support@magepal.com</a></strong><br />
-                    Discover other must have extensions at <a href="https://www.magepal.com" target="_blank">www.magepal.com</a>. Thanks for choosing MagePal Extensions.<br/><br/>
+                    <div id="magepal-info-csms">
+                        Copyright © 2019 <a href="https://www.magepal.com/magento2/extensions.html?utm_source=miscellaneous-scripts&utm_medium=admin" target="_blank">MagePal, LLC</a>
+                        <a href="https://www.magepal.com/help/docs/success-page-miscellaneous-scripts-magento-2/?utm_source=miscellaneous-scripts&utm_medium=admin#documentation" target="_blank">Documentation</a>
+                        <a href="https://www.magepal.com/help/docs/success-page-miscellaneous-scripts-magento-2/?utm_source=miscellaneous-scripts&utm_medium=admin#support">Support</a>
+                        <a href="https://www.magepal.com/help/docs/success-page-miscellaneous-scripts-magento-2?utm_source=miscellaneous-scripts&utm_medium=admin#current_version" target="_blank">Latest Version</a>
+                        <a href="https://www.magepal.com/order-confirmation-miscellaneous-scripts-for-magento-2.html?utm_source=miscellaneous-scripts&utm_medium=admin" target="_blank">Extension Detail</a>
+                        <a href="https://www.magepal.com/magento2/extensions.html?utm_source=miscellaneous-scripts&utm_medium=admin" target="_blank">More Extensions</a>
+                    </div>
+                    <div>
+                    Design beautiful order confirmation page with our new <a href="https://www.magepal.com/enhanced-success-page.html">Enhanced Success Page</a> extension.
+                    </div>
                     <hr style="border-top: 1px solid #e3e3e3" />
-                  ]]>
+                    <style>
+                        #magepal-info-csms a {
+                            font-weight: bold;
+                            border-left: 2px solid #e3e3e3;
+                            padding-left:10px;
+                            padding-right:10px;
+                            color: #ef7e1e;
+                        }
+
+                        #magepal-info-csms a:first-child {
+                            padding-left: 5px;
+                            border-left: none;
+                        }
+
+                        #magepal-info-csms {
+                            padding-bottom: 5px;
+                        }
+                        .section-config.active #magepal_checkout_preview_success_page-head {
+                            padding-bottom: 0px;
+                        }
+                     </style>]]>
                 </comment>
                 <field id="module_version" translate="label" type="label" sortOrder="0" showInDefault="1" showInWebsite="0" showInStore="0">
                     <label>Module Version</label>

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,6 @@ public function __construct(`
`44`	`44`	`*`
`45`	`45`	`* @param AbstractElement $element`
`46`	`46`	`* @return string`
`47`		`- * @throws LocalizedException`
`48`	`47`	`*/`
`49`	`48`	`public function render(AbstractElement $element)`
`50`	`49`	`{`
`@@ -75,14 +74,4 @@ public function getVersion()`
`75`	`74`	`$moduleInfo = $this->_moduleList->getOne($this->getModuleName());`
`76`	`75`	`return $moduleInfo['setup_version'];`
`77`	`76`	`}`
`78`		`-`
`79`		`- /**`
`80`		`- * @return string`
`81`		`- */`
`82`		`- public function getModuleName()`
`83`		`- {`
`84`		`- $classArray = explode('\\', get_class($this));`
`85`		`-`
`86`		`- return count($classArray) > 2 ? "{$classArray[0]}_{$classArray[1]}" : '';`
`87`		`- }`
`88`	`77`	`}`