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