-
Notifications
You must be signed in to change notification settings - Fork 1
/
AutoLoginPlugin.php
187 lines (167 loc) · 5.18 KB
/
AutoLoginPlugin.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<?php
/**
* Auto Login plugin for Craft CMS
*
* Automatically login a front end user after they have successfully used the password reset functionality to set a new password.
*
* --snip--
* Craft plugins are very much like little applications in and of themselves. We’ve made it as simple as we can,
* but the training wheels are off. A little prior knowledge is going to be required to write a plugin.
*
* For the purposes of the plugin docs, we’re going to assume that you know PHP and SQL, as well as some semi-
* advanced concepts like object-oriented programming and PHP namespaces.
*
* https://craftcms.com/docs/plugins/introduction
* --snip--
*
* @author Steve Rowling
* @copyright Copyright (c) 2016 Steve Rowling
* @link https://springworks.co.uk
* @package AutoLogin
* @since 1.0.0
*/
namespace Craft;
class AutoLoginPlugin extends BasePlugin
{
/**
* Called after the plugin class is instantiated; do any one-time initialization here such as hooks and events:
*
* craft()->on('entries.saveEntry', function(Event $event) {
* // ...
* });
*
* or loading any third party Composer packages via:
*
* require_once __DIR__ . '/vendor/autoload.php';
*
* @return mixed
*/
public function init()
{
craft()->on('users.setPassword', function(Event $event) {
// Retrieve the userModel from the event
$user = $event->params['user'];
// Check if this is a front end request, user is not already logged in, user doesn't have an unverified email address and we are not dealing with a new user
if (craft()->request->isSiteRequest() && craft()->userSession->isGuest() && !($user->unverifiedEmail) && ($user->id)) {
// Log the user in
craft()->userSession->loginByUserId($user->id);
}
});
}
/**
* Returns the user-facing name.
*
* @return mixed
*/
public function getName()
{
return Craft::t('Auto Login');
}
/**
* Plugins can have descriptions of themselves displayed on the Plugins page by adding a getDescription() method
* on the primary plugin class:
*
* @return mixed
*/
public function getDescription()
{
return Craft::t('Automatically login a front end user after they have successfully used the password reset functionality to set a new password.');
}
/**
* Plugins can have links to their documentation on the Plugins page by adding a getDocumentationUrl() method on
* the primary plugin class:
*
* @return string
*/
public function getDocumentationUrl()
{
return 'https://github.com/steverowling/autologin/blob/master/README.md';
}
/**
* Plugins can now take part in Craft’s update notifications, and display release notes on the Updates page, by
* providing a JSON feed that describes new releases, and adding a getReleaseFeedUrl() method on the primary
* plugin class.
*
* @return string
*/
public function getReleaseFeedUrl()
{
return 'https://raw.githubusercontent.com/steverowling/autologin/master/releases.json';
}
/**
* Returns the version number.
*
* @return string
*/
public function getVersion()
{
return '1.0.1';
}
/**
* As of Craft 2.5, Craft no longer takes the whole site down every time a plugin’s version number changes, in
* case there are any new migrations that need to be run. Instead plugins must explicitly tell Craft that they
* have new migrations by returning a new (higher) schema version number with a getSchemaVersion() method on
* their primary plugin class:
*
* @return string
*/
public function getSchemaVersion()
{
return '1.0.0';
}
/**
* Returns the developer’s name.
*
* @return string
*/
public function getDeveloper()
{
return 'Steve Rowling';
}
/**
* Returns the developer’s website URL.
*
* @return string
*/
public function getDeveloperUrl()
{
return 'https://springworks.co.uk';
}
/**
* Returns whether the plugin should get its own tab in the CP header.
*
* @return bool
*/
public function hasCpSection()
{
return false;
}
/**
* Called right before your plugin’s row gets stored in the plugins database table, and tables have been created
* for it based on its records.
*/
public function onBeforeInstall()
{
}
/**
* Called right after your plugin’s row has been stored in the plugins database table, and tables have been
* created for it based on its records.
*/
public function onAfterInstall()
{
}
/**
* Called right before your plugin’s record-based tables have been deleted, and its row in the plugins table
* has been deleted.
*/
public function onBeforeUninstall()
{
}
/**
* Called right after your plugin’s record-based tables have been deleted, and its row in the plugins table
* has been deleted.
*/
public function onAfterUninstall()
{
}
}