Bladeren bron

Update doc-blocks and small fixes according to coding standards

Johnny Theill 12 jaren geleden
bovenliggende
commit
a6c43f5eb7
2 gewijzigde bestanden met toevoegingen van 26 en 2 verwijderingen
  1. 2 2
      controllers/SiteController.php
  2. 24 0
      models/User.php

+ 2 - 2
controllers/SiteController.php

@@ -76,7 +76,7 @@ class SiteController extends Controller
 
 	public function actionContact()
 	{
-		$model = new ContactForm;
+		$model = new ContactForm();
 		if ($model->load(Yii::$app->request->post()) && $model->contact(Yii::$app->params['adminEmail'])) {
 			Yii::$app->session->setFlash('contactFormSubmitted');
 			return $this->refresh();
@@ -91,4 +91,4 @@ class SiteController extends Controller
 	{
 		return $this->render('about');
 	}
-}
+}

+ 24 - 0
models/User.php

@@ -24,11 +24,20 @@ class User extends \yii\base\Object implements \yii\web\IdentityInterface
 		],
 	];
 
+	/**
+	 * @inheritdoc
+	 */
 	public static function findIdentity($id)
 	{
 		return isset(self::$users[$id]) ? new static(self::$users[$id]) : null;
 	}
 
+	/**
+	 * Finds user by username
+	 *
+	 * @param string $username
+	 * @return static|null
+	 */
 	public static function findByUsername($username)
 	{
 		foreach (self::$users as $user) {
@@ -39,21 +48,36 @@ class User extends \yii\base\Object implements \yii\web\IdentityInterface
 		return null;
 	}
 
+	/**
+	 * @inheritdoc
+	 */
 	public function getId()
 	{
 		return $this->id;
 	}
 
+	/**
+	 * @inheritdoc
+	 */
 	public function getAuthKey()
 	{
 		return $this->authKey;
 	}
 
+	/**
+	 * @inheritdoc
+	 */
 	public function validateAuthKey($authKey)
 	{
 		return $this->authKey === $authKey;
 	}
 
+	/**
+	 * Validates password
+	 *
+	 * @param string $password password to validate
+	 * @return bool if password provided is valid for current user
+	 */
 	public function validatePassword($password)
 	{
 		return $this->password === $password;