| Conditions | 5 |
| Paths | 9 |
| Total Lines | 307 |
| Code Lines | 205 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 13 | ||
| 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 |
||
| 41 | public function validInputProvider() { |
||
| 42 | $gregorian = 'http://www.wikidata.org/entity/Q1985727'; |
||
| 43 | $julian = 'http://www.wikidata.org/entity/Q1985786'; |
||
| 44 | |||
| 45 | $julianOpts = new ParserOptions(); |
||
| 46 | $julianOpts->setOption( IsoTimestampParser::OPT_CALENDAR, $julian ); |
||
| 47 | |||
| 48 | $gregorianOpts = new ParserOptions(); |
||
| 49 | $gregorianOpts->setOption( IsoTimestampParser::OPT_CALENDAR, $gregorian ); |
||
| 50 | |||
| 51 | $prec10aOpts = new ParserOptions(); |
||
| 52 | $prec10aOpts->setOption( IsoTimestampParser::OPT_PRECISION, TimeValue::PRECISION_YEAR10 ); |
||
| 53 | |||
| 54 | $precDayOpts = new ParserOptions(); |
||
| 55 | $precDayOpts->setOption( IsoTimestampParser::OPT_PRECISION, TimeValue::PRECISION_DAY ); |
||
| 56 | |||
| 57 | $precSecondOpts = new ParserOptions(); |
||
| 58 | $precSecondOpts->setOption( IsoTimestampParser::OPT_PRECISION, TimeValue::PRECISION_SECOND ); |
||
| 59 | |||
| 60 | $valid = array( |
||
| 61 | // Whitespace |
||
| 62 | "+0000000000002013-07-16T00:00:00Z\n" => array( |
||
| 63 | '+2013-07-16T00:00:00Z', |
||
| 64 | TimeValue::PRECISION_DAY, |
||
| 65 | ), |
||
| 66 | ' +0000000000002013-07-00T00:00:00Z ' => array( |
||
| 67 | '+2013-07-00T00:00:00Z', |
||
| 68 | TimeValue::PRECISION_MONTH, |
||
| 69 | ), |
||
| 70 | |||
| 71 | // Empty options tests |
||
| 72 | '+0000000000002013-00-00T00:00:00Z' => array( |
||
| 73 | '+2013-00-00T00:00:00Z', |
||
| 74 | TimeValue::PRECISION_YEAR, |
||
| 75 | ), |
||
| 76 | '+0000000000000000-00-00T00:00:00Z' => array( |
||
| 77 | '+0000-00-00T00:00:00Z', |
||
| 78 | TimeValue::PRECISION_YEAR, |
||
| 79 | $julian |
||
| 80 | ), |
||
| 81 | '+0000000000002000-00-00T00:00:00Z' => array( |
||
| 82 | '+2000-00-00T00:00:00Z', |
||
| 83 | TimeValue::PRECISION_YEAR, |
||
| 84 | ), |
||
| 85 | '+0000000000008000-00-00T00:00:00Z' => array( |
||
| 86 | '+8000-00-00T00:00:00Z', |
||
| 87 | TimeValue::PRECISION_YEAR1K, |
||
| 88 | ), |
||
| 89 | '+0000000000020000-00-00T00:00:00Z' => array( |
||
| 90 | '+20000-00-00T00:00:00Z', |
||
| 91 | TimeValue::PRECISION_YEAR10K, |
||
| 92 | ), |
||
| 93 | '+0000000000200000-00-00T00:00:00Z' => array( |
||
| 94 | '+200000-00-00T00:00:00Z', |
||
| 95 | TimeValue::PRECISION_YEAR100K, |
||
| 96 | ), |
||
| 97 | '+0000000002000000-00-00T00:00:00Z' => array( |
||
| 98 | '+2000000-00-00T00:00:00Z', |
||
| 99 | TimeValue::PRECISION_YEAR1M, |
||
| 100 | ), |
||
| 101 | '+0000000020000000-00-00T00:00:00Z' => array( |
||
| 102 | '+20000000-00-00T00:00:00Z', |
||
| 103 | TimeValue::PRECISION_YEAR10M, |
||
| 104 | ), |
||
| 105 | '+0000000200000000-00-00T00:00:00Z' => array( |
||
| 106 | '+200000000-00-00T00:00:00Z', |
||
| 107 | TimeValue::PRECISION_YEAR100M, |
||
| 108 | ), |
||
| 109 | '+0000002000000000-00-00T00:00:00Z' => array( |
||
| 110 | '+2000000000-00-00T00:00:00Z', |
||
| 111 | TimeValue::PRECISION_YEAR1G, |
||
| 112 | ), |
||
| 113 | '+2000000000000000-00-00T00:00:00Z' => array( |
||
| 114 | '+2000000000000000-00-00T00:00:00Z', |
||
| 115 | TimeValue::PRECISION_YEAR1G, |
||
| 116 | ), |
||
| 117 | '-2000000000000000-00-00T00:00:00Z' => array( |
||
| 118 | '-2000000000000000-00-00T00:00:00Z', |
||
| 119 | TimeValue::PRECISION_YEAR1G, |
||
| 120 | $julian |
||
| 121 | ), |
||
| 122 | '+0000000000002013-07-16T00:00:00Z (Gregorian)' => array( |
||
| 123 | '+2013-07-16T00:00:00Z', |
||
| 124 | TimeValue::PRECISION_DAY, |
||
| 125 | ), |
||
| 126 | '+0000000000000000-01-01T00:00:00Z (Gregorian)' => array( |
||
| 127 | '+0000-01-01T00:00:00Z', |
||
| 128 | TimeValue::PRECISION_DAY, |
||
| 129 | |||
| 130 | ), |
||
| 131 | '+0000000000002001-01-14T00:00:00Z (Julian)' => array( |
||
| 132 | '+2001-01-14T00:00:00Z', |
||
| 133 | TimeValue::PRECISION_DAY, |
||
| 134 | $julian, |
||
| 135 | ), |
||
| 136 | '+0000000000010000-01-01T00:00:00Z (Gregorian)' => array( |
||
| 137 | '+10000-01-01T00:00:00Z', |
||
| 138 | TimeValue::PRECISION_DAY, |
||
| 139 | ), |
||
| 140 | '-0000000000000001-01-01T00:00:00Z (Gregorian)' => array( |
||
| 141 | '-0001-01-01T00:00:00Z', |
||
| 142 | TimeValue::PRECISION_DAY, |
||
| 143 | $gregorian |
||
| 144 | ), |
||
| 145 | '-00000000001-01-01T00:00:00Z (Gregorian)' => array( |
||
| 146 | '-0001-01-01T00:00:00Z', |
||
| 147 | TimeValue::PRECISION_DAY, |
||
| 148 | $gregorian, |
||
| 149 | $julianOpts // overridden by explicit calendar in input string |
||
| 150 | ), |
||
| 151 | '-00000000001-01-01T00:00:00Z (Julian)' => array( |
||
| 152 | '-0001-01-01T00:00:00Z', |
||
| 153 | TimeValue::PRECISION_DAY, |
||
| 154 | $julian, |
||
| 155 | $gregorianOpts // overridden by explicit calendar in input string |
||
| 156 | ), |
||
| 157 | '-000001-01-01T00:00:00Z (Gregorian)' => array( |
||
| 158 | '-0001-01-01T00:00:00Z', |
||
| 159 | TimeValue::PRECISION_DAY, |
||
| 160 | $gregorian |
||
| 161 | ), |
||
| 162 | '-1-01-01T00:00:00Z (Gregorian)' => array( |
||
| 163 | '-0001-01-01T00:00:00Z', |
||
| 164 | TimeValue::PRECISION_DAY, |
||
| 165 | $gregorian |
||
| 166 | ), |
||
| 167 | |||
| 168 | // Tests with different options |
||
| 169 | '-1-01-02T00:00:00Z' => array( |
||
| 170 | '-0001-01-02T00:00:00Z', |
||
| 171 | TimeValue::PRECISION_DAY, |
||
| 172 | $gregorian, |
||
| 173 | $gregorianOpts, |
||
| 174 | ), |
||
| 175 | '+2001-01-03T00:00:00Z' => array( |
||
| 176 | '+2001-01-03T00:00:00Z', |
||
| 177 | TimeValue::PRECISION_DAY, |
||
| 178 | $julian, |
||
| 179 | $julianOpts, |
||
| 180 | ), |
||
| 181 | '-1-01-04T00:00:00Z' => array( |
||
| 182 | '-0001-01-04T00:00:00Z', |
||
| 183 | TimeValue::PRECISION_YEAR10, |
||
| 184 | $julian, |
||
| 185 | $prec10aOpts, |
||
| 186 | ), |
||
| 187 | '-1-01-05T00:00:00Z' => array( |
||
| 188 | '-0001-01-05T00:00:00Z', |
||
| 189 | TimeValue::PRECISION_DAY, |
||
| 190 | $julian, |
||
| 191 | ), |
||
| 192 | |||
| 193 | '+1999-00-00T00:00:00Z' => array( |
||
| 194 | '+1999-00-00T00:00:00Z', |
||
| 195 | TimeValue::PRECISION_YEAR, |
||
| 196 | ), |
||
| 197 | '+2000-00-00T00:00:00Z' => array( |
||
| 198 | '+2000-00-00T00:00:00Z', |
||
| 199 | TimeValue::PRECISION_YEAR, |
||
| 200 | ), |
||
| 201 | '+2010-00-00T00:00:00Z' => array( |
||
| 202 | '+2010-00-00T00:00:00Z', |
||
| 203 | TimeValue::PRECISION_YEAR, |
||
| 204 | ), |
||
| 205 | |||
| 206 | // Optional sign character |
||
| 207 | '2015-01-01T00:00:00Z' => array( |
||
| 208 | '+2015-01-01T00:00:00Z', |
||
| 209 | TimeValue::PRECISION_DAY, |
||
| 210 | ), |
||
| 211 | |||
| 212 | // Optional time zone |
||
| 213 | '2015-01-01T00:00:00' => array( |
||
| 214 | '+2015-01-01T00:00:00Z', |
||
| 215 | TimeValue::PRECISION_DAY, |
||
| 216 | ), |
||
| 217 | |||
| 218 | // Actual minus character from Unicode; roundtrip with TimeDetailsFormatter |
||
| 219 | "\xE2\x88\x922015-01-01T00:00:00" => array( |
||
| 220 | '-2015-01-01T00:00:00Z', |
||
| 221 | TimeValue::PRECISION_DAY, |
||
| 222 | $julian |
||
| 223 | ), |
||
| 224 | |||
| 225 | // Optional colons |
||
| 226 | '2015-01-01T161718' => array( |
||
| 227 | '+0000000000002015-01-01T16:17:18Z', |
||
| 228 | TimeValue::PRECISION_SECOND, |
||
| 229 | ), |
||
| 230 | '2015-01-01T1617' => array( |
||
| 231 | '+0000000000002015-01-01T16:17:00Z', |
||
| 232 | TimeValue::PRECISION_MINUTE, |
||
| 233 | ), |
||
| 234 | |||
| 235 | // Optional second |
||
| 236 | '2015-01-01T00:00' => array( |
||
| 237 | '+2015-01-01T00:00:00Z', |
||
| 238 | TimeValue::PRECISION_DAY, |
||
| 239 | ), |
||
| 240 | |||
| 241 | // Optional hour and minute |
||
| 242 | '2015-01-01' => array( |
||
| 243 | '+2015-01-01T00:00:00Z', |
||
| 244 | TimeValue::PRECISION_DAY, |
||
| 245 | ), |
||
| 246 | '60-01-01' => array( |
||
| 247 | '+0060-01-01T00:00:00Z', |
||
| 248 | TimeValue::PRECISION_DAY, |
||
| 249 | $julian |
||
| 250 | ), |
||
| 251 | // 32 can not be confused with anything. Can't be day or month. Can't be minute or |
||
| 252 | // second because a time can not start with minute or second. |
||
| 253 | '32-01-01' => array( |
||
| 254 | '+0032-01-01T00:00:00Z', |
||
| 255 | TimeValue::PRECISION_DAY, |
||
| 256 | $julian |
||
| 257 | ), |
||
| 258 | |||
| 259 | // Years <= 31 require either the time part or a year with more than 2 digits |
||
| 260 | '1-01-01T00:00' => array( |
||
| 261 | '+0001-01-01T00:00:00Z', |
||
| 262 | TimeValue::PRECISION_DAY, |
||
| 263 | $julian |
||
| 264 | ), |
||
| 265 | '001-01-01' => array( |
||
| 266 | '+0001-01-01T00:00:00Z', |
||
| 267 | TimeValue::PRECISION_DAY, |
||
| 268 | $julian |
||
| 269 | ), |
||
| 270 | // 00-00-00 to 24-00-00 can be confused with a time, but not if it is signed. |
||
| 271 | '-01-02-03' => array( |
||
| 272 | '-0001-02-03T00:00:00Z', |
||
| 273 | TimeValue::PRECISION_DAY, |
||
| 274 | $julian |
||
| 275 | ), |
||
| 276 | '+01-02-03' => array( |
||
| 277 | '+0001-02-03T00:00:00Z', |
||
| 278 | TimeValue::PRECISION_DAY, |
||
| 279 | $julian |
||
| 280 | ), |
||
| 281 | |||
| 282 | // Day zero |
||
| 283 | '2015-01-00' => array( |
||
| 284 | '+2015-01-00T00:00:00Z', |
||
| 285 | TimeValue::PRECISION_MONTH, |
||
| 286 | ), |
||
| 287 | |||
| 288 | // Month zero |
||
| 289 | '2015-00-00' => array( |
||
| 290 | '+2015-00-00T00:00:00Z', |
||
| 291 | TimeValue::PRECISION_YEAR, |
||
| 292 | ), |
||
| 293 | |||
| 294 | // Leap seconds are a valid concept |
||
| 295 | '+2015-01-01T00:00:61Z' => array( |
||
| 296 | '+2015-01-01T00:00:61Z', |
||
| 297 | TimeValue::PRECISION_SECOND, |
||
| 298 | ), |
||
| 299 | |||
| 300 | // Tests for correct precision when a bad precision is passed through the opts |
||
| 301 | // @see https://bugzilla.wikimedia.org/show_bug.cgi?id=62730 |
||
| 302 | '+0000000000000012-12-00T00:00:00Z' => array( |
||
| 303 | '+0012-12-00T00:00:00Z', |
||
| 304 | TimeValue::PRECISION_MONTH, |
||
| 305 | $julian, |
||
| 306 | $precDayOpts, |
||
| 307 | ), |
||
| 308 | '+2015-01-01T00:00:00Z' => array( |
||
| 309 | '+2015-01-01T00:00:00Z', |
||
| 310 | TimeValue::PRECISION_SECOND, |
||
| 311 | $gregorian, |
||
| 312 | $precSecondOpts, |
||
| 313 | ), |
||
| 314 | |||
| 315 | // Test Julian/Gregorian switch in October 1582. |
||
| 316 | '1583-01-01' => array( |
||
| 317 | '+1583-01-01T00:00:00Z', |
||
| 318 | TimeValue::PRECISION_DAY, |
||
| 319 | $gregorian |
||
| 320 | ), |
||
| 321 | |||
| 322 | // Test Julian/Gregorian switch in October 1582. |
||
| 323 | '1582-08-01' => array( |
||
| 324 | '+1582-08-01T00:00:00Z', |
||
| 325 | TimeValue::PRECISION_DAY, |
||
| 326 | $julian |
||
| 327 | ), |
||
| 328 | ); |
||
| 329 | |||
| 330 | $argLists = array(); |
||
| 331 | |||
| 332 | foreach ( $valid as $key => $value ) { |
||
| 333 | $timestamp = $value[0]; |
||
| 334 | $precision = isset( $value[1] ) ? $value[1] : TimeValue::PRECISION_DAY; |
||
| 335 | $calendarModel = isset( $value[2] ) ? $value[2] : $gregorian; |
||
| 336 | $options = isset( $value[3] ) ? $value[3] : null; |
||
| 337 | |||
| 338 | $argLists[] = array( |
||
| 339 | // Because PHP magically turns numeric keys into ints/floats |
||
| 340 | (string)$key, |
||
| 341 | new TimeValue( $timestamp, 0, 0, 0, $precision, $calendarModel ), |
||
| 342 | new IsoTimestampParser( null, $options ) |
||
| 343 | ); |
||
| 344 | } |
||
| 345 | |||
| 346 | return $argLists; |
||
| 347 | } |
||
| 348 | |||
| 506 |
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.