TonisOrmisson / yii2-survey-base-models

migrations/m170302_104953_create_rejections.php

Spacing +6 added lines, -6 removed lines

@@ -4,7 +4,7 @@ 
 
 class m170302_104953_create_rejections extends Migration
 {
-    private $tableName ='rejection';
+    private $tableName = 'rejection';
 
 
     public function safeUp()
@@ -21,17 +21,17 @@ 
                 'time_rejected' => $this->dateTime()->notNull()->comment('Rejection time'),
             ]);
 
-            $this->addForeignKey('fk_rejection_survey_id',$this->tableName,'survey_id','survey','survey_id');
-            $this->addForeignKey('fk_rejection_respondent_id','rejection','respondent_id','respondent','respondent_id');
+            $this->addForeignKey('fk_rejection_survey_id', $this->tableName, 'survey_id', 'survey', 'survey_id');
+            $this->addForeignKey('fk_rejection_respondent_id', 'rejection', 'respondent_id', 'respondent', 'respondent_id');
         }
 
     }
 
     public function safeDown()
     {
-        $this->dropForeignKey('fk_rejection_survey_id',$this->tableName);
-        $this->dropForeignKey('fk_rejection_email_id',$this->tableName);
-        $this->dropForeignKey('fk_rejection_respondent_id',$this->tableName);
+        $this->dropForeignKey('fk_rejection_survey_id', $this->tableName);
+        $this->dropForeignKey('fk_rejection_email_id', $this->tableName);
+        $this->dropForeignKey('fk_rejection_respondent_id', $this->tableName);
         $this->dropTable($this->tableName);
     }
 }

migrations/m170329_072118_remove_response_code_from_rejection.php

Spacing +2 added lines, -2 removed lines

@@ -6,12 +6,12 @@
 {
     public function safeUp()
     {
-        $this->dropColumn('rejection','response_code');
+        $this->dropColumn('rejection', 'response_code');
     }
 
     public function safeDown()
     {
-        $this->addColumn('rejection','response_code',$this->integer(4)->after('type')
+        $this->addColumn('rejection', 'response_code', $this->integer(4)->after('type')
             ->comment('Email response code in case of bounce'));
     }
 }

migrations/m170327_130608_rename_rejection_type.php

Spacing +2 added lines, -2 removed lines

@@ -6,11 +6,11 @@
 {
     public function safeUp()
     {
-        $this->renameColumn('rejection','bounce_type','type');
+        $this->renameColumn('rejection', 'bounce_type', 'type');
     }
 
     public function safeDown()
     {
-        $this->renameColumn('rejection','type','bounce_type');
+        $this->renameColumn('rejection', 'type', 'bounce_type');
     }
 }

Rejection.php

Spacing +17 added lines, -17 removed lines

@@ -41,7 +41,7 @@ 
     {
         return array_merge([
             [['survey_id', 'respondent_id'], 'integer'],
-            [['email_address','time_rejected'], 'required'],
+            [['email_address', 'time_rejected'], 'required'],
             [['bounce'], 'string'],
             [['time_rejected'], 'safe'],
             [['email_address'], 'string', 'max' => 255],
@@ -49,7 +49,7 @@ 
             [['type'], 'string', 'max' => 45],
             [['respondent_id'], 'exist', 'skipOnError' => true, 'targetClass' => Respondent::class, 'targetAttribute' => ['respondent_id' => 'respondent_id']],
             [['survey_id'], 'exist', 'skipOnError' => true, 'targetClass' => Survey::class, 'targetAttribute' => ['survey_id' => 'survey_id']],
-        ],  parent::rules());
+        ], parent::rules());
     }
 
 
@@ -57,9 +57,9 @@ 
      * @param string $email_address
      * @return bool
      */
-    public static function hasBouncedHard($email_address){
+    public static function hasBouncedHard($email_address) {
         $rejection = Rejection::findByEmail($email_address);
-        if($rejection){
+        if ($rejection) {
             return true;
         }
         return false;
@@ -71,7 +71,7 @@ 
      * @param string $email_address
      * @return Rejection[]
      */
-    public static function findHardBounces($email_address){
+    public static function findHardBounces($email_address) {
         return Rejection::find()
             ->andWhere(['email_address'=>$email_address])
 
@@ -84,13 +84,13 @@ 
      * @param string $code
      * @return bool
      */
-    public static function rejectedByCode($code){
+    public static function rejectedByCode($code) {
         $respondent = Respondent::findByToken($code);
-        if($respondent){
+        if ($respondent) {
             $rejections = self::find()
                 ->andWhere(['respondent_id'=>$respondent->primaryKey])
                 ->all();
-            if($rejections){
+            if ($rejections) {
                 return true;
             }
         }
@@ -103,12 +103,12 @@ 
      * @param string $type
      * @return bool
      */
-    public static function bouncedByEmailAddress($email_address,$type = self::BOUNCE_TYPE_HARD){
+    public static function bouncedByEmailAddress($email_address, $type = self::BOUNCE_TYPE_HARD) {
         $rejections = self::find()
             ->andWhere('email_address=:email_address', [':email_address' => $email_address])
             ->andWhere('type=:type', [':type' => $type])
             ->all();
-        if($rejections){
+        if ($rejections) {
             return true;
         }
         return false;
@@ -118,7 +118,7 @@ 
      * @param string $email_address
      * @return Rejection
      */
-    public static function findByEmail($email_address){
+    public static function findByEmail($email_address) {
         return Rejection::findOne(['email_address'=>$email_address]);
     }
 
@@ -138,13 +138,13 @@ 
         return $this->hasOne(Respondent::class, ['respondent_id' => 'respondent_id']);
     }
 
-    public static function getBounceTypes(){
+    public static function getBounceTypes() {
         return [
-            self::BOUNCE_TYPE_COMPLAINT => Yii::t('app','Complaint'),
-            self::BOUNCE_TYPE_SOFT => Yii::t('app','Soft bounce'),
-            self::BOUNCE_TYPE_HARD => Yii::t('app','Hard bounce'),
-            self::BOUNCE_TYPE_ANSWERED => Yii::t('app','Respondent has answered already'),
-            self::BOUNCE_TYPE_OTHER => Yii::t('app','Other'),
+            self::BOUNCE_TYPE_COMPLAINT => Yii::t('app', 'Complaint'),
+            self::BOUNCE_TYPE_SOFT => Yii::t('app', 'Soft bounce'),
+            self::BOUNCE_TYPE_HARD => Yii::t('app', 'Hard bounce'),
+            self::BOUNCE_TYPE_ANSWERED => Yii::t('app', 'Respondent has answered already'),
+            self::BOUNCE_TYPE_OTHER => Yii::t('app', 'Other'),
         ];
     }
 }

SurveyHasStatus.php

Spacing +6 added lines, -6 removed lines

@@ -38,12 +38,12 @@ 
      * @param string $status if not set Status will be taken from Email
      * @return boolean
      */
-    public static function create($survey,$status = null){
+    public static function create($survey, $status = null) {
         $model = new static();
         $model->survey_id = $survey->primaryKey;
-        $model->status =$survey->status;
-        if($status){
-            $model->status =$status;
+        $model->status = $survey->status;
+        if ($status) {
+            $model->status = $status;
         }
         return $model->save();
     }
@@ -54,9 +54,9 @@ 
     public function rules()
     {
         return array_merge([
-            [['survey_id','status'], 'required'],
+            [['survey_id', 'status'], 'required'],
             [['status'], 'string', 'max' => 32],
             [['survey_id'], 'integer'],
-        ],  parent::rules());
+        ], parent::rules());
     }
 }

Rating.php

Spacing +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
      */
     public static function modelName()
     {
-        return Yii::t('app','Rating');
+        return Yii::t('app', 'Rating');
     }
 
      
@@ -49,7 +49,7 @@ 
             [['respondent_id', 'survey_id', 'sample_id', 'value'], 'integer'],
             [['comment'], 'string'],
             [['respondent_id'], 'exist', 'skipOnError' => true, 'targetClass' => Respondent::class, 'targetAttribute' => ['respondent_id' => 'respondent_id']],
-        ],  parent::rules());
+        ], parent::rules());
     }
 
     /**

Survey.php

Spacing +4 added lines, -4 removed lines

@@ -30,10 +30,10 @@ 
     public function rules()
     {
         return array_merge([
-            [['name','status'], 'required'],
+            [['name', 'status'], 'required'],
             [['name', 'status'], 'string', 'max' => 255],
-            [['name'], 'string','max' => 500],
-            [['options'], 'string','max' => 1024 * 10],
+            [['name'], 'string', 'max' => 500],
+            [['options'], 'string', 'max' => 1024 * 10],
         ], parent::rules());
     }
 
@@ -64,7 +64,7 @@ 
     /**
      * @return mixed
      */
-    public function getOptionsDecoded(){
+    public function getOptionsDecoded() {
         return json_decode($this->options);
     }
 

Respondent.php

Spacing +73 added lines, -73 removed lines

@@ -31,7 +31,7 @@ 
     /**
      * @var array $surveyIdentifyingColumns names of the columns that identify a respondent as unique inside a survey
      */
-    public static $surveyIdentifyingColumns = ['phone_number','email_address'];
+    public static $surveyIdentifyingColumns = ['phone_number', 'email_address'];
 
     public function init()
     {
@@ -45,20 +45,20 @@ 
     public function rules()
     {
         return array_merge([
-            [['survey_id','token'], 'required'],
+            [['survey_id', 'token'], 'required'],
             [['survey_id'], 'integer'],
             [['email_address'], 'validateEmail'],
             // email addresses always lowercase
-            [['email_address','email_address'],'trim'],
-            ['email_address','filter', 'filter' => 'strtolower'],
+            [['email_address', 'email_address'], 'trim'],
+            ['email_address', 'filter', 'filter' => 'strtolower'],
             [['alternative_email_addresses'], 'string'],
             [['alternative_email_addresses'], 'validateMultipleEmails'],
-            [['phone_number','email_address'],'trim'],
-            ['phone_number','filter', 'filter' => 'strtolower'],
-            [['phone_number'],'string'],
-            [['phone_number'],'validatePhoneNumber'],
+            [['phone_number', 'email_address'], 'trim'],
+            ['phone_number', 'filter', 'filter' => 'strtolower'],
+            [['phone_number'], 'string'],
+            [['phone_number'], 'validatePhoneNumber'],
             [['alternative_phone_numbers'], 'string'],
-            [['alternative_phone_numbers'],'validateMultiplePhoneNumbers'],
+            [['alternative_phone_numbers'], 'validateMultiplePhoneNumbers'],
             [['token'], 'unique'],
         ], parent::rules());
     }
@@ -70,11 +70,11 @@ 
      * @param string $address
      * @return bool
      */
-    public function validateEmail($attribute,$address = null){
+    public function validateEmail($attribute, $address = null) {
 
-        if($this->validateEmailFormat($attribute, $address)
+        if ($this->validateEmailFormat($attribute, $address)
             && !$this->isSameAsMainAddress($attribute, $address)
-            && !$this->isEmailSurveyDuplicate($attribute, $address)){
+            && !$this->isEmailSurveyDuplicate($attribute, $address)) {
             return true;
         }
         return false;
@@ -92,8 +92,8 @@ 
         if (!$validator->validate($address)) {
             $this->addError($attribute,
                 Yii::t('app',
-                    'Invalid email address "{0}"',[$address]
-                ).' '.Yii::t('app','Reason: {0}',[Yii::t('app','Invalid email format')])
+                    'Invalid email address "{0}"', [$address]
+                ).' '.Yii::t('app', 'Reason: {0}', [Yii::t('app', 'Invalid email format')])
             );
             return false;
         }
@@ -107,48 +107,48 @@ 
      */
     private function isSameAsMainAddress($attribute, $address = null)
     {
-        if(!$address or empty($address)){
+        if (!$address or empty($address)) {
             return false;
         }
-        $isSame = ($attribute=='email_address' ? false : $address == $this->email_address);
+        $isSame = ($attribute == 'email_address' ? false : $address == $this->email_address);
         if ($isSame) {
             $this->addError($attribute,
                 Yii::t('app',
-                    'Invalid email address "{0}"',[$address]
-                ).' '.Yii::t('app','Reason: {0}',[Yii::t('app',$attribute. ' duplicates main address')])
+                    'Invalid email address "{0}"', [$address]
+                ).' '.Yii::t('app', 'Reason: {0}', [Yii::t('app', $attribute.' duplicates main address')])
             );
         }
         return $isSame;
     }
 
 
-    public function validateMultipleEmails($attribute){
+    public function validateMultipleEmails($attribute) {
         $addresses = yii\helpers\Json::decode($this->alternative_email_addresses);
-        if($this->alternative_email_addresses && !empty($addresses)){
+        if ($this->alternative_email_addresses && !empty($addresses)) {
             $cleanAddresses = [];
-            if(!empty($addresses)){
-                $i=0;
-                foreach ($addresses as $key => $address){
-                    if($address <> ""){
+            if (!empty($addresses)) {
+                $i = 0;
+                foreach ($addresses as $key => $address) {
+                    if ($address <> "") {
                         // check the alternative numbers of that model for duplicates
                         $checkItems = $addresses;
                         unset($checkItems[$key]);
-                        if(in_array($address,$checkItems)){
-                            $this->addError($attribute,Yii::t('app','Duplicate email in alternative email addresses'));
+                        if (in_array($address, $checkItems)) {
+                            $this->addError($attribute, Yii::t('app', 'Duplicate email in alternative email addresses'));
                         }
 
                         $i++;
-                        if($i>=static::MAX_ALTERNATIVE_CONTACTS){
-                            $this->addError($attribute,Yii::t('app','Maximum alternative addresses limit ({0}) reached for {1}',[static::MAX_ALTERNATIVE_CONTACTS,$this->email_address]));
+                        if ($i >= static::MAX_ALTERNATIVE_CONTACTS) {
+                            $this->addError($attribute, Yii::t('app', 'Maximum alternative addresses limit ({0}) reached for {1}', [static::MAX_ALTERNATIVE_CONTACTS, $this->email_address]));
                         }
                         $address = strtolower(trim($address));
-                        if($this->validateEmail($attribute,$address)){
-                            $cleanAddresses[]=$address;
+                        if ($this->validateEmail($attribute, $address)) {
+                            $cleanAddresses[] = $address;
                         }
                     }
 
                 }
-                if(!empty($cleanAddresses)){
+                if (!empty($cleanAddresses)) {
                     $this->alternative_email_addresses = yii\helpers\Json::encode($cleanAddresses);
                 } else {
                     $this->alternative_email_addresses = null;
@@ -158,42 +158,42 @@ 
     }
 
 
-    public function validatePhoneNumber($attribute, $phone_number = null){
+    public function validatePhoneNumber($attribute, $phone_number = null) {
         $this->validateSameAsMainNumber($attribute, $phone_number);
         // TODO
         $isValidFormat = true;
         $this->validatePhoneSurveyDuplicate($attribute, $phone_number);
     }
 
-    public function validateMultiplePhoneNumbers($attribute){
-        if($this->alternative_phone_numbers){
+    public function validateMultiplePhoneNumbers($attribute) {
+        if ($this->alternative_phone_numbers) {
             $cleanItems = [];
             $items = yii\helpers\Json::decode($this->alternative_phone_numbers);
 
-            if(!empty($items)){
-                $i=0;
-                foreach ($items as $key=> $item){
+            if (!empty($items)) {
+                $i = 0;
+                foreach ($items as $key=> $item) {
                     $item = strtolower(trim($item));
-                    if($item <> ''){
+                    if ($item <> '') {
                         $i++;
                         // check the alternative numbers of that model for duplicates
                         $checkItems = $items;
                         unset($checkItems[$key]);
-                        if(in_array($item,$checkItems)){
-                            $this->addError($attribute,Yii::t('app','Duplicate number in alternative phone numbers'));
+                        if (in_array($item, $checkItems)) {
+                            $this->addError($attribute, Yii::t('app', 'Duplicate number in alternative phone numbers'));
                         }
 
 
-                        if($i>=static::MAX_ALTERNATIVE_CONTACTS){
-                            $this->addError($attribute,Yii::t('app','Maximum alternative phone numbers limit ({0}) reached for {1}',[static::MAX_ALTERNATIVE_CONTACTS,$this->phone_number]));
+                        if ($i >= static::MAX_ALTERNATIVE_CONTACTS) {
+                            $this->addError($attribute, Yii::t('app', 'Maximum alternative phone numbers limit ({0}) reached for {1}', [static::MAX_ALTERNATIVE_CONTACTS, $this->phone_number]));
                         }
-                        if($this->validatePhoneNumber($attribute,$item)){
-                            $cleanItems[]=$item;
+                        if ($this->validatePhoneNumber($attribute, $item)) {
+                            $cleanItems[] = $item;
                         }
 
                     }
                 }
-                if(!empty($cleanItems)){
+                if (!empty($cleanItems)) {
                     $this->alternative_phone_numbers = yii\helpers\Json::encode($cleanItems);
                 } else {
                     $this->alternative_phone_numbers = null;
@@ -214,13 +214,13 @@ 
             return null;
         }
 
-        $isSame = ($attribute=='phone_number' ? false : $number == $this->phone_number);
+        $isSame = ($attribute == 'phone_number' ? false : $number == $this->phone_number);
 
         if ($isSame) {
             $this->addError($attribute,
                 Yii::t('app',
-                    'Invalid phone number "{0}"',[$number]
-                ).' '.Yii::t('app','Reason: {0}',[Yii::t('app',$attribute. ' duplicates main phone number')])
+                    'Invalid phone number "{0}"', [$number]
+                ).' '.Yii::t('app', 'Reason: {0}', [Yii::t('app', $attribute.' duplicates main phone number')])
             );
         }
         return null;
@@ -231,27 +231,27 @@ 
      * @param string $attribute
      * @param string $phone_number Phone number to check duplicates for
      */
-    private function validatePhoneSurveyDuplicate($attribute, $phone_number){
+    private function validatePhoneSurveyDuplicate($attribute, $phone_number) {
         $query = static::find();
         // check only this survey
         $query->andWhere(['survey_id'=>$this->survey_id]);
 
-        if($this->respondent_id){
+        if ($this->respondent_id) {
             // not itself
-            $query->andWhere(['!=','respondent_id',$this->respondent_id]);
+            $query->andWhere(['!=', 'respondent_id', $this->respondent_id]);
         }
 
         $condition = ['or',
             '`phone_number`=:phone_number',
             '`alternative_phone_numbers` LIKE :phone_number2',
         ];
-        $query->andWhere($condition,[':phone_number'=>$phone_number,':phone_number2'=>'%\"'.$phone_number.'\"%']);
+        $query->andWhere($condition, [':phone_number'=>$phone_number, ':phone_number2'=>'%\"'.$phone_number.'\"%']);
 
-        if($query->count() > 0) {
+        if ($query->count() > 0) {
             $this->addError($attribute,
                 Yii::t('app',
-                    'Invalid phone number "{0}"',[$phone_number]
-                ).' '.Yii::t('app','Reason: {0}',[Yii::t('app','Duplicate phone number')])
+                    'Invalid phone number "{0}"', [$phone_number]
+                ).' '.Yii::t('app', 'Reason: {0}', [Yii::t('app', 'Duplicate phone number')])
             );
         }
     }
@@ -261,29 +261,29 @@ 
      * @param string $email_address Email address to check duplicates for
      * @return bool
      */
-    public function isEmailSurveyDuplicate($attribute, $email_address){
+    public function isEmailSurveyDuplicate($attribute, $email_address) {
         $query = static::find();
         // check only this survey
         $query->andWhere(['survey_id'=>$this->survey_id]);
         // not itself
-        if($this->respondent_id){
+        if ($this->respondent_id) {
             // not itself
-            $query->andWhere(['!=','respondent_id',$this->respondent_id]);
+            $query->andWhere(['!=', 'respondent_id', $this->respondent_id]);
         }
 
         $email_condition = ['or',
             '`email_address`=:email_address',
             '`alternative_email_addresses` LIKE :email_address2',
         ];
-        $query->andWhere($email_condition,[':email_address'=>$email_address,':email_address2'=>'%\"'.$email_address.'\"%']);
-        if($query->count() > 0){
+        $query->andWhere($email_condition, [':email_address'=>$email_address, ':email_address2'=>'%\"'.$email_address.'\"%']);
+        if ($query->count() > 0) {
             return true;
         }
 
         $this->addError($attribute,
             Yii::t('app',
-                'Invalid email address "{0}"',[$email_address]
-            ).' '.Yii::t('app','Reason: {0}',[Yii::t('app','Duplicates some other address')])
+                'Invalid email address "{0}"', [$email_address]
+            ).' '.Yii::t('app', 'Reason: {0}', [Yii::t('app', 'Duplicates some other address')])
         );
 
         return false;
@@ -303,10 +303,10 @@ 
      * @param string $token Respondents token
      * @return static
      */
-    public static function findByToken($token = null){
-        if($token){
+    public static function findByToken($token = null) {
+        if ($token) {
             $models = self::findByTokens([$token]);
-            if (!empty($models)){
+            if (!empty($models)) {
                 return $models[0];
             }
         }
@@ -317,10 +317,10 @@ 
      * @param string[] $tokens Respondents tokens
      * @return static[]
      */
-    public static function findByTokens($tokens){
+    public static function findByTokens($tokens) {
         /** @var static[] $model */
         $models = static::find()
-            ->andWhere(['in','token', $tokens])
+            ->andWhere(['in', 'token', $tokens])
             ->all();
         return $models;
     }
@@ -329,11 +329,11 @@ 
      * Check whether respondent has rejected this specific survey or has a hard bounce on e_mail address
      * @return bool
      */
-    public function getIsRejected(){
-        if(Rejection::rejectedByCode($this->token)){
+    public function getIsRejected() {
+        if (Rejection::rejectedByCode($this->token)) {
             return true;
         }
-        if(Rejection::bouncedByEmailAddress($this->email_address)){
+        if (Rejection::bouncedByEmailAddress($this->email_address)) {
             return true;
         }
 
@@ -345,7 +345,7 @@ 
      * @param string $email_address
      * @return static
      */
-    public static function getLatestByEmail($email_address){
+    public static function getLatestByEmail($email_address) {
         /** @var static $model */
         $model = static::find()
             ->andWhere(['email_address'=>$email_address])
@@ -357,8 +357,8 @@ 
     /**
      * @return string
      */
-    public function getShortToken(){
-        if(Uuid::isValid($this->token)){
+    public function getShortToken() {
+        if (Uuid::isValid($this->token)) {
             $uuid = Uuid::fromString($this->token);
             $shotUuid = new ShortUuid();
             return $shotUuid->encode($uuid);