Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated docs to match Magento2 marketplace regulations #24

Merged
merged 5 commits into from
Sep 1, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Api/Controller/LoginCheckInterface.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Api/Data/WhitelistEntryFactoryInterface.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Api/Data/WhitelistEntryInterface.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Api/Observer/LoginRequiredObserverInterface.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Api/Repository/WhitelistRepositoryInterface.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Block/Adminhtml/Whitelist.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Block/Adminhtml/Whitelist/Create.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Block/Adminhtml/Whitelist/Create/Form.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Block/Adminhtml/Whitelist/Create/Submit.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion Controller/Adminhtml/Whitelist/Create.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Controller/Adminhtml/Whitelist/Delete.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Controller/Adminhtml/Whitelist/Edit.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Controller/Adminhtml/Whitelist/Index.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Controller/Adminhtml/Whitelist/Save.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Controller/LoginCheck.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Model/ResourceModel/WhitelistEntry.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Model/ResourceModel/WhitelistEntry/Collection.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Model/ResourceModel/WhitelistEntry/CollectionFactory.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Model/WhitelistEntry.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Model/WhitelistEntryFactory.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Model/WhitelistEntrySearchResultInterfaceFactory.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Observer/LoginRequiredOnCustomerSessionInitObserver.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Observer/LoginRequiredOnVisitorInitObserver.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
120 changes: 60 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion Repository/WhitelistRepository.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Setup/UpgradeData.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Setup/UpgradeSchema.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion Test/Unit/Controller/LoginCheckUnitTest.php
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
Loading