rhosocial /
yii2-base-models
Complex classes like MultipleBlameableTrait 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 MultipleBlameableTrait, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 60 | trait MultipleBlameableTrait |
||
| 61 | { |
||
| 62 | |||
| 63 | /** |
||
| 64 | * @var string class name of multiple blameable class. |
||
| 65 | */ |
||
| 66 | public $multiBlamesClass = ''; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * @var string name of multiple blameable attribute. |
||
| 70 | */ |
||
| 71 | public $multiBlamesAttribute = 'blames'; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * @var integer the limit of blames. it should be greater than or equal 1, and |
||
| 75 | * less than or equal 10. |
||
| 76 | */ |
||
| 77 | public $blamesLimit = 10; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * @var boolean determines whether blames list has been changed. |
||
| 81 | */ |
||
| 82 | public $blamesChanged = false; |
||
| 83 | |||
| 84 | /** |
||
| 85 | * @var string event name. |
||
| 86 | */ |
||
| 87 | public static $eventMultipleBlamesChanged = 'multipleBlamesChanged'; |
||
| 88 | |||
| 89 | /** |
||
| 90 | * Get the rules associated with multiple blameable attribute. |
||
| 91 | * @return array rules. |
||
| 92 | */ |
||
| 93 | 15 | public function getMultipleBlameableAttributeRules() |
|
| 94 | { |
||
| 95 | 15 | return is_string($this->multiBlamesAttribute) ? [ |
|
| 96 | 15 | [[$this->multiBlamesAttribute], 'string', 'max' => $this->blamesLimit * 16], |
|
| 97 | 15 | [[$this->multiBlamesAttribute], 'default', 'value' => ''], |
|
| 98 | 15 | ] : []; |
|
| 99 | } |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Add specified blame. |
||
| 103 | * @param {$this->multiBlamesClass}|string $blame |
||
|
|
|||
| 104 | * @return false|array |
||
| 105 | * @throws InvalidParamException if blame existed. |
||
| 106 | * @throws InvalidCallException if blame limit reached. |
||
| 107 | */ |
||
| 108 | public function addBlame($blame) |
||
| 109 | { |
||
| 110 | if (!is_string($this->multiBlamesAttribute)) { |
||
| 111 | return false; |
||
| 112 | } |
||
| 113 | $blameGuid = ''; |
||
| 114 | if (is_string($blame)) { |
||
| 115 | $blameGuid = $blame; |
||
| 116 | } |
||
| 117 | if ($blame instanceof $this->multiBlamesClass) { |
||
| 118 | $blameGuid = $blame->guid; |
||
| 119 | } |
||
| 120 | $blameGuids = $this->getBlameGuids(true); |
||
| 121 | if (array_search($blameGuid, $blameGuids)) { |
||
| 122 | throw new InvalidParamException('the blame has existed.'); |
||
| 123 | } |
||
| 124 | if ($this->getBlamesCount() >= $this->blamesLimit) { |
||
| 125 | throw new InvalidCallException("the limit($this->blamesLimit) of blames has been reached."); |
||
| 126 | } |
||
| 127 | $blameGuids[] = $blameGuid; |
||
| 128 | $this->setBlameGuids($blameGuids); |
||
| 129 | return $this->getBlameGuids(); |
||
| 130 | } |
||
| 131 | |||
| 132 | /** |
||
| 133 | * Create blame. |
||
| 134 | * @param BaseUserModel $user who will own this blame. |
||
| 135 | * @param array $config blame class configuration array. |
||
| 136 | * @return {$this->multiBlamesClass} |
||
| 137 | */ |
||
| 138 | public static function createBlame($user, $config = []) |
||
| 148 | |||
| 149 | /** |
||
| 150 | * Add specified blame, or create it before adding if doesn't exist. |
||
| 151 | * But you should save the blame instance before adding, or the operation |
||
| 152 | * will fail. |
||
| 153 | * @param {$this->multiBlamesClass}|string|array $blame |
||
| 154 | * It will be regarded as blame's guid if it is a string. And assign the |
||
| 155 | * reference parameter $blame the instance if it existed, or create one if not |
||
| 156 | * found. |
||
| 157 | * If it is {$this->multiBlamesClass} instance and existed, then will add it, or |
||
| 158 | * false will be given if it is not found in database. So if you want to add |
||
| 159 | * blame instance, you should save it before adding. |
||
| 160 | * If it is a array, it will be regarded as configuration array of blame. |
||
| 161 | * Notice! This parameter passed by reference, so it must be a variable! |
||
| 162 | * @param BaseUserModel $user whose blame. |
||
| 163 | * If null, it will take this blameable model's user. |
||
| 164 | * @return false|array false if blame created failed or not enable this feature. |
||
| 165 | * blames guid array if created and added successfully. |
||
| 166 | * @throws InvalidConfigException |
||
| 167 | * @throws InvalidParamException |
||
| 168 | * @see addBlame() |
||
| 169 | */ |
||
| 170 | public function addOrCreateBlame(&$blame = null, $user = null) |
||
| 171 | { |
||
| 172 | if (!is_string($this->multiBlamesClass)) { |
||
| 173 | throw new InvalidConfigException('$multiBlamesClass must be specified if you want to use multiple blameable features.'); |
||
| 174 | } |
||
| 175 | if (is_array($blame)) { |
||
| 176 | if ($user == null) { |
||
| 177 | $user = $this->user; |
||
| 178 | } |
||
| 179 | $blame = static::getOrCreateBlame($blame, $user); |
||
| 180 | if (!$blame->save()) { |
||
| 181 | return false; |
||
| 182 | } |
||
| 183 | return $this->addBlame($blame->guid); |
||
| 184 | } |
||
| 185 | $blameGuid = ''; |
||
| 186 | if (is_string($blame)) { |
||
| 187 | $blameGuid = $blame; |
||
| 188 | } |
||
| 189 | if ($blame instanceof $this->multiBlamesClass) { |
||
| 190 | $blameGuid = $blame->guid; |
||
| 191 | } |
||
| 192 | if (($mbi = static::getBlame($blameGuid)) !== null) { |
||
| 193 | return $this->addBlame($mbi); |
||
| 194 | } |
||
| 195 | return false; |
||
| 196 | } |
||
| 197 | |||
| 198 | /** |
||
| 199 | * Remove specified blame. |
||
| 200 | * @param {$this->multiBlamesClass} $blame |
||
| 201 | * @return false|array all guids in json format. |
||
| 202 | */ |
||
| 203 | public function removeBlame($blame) |
||
| 204 | { |
||
| 205 | if (!is_string($this->multiBlamesAttribute)) { |
||
| 206 | return false; |
||
| 207 | } |
||
| 208 | $blameGuid = ''; |
||
| 209 | if (is_string($blame)) { |
||
| 210 | $blameGuid = $blame; |
||
| 211 | } |
||
| 212 | if ($blame instanceof $this->multiBlamesClass) { |
||
| 213 | $blameGuid = $blame->guid; |
||
| 214 | } |
||
| 215 | $blameGuids = $this->getBlameGuids(true); |
||
| 216 | if (($key = array_search($blameGuid, $blameGuids)) !== false) { |
||
| 217 | unset($blameGuids[$key]); |
||
| 218 | $this->setBlameGuids($blameGuids); |
||
| 219 | } |
||
| 220 | return $this->getBlameGuids(); |
||
| 221 | } |
||
| 222 | |||
| 223 | /** |
||
| 224 | * Remove all blames. |
||
| 225 | */ |
||
| 226 | 16 | public function removeAllBlames() |
|
| 227 | { |
||
| 228 | 16 | $this->setBlameGuids(); |
|
| 229 | 16 | } |
|
| 230 | |||
| 231 | /** |
||
| 232 | * Count the blames. |
||
| 233 | * @return integer |
||
| 234 | */ |
||
| 235 | public function getBlamesCount() |
||
| 239 | |||
| 240 | /** |
||
| 241 | * Get the guid array of blames. it may check all guids if valid before return. |
||
| 242 | * @param boolean $checkValid determines whether checking the blame is valid. |
||
| 243 | * @return array all guids in json format. |
||
| 244 | */ |
||
| 245 | public function getBlameGuids($checkValid = false) |
||
| 246 | { |
||
| 247 | $multiBlamesAttribute = $this->multiBlamesAttribute; |
||
| 248 | if ($multiBlamesAttribute === false) { |
||
| 249 | return []; |
||
| 250 | } |
||
| 251 | $guids = Number::divide_guid_bin($this->$multiBlamesAttribute); |
||
| 252 | if ($checkValid) { |
||
| 253 | $guids = $this->unsetInvalidBlames($guids); |
||
| 254 | } |
||
| 255 | return $guids; |
||
| 256 | } |
||
| 257 | |||
| 258 | /** |
||
| 259 | * Event triggered when blames list changed. |
||
| 260 | * @param MultipleBlameableEvent $event |
||
| 261 | */ |
||
| 262 | 16 | public function onBlamesChanged($event) |
|
| 263 | { |
||
| 264 | 16 | $sender = $event->sender; |
|
| 265 | 16 | $sender->blamesChanged = $event->blamesChanged; |
|
| 266 | 16 | } |
|
| 267 | |||
| 268 | /** |
||
| 269 | * Remove invalid blame guid from provided guid array. |
||
| 270 | * @param array $guids guid array of blames. |
||
| 271 | * @return array guid array of blames unset invalid. |
||
| 272 | */ |
||
| 273 | 16 | protected function unsetInvalidBlames($guids) |
|
| 274 | { |
||
| 275 | 16 | $unchecked = $guids; |
|
| 276 | 16 | $multiBlamesClass = $this->multiBlamesClass; |
|
| 277 | 16 | $mbi = $multiBlamesClass::buildNoInitModel(); |
|
| 278 | 16 | foreach ($guids as $key => $guid) { |
|
| 279 | $blame = $multiBlamesClass::find()->where([$mbi->guidAttribute => $guid])->exists(); |
||
| 280 | if (!$blame) { |
||
| 281 | unset($guids[$key]); |
||
| 282 | } |
||
| 283 | } |
||
| 284 | 16 | $diff = array_diff($unchecked, $guids); |
|
| 285 | 16 | $eventName = static::$eventMultipleBlamesChanged; |
|
| 286 | 16 | $this->trigger($eventName, new MultipleBlameableEvent(['blamesChanged' => !empty($diff)])); |
|
| 287 | 16 | return $guids; |
|
| 288 | } |
||
| 289 | |||
| 290 | /** |
||
| 291 | * Set the guid array of blames, it may check all guids if valid. |
||
| 292 | * @param array $guids guid array of blames. |
||
| 293 | * @param boolean $checkValid determines whether checking the blame is valid. |
||
| 294 | * @return false|array all guids. |
||
| 295 | */ |
||
| 296 | 16 | public function setBlameGuids($guids = [], $checkValid = true) |
|
| 297 | { |
||
| 298 | 16 | if (!is_array($guids) || $this->multiBlamesAttribute === false) { |
|
| 299 | return null; |
||
| 300 | } |
||
| 301 | 16 | if ($checkValid) { |
|
| 302 | 16 | $guids = $this->unsetInvalidBlames($guids); |
|
| 303 | } |
||
| 304 | 16 | $multiBlamesAttribute = $this->multiBlamesAttribute; |
|
| 305 | 16 | $this->$multiBlamesAttribute = Number::composite_guid($guids); |
|
| 306 | 16 | return $guids; |
|
| 307 | } |
||
| 308 | |||
| 309 | /** |
||
| 310 | * Get blame. |
||
| 311 | * @param string $blameGuid |
||
| 312 | * @return {$this->multiBlamesClass} |
||
| 313 | */ |
||
| 314 | public static function getBlame($blameGuid) |
||
| 323 | |||
| 324 | /** |
||
| 325 | * Get or create blame. |
||
| 326 | * @param string|array $blameGuid |
||
| 327 | * @param BaseUserModel $user |
||
| 328 | * @return {$this->multiBlamesClass}|null |
||
| 329 | */ |
||
| 330 | public static function getOrCreateBlame($blameGuid, $user = null) |
||
| 331 | { |
||
| 332 | if (is_string($blameGuid)) { |
||
| 333 | $blameGuid = static::getBlame($blameGuid); |
||
| 334 | if ($blameGuid !== null) { |
||
| 335 | return $blameGuid; |
||
| 336 | } |
||
| 337 | } |
||
| 338 | if (is_array($blameGuid)) { |
||
| 339 | return static::createBlame($user, $blameGuid); |
||
| 340 | } |
||
| 341 | return null; |
||
| 342 | } |
||
| 343 | |||
| 344 | /** |
||
| 345 | * Get all ones to be blamed by `$blame`. |
||
| 346 | * @param {$this->multiBlamesClass} $blame |
||
| 347 | * @return array |
||
| 348 | */ |
||
| 349 | public function getBlameds($blame) |
||
| 359 | |||
| 360 | /** |
||
| 361 | * Get all the blames of record. |
||
| 362 | * @return array all blames. |
||
| 363 | */ |
||
| 364 | public function getAllBlames() |
||
| 375 | |||
| 376 | /** |
||
| 377 | * Get all records which without any blames. |
||
| 378 | * @return array all non-blameds. |
||
| 379 | */ |
||
| 380 | public function getNonBlameds() |
||
| 389 | |||
| 390 | /** |
||
| 391 | * Initialize blames limit. |
||
| 392 | * @param ModelEvent $event |
||
| 393 | */ |
||
| 394 | 16 | public function onInitBlamesLimit($event) |
|
| 401 | } |
||
| 402 |
Loading history...
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.