ProfileForm::setNewEmail() - Code Metrics - charlesportwoodii/CiiMS - Measure and Improve Code Quality continuously with Scrutinizer

ProfileForm::setNewEmail() A
last analyzed 2017-09-05 15:05 UTC

↳ Parent: ProfileForm

Complexity

Conditions	2
Paths	2

Size

Total Lines	21
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	9.3142
c	0
b	0
f	0
cc	2
eloc	11
nc	2
nop	0

<?php

class ProfileForm extends CFormModel
namespace YourVendor;

class YourClass { }
{
	/**
	 * The user's email address
	 * @var string $email
	 */
	public $email;

	/**
	 * The user's NEW password
	 * @var string $password
	 */
	public $password;

	/**
	 * The repeated password if a NEW password is applied
	 * @var string $password_repeat
	 */
	public $password_repeat;

	/**
	 * The user's current password
	 * This field is required to make any changes to the account
	 * @var string $currentPassword
	 */
	public $currentPassword;

	/**
	 * The user's display name
	 * @var string $username
	 */
	public $username;

	/**
	 * The user role
	 * @var int $role
	 */
	public $user_role;

	/**
	 * The user model
	 * @var Users $_user
	 */
	private $_user = NULL;

	/**
	 * This form will likely be reused in admin portals, for re-use purposes authentication is not required to change privileged information
	 * @var boolean $overridePasswordCheck
	 */
	private $overridePasswordCheck = false;


	private function canOverridePasswordCheck()
	{
		if ($this->overridePasswordCheck)
			return true;

		if (isset(Yii::app()->user) && $this->getId() == Yii::app()->user->id)
			return true;

		return false;
	}

	/**
	 * Overload of the __getter method to retrieve the user's ID
	 * @var int $id
	 */
	public function getId()
	{
		return $this->_user->id;
	}

	/**
	 * Retrieves the new email address if it is set
	 * @return mixed
	 */
	public function getNewEmail()
	{
		$metadata = UserMetadata::model()->findByAttributes(array(
			'user_id' => $this->_user->id,
			'key'     => 'newEmailAddress'
		));

		if ($metadata == NULL)
			return NULL;

		return $metadata->value;
	}

	/**
	 * Sets the new email address
	 * @return boolean
	 */
	public function setNewEmail()
	{
		$metadata = UserMetadata::model()->findByAttributes(array(
			'user_id' => $this->_user->id,
			'key'     => 'newEmailAddress'
		));

		if ($metadata == NULL)
		{
			$metadata = new UserMetadata;
			$metadata->attributes = array(
				'user_id' => $this->_user->id,
				'key'     => 'newEmailAddress'
			);
		}

		$metadata->value = $this->email;

		// Save the record
		return $metadata->save();
	}

	/**
	 * Retrieves the new email address if it is set
	 * @return mixed
	 */
	public function getNewEmailChangeKey()
	{
		$metadata = UserMetadata::model()->findByAttributes(array(
			'user_id' => $this->_user->id,
			'key'     => 'newEmailAddressChangeKey'
		));

		if ($metadata == NULL)
			return NULL;

		return $metadata->value;
	}

	/**
	 * Generates a new change key
	 * @return boolean
	 */
	public function setNewEmailChangeKey()
	{
		$metadata = UserMetadata::model()->findByAttributes(array(
			'user_id' => $this->_user->id,
			'key'     => 'newEmailAddressChangeKey'
		));

		if ($metadata == NULL)
		{
			$metadata = new UserMetadata;
			$metadata->attributes = array(
				'user_id' => $this->_user->id,
				'key'     => 'newEmailAddressChangeKey'
			);
		}

		// Generate a new key
		$metadata->value = Cii::generateSafeHash();

		// Save the record
		if ($metadata->save())
			return $metadata->value;
	
		throw new CHttpException(500, Yii::t('ciims.ProfileForm', 'Unable to save change key'));
	}

	/**
	 * Validation rules
	 * @return array
	 */
	public function rules()
	{
		return array(
			array('email, username', 'required'),
			array('username', 'length', 'max' => 255),
			array('currentPassword', 'validateUserPassword'),
			array('password', 'compare'),
			array('password', 'length', 'min' => 8),
			array('user_role', 'numerical'),
			array('user_role', 'validateUserRole')
		);
	}

	/**
	 * Retrieves the attributes labels from the Users model and returns them to reduce code redundancy
	 * @return array
	 */
	public function attributeLabels()
	{
		return CMap::mergeArray(Users::model()->attributeLabels(), array(
			'currentPassword' => Yii::t('ciims.models.ProfileForm', 'Your current password'),
			'password_repeat' => Yii::t('ciims.models.ProfileForm', 'Your New Password (again)')
		));
	}

	/**
	 * Validates the role
	 * @param array $attributes
	 * @param array $params
	 * return array
	 */
	public function validateUserRole($attributes, $params)
	{
		if ($this->canOverridePasswordCheck())
			return true;

		$this->addError('user_role', Yii::t('ciims.models.ProfileForm', 'You do not have permission to modify this attribute'));
		return false;
	}

	/**
	 * Ensures that the password entered matches the one provided during registration
	 * @param array $attributes
	 * @param array $params
	 * return array
	 */
	public function validateUserPassword($attributes, $params)
	{
		// Apply the override if it was set
		if ($this->canOverridePasswordCheck())
		{
			$this->password_repeat = $this->password;
			return true;
		}

		$result = password_verify($this->password, $this->_user->password);
		
		if ($result == false)
		{
			$this->addError('currentPassword', Yii::t('ciims.models.ProfileForm', 'The password you entered is invalid.'));
			return false;
		}

		return true;
	}

	/**
	 * Internally loads the user's information before attempting to validate it
	 * @param int  $id         The user's ID
	 * @param bool $override   This form may be reused
	 * @return ProfileForm
	 */
	public function load($id, $override = false)
	{
		$this->overridePasswordCheck = $override;

		// Load the user
		$this->_user = Users::model()->findByPk($id);

		if ($this->_user == NULL)
			throw new CHttpException(400, Yii::t('ciims.models.ProfileForm', 'The request user\'s profile could not be loaded'));

		// Reload the attribute labels
		$this->attributes = array(
			'email'         => $this->_user->email,
			'username'      => $this->_user->username,
			'user_role'     => $this->_user->role->id
		);

		return $this;
	}

	/**
	 * Updates the user's profile information
	 * @return boolean
	 */
	public function save()
	{
		if (!$this->validate(NULL, false))
			return false;

		// Change the email address, if necessary
		$this->changeEmail();

		$this->_user->attributes = array(
			'password'      => $this->password,
			'username'      => $this->username,
			'user_role'     => $this->user_role
		);

		if ($this->_user->save())
			return true;

		return false;
	}

	/**
	 * Changes the user's email address if necessary
	 * @return boolean
	 */
	private function changeEmail()
	{
		if ($this->email != $this->_user->email)
		{
			$this->setNewemail();
			$this->setNewEmailChangeKey();
			$this->sendVerificationEmail();
		}

		return true;
	}

	/**
	 * Sends the verification email to the user. This is broken to it's own method to allow for the resending email to be resent
	 * @return boolean
	 */
	public function sendVerificationEmail()
	{
		$emailSettings = new EmailSettings;
        return $emailSettings->send(
			$this->_user,
			Yii::t('ciims.models.Users', 'CiiMS Email Change Notification'),
			'base.themes.' . Cii::getConfig('theme', 'default') .'.views.email.email-change',
			array(
				'key' => $this->setNewEmailChangeKey(),
				'user' => $this->_user
			)
		);
	}
}


1			<?php
2
3			class ProfileForm extends CFormModel
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-24 15:26 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
4			{
5			/**
6			* The user's email address
7			* @var string $email
8			*/
9			public $email;
10
11			/**
12			* The user's NEW password
13			* @var string $password
14			*/
15			public $password;
16
17			/**
18			* The repeated password if a NEW password is applied
19			* @var string $password_repeat
20			*/
21			public $password_repeat;
22
23			/**
24			* The user's current password
25			* This field is required to make any changes to the account
26			* @var string $currentPassword
27			*/
28			public $currentPassword;
29
30			/**
31			* The user's display name
32			* @var string $username
33			*/
34			public $username;
35
36			/**
37			* The user role
38			* @var int $role
39			*/
40			public $user_role;
41
42			/**
43			* The user model
44			* @var Users $_user
45			*/
46			private $_user = NULL;
47
48			/**
49			* This form will likely be reused in admin portals, for re-use purposes authentication is not required to change privileged information
50			* @var boolean $overridePasswordCheck
51			*/
52			private $overridePasswordCheck = false;
53
54
55			private function canOverridePasswordCheck()
56			{
57			if ($this->overridePasswordCheck)
58			return true;
59
60			if (isset(Yii::app()->user) && $this->getId() == Yii::app()->user->id)
61			return true;
62
63			return false;
64			}
65
66			/**
67			* Overload of the __getter method to retrieve the user's ID
68			* @var int $id
69			*/
70			public function getId()
71			{
72			return $this->_user->id;
73			}
74
75			/**
76			* Retrieves the new email address if it is set
77			* @return mixed
78			*/
79			public function getNewEmail()
80			{
81			$metadata = UserMetadata::model()->findByAttributes(array(
82			'user_id' => $this->_user->id,
83			'key' => 'newEmailAddress'
84			));
85
86			if ($metadata == NULL)
87			return NULL;
88
89			return $metadata->value;
90			}
91
92			/**
93			* Sets the new email address
94			* @return boolean
95			*/
96			public function setNewEmail()
97			{
98			$metadata = UserMetadata::model()->findByAttributes(array(
99			'user_id' => $this->_user->id,
100			'key' => 'newEmailAddress'
101			));
102
103			if ($metadata == NULL)
104			{
105			$metadata = new UserMetadata;
106			$metadata->attributes = array(
107			'user_id' => $this->_user->id,
108			'key' => 'newEmailAddress'
109			);
110			}
111
112			$metadata->value = $this->email;
113
114			// Save the record
115			return $metadata->save();
116			}
117
118			/**
119			* Retrieves the new email address if it is set
120			* @return mixed
121			*/
122			public function getNewEmailChangeKey()
123			{
124			$metadata = UserMetadata::model()->findByAttributes(array(
125			'user_id' => $this->_user->id,
126			'key' => 'newEmailAddressChangeKey'
127			));
128
129			if ($metadata == NULL)
130			return NULL;
131
132			return $metadata->value;
133			}
134
135			/**
136			* Generates a new change key
137			* @return boolean
138			*/
139			public function setNewEmailChangeKey()
140			{
141			$metadata = UserMetadata::model()->findByAttributes(array(
142			'user_id' => $this->_user->id,
143			'key' => 'newEmailAddressChangeKey'
144			));
145
146			if ($metadata == NULL)
147			{
148			$metadata = new UserMetadata;
149			$metadata->attributes = array(
150			'user_id' => $this->_user->id,
151			'key' => 'newEmailAddressChangeKey'
152			);
153			}
154
155			// Generate a new key
156			$metadata->value = Cii::generateSafeHash();
157
158			// Save the record
159			if ($metadata->save())
160			return $metadata->value;
161
162			throw new CHttpException(500, Yii::t('ciims.ProfileForm', 'Unable to save change key'));
163			}
164
165			/**
166			* Validation rules
167			* @return array
168			*/
169			public function rules()
170			{
171			return array(
172			array('email, username', 'required'),
173			array('username', 'length', 'max' => 255),
174			array('currentPassword', 'validateUserPassword'),
175			array('password', 'compare'),
176			array('password', 'length', 'min' => 8),
177			array('user_role', 'numerical'),
178			array('user_role', 'validateUserRole')
179			);
180			}
181
182			/**
183			* Retrieves the attributes labels from the Users model and returns them to reduce code redundancy
184			* @return array
185			*/
186			public function attributeLabels()
187			{
188			return CMap::mergeArray(Users::model()->attributeLabels(), array(
189			'currentPassword' => Yii::t('ciims.models.ProfileForm', 'Your current password'),
190			'password_repeat' => Yii::t('ciims.models.ProfileForm', 'Your New Password (again)')
191			));
192			}
193
194			/**
195			* Validates the role
196			* @param array $attributes
197			* @param array $params
198			* return array
199			*/
200			public function validateUserRole($attributes, $params)
201			{
202			if ($this->canOverridePasswordCheck())
203			return true;
204
205			$this->addError('user_role', Yii::t('ciims.models.ProfileForm', 'You do not have permission to modify this attribute'));
206			return false;
207			}
208
209			/**
210			* Ensures that the password entered matches the one provided during registration
211			* @param array $attributes
212			* @param array $params
213			* return array
214			*/
215			public function validateUserPassword($attributes, $params)
216			{
217			// Apply the override if it was set
218			if ($this->canOverridePasswordCheck())
219			{
220			$this->password_repeat = $this->password;
221			return true;
222			}
223
224			$result = password_verify($this->password, $this->_user->password);
225
226			if ($result == false)
227			{
228			$this->addError('currentPassword', Yii::t('ciims.models.ProfileForm', 'The password you entered is invalid.'));
229			return false;
230			}
231
232			return true;
233			}
234
235			/**
236			* Internally loads the user's information before attempting to validate it
237			* @param int $id The user's ID
238			* @param bool $override This form may be reused
239			* @return ProfileForm
240			*/
241			public function load($id, $override = false)
242			{
243			$this->overridePasswordCheck = $override;
244
245			// Load the user
246			$this->_user = Users::model()->findByPk($id);
247
248			if ($this->_user == NULL)
249			throw new CHttpException(400, Yii::t('ciims.models.ProfileForm', 'The request user\'s profile could not be loaded'));
250
251			// Reload the attribute labels
252			$this->attributes = array(
253			'email' => $this->_user->email,
254			'username' => $this->_user->username,
255			'user_role' => $this->_user->role->id
256			);
257
258			return $this;
259			}
260
261			/**
262			* Updates the user's profile information
263			* @return boolean
264			*/
265			public function save()
266			{
267			if (!$this->validate(NULL, false))
268			return false;
269
270			// Change the email address, if necessary
271			$this->changeEmail();
272
273			$this->_user->attributes = array(
274			'password' => $this->password,
275			'username' => $this->username,
276			'user_role' => $this->user_role
277			);
278
279			if ($this->_user->save())
280			return true;
281
282			return false;
283			}
284
285			/**
286			* Changes the user's email address if necessary
287			* @return boolean
288			*/
289			private function changeEmail()
290			{
291			if ($this->email != $this->_user->email)
292			{
293			$this->setNewemail();
294			$this->setNewEmailChangeKey();
295			$this->sendVerificationEmail();
296			}
297
298			return true;
299			}
300
301			/**
302			* Sends the verification email to the user. This is broken to it's own method to allow for the resending email to be resent
303			* @return boolean
304			*/
305			public function sendVerificationEmail()
306			{
307			$emailSettings = new EmailSettings;
308			return $emailSettings->send(
309			$this->_user,
310			Yii::t('ciims.models.Users', 'CiiMS Email Change Notification'),
311			'base.themes.' . Cii::getConfig('theme', 'default') .'.views.email.email-change',
312			array(
313			'key' => $this->setNewEmailChangeKey(),
314			'user' => $this->_user
315			)
316			);
317			}
318			}
319

charlesportwoodii / CiiMS

ProfileForm::setNewEmail() A last analyzed 2017-09-05 15:05 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ProfileForm::setNewEmail() A
last analyzed 2017-09-05 15:05 UTC