TonisOrmisson /
yii2-survey-base-models
| Total Complexity | 44 |
| Total Lines | 339 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Respondent often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Respondent, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 25 | class Respondent extends MyActiveRecord |
||
| 26 | { |
||
| 27 | const MAX_ALTERNATIVE_CONTACTS = 20; |
||
| 28 | /** @var bool $checkDSNForEmails whether email validation also used DSN records to check if domain exists */ |
||
| 29 | public static $checkDSNForEmails = true; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * @var array $surveyIdentifyingColumns names of the columns that identify a respondent as unique inside a survey |
||
| 33 | */ |
||
| 34 | public static $surveyIdentifyingColumns = ['phone_number', 'email_address']; |
||
| 35 | |||
| 36 | public function init() |
||
| 39 | } |
||
| 40 | |||
| 41 | |||
| 42 | /** |
||
| 43 | * {@inheritdoc} |
||
| 44 | */ |
||
| 45 | public function rules() |
||
| 64 | } |
||
| 65 | |||
| 66 | |||
| 67 | /** |
||
| 68 | * @param string $attribute |
||
| 69 | * @param string $address |
||
| 70 | * @return bool |
||
| 71 | */ |
||
| 72 | public function validateEmail($attribute, $address = null) |
||
| 73 | { |
||
| 74 | |||
| 75 | if ($this->validateEmailFormat($attribute, $address) |
||
| 76 | && !$this->isSameAsMainAddress($attribute, $address) |
||
| 77 | && !$this->isEmailSurveyDuplicate($attribute, $address)) { |
||
| 78 | return true; |
||
| 79 | } |
||
| 80 | return false; |
||
| 81 | } |
||
| 82 | |||
| 83 | /** |
||
| 84 | * @param string $attribute |
||
| 85 | * @param string $address |
||
| 86 | * @return bool |
||
| 87 | */ |
||
| 88 | private function validateEmailFormat($attribute, $address = null) |
||
| 101 | } |
||
| 102 | |||
| 103 | /** |
||
| 104 | * @param string $attribute |
||
| 105 | * @param string $address |
||
| 106 | * @return bool |
||
| 107 | */ |
||
| 108 | private function isSameAsMainAddress($attribute, $address = null) |
||
| 109 | { |
||
| 110 | if (empty($address) | $attribute == 'email_address' ) { |
||
|
Bug
introduced
by
|
|||
| 111 | return false; |
||
| 112 | } |
||
| 113 | |||
| 114 | if ($address === $this->email_address) { |
||
| 115 | $this->addError($attribute, |
||
| 116 | Yii::t('app', |
||
| 117 | 'Invalid email address "{0}"', [$address] |
||
| 118 | ) . ' ' . Yii::t('app', 'Reason: {0}', [Yii::t('app', $attribute . ' duplicates main address')]) |
||
| 119 | ); |
||
| 120 | return false; |
||
| 121 | } |
||
| 122 | return true; |
||
| 123 | } |
||
| 124 | |||
| 125 | |||
| 126 | public function validateMultipleEmails($attribute) |
||
| 127 | { |
||
| 128 | $cleanAddresses = []; |
||
| 129 | $addresses = yii\helpers\Json::decode($this->alternative_email_addresses); |
||
| 130 | if (!empty($addresses)) { |
||
| 131 | $i = 0; |
||
| 132 | foreach ($addresses as $key => $address) { |
||
| 133 | $i++; |
||
| 134 | // check the alternative numbers of that model for duplicates |
||
| 135 | $checkItems = $addresses; |
||
| 136 | unset($checkItems[$key]); |
||
| 137 | if (in_array($address, $checkItems)) { |
||
| 138 | $this->addError($attribute, Yii::t('app', 'Duplicate email in alternative email addresses')); |
||
| 139 | } |
||
| 140 | |||
| 141 | if ($i >= static::MAX_ALTERNATIVE_CONTACTS) { |
||
| 142 | $this->addError($attribute, Yii::t('app', 'Maximum alternative addresses limit ({0}) reached for {1}', [static::MAX_ALTERNATIVE_CONTACTS, $this->email_address])); |
||
| 143 | } |
||
| 144 | $address = strtolower(trim($address)); |
||
| 145 | if ($this->validateEmail($attribute, $address)) { |
||
| 146 | $cleanAddresses[] = $address; |
||
| 147 | } |
||
| 148 | } |
||
| 149 | } |
||
| 150 | $this->alternative_email_addresses = yii\helpers\Json::encode($cleanAddresses); |
||
| 151 | } |
||
| 152 | |||
| 153 | |||
| 154 | public function validatePhoneNumber($attribute, $phone_number = null) |
||
| 155 | { |
||
| 156 | $this->validateSameAsMainNumber($attribute, $phone_number); |
||
| 157 | // TODO |
||
| 158 | $isValidFormat = true; |
||
| 159 | $this->validatePhoneSurveyDuplicate($attribute, $phone_number); |
||
| 160 | } |
||
| 161 | |||
| 162 | |||
| 163 | public function validateMultiplePhoneNumbers($attribute) |
||
| 164 | { |
||
| 165 | $cleanItems = []; |
||
| 166 | $items = yii\helpers\Json::decode($this->alternative_phone_numbers); |
||
| 167 | if (!empty($items)) { |
||
| 168 | $i = 0; |
||
| 169 | foreach ($items as $key => $item) { |
||
| 170 | $i++; |
||
| 171 | $item = strtolower(trim($item)); |
||
| 172 | $this->validateAlternativePhoneNumberInternalDuplicates($attribute, $item, $key); |
||
| 173 | |||
| 174 | if ($i >= static::MAX_ALTERNATIVE_CONTACTS) { |
||
| 175 | $this->addError($attribute, Yii::t('app', 'Maximum alternative phone numbers limit ({0}) reached for {1}', [static::MAX_ALTERNATIVE_CONTACTS, $this->phone_number])); |
||
| 176 | } |
||
| 177 | $this->validatePhoneNumber($attribute, $item); |
||
| 178 | } |
||
| 179 | } |
||
| 180 | $this->alternative_phone_numbers = yii\helpers\Json::encode($cleanItems); |
||
| 181 | } |
||
| 182 | |||
| 183 | private function validateAlternativePhoneNumberInternalDuplicates($attribute, $number, $key) |
||
| 184 | { |
||
| 185 | $items = yii\helpers\Json::decode($this->alternative_phone_numbers); |
||
| 186 | $checkItems = $items; |
||
| 187 | unset($checkItems[$key]); |
||
| 188 | if (in_array($number, $checkItems)) { |
||
| 189 | $this->addError($attribute, Yii::t('app', 'Duplicate number in alternative phone numbers')); |
||
| 190 | } |
||
| 191 | } |
||
| 192 | |||
| 193 | |||
| 194 | /** |
||
| 195 | * @param string $attribute |
||
| 196 | * @param string $number |
||
| 197 | * @return null |
||
| 198 | */ |
||
| 199 | private function validateSameAsMainNumber($attribute, $number = null) |
||
| 200 | { |
||
| 201 | if (empty($number) | $attribute === 'phone_number') { |
||
| 202 | return null; |
||
| 203 | } |
||
| 204 | |||
| 205 | if ($number === $this->phone_number) { |
||
| 206 | $this->addError($attribute, |
||
| 207 | Yii::t('app', |
||
| 208 | 'Invalid phone number "{0}"', [$number] |
||
| 209 | ) . ' ' . Yii::t('app', 'Reason: {0}', [Yii::t('app', $attribute . ' duplicates main phone number')]) |
||
| 210 | ); |
||
| 211 | } |
||
| 212 | return null; |
||
| 213 | } |
||
| 214 | |||
| 215 | |||
| 216 | /** |
||
| 217 | * @param string $attribute |
||
| 218 | * @param string $phone_number Phone number to check duplicates for |
||
| 219 | */ |
||
| 220 | private function validatePhoneSurveyDuplicate($attribute, $phone_number) |
||
| 243 | ); |
||
| 244 | } |
||
| 245 | } |
||
| 246 | |||
| 247 | |||
| 248 | /** |
||
| 249 | * @param string $email_address Email address to check duplicates for |
||
| 250 | * @return bool |
||
| 251 | */ |
||
| 252 | public function isEmailSurveyDuplicate($attribute, $email_address) |
||
| 253 | { |
||
| 254 | $query = static::find(); |
||
| 255 | // check only this survey |
||
| 256 | $query->andWhere(['survey_id' => $this->survey_id]); |
||
| 257 | |||
| 258 | // not itself |
||
| 259 | if (!empty($this->respondent_id)) { |
||
| 260 | // not itself |
||
| 261 | $query->andWhere(['!=', 'respondent_id', $this->respondent_id]); |
||
| 262 | } |
||
| 263 | |||
| 264 | $email_condition = ['or', |
||
| 265 | '`email_address`=:email_address', |
||
| 266 | '`alternative_email_addresses` LIKE :email_address2', |
||
| 267 | ]; |
||
| 268 | |||
| 269 | $query->andWhere($email_condition, [':email_address' => $email_address, ':email_address2' => '%\"' . $email_address . '\"%']); |
||
| 270 | if ($query->count() > 0) { |
||
| 271 | return true; |
||
| 272 | } |
||
| 273 | |||
| 274 | $this->addError($attribute, |
||
| 275 | Yii::t('app', |
||
| 276 | 'Invalid email address "{0}"', [$email_address] |
||
| 277 | ) . ' ' . Yii::t('app', 'Reason: {0}', [Yii::t('app', 'Duplicates some other address')]) |
||
| 278 | ); |
||
| 279 | |||
| 280 | return false; |
||
| 281 | } |
||
| 282 | |||
| 283 | /** |
||
| 284 | * {@inheritdoc} |
||
| 285 | */ |
||
| 286 | public function attributeLabels() |
||
| 290 | ]; |
||
| 291 | } |
||
| 292 | |||
| 293 | /** |
||
| 294 | * @param string $token Respondents token |
||
| 295 | * @return static |
||
| 296 | */ |
||
| 297 | public static function findByToken($token = null) |
||
| 298 | { |
||
| 299 | if ($token) { |
||
| 300 | $models = self::findByTokens([$token]); |
||
| 301 | if (!empty($models)) { |
||
| 302 | return $models[0]; |
||
| 303 | } |
||
| 304 | } |
||
| 305 | return null; |
||
| 306 | } |
||
| 307 | |||
| 308 | /** |
||
| 309 | * @param string[] $tokens Respondents tokens |
||
| 310 | * @return static[] |
||
| 311 | */ |
||
| 312 | public static function findByTokens($tokens) |
||
| 319 | } |
||
| 320 | |||
| 321 | /** |
||
| 322 | * Check whether respondent has rejected this specific survey or has a hard bounce on e_mail address |
||
| 323 | * @return bool |
||
| 324 | */ |
||
| 325 | public function getIsRejected() |
||
| 326 | { |
||
| 327 | if (Rejection::rejectedByCode($this->token)) { |
||
| 328 | return true; |
||
| 329 | } |
||
| 330 | |||
| 331 | if (Rejection::bouncedByEmailAddress($this->email_address)) { |
||
| 332 | return true; |
||
| 333 | } |
||
| 334 | |||
| 335 | return false; |
||
| 336 | } |
||
| 337 | |||
| 338 | /** |
||
| 339 | * Get the last respondent based on Email-address |
||
| 340 | * @param string $email_address |
||
| 341 | * @return static |
||
| 342 | */ |
||
| 343 | public static function getLatestByEmail($email_address) |
||
| 351 | } |
||
| 352 | |||
| 353 | /** |
||
| 354 | * @return string |
||
| 355 | */ |
||
| 356 | public function getShortToken() |
||
| 364 | } |
||
| 365 | |||
| 366 | |||
| 367 | } |
Loading history...