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