├── Block
    └── Adminhtml
    │   ├── Help.php
    │   └── System
    │       └── Config
    │           └── Form
    │               └── Info.php
├── Cron
    └── XmlUpdate.php
├── Model
    ├── Config.php
    └── XmlReader.php
├── README.md
├── composer.json
├── etc
    ├── acl.xml
    ├── adminhtml
    │   └── system.xml
    ├── config.xml
    ├── crontab.xml
    └── module.xml
├── registration.php
└── view
    └── adminhtml
        ├── layout
            └── default.xml
        └── templates
            └── help.phtml


/Block/Adminhtml/Help.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | namespace Magefan\AdminUserGuide\Block\Adminhtml;
  7 | 
  8 | use Magento\Framework\View\Element\Template;
  9 | use Magefan\AdminUserGuide\Model\XmlReader;
 10 | use Magefan\AdminUserGuide\Model\Config;
 11 | use Magento\Framework\AuthorizationInterface;
 12 | 
 13 | class Help extends \Magento\Framework\View\Element\Template
 14 | {
 15 |     /**
 16 |      * @var XmlReader
 17 |      */
 18 |     private $xmlReader;
 19 | 
 20 |     /**
 21 |      * @var Config
 22 |      */
 23 |     private $config;
 24 | 
 25 |     /**
 26 |      * @var AuthorizationInterface
 27 |      */
 28 |     private $authorization;
 29 | 
 30 |     /**
 31 |      * Help constructor.
 32 |      * @param Template\Context $context
 33 |      * @param XmlReader $xmlReader
 34 |      * @param Config $config
 35 |      * @param AuthorizationInterface $authorization
 36 |      * @param array $data
 37 |      */
 38 |     public function __construct(
 39 |         Template\Context $context,
 40 |         XmlReader $xmlReader,
 41 |         Config $config,
 42 |         AuthorizationInterface $authorization,
 43 |         array $data = []
 44 |     ) {
 45 |         parent::__construct($context, $data);
 46 |         $this->xmlReader = $xmlReader;
 47 |         $this->config = $config;
 48 |         $this->authorization = $authorization;
 49 |     }
 50 | 
 51 |     /**
 52 |      * @return array
 53 |      * @throws \Magento\Framework\Exception\FileSystemException
 54 |      */
 55 |     public function getPageHelp()
 56 |     {
 57 |         $data = [];
 58 |         if (!$this->authorization->isAllowed('Magefan_AdminUserGuide::help')) {
 59 |             return $data;
 60 |         }
 61 | 
 62 |         if ($this->config->isEnabled()) {
 63 |             $guideData = $this->xmlReader->get();
 64 | 
 65 |             $fullActionName = str_replace('_', '-', $this->getRequest()->getFullActionName());
 66 |             $secondActionName = $fullActionName;
 67 | 
 68 |             if ('adminhtml-system-config-edit' == $secondActionName) {
 69 |                 $secondActionName .= '-section-' . $this->getRequest()->getParam('section');
 70 |             }
 71 | 
 72 |             $data = [];
 73 |             if ($guideData) {
 74 |                 foreach ($guideData as $item) {
 75 |                     if (empty($item['class']) || empty($item['title'])) {
 76 |                         continue;
 77 |                     }
 78 | 
 79 |                     $classes = explode(' ', $item['class']);
 80 |                     if (in_array($fullActionName, $classes)
 81 |                         || in_array($secondActionName, $classes)
 82 |                     ) {
 83 |                         $links = [];
 84 |                         for ($i = 0; $i <= count($item) - 2; $i++) {
 85 |                             if ($i == 0) {
 86 |                                 if (isset($item['link'])) {
 87 |                                     $links[] = $item['link'];
 88 |                                 }
 89 |                                 $i++;
 90 |                             } else {
 91 |                                 if (isset($item['link' . $i])) {
 92 |                                     $links[] = $item['link' . $i];
 93 |                                 }
 94 |                             }
 95 |                         }
 96 | 
 97 |                         if (!count($links)) {
 98 |                             continue;
 99 |                         }
100 | 
101 |                         foreach ($links as $klink => $link) {
102 |                             if (false !== strpos($link, 'magefan.com') && false === strpos($link, 'utm_source')) {
103 |                                 $linkInfo = explode('#', $link);
104 |                                 $linkInfo[0] .= (false !== strpos($linkInfo[0], '?')) ? '&' : '?';
105 |                                 $linkInfo[0] .= 'utm_source=admin&utm_medium=admin-user-guide&utm_campaign=admin-user-guide';
106 |                                 $link = implode('#', $linkInfo);
107 |                                 $links[$klink] = $link;
108 |                             }
109 |                         }
110 | 
111 |                         $data[] = [
112 |                             'title' => $item['title'],
113 |                             'links' => $links
114 |                         ];
115 |                     }
116 |                 }
117 |             }
118 | 
119 |         }
120 |         return $data;
121 |     }
122 | }
123 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/Info.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | namespace Magefan\AdminUserGuide\Block\Adminhtml\System\Config\Form;
 8 | 
 9 | /**
10 |  * Admin user guide configurations information block
11 |  */
12 | class Info extends \Magefan\Community\Block\Adminhtml\System\Config\Form\Info
13 | {
14 |     /**
15 |      * Return extension url
16 |      * @return string
17 |      */
18 |     protected function getModuleUrl()
19 |     {
20 |         return 'https://mage' . 'fan.com';
21 |     }
22 | 
23 |     /**
24 |      * Return extension title
25 |      * @return string
26 |      */
27 |     protected function getModuleTitle()
28 |     {
29 |         return 'Admin User Guide Extension';
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/Cron/XmlUpdate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | namespace Magefan\AdminUserGuide\Cron;
 7 | 
 8 | use Magefan\AdminUserGuide\Model\XmlReader;
 9 | 
10 | /**
11 |  * Class XmlReader
12 |  */
13 | class XmlUpdate
14 | {
15 |     /**
16 |      * @var XmlReader
17 |      */
18 |     private $xmlReader;
19 | 
20 |     /**
21 |      * @param XmlReader $xmlReader
22 |      */
23 |     public function __construct(
24 |         XmlReader $xmlReader
25 |     ) {
26 |         $this->xmlReader = $xmlReader;
27 |     }
28 | 
29 |     /**
30 |      * @throws \Magento\Framework\Exception\FileSystemException
31 |      */
32 |     public function execute()
33 |     {
34 |         $this->xmlReader->update();
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/Model/Config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | namespace Magefan\AdminUserGuide\Model;
 8 | 
 9 | use Magento\Framework\App\Config\ScopeConfigInterface;
10 | use Magento\Store\Model\ScopeInterface;
11 | 
12 | /**
13 |  * Class Config
14 |  */
15 | class Config
16 | {
17 |     /**
18 |      * @var ScopeConfigInterface
19 |      */
20 |     private $scopeConfig;
21 | 
22 |     /**
23 |      * Extension enabled config path
24 |      */
25 |     const XML_PATH_EXTENSION_ENABLED = 'mfadminuserguide/general/enabled';
26 | 
27 |     /**
28 |      * Config constructor.
29 |      * @param ScopeConfigInterface $scopeConfig
30 |      */
31 |     public function __construct(
32 |         ScopeConfigInterface $scopeConfig
33 |     ) {
34 |         $this->scopeConfig = $scopeConfig;
35 |     }
36 | 
37 |     /**
38 |      * Retrieve true if blog module is enabled
39 |      *
40 |      * @return bool
41 |      */
42 |     public function isEnabled($storeId = null)
43 |     {
44 |         return (bool)$this->getConfig(self::XML_PATH_EXTENSION_ENABLED, $storeId);
45 |     }
46 | 
47 |     /**
48 |      * Retrieve store config value
49 |      * @param string $path
50 |      * @param null $storeId
51 |      * @return mixed
52 |      */
53 |     public function getConfig($path, $storeId = null)
54 |     {
55 |         return $this->scopeConfig->getValue(
56 |             $path,
57 |             ScopeInterface::SCOPE_STORE,
58 |             $storeId
59 |         );
60 |     }
61 | }
62 | 


--------------------------------------------------------------------------------
/Model/XmlReader.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | namespace Magefan\AdminUserGuide\Model;
  7 | 
  8 | use Magento\Framework\Filesystem;
  9 | use Magento\Framework\App\CacheInterface;
 10 | use Magento\Framework\HTTP\Client\Curl;
 11 | use Magento\Framework\Serialize\Serializer\Json;
 12 | use Magento\Framework\App\Filesystem\DirectoryList;
 13 | 
 14 | /**
 15 |  * Class XmlReader
 16 |  */
 17 | class XmlReader
 18 | {
 19 | 
 20 |     const DATA_FILE_NAME = 'magefan/aug-data/knowledge-base.xml';
 21 | 
 22 |     /**
 23 |      * @var CacheInterface
 24 |      */
 25 |     private $cache;
 26 | 
 27 |     /**
 28 |      * @var Filesystem
 29 |      */
 30 |     private $filesystem;
 31 | 
 32 |     /**
 33 |      * @var Json
 34 |      */
 35 |     private $json;
 36 | 
 37 |     /**
 38 |      * @var Curl
 39 |      */
 40 |     private $curl;
 41 | 
 42 |     /**
 43 |      * @param CacheInterface $cache
 44 |      * @param Filesystem $filesystem
 45 |      * @param Json $json
 46 |      * @param Curl $curl
 47 |      */
 48 |     public function __construct(
 49 |         CacheInterface $cache,
 50 |         Filesystem $filesystem,
 51 |         Json $json,
 52 |         Curl $curl
 53 |     ) {
 54 |         $this->cache = $cache;
 55 |         $this->filesystem = $filesystem;
 56 |         $this->json = $json;
 57 |         $this->curl = $curl;
 58 |     }
 59 | 
 60 |     /**
 61 |      * @return array|bool|float|int|mixed|string|null
 62 |      * @throws \Magento\Framework\Exception\FileSystemException
 63 |      */
 64 |     public function get()
 65 |     {
 66 |         if (!$this->cache->load('magefan_aug_data')) {
 67 |             $this->readFile();
 68 |         }
 69 | 
 70 |         try {
 71 |             return $this->json->unserialize($this->cache->load('magefan_aug_data'));
 72 |         } catch (\Exception $e) {
 73 |             return [];
 74 |         }
 75 |     }
 76 | 
 77 |     /**
 78 |      * @throws \Magento\Framework\Exception\FileSystemException
 79 |      */
 80 |     private function readFile()
 81 |     {
 82 |         $directoryRead = $this->filesystem->getDirectoryRead(DirectoryList::VAR_DIR);
 83 |         if (!$directoryRead->isExist(self::DATA_FILE_NAME)) {
 84 |             $this->update();
 85 |         }
 86 |         if (!$directoryRead->isExist(self::DATA_FILE_NAME)) {
 87 |             return;
 88 |         }
 89 |         $xml = $directoryRead->readFile(self::DATA_FILE_NAME);
 90 |         try {
 91 |             $new = simplexml_load_string($xml);
 92 |         } catch (\Exception $e) {
 93 |             $new = null;
 94 |         }
 95 | 
 96 |         $data = [];
 97 |         if (isset($new) && isset($new->channel) && isset($new->channel->item)) {
 98 |             foreach ($new->channel->item as $item) {
 99 |                 $data[] = (array)$item;
100 |             }
101 |         }
102 |         $this->cache->save($this->json->serialize($data),'magefan_aug_data');
103 |     }
104 | 
105 |     /**
106 |      * @throws \Magento\Framework\Exception\FileSystemException
107 |      */
108 |     public function update()
109 |     {
110 |         $fileUrl = 'https://' . 'mage' . 'fan.com' .'/media/knowledge-base.xml';
111 |         try {
112 |             $this->curl->get($fileUrl);
113 |             $contents = $this->curl->getBody();
114 |         } catch (\Exception $e) {
115 |             $contents = null;
116 |         }
117 |         if ($contents) {
118 |             $media = $this->filesystem->getDirectoryWrite(DirectoryList::VAR_DIR);
119 |             $media->writeFile(self::DATA_FILE_NAME, $contents);
120 |         }
121 |     }
122 | }
123 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # [Magento 2 Admin User Guide Extension](https://magefan.com/) by Magefan
  2 | 
  3 | [![Total Downloads](https://poser.pugx.org/magefan/module-admin-user-guide/downloads)](https://packagist.org/packages/magefan/module-admin-user-guide)
  4 | [![Latest Stable Version](https://poser.pugx.org/magefan/module-admin-user-guide/v/stable)](https://packagist.org/packages/magefan/module-admin-user-guide)
  5 | 
  6 | This Magento 2 Admin User Guide module adds guide links in admin panel to improve admin experience.
  7 | 
  8 | ## 🇺🇦 Stand with Ukraine! [How can you help?](https://magefan.com/blog/join-our-donations)
  9 | 
 10 | ## Requirements
 11 |   * Magento Community Edition 2.1.x-2.4.x or Magento Enterprise Edition 2.1.x-2.4.x
 12 | 
 13 | ## Installation Method 1 - Installing via composer
 14 |   * Open command line
 15 |   * Using command "cd" navigate to your magento2 root directory
 16 |   * Run command: composer require magefan/module-admin-user-guide
 17 | 
 18 |   
 19 | 
 20 | ## Installation Method 2 - Installing using archive
 21 |   * Download [ZIP Archive](https://github.com/magefan/module-admin-user-guide/archive/refs/heads/main.zip)
 22 |   * Extract files
 23 |   * In your Magento 2 root directory create folder app/code/Magefan/AdminUserGuide
 24 |   * Copy files and folders from archive to that folder
 25 |   * In command line, using "cd", navigate to your Magento 2 root directory
 26 |   * Run commands:
 27 | ```
 28 | php bin/magento setup:upgrade
 29 | php bin/magento setup:di:compile
 30 | php bin/magento setup:static-content:deploy
 31 | ```
 32 | 
 33 | ## Support
 34 | If you have any issues, please [contact us](mailto:support@magefan.com)
 35 | then if you still need help, open a bug report in GitHub's
 36 | [issue tracker](https://github.com/magefan/module-admin-user-guide/issues).
 37 | 
 38 | Please do not use Magento Marketplace Reviews or (especially) the Q&A for support.
 39 | There isn't a way for us to reply to reviews and the Q&A moderation is very slow.
 40 | 
 41 | ## Need More Features?
 42 | Please contact us to get a quote
 43 | https://magefan.com/contact
 44 | 
 45 | ## License
 46 | The code is licensed under [EULA](https://magefan.com/end-user-license-agreement).
 47 | 
 48 | ## [Magento 2 Extensions](https://magefan.com/magento-2-extensions) by Magefan
 49 | 
 50 | ### [Magento 2 Google Extensions](https://magefan.com/magento-2-extensions/google-extensions)
 51 | 
 52 |   * [Magento 2 Google Indexing](https://magefan.com/magento-2-google-indexing-api)
 53 |   * [Magento 2 Google Analytics 4](https://magefan.com/magento-2-google-analytics-4)
 54 |   * [Magento 2 Google Tag Manager](https://magefan.com/magento-2-google-tag-manager)
 55 |   * [Magento 2 Google Shopping Feed](https://magefan.com/magento-2-google-shopping-feed-extension)
 56 |   * [Magento 2 Google Customer Reviews](https://magefan.com/magento-2-google-customer-reviews)
 57 | 
 58 | ### Magento 2 SEO Extensions
 59 | 
 60 |   * [Magento 2 SEO Extension](https://magefan.com/magento-2-seo-extension)
 61 |   * [Magento 2 Rich Snippets](https://magefan.com/magento-2-rich-snippets)
 62 |   * [Magento 2 HTML Sitemap](https://magefan.com/magento-2-html-sitemap-extension)
 63 |   * [Magento 2 XML Sitemap](https://magefan.com/magento-2-xml-sitemap-extension)
 64 |   * [Magento 2 Facebook Open Graph](https://magefan.com/magento-2-open-graph-extension-og-tags)
 65 |   * [Magento 2 Twitter Cards](https://magefan.com/magento-2-twitter-cards-extension)
 66 | 
 67 | 
 68 | ### [Magento 2 Speed Optimization Extensions](https://magefan.com/magento-2-extensions/speed-optimization)
 69 | 
 70 |   * [Magento 2 Google Page Speed Optimizer](https://magefan.com/magento-2-google-page-speed-optimizer)
 71 |   * [Magento 2 Full Page Cache Warmer](https://magefan.com/magento-2-full-page-cache-warmer)
 72 |   * [Magento 2 Image Lazy Load](https://magefan.com/magento-2-image-lazy-load-extension)
 73 |   * [Magento 2 WebP Images](https://magefan.com/magento-2-webp-optimized-images)
 74 |   * [Magento 2 Rocket JavaScript](https://magefan.com/rocket-javascript-deferred-javascript)
 75 | 
 76 |   ### [Magento 2 Admin Panel Extensions](https://magefan.com/magento-2-extensions/admin-extensions)
 77 | 
 78 |   * [Magento 2 Size Chart Extension](https://magefan.com/magento-2-size-chart)
 79 |   * [Magento 2 Security Extension](https://magefan.com/magento-2-security-extension)
 80 |   * [Magento 2 Admin Action Log](https://magefan.com/magento-2-admin-action-log)
 81 |   * [Magento 2 Order Editor](https://magefan.com/magento-2-edit-order-extension)
 82 |   * [Magento 2 Better Order Grid](https://magefan.com/magento-2-better-order-grid-extension)
 83 |   * [Magento 2 Extended Product Grid](https://magefan.com/magento-2-product-grid-inline-editor)
 84 |   * [Magento 2 Product Tabs](https://magefan.com/magento-2/extensions/product-tabs)
 85 |   * [Magento 2 Facebook Pixel](https://magefan.com/magento-2-facebook-pixel-extension)
 86 |   * [Magento 2 Email Attachments](https://magefan.com/magento-2-email-attachments)
 87 |   * [Magento 2 Admin View](https://magefan.com/magento-2-admin-view-extension)
 88 |   * [Magento 2 Admin Email Notifications](https://magefan.com/magento-2-admin-email-notifications)
 89 |   * [Magento 2 Login As Customer](https://magefan.com/login-as-customer-magento-2-extension)
 90 | 
 91 | ### Magento 2 Blog Extensions
 92 | 
 93 |   * [Magento 2 Blog](https://magefan.com/magento2-blog-extension)
 94 |   * [Magento 2 Multi Blog](https://magefan.com/magento-2-multi-blog-extension)
 95 |   * [Magento 2 Product Widget](https://magefan.com/magento-2-product-widget)
 96 | 
 97 | ### [Magento 2 Marketing Automation Extensions](https://magefan.com/magento-2-extensions/marketing-automation)
 98 | 
 99 |   * [Magento 2 Cookie Consent](https://magefan.com/magento-2-cookie-consent)
100 |   * [Magento 2 Product Labels](https://magefan.com/magento-2-product-labels)
101 |   * [Magento 2 Base Price](https://magefan.com/magento-2-base-price)
102 |   * [Magento 2 Dynamic Categories](https://magefan.com/magento-2-dynamic-categories)
103 |   * [Magento 2 Dynamic Blocks and Pages Extension](https://magefan.com/magento-2-cms-display-rules-extension)
104 |   * [Magento 2 Automatic Related Products](https://magefan.com/magento-2-automatic-related-products)
105 |   * [Magento 2 Price History](https://magefan.com/magento-2-price-history)
106 |   * [Magento 2 Mautic Integration](https://magefan.com/magento-2-mautic-extension)
107 |   * [Magento 2 YouTube Video](https://magefan.com/magento2-youtube-extension)    
108 |  
109 | ### [Magento 2 Cart Extensions](https://magefan.com/magento-2-extensions/cart-extensions)
110 | 
111 |   * [Magento 2 Checkout Extension](https://magefan.com/better-magento-2-checkout-extension)
112 |   * [Magento 2 Coupon Code](https://magefan.com/magento-2-coupon-code-link)
113 |   * [Magento 2 Guest to Customer](https://magefan.com/magento2-convert-guest-to-customer)
114 | 
115 | ### [Magento 2 Multi-Language Extensions](https://magefan.com/magento-2-extensions/multi-language-extensions)
116 | 
117 |   * [Magento 2 Hreflang Tags](https://magefan.com/magento2-alternate-hreflang-extension)
118 |   * [Magento 2 Auto Currency Switcher](https://magefan.com/magento-2-currency-switcher-auto-currency-by-country)
119 |   * [Magento 2 Auto Language Switcher](https://magefan.com/magento-2-auto-language-switcher)
120 |   * [Magento 2 GeoIP Store Switcher](https://magefan.com/magento-2-geoip-switcher-extension)
121 |   * [Magento 2 Translation](https://magefan.com/magento-2-translation-extension)
122 | 
123 | ### [Developers Tools](https://magefan.com/magento-2-extensions/developer-tools)
124 | 
125 |   * [Magento 2 Zero Downtime Deployment](https://magefan.com/blog/magento-2-zero-downtime-deployment)
126 |   * [Magento 2 Cron Schedule](https://magefan.com/magento-2-cron-schedule)
127 |   * [Magento 2 CLI Extension](https://magefan.com/magento2-cli-extension)
128 |   * [Magento 2 Conflict Detector](https://magefan.com/magento2-conflict-detector)
129 |      
130 |   ## [Shopify Apps](https://magefan.com/shopify/apps) by Magefan
131 | 
132 |   * [Shopify Login As Customer](https://apps.shopify.com/login-as-customer)
133 |   * [Shopify Blog](https://apps.shopify.com/magefan-blog)
134 |   * [Shopify Size Chart](https://magefan.com/shopify/apps/size-chart)
135 |   * [Shopify Google Indexer](https://magefan.com/shopify/apps/google-indexing)
136 |   * [Shopify Product Feeds](https://magefan.com/shopify/apps/product-feed)
137 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "magefan/module-admin-user-guide",
 3 |     "description": "Admin panel user guides.",
 4 |     "type": "magento2-module",
 5 |     "version": "2.0.6",
 6 |     "autoload": {
 7 |         "files": [ "registration.php" ],
 8 |         "psr-4": {
 9 |             "Magefan\\AdminUserGuide\\": ""
10 |         }
11 |     }
12 | }
13 | 


--------------------------------------------------------------------------------
/etc/acl.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Acl/etc/acl.xsd">
 9 |     <acl>
10 |         <resources>
11 |             <resource id="Magento_Backend::admin">
12 |                 <resource id="Magento_Backend::stores">
13 |                     <resource id="Magento_Backend::stores_settings">
14 |                         <resource id="Magento_Config::config">
15 |                             <resource id="Magefan_AdminUserGuide::configuration" title="Admin User Guide Section" translate="title" sortOrder="20" />
16 |                         </resource>
17 |                     </resource>
18 |                 </resource>
19 |                 <resource id="Magefan_AdminUserGuide::help" title="Magefan Help Button" translate="title" sortOrder="30" />
20 |             </resource>
21 |         </resources>
22 |     </acl>
23 | </config>
24 | 


--------------------------------------------------------------------------------
/etc/adminhtml/system.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 |  -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
 9 |     <system>
10 |         <section id="mfadminuserguide" translate="label" sortOrder="9812072850" showInDefault="1" showInWebsite="1" showInStore="1">
11 |             <class>separator-top</class>
12 |             <label>Admin User Guide</label>
13 |             <tab>magefan</tab>
14 |             <resource>Magefan_AdminUserGuide::configuration</resource>
15 |             <group id="general" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="0" showInStore="0">
16 |                 <label>General</label>
17 |                 <attribute type="expanded">1</attribute>
18 |                 <field id="version" translate="label comment" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
19 |                     <frontend_model>Magefan\AdminUserGuide\Block\Adminhtml\System\Config\Form\Info</frontend_model>
20 |                 </field>
21 |                 <field id="enabled" translate="label" type="select" sortOrder="15" showInDefault="1" showInWebsite="0" showInStore="0">
22 |                     <label>Enable Extension</label>
23 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
24 |                 </field>
25 |             </group>
26 |         </section>
27 |     </system>
28 | </config>
29 | 


--------------------------------------------------------------------------------
/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 |  -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
10 |     <default>
11 |         <mfadminuserguide>
12 |             <general>
13 |                 <enabled>1</enabled>
14 |             </general>
15 |         </mfadminuserguide>
16 |     </default>
17 | </config>
18 | 


--------------------------------------------------------------------------------
/etc/crontab.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
 9 |     <group id="default">
10 |         <job instance="Magefan\AdminUserGuide\Cron\XmlUpdate" method="execute" name="magefan_admin_user_guide_xml_update">
11 |             <schedule>15 2 * * *</schedule>
12 |         </job>
13 |     </group>
14 | </config>
15 | 


--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
 9 |     <module name="Magefan_AdminUserGuide" setup_version="2.0.1"/>
10 | </config>
11 | 


--------------------------------------------------------------------------------
/registration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | \Magento\Framework\Component\ComponentRegistrar::register(
 8 |     \Magento\Framework\Component\ComponentRegistrar::MODULE,
 9 |     'Magefan_AdminUserGuide',
10 |     __DIR__
11 | );
12 | 


--------------------------------------------------------------------------------
/view/adminhtml/layout/default.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 9 |     <body>
10 |         <referenceBlock name="header">
11 |             <block class="Magefan\AdminUserGuide\Block\Adminhtml\Help" name="magefan_admin_user_guide" template="Magefan_AdminUserGuide::help.phtml"/>
12 |         </referenceBlock>
13 |     </body>
14 | </page>
15 | 


--------------------------------------------------------------------------------
/view/adminhtml/templates/help.phtml:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | ?>
  7 | <?php
  8 | /**
  9 |  * Help template
 10 |  *
 11 |  * @var $block \Magefan\AdminUserGuide\Block\Adminhtml\Help
 12 |  * @var $mfSecureRenderer \Magefan\Community\Api\SecureHtmlRendererInterface
 13 |  */
 14 | ?>
 15 | <?php
 16 | $pageHelp = $block->getPageHelp();
 17 | ?>
 18 | <?php if ($pageHelp) { ?>
 19 |     <div id="magefan_help_container">
 20 |         <div title="<?= $block->escapeHtml(__('Admin Guide')) ?>" id="magefan_show_help">
 21 |             <svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" fill="none">
 22 |                 <path opacity="0.5" fill-rule="evenodd" clip-rule="evenodd" d="M15 3.4375C8.61421 3.4375 3.4375 8.61421 3.4375 15C3.4375 21.3857 8.61421 26.5625 15 26.5625C21.3857 26.5625 26.5625 21.3857 26.5625 15C26.5625 8.61421 21.3857 3.4375 15 3.4375ZM1.5625 15C1.5625 7.57868 7.57868 1.5625 15 1.5625C22.4214 1.5625 28.4375 7.57868 28.4375 15C28.4375 22.4214 22.4214 28.4375 15 28.4375C7.57868 28.4375 1.5625 22.4214 1.5625 15Z" fill="white"/>
 23 |                 <path fill-rule="evenodd" clip-rule="evenodd" d="M15 10.3125C13.7919 10.3125 12.8125 11.2919 12.8125 12.5H10.9375C10.9375 10.2563 12.7564 8.4375 15 8.4375C17.2436 8.4375 19.0625 10.2563 19.0625 12.5C19.0625 14.421 17.7292 16.0306 15.9375 16.4538V18.125H14.0625V14.6875H15C16.2081 14.6875 17.1875 13.7081 17.1875 12.5C17.1875 11.2919 16.2081 10.3125 15 10.3125ZM14.0625 21.875V20H15.9375V21.875H14.0625Z" fill="white"/>
 24 |             </svg>
 25 |         </div>
 26 | 
 27 |         <div id="magefan_aug" style="display: none">
 28 |             <div class="magefan-aug-header">Admin Guide
 29 |                 <button class="action-close" type="button" title="<?= $block->escapeHtml(__('Close')) ?>">
 30 |                     <span><?= $block->escapeHtml(__('Close')) ?></span>
 31 |                 </button>
 32 |             </div>
 33 |             <div class="magefan-aug-content">
 34 |                 <ul>
 35 |                     <?php foreach ($pageHelp as $question) { ?>
 36 |                         <?php foreach ($question['links'] as $link) { ?>
 37 |                             <li>
 38 |                                 <div class="icon">
 39 |                                     <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" fill="none">
 40 |                                         <g clip-path="url(#clip0_14819_9754)">
 41 |                                             <path d="M11.5555 16H2.66665C1.95431 16 1.28467 15.7226 0.781023 15.2189C0.277378 14.7152 0 14.0456 0 13.3333V4.44444C0 3.73213 0.277409 3.06249 0.781054 2.55884C1.2847 2.0552 1.95434 1.77779 2.66668 1.77779H6.22223C6.71317 1.77779 7.11112 2.17574 7.11112 2.66668C7.11112 3.15763 6.71317 3.55558 6.22223 3.55558H2.66665C2.4292 3.55558 2.20601 3.64805 2.03815 3.81591C1.87029 3.98377 1.77779 4.20699 1.77779 4.44444V13.3333C1.77779 13.5708 1.87026 13.794 2.03815 13.9619C2.20601 14.1297 2.4292 14.2222 2.66665 14.2222H11.5555C11.7929 14.2222 12.0161 14.1297 12.184 13.9618C12.3519 13.794 12.4444 13.5707 12.4444 13.3333V9.77777C12.4444 9.28683 12.8423 8.88891 13.3333 8.88891C13.8242 8.88891 14.2222 9.28686 14.2222 9.77777V13.3333C14.2222 14.0456 13.9448 14.7152 13.4411 15.2189C12.9374 15.7226 12.2678 16 11.5555 16ZM6.22223 10.6666C5.99472 10.6666 5.76724 10.5799 5.5937 10.4063C5.24658 10.0592 5.24658 9.49633 5.5937 9.14921L12.9651 1.77779H9.77777C9.28683 1.77779 8.88891 1.37984 8.88891 0.888894C8.88891 0.397948 9.28683 0 9.77777 0H15.1111C15.234 0 15.3511 0.0249649 15.4576 0.0700819C15.557 0.112125 15.6504 0.173047 15.732 0.252878L15.7321 0.252941C15.7327 0.253531 15.7333 0.254089 15.7338 0.254679C15.734 0.254835 15.7342 0.255021 15.7344 0.255176C15.7348 0.255611 15.7353 0.256077 15.7357 0.256543C15.736 0.256853 15.7363 0.257132 15.7366 0.257443C15.737 0.257785 15.7373 0.258157 15.7376 0.258437C15.7382 0.259058 15.7389 0.25971 15.7395 0.260362C15.7402 0.260983 15.7408 0.261666 15.7415 0.262287C15.7418 0.262597 15.7422 0.263001 15.7424 0.263281C15.7428 0.263591 15.743 0.263871 15.7433 0.264181C15.7438 0.264647 15.7443 0.265082 15.7447 0.265578C15.7449 0.265703 15.7451 0.26592 15.7452 0.266075C15.7458 0.266665 15.7464 0.267255 15.7469 0.267845L15.747 0.267907C15.8268 0.349633 15.8878 0.442972 15.9298 0.542335C15.9749 0.64884 15.9999 0.765901 15.9999 0.888863V6.2222C15.9999 6.71314 15.6019 7.11109 15.111 7.11109C14.62 7.11109 14.2221 6.71314 14.2221 6.2222V3.03488L6.8506 10.4063C6.67719 10.5799 6.44971 10.6666 6.22223 10.6666Z" fill="#DA5D28"/>
 42 |                                         </g>
 43 |                                         <defs>
 44 |                                             <clipPath id="clip0_14819_9754">
 45 |                                                 <rect width="16" height="16" fill="white"/>
 46 |                                             </clipPath>
 47 |                                         </defs>
 48 |                                     </svg>
 49 |                                 </div>
 50 |                                 <a title="<?= $block->escapeHtml(__($question['title'])); ?>" href="<?= $block->escapeHtml(__($link)); ?>" target="_blank" rel="nofollow noopener"><?= $block->escapeHtml(__($question['title'])); ?></a>
 51 |                             </li>
 52 |                             <?php break; ?>
 53 |                         <?php } ?>
 54 |                     <?php } ?>
 55 |                 </ul>
 56 |             </div>
 57 |             <div class="magefan-aug-footer">
 58 |                 <a title="<?= $block->escapeHtml(__('Admin Guide Configuration')) ?>" class="config_link" href="<?= $block->escapeHtml($block->getUrl('adminhtml/system_config/edit', ['section' => 'mfadminuserguide'])) ?>">
 59 |                     <span class="icon">
 60 |                         <svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" fill="none">
 61 |                             <path d="M26.9441 17.9076L25.9457 17.0857C25.2618 16.5227 25.263 15.4762 25.9457 14.9143L26.9441 14.0924C27.6546 13.5075 27.8363 12.5044 27.3762 11.7073L25.4047 8.29267C24.9445 7.49561 23.9848 7.15155 23.1231 7.47433L21.9121 7.92803C21.0826 8.23872 20.177 7.7147 20.0316 6.84236L19.8191 5.5667C19.6677 4.65892 18.89 4 17.9696 4H14.0267C13.1063 4 12.3285 4.65892 12.1772 5.56675L11.9646 6.84236C11.819 7.71625 10.9121 8.2382 10.0842 7.92808L8.87314 7.47433C8.01144 7.15155 7.05181 7.49566 6.59155 8.29267L4.62012 11.7073C4.15995 12.5043 4.34164 13.5074 5.05222 14.0924L6.05061 14.9143C6.73461 15.4773 6.73325 16.5237 6.05061 17.0856L5.05217 17.9075C4.34164 18.4925 4.15991 19.4956 4.62008 20.2926L6.59155 23.7073C7.05176 24.5043 8.0112 24.8484 8.87314 24.5256L10.0841 24.0719C10.9137 23.7611 11.8192 24.2855 11.9645 25.1576L12.1772 26.4332C12.3285 27.3411 13.1063 28 14.0267 28H17.9696C18.8899 28 19.6677 27.3411 19.819 26.4333L20.0316 25.1577C20.1772 24.284 21.084 23.7617 21.9121 24.072L23.1231 24.5257C23.985 24.8485 24.9445 24.5044 25.4047 23.7073L27.3762 20.2926C27.8363 19.4956 27.6546 18.4925 26.9441 17.9076ZM23.7809 22.7698L22.5699 22.3161C20.634 21.5909 18.5213 22.8144 18.1822 24.8494L17.9696 26.125H14.0267L13.8141 24.8494C13.4743 22.8105 11.3585 21.5923 9.42636 22.3161L8.21534 22.7698L6.24392 19.3552L7.24231 18.5333C8.83836 17.2194 8.83503 14.7779 7.24231 13.4667L6.24392 12.6448L8.21539 9.23017L9.42636 9.68388C11.3623 10.409 13.475 9.18559 13.8141 7.15061L14.0267 5.875H17.9696L18.1821 7.15061C18.522 9.18977 20.6379 10.4075 22.5699 9.68388L23.7809 9.23017L25.7528 12.6444C25.7528 12.6444 25.7526 12.6445 25.7523 12.6448L24.7539 13.4667C23.1579 14.7805 23.1611 17.222 24.7539 18.5332L25.7523 19.3551L23.7809 22.7698ZM15.9981 11.375C13.4479 11.375 11.3731 13.4498 11.3731 16C11.3731 18.5502 13.4479 20.625 15.9981 20.625C18.5484 20.625 20.6232 18.5502 20.6232 16C20.6232 13.4498 18.5484 11.375 15.9981 11.375ZM15.9981 18.75C14.4818 18.75 13.2481 17.5164 13.2481 16C13.2481 14.4836 14.4818 13.25 15.9981 13.25C17.5145 13.25 18.7482 14.4836 18.7482 16C18.7482 17.5164 17.5145 18.75 15.9981 18.75Z" fill="currentColor" />
 62 |                         </svg>
 63 |                     </span>
 64 |                     <span>Admin Guide Configuration</span>
 65 |                 </a>
 66 |             </div>
 67 |         </div>
 68 |     </div>
 69 |     <?php $script = "
 70 |         require(['jquery', 'domReady!'], function($){
 71 |             $('#magefan_show_help').click(function() {
 72 |                 $('#magefan_aug').toggle();
 73 |             });
 74 |             
 75 |             $('.action-close').click(function() {
 76 |                 $('#magefan_aug').hide();
 77 |             });
 78 |         });
 79 |     "; ?>
 80 |     <?= /* @noEscape */ $mfSecureRenderer->renderTag('script', [], $script, false) ?>
 81 |     <style>
 82 | 		#magefan_help_container {position: fixed;right: 20px;bottom: 20px;z-index: 99999;}
 83 | 		#magefan_show_help {cursor:pointer; display: flex;align-items: center;justify-content: center;width: 48px;height: 48px;border-radius: 50%;background: #2F3045;}
 84 | 		#magefan_show_help:hover {background: #504944;}
 85 | 
 86 | 		/* aug */
 87 | 		#magefan_aug {position: absolute;bottom: 75px;right: 10px;z-index: 1;width: 520px;max-width: 520px;max-height: 70vh;padding: 0;background: #fff;border-radius: 9px;box-shadow: 0 4px 14px 0 rgba(0, 0, 0, 0.25);overflow: hidden;}
 88 | 		#magefan_aug .magefan-aug-header {font-size: 24px;font-weight: 600;padding: 22px 22px 18px;color: #141414;position: relative;}
 89 | 		#magefan_aug .magefan-aug-header .action-close {width: 18px;height: 18px;line-height: 14px;vertical-align: middle;position: absolute;top: 30px;right: 24px;z-index: 1;}
 90 | 		#magefan_aug .magefan-aug-header .action-close:before {display: inline-block;width: 18px;height: 18px;color: #98A2B3;font-size: 18px;line-height: 1;vertical-align: middle;}
 91 | 		#magefan_aug .magefan-aug-header .action-close > span {border: 0;clip: rect(0, 0, 0, 0);height: 1px;margin: -1px;overflow: hidden;padding: 0;position: absolute;width: 1px;}
 92 | 
 93 | 		#magefan_aug .magefan-aug-content {padding: 0 22px;max-height: calc(70vh - 145px);overflow-y: auto;}
 94 | 		#magefan_aug .magefan-aug-content ul {margin: 0;padding: 0;list-style: none;}
 95 | 		#magefan_aug .magefan-aug-content ul li {padding: 0;margin-bottom: 14px;color: #141414;font-size: 16px;line-height: 20px;font-weight: 600;}
 96 | 		#magefan_aug .magefan-aug-content ul li .icon {width: 32px;height: 32px;display: flex;align-items: center;justify-content: center;margin-right: 12px;float: left;background: #fbefe9;border-radius: 50%;}
 97 | 		#magefan_aug .magefan-aug-content ul li a {color: #141414;font-size: 16px;line-height: 30px;font-weight: 600;}
 98 | 		#magefan_aug .magefan-aug-content ul li a:hover {color: #DA5D28;text-decoration: none;}
 99 | 
100 | 		#magefan_aug .magefan-aug-footer {padding: 20px 22px;background: #F2F4F7;}
101 | 		#magefan_aug .magefan-aug-footer .config_link {display: flex;align-items: center;font-size: 16px;line-height: 20px;font-weight: 600;color: #141414;}
102 | 		#magefan_aug .magefan-aug-footer .config_link:hover {text-decoration: none;color: #DA5D28;}
103 | 		#magefan_aug .magefan-aug-footer .config_link .icon {width: 32px;height: 32px;display: inline-flex;margin-right: 12px;color: #b2b2b2;}
104 | 		#magefan_aug .magefan-aug-footer .config_link:hover .icon {color: #DA5D28;}
105 | 
106 | 		/* Animation */
107 | 		#magefan_show_help {
108 | 			-webkit-animation: rotate 30s linear;-moz-animation: rotate 30s linear;animation: rotate 30s linear;
109 | 		}
110 | 		@keyframes rotate {
111 | 			0% {
112 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
113 | 			}
114 | 			10% {
115 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
116 | 			}
117 | 			20% {
118 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
119 | 			}
120 | 			30% {
121 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
122 | 			}
123 | 			40% {
124 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
125 | 			}
126 | 			50% {
127 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
128 | 			}
129 | 			60% {
130 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
131 | 			}
132 | 			70% {
133 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
134 | 			}
135 | 			80% {
136 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
137 | 			}
138 | 			90% {
139 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
140 | 			}
141 | 			100% {-webkit-transform: rotateY(-360deg);-o-transform: rotateY(-360deg);transform: rotateY(-360deg);
142 | 			}
143 | 		}
144 | 		@-webkit-keyframes rotate {
145 | 			0% {
146 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
147 | 
148 | 			}
149 | 			10% {
150 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
151 | 			}
152 | 			20% {
153 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
154 | 			}
155 | 			30% {
156 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
157 | 			}
158 | 			40% {
159 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
160 | 			}
161 | 			50% {
162 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
163 | 			}
164 | 			60% {
165 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
166 | 			}
167 | 			70% {
168 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
169 | 			}
170 | 			80% {
171 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
172 | 			}
173 | 			90% {
174 | 				-webkit-transform: rotateY(0deg);-o-transform: rotateY(0deg);transform: rotateY(0deg);
175 | 			}
176 | 			100% {-webkit-transform: rotateY(-360deg);-o-transform: rotateY(-360deg);transform: rotateY(-360deg);
177 | 			}
178 | 		}
179 |     </style>
180 | <?php }?>
181 | 


--------------------------------------------------------------------------------