pgaultier /
yii2-mailjet
| Conditions | 9 |
| Paths | 50 |
| Total Lines | 60 |
| Code Lines | 30 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 99 | public function sendMultiple(array $messages, $returnResponse = false) |
||
| 100 | { |
||
| 101 | $mailJetMessages = []; |
||
| 102 | foreach ($messages as $message) { |
||
| 103 | $mailJetMessages[] = $message->getMailJetMessage(); |
||
| 104 | } |
||
| 105 | |||
| 106 | try { |
||
| 107 | if ($this->apiKey === null) { |
||
| 108 | throw new InvalidConfigException('API Key is missing'); |
||
| 109 | } |
||
| 110 | if ($this->apiSecret === null) { |
||
| 111 | throw new InvalidConfigException('API Secret is missing'); |
||
| 112 | } |
||
| 113 | $settings = [ |
||
| 114 | 'secured' => $this->secured, |
||
| 115 | 'version' => $this->apiVersion, |
||
| 116 | ]; |
||
| 117 | |||
| 118 | if ($this->apiUrl !== null) { |
||
| 119 | $settings['url'] = $this->apiUrl; |
||
| 120 | } |
||
| 121 | |||
| 122 | $client = new Client($this->apiKey, $this->apiSecret, $this->enable, $settings); |
||
| 123 | |||
| 124 | $this->apiResponse = $client->post(Resources::$Email, [ |
||
| 125 | 'body' => [ |
||
| 126 | 'Messages' => $mailJetMessages, |
||
| 127 | ] |
||
| 128 | ]); |
||
| 129 | |||
| 130 | //TODO: handle error codes and log stuff |
||
| 131 | |||
| 132 | if ($returnResponse) { |
||
| 133 | return $this->apiResponse; |
||
|
|
|||
| 134 | } |
||
| 135 | |||
| 136 | // count successfully sent messages using MailJet's response |
||
| 137 | // the format of the response body is: |
||
| 138 | // ['Messages' => [ |
||
| 139 | // 0 => ['Status' => 'success', ...], |
||
| 140 | // 1 => ['Status' => 'success', ...], |
||
| 141 | // ... |
||
| 142 | // ]] |
||
| 143 | $successCount = 0; |
||
| 144 | $resultBody = $this->apiResponse->getBody(); |
||
| 145 | if ( ! empty($resultBody['Messages'])) { |
||
| 146 | $resultStatusColumns = ArrayHelper::getColumn($resultBody['Messages'], 'Status'); |
||
| 147 | $statusCounts = array_count_values($resultStatusColumns); |
||
| 148 | if (isset($statusCounts['success'])) { |
||
| 149 | $successCount = $statusCounts['success']; |
||
| 150 | } |
||
| 151 | } |
||
| 152 | |||
| 153 | return $successCount; |
||
| 154 | |||
| 155 | } catch (InvalidConfigException $e) { |
||
| 156 | throw $e; |
||
| 157 | } |
||
| 158 | } |
||
| 159 | } |
||
| 160 |
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_functionexpects aPostobject, and outputs the author of the post. The base classPostreturns a simple string and outputting a simple string will work just fine. However, the child classBlogPostwhich is a sub-type ofPostinstead decided to return anobject, and is therefore violating the SOLID principles. If aBlogPostwere passed tomy_function, PHP would not complain, but ultimately fail when executing thestrtouppercall in its body.