| Conditions | 3 |
| Paths | 3 |
| Total Lines | 57 |
| 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 |
||
| 26 | public function createSpIfNotExists($entityId, $certificate, $sfoEnabled = false) |
||
| 27 | { |
||
| 28 | // Does the SP exist? |
||
| 29 | $stmt = $this->connection->prepare('SELECT * FROM saml_entity WHERE entity_id=:entityId LIMIT 1'); |
||
| 30 | $stmt->bindParam('entityId', $entityId, PDO::PARAM_STR); |
||
| 31 | $stmt->execute(); |
||
| 32 | if ($stmt->rowCount() === 0) { |
||
| 33 | // If not, create it |
||
| 34 | $uuid = Uuid::uuid4()->toString(); |
||
| 35 | $type = 'sp'; |
||
| 36 | $configuration['acs'] = [self::SP_ACS_LOCATION]; |
||
|
|
|||
| 37 | $configuration['public_key'] = $certificate; |
||
| 38 | $configuration['loa'] = ['__default__' => 'http://stepup.example.com/assurance/loa1']; |
||
| 39 | $configuration['second_factor_only'] = $sfoEnabled; |
||
| 40 | $configuration['second_factor_only_nameid_patterns'] = [ |
||
| 41 | 'urn:collab:person:stepup.example.com:admin', |
||
| 42 | 'urn:collab:person:stepup.example.com:*', |
||
| 43 | ]; |
||
| 44 | |||
| 45 | $data = [ |
||
| 46 | 'entityId' => $entityId, |
||
| 47 | 'type' => $type, |
||
| 48 | 'configuration' => json_encode($configuration), |
||
| 49 | 'id' => $uuid, |
||
| 50 | ]; |
||
| 51 | $sql = <<<SQL |
||
| 52 | INSERT INTO saml_entity ( |
||
| 53 | `entity_id`, |
||
| 54 | `type`, |
||
| 55 | `configuration`, |
||
| 56 | `id` |
||
| 57 | ) |
||
| 58 | VALUES ( |
||
| 59 | :entityId, |
||
| 60 | :type, |
||
| 61 | :configuration, |
||
| 62 | :id |
||
| 63 | ) |
||
| 64 | SQL; |
||
| 65 | $stmt = $this->connection->prepare($sql); |
||
| 66 | if ($stmt->execute($data)) { |
||
| 67 | return $data; |
||
| 68 | } |
||
| 69 | |||
| 70 | throw new Exception('Unable to insert the new SP saml_entity'); |
||
| 71 | } else { |
||
| 72 | // Return the SP data |
||
| 73 | $results = reset($stmt->fetchAll()); |
||
| 74 | $data = [ |
||
| 75 | 'entityId' => $results['entity_id'], |
||
| 76 | 'type' => $results['type'], |
||
| 77 | 'configuration' => $results['configuration'], |
||
| 78 | 'id' => $results['id'], |
||
| 79 | ]; |
||
| 80 | return $data; |
||
| 81 | } |
||
| 82 | } |
||
| 83 | } |
||
| 84 |
Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.
Let’s take a look at an example:
As you can see in this example, the array
$myArrayis initialized the first time when the foreach loop is entered. You can also see that the value of thebarkey is only written conditionally; thus, its value might result from a previous iteration.This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.