| Conditions | 9 |
| Paths | 10 |
| Total Lines | 55 |
| Code Lines | 28 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 3 | ||
| Bugs | 0 | Features | 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 |
||
| 21 | public function requireDefaultRecords() |
||
| 22 | { |
||
| 23 | parent::requireDefaultRecords(); |
||
| 24 | |||
| 25 | // verbose messages |
||
| 26 | DB::alteration_message('Searching for environment configuration for ' . Director::absoluteURL('/'), 'created'); |
||
| 27 | |||
| 28 | // get the config based on the URL (URL is key) |
||
| 29 | $config = $this->prepConfig($this->config()->get('environments'), Director::absoluteURL('/')); |
||
| 30 | |||
| 31 | // only run if everything is fine |
||
| 32 | if (!is_array($config) || empty($config)) { |
||
| 33 | DB::alteration_message('No configuration found.', 'created'); |
||
| 34 | } else if (!file_exists('../' . $config['filename'])) { |
||
| 35 | DB::alteration_message('No CHANGELOG.md-file found.', 'created'); |
||
| 36 | } else { |
||
| 37 | // get the information in the database for the last release notification |
||
| 38 | $record = (self::get()->count() == 0) ? new self() : self::get()->first(); |
||
| 39 | |||
| 40 | // load the changelog |
||
| 41 | $changelog = file_get_contents('../' . $config['filename']); |
||
| 42 | |||
| 43 | // check if the CHANGELOG.md file has been changed since the last run |
||
| 44 | if ($changelog != '' && md5($changelog) != md5($record->Changelog)) { |
||
| 45 | // email the changelog out |
||
| 46 | foreach ($config['recipients'] as $recipient) { |
||
| 47 | Email::create( |
||
| 48 | $config['from'], |
||
| 49 | $recipient, |
||
| 50 | $config['subject'], |
||
| 51 | |||
| 52 | // remove the old part and add more useful information to the content |
||
| 53 | sprintf( |
||
| 54 | "%s (%s)\n\n%s", |
||
| 55 | $config['environment_name'], |
||
| 56 | $config['url'], |
||
| 57 | $changelog |
||
| 58 | ) |
||
| 59 | )->sendPlain(); |
||
| 60 | |||
| 61 | DB::alteration_message($recipient . ' notified', 'created'); |
||
| 62 | } |
||
| 63 | |||
| 64 | // save the new changelog to ensure we aren't re-running this in the next step |
||
| 65 | $record->Changelog = $changelog; |
||
| 66 | } |
||
| 67 | |||
| 68 | // say welcome :) |
||
| 69 | if (!$record->ID) { |
||
| 70 | DB::alteration_message('Install of FriendsOfSilverStripe/release-notifications'); |
||
| 71 | } |
||
| 72 | |||
| 73 | $record->write(); |
||
| 74 | } |
||
| 75 | } |
||
| 76 | |||
| 101 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.