| Conditions | 1 |
| Paths | 1 |
| Total Lines | 115 |
| 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 // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
||
| 114 | public function provideNextVersion() { |
||
| 115 | return array( |
||
| 116 | 'No changes' => array( |
||
| 117 | '1.2.3', |
||
| 118 | array(), |
||
| 119 | array(), |
||
| 120 | '1.2.4', |
||
| 121 | ), |
||
| 122 | 'Patch changes' => array( |
||
| 123 | '1.2.3', |
||
| 124 | array( |
||
| 125 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 126 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 127 | new ChangeEntry( array( 'significance' => null ) ), |
||
| 128 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 129 | ), |
||
| 130 | array(), |
||
| 131 | '1.2.4', |
||
| 132 | ), |
||
| 133 | 'Minor change' => array( |
||
| 134 | '1.2.3', |
||
| 135 | array( |
||
| 136 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 137 | new ChangeEntry( array( 'significance' => 'minor' ) ), |
||
| 138 | new ChangeEntry( array( 'significance' => null ) ), |
||
| 139 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 140 | ), |
||
| 141 | array(), |
||
| 142 | '1.3.0', |
||
| 143 | ), |
||
| 144 | 'Major change' => array( |
||
| 145 | '1.2.3', |
||
| 146 | array( |
||
| 147 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 148 | new ChangeEntry( array( 'significance' => 'minor' ) ), |
||
| 149 | new ChangeEntry( array( 'significance' => null ) ), |
||
| 150 | new ChangeEntry( array( 'significance' => 'major' ) ), |
||
| 151 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 152 | ), |
||
| 153 | array(), |
||
| 154 | '2.0.0', |
||
| 155 | ), |
||
| 156 | 'Version number with extra components' => array( |
||
| 157 | '1.2.3-foo', |
||
| 158 | array(), |
||
| 159 | array(), |
||
| 160 | '1.2.4', |
||
| 161 | ), |
||
| 162 | 'Version number with extra components (2)' => array( |
||
| 163 | '1.2.9+123', |
||
| 164 | array(), |
||
| 165 | array(), |
||
| 166 | '1.2.10', |
||
| 167 | ), |
||
| 168 | 'Version number with extra components (3)' => array( |
||
| 169 | '1.2.3-foo+bar', |
||
| 170 | array(), |
||
| 171 | array(), |
||
| 172 | '1.2.4', |
||
| 173 | ), |
||
| 174 | |||
| 175 | 'Non-major update for version 0' => array( |
||
| 176 | '0.1.2', |
||
| 177 | array( |
||
| 178 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 179 | new ChangeEntry( array( 'significance' => 'minor' ) ), |
||
| 180 | new ChangeEntry( array( 'significance' => null ) ), |
||
| 181 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 182 | ), |
||
| 183 | array(), |
||
| 184 | '0.2.0', |
||
| 185 | ), |
||
| 186 | 'Major update for version 0' => array( |
||
| 187 | '0.1.2', |
||
| 188 | array( |
||
| 189 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 190 | new ChangeEntry( array( 'significance' => 'major' ) ), |
||
| 191 | new ChangeEntry( array( 'significance' => null ) ), |
||
| 192 | new ChangeEntry( array( 'significance' => 'patch' ) ), |
||
| 193 | ), |
||
| 194 | array(), |
||
| 195 | '0.2.0', |
||
| 196 | "<warning>Semver does not automatically move version 0.y.z to 1.0.0.\n<warning>You will have to do that manually when you're ready for the first release.\n", |
||
| 197 | ), |
||
| 198 | |||
| 199 | 'Including extra components' => array( |
||
| 200 | '1.2.3', |
||
| 201 | array(), |
||
| 202 | array( |
||
| 203 | 'prerelease' => 'alpha.002', |
||
| 204 | 'buildinfo' => 'g12345678.003', |
||
| 205 | ), |
||
| 206 | '1.2.4-alpha.2+g12345678.003', |
||
| 207 | ), |
||
| 208 | 'Including extra components (2)' => array( |
||
| 209 | '1.2.3-foo', |
||
| 210 | array(), |
||
| 211 | array( 'buildinfo' => 'g12345678' ), |
||
| 212 | '1.2.4+g12345678', |
||
| 213 | ), |
||
| 214 | |||
| 215 | 'Invalid prerelease component' => array( |
||
| 216 | '1.2.3-foo', |
||
| 217 | array(), |
||
| 218 | array( 'prerelease' => 'delta?' ), |
||
| 219 | new InvalidArgumentException( 'Invalid prerelease data' ), |
||
| 220 | ), |
||
| 221 | 'Invalid buildinfo component' => array( |
||
| 222 | '1.2.3-foo', |
||
| 223 | array(), |
||
| 224 | array( 'buildinfo' => 'build?' ), |
||
| 225 | new InvalidArgumentException( 'Invalid buildinfo data' ), |
||
| 226 | ), |
||
| 227 | ); |
||
| 228 | } |
||
| 229 | |||
| 292 |
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignorePhpDoc annotation to the duplicate definition and it will be ignored.