enigmatix / yii2-confirmation

ConfirmationBehavior.php

Doc Comments +1 added lines, -1 removed lines

@@ -223,7 +223,7 @@
 
     /**
      * Adds a flash message to the interface stating the change has been held over pending confirmation.
-     * @param $model
+     * @param ConfirmationRequest $model
      */
     public function createFeedbackMessage($model){
         $this->displayMessage($model);

Spacing +29 added lines, -29 removed lines

@@ -90,7 +90,7 @@ 
      * @param $event Event;
      */
 
-    public function beforeSave($event){
+    public function beforeSave($event) {
         $this->protectAttributes();
     }
 
@@ -109,7 +109,7 @@ 
             if ($this->skipOnNull && $value === null || $attribute == $this->timestampAttribute)
                 continue;
 
-            if(!$this->isAuthorised($user, $attribute, $value)){
+            if (!$this->isAuthorised($user, $attribute, $value)) {
                 $this->createConfirmationRequest();
                 $this->resetAttribute($attribute);
             }
@@ -124,17 +124,17 @@ 
      *
      * @return bool
      */
-    protected function isAuthorised($user, $attribute, $value){
+    protected function isAuthorised($user, $attribute, $value) {
 
         //Check for pre-defined administration roles
         if ($this->userIsAuthorised($user))
             return true;
 
         //Check for valid release token , eg that the token exists and is for the same record as this
-        if($this->releaseToken != null){
-            $confirmation =  ConfirmationRequest::findOne(['release_token' => $this->releaseToken]);
+        if ($this->releaseToken != null) {
+            $confirmation = ConfirmationRequest::findOne(['release_token' => $this->releaseToken]);
 
-            if($confirmation == null)
+            if ($confirmation == null)
                 return false;
 
             $model = $confirmation->constructObject();
@@ -145,7 +145,7 @@ 
 
         //Check to see if any protected attributes have been altered
         foreach ($this->protectedAttributes as $attribute)
-            if($this->hasChanged($attribute))
+            if ($this->hasChanged($attribute))
                 return false;
 
         return true;
@@ -157,9 +157,9 @@ 
      *
      * @return bool
      */
-    protected function userIsAuthorised($user){
+    protected function userIsAuthorised($user) {
         foreach ($this->allow as $role)
-            if($user->can($role))
+            if ($user->can($role))
                 return true;
 
         return false;
@@ -168,7 +168,7 @@ 
     /**
      * Business logic handling the creation of the Confirmation Request, and sending the second factor message.
      */
-    protected function createConfirmationRequest(){
+    protected function createConfirmationRequest() {
 
         $model          = $this->owner;
         $changedValues  = $this->getChangedValues();
@@ -193,7 +193,7 @@ 
      *
      * @return bool
      */
-    protected function hasChanged($attribute){
+    protected function hasChanged($attribute) {
         return $this->owner->oldAttributes[$attribute] != $this->owner->{$attribute};
     }
 
@@ -201,11 +201,11 @@ 
      * Fetches all values which have changed, expect for the timestamp attribute.
      * @return array
      */
-    public function getChangedValues(){
+    public function getChangedValues() {
         $changedAttributes = [];
 
         foreach ($this->owner->attributes() as $attribute)
-            if($this->hasChanged($attribute))
+            if ($this->hasChanged($attribute))
                 $changedAttributes[$attribute] = $this->owner->$attribute;
 
         unset($changedAttributes[$this->timestampAttribute]);
@@ -217,7 +217,7 @@ 
      * Sets an attribute back to it's original value when it was fetched.
      * @param string $attribute
      */
-    protected function resetAttribute($attribute){
+    protected function resetAttribute($attribute) {
         $this->owner->$attribute = $this->owner->oldAttributes[$attribute];
     }
 
@@ -225,7 +225,7 @@ 
      * Adds a flash message to the interface stating the change has been held over pending confirmation.
      * @param $model
      */
-    public function createFeedbackMessage($model){
+    public function createFeedbackMessage($model) {
         $this->displayMessage($model);
     }
 
@@ -233,7 +233,7 @@ 
      * Business logic around displaying an appropriate feedback message to the user regbarding the change.
      * @param $model
      */
-    protected function displayMessage($model){
+    protected function displayMessage($model) {
         Yii::$app->session->setFlash('warning', 'Your update is pending confirmation.  Please check your email for a confirmation link.');
     }
 
@@ -241,8 +241,8 @@ 
      * Business logic around transmitting the second factor message.
      * @param ConfirmationRequest $model
      */
-    public function sendSecondFactorMessage($model){
-        switch ($this->secondFactor){
+    public function sendSecondFactorMessage($model) {
+        switch ($this->secondFactor) {
             case 'email':
                 Yii::$app->mailer
                     ->compose($this->confirmationViewPath, ['model' => $model])
@@ -265,25 +265,25 @@ 
      * @return string
      * @throws InvalidCallException
      */
-    protected function getEmail($model){
+    protected function getEmail($model) {
 
         $values = unserialize($model->values);
-        $email  = ArrayHelper::getValue($values,'email');
+        $email  = ArrayHelper::getValue($values, 'email');
         $object = $model->constructObject();
 
-        if($email == null)
-            $email = ArrayHelper::getValue($values,'email_address');
+        if ($email == null)
+            $email = ArrayHelper::getValue($values, 'email_address');
 
-        if($email == null)
-            $email = ArrayHelper::getValue($object,'email');
+        if ($email == null)
+            $email = ArrayHelper::getValue($object, 'email');
 
-        if($email == null)
-            $email = ArrayHelper::getValue($object,'email_address');
+        if ($email == null)
+            $email = ArrayHelper::getValue($object, 'email_address');
 
-        if($email == null)
-            $email = ArrayHelper::getValue($object,$this->createdByAttribute.'.email');
+        if ($email == null)
+            $email = ArrayHelper::getValue($object, $this->createdByAttribute . '.email');
 
-        if($email == null)
+        if ($email == null)
             throw new InvalidCallException("Unable to locate email address via record, changed values, or user account");
 
         return $email;

Braces +33 added lines, -22 removed lines

@@ -106,8 +106,9 @@ 
 
         foreach ($changedValues as $attribute => $value) {
 
-            if ($this->skipOnNull && $value === null || $attribute == $this->timestampAttribute)
-                continue;
+            if ($this->skipOnNull && $value === null || $attribute == $this->timestampAttribute) {
+                            continue;
+            }
 
             if(!$this->isAuthorised($user, $attribute, $value)){
                 $this->createConfirmationRequest();
@@ -127,15 +128,17 @@ 
     protected function isAuthorised($user, $attribute, $value){
 
         //Check for pre-defined administration roles
-        if ($this->userIsAuthorised($user))
-            return true;
+        if ($this->userIsAuthorised($user)) {
+                    return true;
+        }
 
         //Check for valid release token , eg that the token exists and is for the same record as this
         if($this->releaseToken != null){
             $confirmation =  ConfirmationRequest::findOne(['release_token' => $this->releaseToken]);
 
-            if($confirmation == null)
-                return false;
+            if($confirmation == null) {
+                            return false;
+            }
 
             $model = $confirmation->constructObject();
 
@@ -144,9 +147,10 @@ 
         }
 
         //Check to see if any protected attributes have been altered
-        foreach ($this->protectedAttributes as $attribute)
-            if($this->hasChanged($attribute))
+        foreach ($this->protectedAttributes as $attribute) {
+                    if($this->hasChanged($attribute))
                 return false;
+        }
 
         return true;
     }
@@ -158,9 +162,10 @@ 
      * @return bool
      */
     protected function userIsAuthorised($user){
-        foreach ($this->allow as $role)
-            if($user->can($role))
+        foreach ($this->allow as $role) {
+                    if($user->can($role))
                 return true;
+        }
 
         return false;
     }
@@ -204,9 +209,10 @@ 
     public function getChangedValues(){
         $changedAttributes = [];
 
-        foreach ($this->owner->attributes() as $attribute)
-            if($this->hasChanged($attribute))
+        foreach ($this->owner->attributes() as $attribute) {
+                    if($this->hasChanged($attribute))
                 $changedAttributes[$attribute] = $this->owner->$attribute;
+        }
 
         unset($changedAttributes[$this->timestampAttribute]);
 
@@ -271,20 +277,25 @@ 
         $email  = ArrayHelper::getValue($values,'email');
         $object = $model->constructObject();
 
-        if($email == null)
-            $email = ArrayHelper::getValue($values,'email_address');
+        if($email == null) {
+                    $email = ArrayHelper::getValue($values,'email_address');
+        }
 
-        if($email == null)
-            $email = ArrayHelper::getValue($object,'email');
+        if($email == null) {
+                    $email = ArrayHelper::getValue($object,'email');
+        }
 
-        if($email == null)
-            $email = ArrayHelper::getValue($object,'email_address');
+        if($email == null) {
+                    $email = ArrayHelper::getValue($object,'email_address');
+        }
 
-        if($email == null)
-            $email = ArrayHelper::getValue($object,$this->createdByAttribute.'.email');
+        if($email == null) {
+                    $email = ArrayHelper::getValue($object,$this->createdByAttribute.'.email');
+        }
 
-        if($email == null)
-            throw new InvalidCallException("Unable to locate email address via record, changed values, or user account");
+        if($email == null) {
+                    throw new InvalidCallException("Unable to locate email address via record, changed values, or user account");
+        }
 
         return $email;
     }

ConfirmationRequestsController.php

Doc Comments -2 removed lines

@@ -34,7 +34,6 @@ 
 
     /**
      * Releases a single change as stored in the  ConfirmationRequest model.
-     * @param integer $id
      * @return mixed
      */
     public function actionRelease($release_token)
@@ -71,7 +70,6 @@ 
     /**
      * Finds the ConfirmationRequest model based on its primary key value.
      * If the model is not found, a 404 HTTP exception will be thrown.
-     * @param integer $id
      * @return ConfirmationRequest the loaded model
      * @throws NotFoundHttpException if the model cannot be found
      */

Spacing +8 added lines, -8 removed lines

@@ -40,30 +40,30 @@
     public function actionRelease($release_token)
     {
 
-        try{
-            $model =  $this->findModel($release_token);
-        } catch (NotFoundHttpException $e){
-            Yii::$app->session->setFlash('danger' , "We were not able to find your change.  Perhaps it has already been processed?");
+        try {
+            $model = $this->findModel($release_token);
+        } catch (NotFoundHttpException $e) {
+            Yii::$app->session->setFlash('danger', "We were not able to find your change.  Perhaps it has already been processed?");
             return $this->goHome();
         }
 
-        try{
+        try {
             $model->release();
-        } catch (ErrorException $e){
+        } catch (ErrorException $e) {
             return $this->redirect(['confirmation-requests/expired']);
         }
 
         $viewLink = $model->constructObject()->getViewLink();
         $model->delete();
 
-        if(!Yii::$app->user->isGuest){
+        if (!Yii::$app->user->isGuest) {
             return $this->redirect($viewLink);
         }
 
         return $this->render('@vendor/enigmatix/yii2-confirmation/views/confirm', []);
     }
 
-    public function actionExpired(){
+    public function actionExpired() {
         return $this->render('@vendor/enigmatix/yii2-confirmation/views/expired', []);
 
     }

mail/layouts/text.php

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 
-use yii\helpers\Html;
-
 /** @var \yii\web\View $this view component instance */
 /** @var \yii\mail\MessageInterface $message the message being composed */
 /** @var string $content main view render result */

mail/_confirmationEmail.php

Spacing +2 added lines, -2 removed lines

@@ -3,12 +3,12 @@
 /* @var $model /yii/base/Model */
 use yii\helpers\Html;
 
-$link =  $model->getViewLink();
+$link = $model->getViewLink();
 ?>
 
 <p>Your details have been changed in <?=Yii::$app->name ?>. specifically:</p>
 
-  <?=  Html::ul(unserialize($model->values), ['item' => function($item, $index){return Html::tag('li', $index .' : ' . $item);}]) ?>
+  <?=  Html::ul(unserialize($model->values), ['item' => function($item, $index) {return Html::tag('li', $index . ' : ' . $item); }]) ?>
 
 <p>If these details are correct, please follow this link to 
     finalise your changes: <?= Html::a('Finalise link', $model->getViewLink()) ?></p>

ConfirmationRequest.php

Spacing +8 added lines, -8 removed lines

@@ -38,7 +38,7 @@ 
             [['object_id'], 'integer'],
             [['object', 'values'], 'string'],
             [['model', 'release_token'], 'string', 'max' => 255],
-            [['release_token'], 'default',  'value' => function ($model, $attribute){ return $this->generateReleaseToken();}],
+            [['release_token'], 'default', 'value' => function($model, $attribute) { return $this->generateReleaseToken(); }],
             [['created_by'], 'exist', 'skipOnError' => true, 'targetClass' => $this->getUserClassName(), 'targetAttribute' => ['created_by' => 'id']],
             [['updated_by'], 'exist', 'skipOnError' => true, 'targetClass' => $this->getUserClassName(), 'targetAttribute' => ['updated_by' => 'id']],
         ];
@@ -84,8 +84,8 @@ 
             ]);
     }
 
-    public function getViewLink(){
-        return Url::to(['@web/confirmation-requests', 'release_token' => $this->release_token],true);
+    public function getViewLink() {
+        return Url::to(['@web/confirmation-requests', 'release_token' => $this->release_token], true);
     }
 
     /**
@@ -113,20 +113,20 @@ 
         return $this->hasOne($this->getUserClassName(), ['id' => 'updated_by']);
     }
 
-    protected function getUserClassName(){
+    protected function getUserClassName() {
         return Yii::$app->user->identityClass;
     }
 
-    public function release(){
+    public function release() {
 
         $model          = $this->constructObject();
         $changedValues  = $model->getChangedValues();
         $current        = clone $model;
         $current->refresh();
 
-        foreach ($changedValues as $field => $value){
+        foreach ($changedValues as $field => $value) {
             $oldValue = $model->oldAttributes[$field];
-            if($current->$field !== $oldValue && $current->$field !== $value)
+            if ($current->$field !== $oldValue && $current->$field !== $value)
                 throw new ErrorException("Unable to release change, protected field $field has been updated since this request."
                 . " Expected to find $value or $oldValue, found " . $current->$field);
 
@@ -141,7 +141,7 @@ 
     /**
      * @return \enigmatix\core\Model
      */
-    public function constructObject(){
+    public function constructObject() {
         return unserialize($this->object);
     }
 

Braces +3 added lines, -2 removed lines

@@ -126,9 +126,10 @@
 
         foreach ($changedValues as $field => $value){
             $oldValue = $model->oldAttributes[$field];
-            if($current->$field !== $oldValue && $current->$field !== $value)
-                throw new ErrorException("Unable to release change, protected field $field has been updated since this request."
+            if($current->$field !== $oldValue && $current->$field !== $value) {
+                            throw new ErrorException("Unable to release change, protected field $field has been updated since this request."
                 . " Expected to find $value or $oldValue, found " . $current->$field);
+            }
 
         }