Merge pull request #24 from websharp/release/r1.2.0

Updated docs to match Magento2 marketplace regulations
bitExpert · Sep 1, 2016 · ea8e147 · ea8e147
2 parents 3b39b77 + 7e0226a
commit ea8e147
Show file tree

Hide file tree

Showing 47 changed files with 131 additions and 102 deletions.
diff --git a/Api/Controller/LoginCheckInterface.php b/Api/Controller/LoginCheckInterface.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Api/Data/Collection/WhitelistEntryCollectionFactoryInterface.php b/Api/Data/Collection/WhitelistEntryCollectionFactoryInterface.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Api/Data/Collection/WhitelistEntrySearchResultInterface.php b/Api/Data/Collection/WhitelistEntrySearchResultInterface.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Api/Data/WhitelistEntryFactoryInterface.php b/Api/Data/WhitelistEntryFactoryInterface.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Api/Data/WhitelistEntryInterface.php b/Api/Data/WhitelistEntryInterface.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Api/Observer/LoginRequiredObserverInterface.php b/Api/Observer/LoginRequiredObserverInterface.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Api/Repository/WhitelistRepositoryInterface.php b/Api/Repository/WhitelistRepositoryInterface.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Block/Adminhtml/Whitelist.php b/Block/Adminhtml/Whitelist.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Block/Adminhtml/Whitelist/Create.php b/Block/Adminhtml/Whitelist/Create.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Block/Adminhtml/Whitelist/Create/Form.php b/Block/Adminhtml/Whitelist/Create/Form.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Block/Adminhtml/Whitelist/Create/Submit.php b/Block/Adminhtml/Whitelist/Create/Submit.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Changelog.md b/Changelog.md
@@ -221,4 +221,4 @@ All notable changes to this project will be documented in this file, in reverse
 
 ## 1.0.0
 
-Initial release of the Magento2 Force Frontend Customer Login Module package.
+Initial release of the Force Login module for Magento2.
diff --git a/Controller/Adminhtml/Whitelist/Create.php b/Controller/Adminhtml/Whitelist/Create.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Controller/Adminhtml/Whitelist/Delete.php b/Controller/Adminhtml/Whitelist/Delete.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Controller/Adminhtml/Whitelist/Edit.php b/Controller/Adminhtml/Whitelist/Edit.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Controller/Adminhtml/Whitelist/Index.php b/Controller/Adminhtml/Whitelist/Index.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Controller/Adminhtml/Whitelist/Save.php b/Controller/Adminhtml/Whitelist/Save.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Controller/LoginCheck.php b/Controller/LoginCheck.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Model/ResourceModel/WhitelistEntry.php b/Model/ResourceModel/WhitelistEntry.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Model/ResourceModel/WhitelistEntry/Collection.php b/Model/ResourceModel/WhitelistEntry/Collection.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Model/ResourceModel/WhitelistEntry/CollectionFactory.php b/Model/ResourceModel/WhitelistEntry/CollectionFactory.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Model/WhitelistEntry.php b/Model/WhitelistEntry.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Model/WhitelistEntryFactory.php b/Model/WhitelistEntryFactory.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Model/WhitelistEntrySearchResultInterfaceFactory.php b/Model/WhitelistEntrySearchResultInterfaceFactory.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Observer/LoginRequiredOnCustomerSessionInitObserver.php b/Observer/LoginRequiredOnCustomerSessionInitObserver.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Observer/LoginRequiredOnVisitorInitObserver.php b/Observer/LoginRequiredOnVisitorInitObserver.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/README.md b/README.md
@@ -1,60 +1,60 @@
-# Force Frontend Customer Login Module for Magento2
-
-The *Force Frontend Customer Login* Module for **Magento2** redirects a storefront visitor to the Magento2 Frontend login page, 
-if the visitor is not logged in. It is possible to configure the whitelisted urls to add custom definitions.
-
-## Use Case
-
-Merchants provide some closed up products for only a specific group of users, e.g. enterprise related business partners and must assure only these partners can see the website or the product catalog.
-
-## Features:
-
-* Force your guest visitors to log in first (or register), before allowing them to visit your pages and catalog
-* Administration: Manage the whitelist rules by the GUI in the administration area
-* ACL: Restrict the administration of whitelist rules to certain backend user groups
-* Whitelisting: Define url rules as pattern to define which pages guest visitors can visit without logging in first
-* Multistore-Support: Define if whitelist rules either apply globally or for specific stores
-
-## Installation
-
-The preferred way of installing `bitexpert/magento2-force-customer-login` is through Composer. Simply add `bitexpert/magento2-force-customer-login` 
-as a dependency:
-
-```
-composer.phar require bitexpert/magento2-force-customer-login
-```
-
-## How to configure the module
-
-### Navigation
-
-Navigating through the *Magento 2* backend menu by clicking onto **Customers** you must see a new menu entry **Forced Login Whitelist**. 
-Enter this menu entry.
-
-![alt text](./resources/ui_step_01.png "UI Navigation")
-
-### Overview Grid
-
-You can add new entries by clicking on the *Add Entry* button in the upper right corner ( **1** ), [see below](#detail-form). 
-The grid ( **2** ) contains all existing whitelisted *Url Rules*, for which the forced redirect to the *Customer Login Page* is omitted.
-The *Url Rules* ( **3** ) are part of a regular expression checking on the called *Url* and tries to match against the whitelist.
-*Url Rules* may be related to all stores or to a specific one ( **4** ). All rules except some mandatory ones are editable ( **5** ) and removeable ( **6** ).
-
-![alt text](./resources/ui_step_02.png "UI Grid")
-
-### Detail Form
-
-You can return to the *Overview Grid* by using the *Back* button ( **1** ). The *Label* value has only declarative character and
-is for information purpose only ( **2** ). The *Url Rule* is part of a regular expression checking on the called 
-*Url* and tries to match against the whitelist ( **3** ). *Url Rules* may be related to all stores or to a specific one ( **4** ).
-Persist the rule by using the *Save* button ( **5** ).
-
-![alt text](./resources/ui_step_03.png "UI Form")
-
-## Contribution
-
-Feel free to contribute to this module by reporting issues or create some pull requests for improvements.
-
-## License
-
-The Magento2 Frontend Customer Force Login Module is released under the Apache 2.0 license.
+# Force Login Module for Magento® 2
+The **Force Login** Module for *Magento® 2* allows you to restrict which pages a visitor is
+able to see. Visitors get redirected to the login page if the page is not marked visitable.
+The **Force Login** Module for *Magento® 2* is especially useful for merchants serving only a specific
+group of users, e.g. enterprise related business partners and need to ensure that only those users are
+able to browse the the website or the product catalog.
+
+## Features:
+* Force your guest visitors to log in first (or register), before allowing them to visit your pages and catalog
+* Administration: Manage the whitelist rules by the GUI in the administration area
+* ACL: Restrict the administration of whitelist rules to certain backend user groups
+* Whitelisting: Define url rules as pattern to define which pages guest visitors can visit without logging in first
+* Multistore-Support: Define if whitelist rules either apply globally or for specific stores
+
+## Installation
+The preferred way of installing `bitexpert/magento2-force-customer-login` is through Composer. Simply add `bitexpert/magento2-force-customer-login` 
+as a dependency:
+
+```
+composer.phar require bitexpert/magento2-force-customer-login
+```
+
+# User Guide
+Find the complete user guide [here](./docs/UserGuide.pdf "User Guide").
+
+## How to use
+The usage of the **Force Login** Module for *Magento® 2* is applied implicitly by redirecting visitors 
+if the called URI does not match any configured whitelisted url rules.
+
+## How to configure
+
+### Navigation
+Navigating through the *Magento® 2* backend menu by clicking onto **Customers** you must see a new menu 
+entry **Forced Login Whitelist**. 
+
+Enter this menu entry.
+
+![alt text](./resources/ui_step_01.png "UI Navigation")
+
+### Overview Grid
+You can add new entries by clicking on the *Add Entry* button in the upper right corner ( **1** ), [see below](#detail-form). 
+The grid ( **2** ) contains all existing whitelisted *Url Rules*, for which the forced redirect to the *Customer Login Page* is omitted.
+The *Url Rules* ( **3** ) are part of a regular expression checking on the called *Url* and tries to match against the whitelist.
+*Url Rules* may be related to all stores or to a specific one ( **4** ). All rules except some mandatory ones are editable ( **5** ) and removeable ( **6** ).
+
+![alt text](./resources/ui_step_02.png "UI Grid")
+
+### Detail Form
+You can return to the *Overview Grid* by using the *Back* button ( **1** ). The *Label* value has only declarative character and
+is for information purpose only ( **2** ). The *Url Rule* is part of a regular expression checking on the called 
+*Url* and tries to match against the whitelist ( **3** ). *Url Rules* may be related to all stores or to a specific one ( **4** ).
+Persist the rule by using the *Save* button ( **5** ).
+
+![alt text](./resources/ui_step_03.png "UI Form")
+
+## Contribution
+Feel free to contribute to this module by reporting issues or create some pull requests for improvements.
+
+## License
+The **Force Login** Module for *Magento® 2* is released under the Apache 2.0 license.
diff --git a/Repository/WhitelistRepository.php b/Repository/WhitelistRepository.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Setup/UpgradeData.php b/Setup/UpgradeData.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Setup/UpgradeSchema.php b/Setup/UpgradeSchema.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Test/Unit/Controller/LoginCheckUnitTest.php b/Test/Unit/Controller/LoginCheckUnitTest.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *

diff --git a/Test/Unit/Observer/LoginRequiredOnCustomerSessionInitObserverUnitTest.php b/Test/Unit/Observer/LoginRequiredOnCustomerSessionInitObserverUnitTest.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Force Login Module package for Magento2.
+ * This file is part of the Force Login module for Magento2.
  *
  * (c) bitExpert AG
  *