Added: porter.php config file example

bymayo · Aug 23, 2022 · b166884 · b166884
1 parent deab7a1
commit b166884
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Porter Changelog
 
+## 1.0.3 - 2022-08-23
+### Added
+- `porter.php` config file example.
+
 ## 1.0.2 - 2022-08-23
 ### Added
 - `craft.porter.deleteAccountFormProperties()` variable to get default delete account form template properties in Twig.

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "bymayo/porter",
     "description": "A toolkit with lots of helpers for users and accounts",
     "type": "craft-plugin",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "keywords": [
         "craft",
         "cms",

diff --git a/src/config.php b/src/config.php
@@ -1,12 +1,4 @@
 <?php
-/**
- * Porter plugin for Craft CMS 3.x
- *
- * A toolkit with lots of helpers for users and accounts
- *
- * @link      https://bymayo.co.uk
- * @copyright Copyright (c) 2020 Jason Mayo
- */
 
 /**
  * Porter config.php
@@ -24,7 +16,36 @@
 
 return [
 
-    // This controls blah blah blah
-    "someAttribute" => true,
+    // Delete Account
+    'deleteAccount' => false,
+    'deleteAccountConfirmationType' => 'confirmationKeyword',
+    'deleteAccountConfirmationKeyword' => 'DELETE',
+    'deleteAccountConfirmationField' => 'email',
+    'deleteAccountConfirmationEmail' => true,
+    'deleteAccountRedirect' => '/',
+    'deleteAccountTransfer' => null,
+
+    // Deactivate Account
+    'deactivateAccount' => false,
+    'deactivateAccountRedirect' => '/',
+    'deactivateAccountConfirmationEmail' => true,
+    'deactivateAccountDeleteDays' => 30,
+
+    // Magic Link
+    'magicLink' => false,
+    'magicLinkControlPanel' => false,
+    'magicLinkFrontEnd' => false,
+    'magicLinkExpirySeconds' => '300',
+    'magicLinkRedirect' => '/',
+
+    // Email
+    'emailBurners' => false,
+    'emailsBurnersVerifierApiKey' => null,
 
+    // Password
+    'passwordForcePolicy' => false,
+    'passwordForcePolicyMin' => 8,
+    'passwordForcePolicyMax' => 128,
+    'passwordForcePolicyRules' => null
+
 ];