Merge branch 'release/1.0.0'

firegento · Oct 26, 2013 · 036cd34 · 036cd34
2 parents 990e745 + 1183e4a
commit 036cd34
Show file tree

Hide file tree

Showing 48 changed files with 2,428 additions and 234 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,70 @@
-# FIREGENTO CUSTOMER
+FireGento_Customer
+==================
 
-Extended version of Core Customer models. New functionalities:
+This extension extends the core functionality of the customer module of Magento.
+
+Branches
+--------
+* master => stable version of the extension
+* develop => contains new features
+
+Facts
+-----
+- Version: check [config.xml](https://github.com/firegento/firegento-customer/blob/master/src/app/code/community/FireGento/Customer/etc/config.xml)
+- [Extension on GitHub](https://github.com/firegento/firegento-customer/)
+
+Description
+-----------
+This extension extends the core functionality of the customer module of Magento. The features of this extension are:
 
 * Customers can be deactivated. Deactivated customers can be filtered in customer grid.
-* Customers are temporarily deactivated if wrong password given too often.
+* Customers are temporarily deactivated if wrong password is entered too often.
+* Password can be validated and rejected (password strength, password length, ..)
+
+Requirements
+------------
+- PHP >= 5.3.0
+
+Compatibility
+-------------
+- Magento >= 1.6
+
+Installation Instructions
+-------------------------
+1. Install the extension by copying all the extension files into your document root.
+2. Clear the cache, logout from the admin panel and then login again.
+3. You can now configure the extenion via *System -> Configuration -> Customer -> Customer Configuration -> Password*
+
+Uninstallation
+--------------
+1. Remove all extension files from your Magento installation
+2. Run the following sql script in your database:
+
+```sql
+DELETE FROM eav_attribute WHERE attribute_code = 'customer_active';
+DELETE FROM eav_attribute WHERE attribute_code = 'customer_logins_failed';
+DELETE FROM eav_attribute WHERE attribute_code = 'customer_last_login_failed';
+```
+
+
+Support
+-------
+If you have any issues with this extension, open an issue on [GitHub](https://github.com/firegento/firegento-customer/issues).
+
+Contribution
+------------
+Any contribution is highly appreciated. The best way to contribute code is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).
+
+Developer
+---------
+FireGento Team
+* Website: [http://firegento.com](http://firegento.com)
+* Twitter: [@firegento](https://twitter.com/firegento)
+
+License
+-------
+[GNU General Public License, version 3 (GPLv3)](http://opensource.org/licenses/gpl-3.0)
+
+Copyright
+---------
+(c) 2013 FireGento Team
diff --git a/composer.json b/composer.json
@@ -1,9 +1,16 @@
 {
-   "name": "firegento/customer",
-   "license": ["GPL-3.0"],
-   "type": "magento-module",
-   "description": "Activate/deactivate customers, deactivate customers after max-retry logins.",
-   "require": {
-      "magento-hackathon/magento-composer-installer": "*"
-   }
+  "name": "firegento/customer",
+  "license": ["GPL-3.0"],
+  "type": "magento-module",
+  "description": "Activate/deactivate customers, deactivate customers after max-retry logins.",
+  "homepage": "https://github.com/firegento/firegento-customer",
+  "require": {
+    "magento-hackathon/magento-composer-installer": "*"
+  },
+  "repositories": [
+    {
+      "type": "composer",
+      "url": "http://packages.firegento.com"
+    }
+  ]
 }
diff --git a/docs/api/html/classes/FireGento_Customer_Block_Password.xhtml b/docs/api/html/classes/FireGento_Customer_Block_Password.xhtml
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "html" "">
+<html xmlns="http://www.w3.org/1999/xhtml" class="no-js" lang="en">
+  <head>
+    <meta charset="utf-8"/>
+    <title>FireGento_Customer - FireGento_Customer_Block_Password - API Documentation</title>
+    <link href="../css/normalize.css" rel="stylesheet" type="text/css" media="all"/>
+    <link href="../css/styles.css" rel="stylesheet" type="text/css" media="all"/>
+  </head>
+  <body>
+    <div class="wrapper clearfix">
+      <div class="topbar clearfix">
+        <h1>
+          <a class="brand" href="../index.xhtml">FireGento_Customer - API Documentation</a>
+        </h1>
+        <ul class="nav">
+          <li class="active">
+            <a href="../index.xhtml">Overview</a>
+          </li>
+        </ul>
+      </div>
+      <div class="navigation">
+        <h3>Methods</h3>
+        <ul>
+          <li>
+            <a href="#_construct">_construct</a>
+          </li>
+          <li>
+            <a href="#_toHtml">_toHtml</a>
+          </li>
+          <li>
+            <a href="#getMinimumPasswordLength">getMinimumPasswordLength</a>
+          </li>
+        </ul>
+      </div>
+      <div class="content">
+        <h2><span style="font-size:60%">\</span>FireGento_Customer_Block_Password</h2>
+        <div class="file-notice">
+          <p>Adds the custom password validation rules to the page if activated</p>
+        </div>
+        <ul class="fileinfos">
+          <li><b>Author: </b>FireGento Team &lt;[email protected]&gt;</li>
+        </ul>
+        <h3>Methods</h3>
+        <ul class="varlist">
+          <li>
+            <a name="getMinimumPasswordLength"/>
+            <h4><span class="label public">public</span>getMinimumPasswordLength<span style="font-size:90%;">(  )</span></h4>
+            <p style="font-size:110%; padding-top:5px;">
+              <li>Retrieve the minimum password length</li>
+            </p>
+            <ul>
+              <h4 class="return">Returns:</h4>
+              <ul class="return">
+                <li>Minimum Password length</li>
+              </ul>
+            </ul>
+          </li>
+          <li>
+            <a name="_construct"/>
+            <h4><span class="label protected">protected</span>_construct<span style="font-size:90%;">(  )</span></h4>
+            <p style="font-size:110%; padding-top:5px;">
+              <li>Set the block template</li>
+            </p>
+          </li>
+          <li>
+            <a name="_toHtml"/>
+            <h4><span class="label protected">protected</span>_toHtml<span style="font-size:90%;">(  )</span></h4>
+            <p style="font-size:110%; padding-top:5px;">
+              <li>Deactivate output if not activated</li>
+            </p>
+            <ul>
+              <h4 class="return">Returns:</h4>
+              <ul class="return">
+                <li>Rendered output</li>
+              </ul>
+            </ul>
+          </li>
+        </ul>
+        <div class="footer">Generated using phpDox 0.5 - Copyright (C) 2010 - 2013 by Arne Blankerts</div>
+      </div>
+    </div>
+  </body>
+</html>
diff --git a/docs/api/html/classes/FireGento_Customer_Exception.xhtml b/docs/api/html/classes/FireGento_Customer_Exception.xhtml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "html" "">
+<html xmlns="http://www.w3.org/1999/xhtml" class="no-js" lang="en">
+  <head>
+    <meta charset="utf-8"/>
+    <title>FireGento_Customer - FireGento_Customer_Exception - API Documentation</title>
+    <link href="../css/normalize.css" rel="stylesheet" type="text/css" media="all"/>
+    <link href="../css/styles.css" rel="stylesheet" type="text/css" media="all"/>
+  </head>
+  <body>
+    <div class="wrapper clearfix">
+      <div class="topbar clearfix">
+        <h1>
+          <a class="brand" href="../index.xhtml">FireGento_Customer - API Documentation</a>
+        </h1>
+        <ul class="nav">
+          <li class="active">
+            <a href="../index.xhtml">Overview</a>
+          </li>
+        </ul>
+      </div>
+      <div class="navigation"/>
+      <div class="content">
+        <h2><span style="font-size:60%">\</span>FireGento_Customer_Exception</h2>
+        <div class="file-notice">
+          <p>Custom exception class.</p>
+        </div>
+        <ul class="fileinfos">
+          <li><b>Author: </b>FireGento Team &lt;[email protected]&gt;</li>
+        </ul>
+        <div class="footer">Generated using phpDox 0.5 - Copyright (C) 2010 - 2013 by Arne Blankerts</div>
+      </div>
+    </div>
+  </body>
+</html>
diff --git a/docs/api/html/classes/FireGento_Customer_Helper_Data.xhtml b/docs/api/html/classes/FireGento_Customer_Helper_Data.xhtml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "html" "">
+<html xmlns="http://www.w3.org/1999/xhtml" class="no-js" lang="en">
+  <head>
+    <meta charset="utf-8"/>
+    <title>FireGento_Customer - FireGento_Customer_Helper_Data - API Documentation</title>
+    <link href="../css/normalize.css" rel="stylesheet" type="text/css" media="all"/>
+    <link href="../css/styles.css" rel="stylesheet" type="text/css" media="all"/>
+  </head>
+  <body>
+    <div class="wrapper clearfix">
+      <div class="topbar clearfix">
+        <h1>
+          <a class="brand" href="../index.xhtml">FireGento_Customer - API Documentation</a>
+        </h1>
+        <ul class="nav">
+          <li class="active">
+            <a href="../index.xhtml">Overview</a>
+          </li>
+        </ul>
+      </div>
+      <div class="navigation"/>
+      <div class="content">
+        <h2><span style="font-size:60%">\</span>FireGento_Customer_Helper_Data</h2>
+        <div class="file-notice">
+          <p>Helper class for translations, etc.</p>
+        </div>
+        <ul class="fileinfos">
+          <li><b>Author: </b>FireGento Team &lt;[email protected]&gt;</li>
+        </ul>
+        <div class="footer">Generated using phpDox 0.5 - Copyright (C) 2010 - 2013 by Arne Blankerts</div>
+      </div>
+    </div>
+  </body>
+</html>