Skip to content

Commit a97cfc8

Browse files
authored
Merge pull request #46 from Rahulsingh1939/main
Added Notice Module for password reset, updated docs and fixed tests.
2 parents 6df5405 + 8ae090d commit a97cfc8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+2174
-466
lines changed

assets/Module-guest-view.png

118 KB
Loading

assets/Module-logged-view.png

98.8 KB
Loading

assets/Module_configuration.png

72 KB
Loading

assets/Module_installation.png

102 KB
Loading

assets/Module_management.png

109 KB
Loading

composer.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,18 @@
1717
},
1818
"autoload": {
1919
"psr-4": {
20-
"Binary\\Component\\CmsMigrator\\": "src/component/admin/src/"
20+
"Joomla\\Component\\CmsMigrator\\Administrator\\": "src/component/admin/src/"
2121
}
2222
},
2323
"require-dev": {
2424
"phpunit/phpunit": "^10",
2525
"joomla/test": "^2",
26-
"mockery/mockery": "^1.6"
26+
"mockery/mockery": "^1.6",
27+
"squizlabs/php_codesniffer": "*"
2728
},
2829
"autoload-dev": {
2930
"psr-4": {
30-
"Binary\\Component\\CmsMigrator\\Tests\\": "tests/"
31+
"Joomla\\Component\\CmsMigrator\\Tests\\": "tests/unit/"
3132
}
3233
},
3334
"scripts": {

docs/Migration_Notice_Guide.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Migration Notice Module - User Manual
2+
3+
The Migration Notice Module helps to explain password reset requirements to end users after migrating from Source into Joomla. It displays clear instructions and reduces login issues.
4+
5+
---
6+
7+
## 🚀 Installation
8+
9+
### Step 1: Install the Module
10+
11+
#### The Module is by default installed with the com_cmsmigrator component. If you need to install it separately, follow these steps:
12+
13+
1. **Login** to Joomla Administrator
14+
2. **Go to** Extensions → Manage → Install
15+
3. **Upload** the ZIP file (`mod_migrationnotice_v1.0.0.zip`)
16+
4. **Click** Install
17+
18+
![Installation Process](../assets/Module_installation.png)
19+
20+
**Success**: Language overrides are automatically created for login error messages.
21+
22+
---
23+
24+
## ⚙️ Configuration
25+
26+
### Step 2: Set Up the Module
27+
1. **Go to** Extensions → Modules
28+
2. **Click** "New" → Select "Migration Notice Module"
29+
3. **Configure** these key settings:
30+
31+
![Module Configuration](../assets/Module_configuration.png)
32+
33+
| Setting | Recommended Value |
34+
|---------|------------------|
35+
| **Show Migration Notice** | Yes |
36+
| **Notice Type** | Both |
37+
| **Alert Style** | Warning |
38+
| **Show Password Reset Link** | Yes |
39+
| **Menu Assignment** | All Pages |
40+
| **Position** | Top |
41+
42+
4. **Save & Close**
43+
44+
---
45+
46+
## 👀 What Users See
47+
48+
### Guest Users (Not Logged In)
49+
![Guest User View](../assets/Module-guest-view.png)
50+
51+
Shows:
52+
- Migration explanation
53+
- Password reset requirement
54+
- Login button
55+
56+
### Logged-In Users
57+
![Logged User View](../assets/Module-logged-view.png)
58+
59+
Shows:
60+
- Password reset notice
61+
- Direct "Reset Password" button
62+
63+
## 🔧 Management
64+
65+
### Editing the Module
66+
**Extensions****Modules****Find your module****Click title to edit**
67+
68+
![Module Management](../assets/Module_management.png)
69+
70+
### Common Tasks
71+
- **Hide temporarily**: Set "Show Migration Notice" to No
72+
- **Change message**: Use "Custom Message" field
73+
- **Different pages**: Adjust "Menu Assignment"
74+
- **New position**: Change "Position" setting

0 commit comments

Comments
 (0)