SemanticMediaWiki /
SemanticMediaWiki
Complex classes like TimeValueFormatter often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use TimeValueFormatter, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 21 | class TimeValueFormatter extends DataValueFormatter { |
||
| 22 | |||
| 23 | /** |
||
| 24 | * @since 2.4 |
||
| 25 | * |
||
| 26 | * {@inheritDoc} |
||
| 27 | */ |
||
| 28 | 55 | public function isFormatterFor( DataValue $dataValue ) { |
|
| 31 | |||
| 32 | /** |
||
| 33 | * @since 2.4 |
||
| 34 | * |
||
| 35 | * {@inheritDoc} |
||
| 36 | */ |
||
| 37 | 42 | public function format( $type, $linker = null ) { |
|
| 58 | |||
| 59 | /** |
||
| 60 | * @private |
||
| 61 | * |
||
| 62 | * Compute a string representation that largely follows the ISO8601 standard |
||
| 63 | * of representing dates. Large year numbers may have more than 4 digits, |
||
| 64 | * which is not strictly conforming to the standard. The date includes year, |
||
| 65 | * month, and day regardless of the input precision, but will only include |
||
| 66 | * time when specified. |
||
| 67 | * |
||
| 68 | * Conforming to the 2000 version of ISO8601, year 1 BC(E) is represented |
||
| 69 | * as "0000", year 2 BC(E) as "-0001" and so on. |
||
| 70 | * |
||
| 71 | * @since 2.4 |
||
| 72 | * |
||
| 73 | * @param DITime $dataItem |
||
|
|
|||
| 74 | * @param boolean $mindefault determining whether values below the |
||
| 75 | * precision of our input should be completed with minimal or maximal |
||
| 76 | * conceivable values |
||
| 77 | * |
||
| 78 | * @return string |
||
| 79 | */ |
||
| 80 | 44 | public function getISO8601Date( $mindefault = true ) { |
|
| 105 | |||
| 106 | /** |
||
| 107 | * @private |
||
| 108 | * |
||
| 109 | * Use MediaWiki's date and time formatting. It can't handle all inputs |
||
| 110 | * properly, but has superior i18n support. |
||
| 111 | * |
||
| 112 | * @since 2.4 |
||
| 113 | * |
||
| 114 | * @param DITime $dataItem |
||
| 115 | * |
||
| 116 | * @return string |
||
| 117 | */ |
||
| 118 | 4 | public function getMediaWikiDate() { |
|
| 157 | |||
| 158 | /** |
||
| 159 | * @private |
||
| 160 | * |
||
| 161 | * @todo Internationalize the CE and BCE strings. |
||
| 162 | * |
||
| 163 | * Compute a suitable string to display the given date item. |
||
| 164 | * |
||
| 165 | * @note MediaWiki's date functions are not applicable for the range of |
||
| 166 | * historic dates we support. |
||
| 167 | * |
||
| 168 | * @since 2.4 |
||
| 169 | * |
||
| 170 | * @param DITime $dataitem |
||
| 171 | * |
||
| 172 | * @return string |
||
| 173 | */ |
||
| 174 | 14 | public function getCaptionFromDataItem( DITime $dataItem ) { |
|
| 210 | |||
| 211 | /** |
||
| 212 | * @private |
||
| 213 | * |
||
| 214 | * Return the time as a string. The time string has the format HH:MM:SS, |
||
| 215 | * without any timezone information (see class documentation for details |
||
| 216 | * on current timezone handling). |
||
| 217 | * The parameter $default optionally specifies the value returned |
||
| 218 | * if the date is valid but has no explicitly specified time. It can |
||
| 219 | * also be set to false to detect this situation. |
||
| 220 | * |
||
| 221 | * @since 2.4 |
||
| 222 | * |
||
| 223 | * @param string $default |
||
| 224 | * |
||
| 225 | * @return string |
||
| 226 | */ |
||
| 227 | 44 | public function getTimeString( $default = '00:00:00' ) { |
|
| 239 | |||
| 240 | /** |
||
| 241 | * @since 2.4 |
||
| 242 | * |
||
| 243 | * @param DITime|null $dataItem |
||
| 244 | * |
||
| 245 | * @return string |
||
| 246 | */ |
||
| 247 | 1 | public function getCaptionFromFreeFormat( DITime $dataItem = null ) { |
|
| 273 | |||
| 274 | /** |
||
| 275 | * @since 2.4 |
||
| 276 | * |
||
| 277 | * @param DITime|null $dataItem |
||
| 278 | * |
||
| 279 | * @return string |
||
| 280 | */ |
||
| 281 | public function getLocalizedFormat( DITime $dataItem = null ) { |
||
| 299 | |||
| 300 | |||
| 301 | /** |
||
| 302 | * Compute a suitable string to display this date, taking into account the |
||
| 303 | * output format and the preferrable calendar models for the data. |
||
| 304 | * |
||
| 305 | * @note MediaWiki's date functions are not applicable for the range |
||
| 306 | * of historic dates we support. |
||
| 307 | * |
||
| 308 | * @return string |
||
| 309 | */ |
||
| 310 | 19 | protected function getPreferredCaption() { |
|
| 352 | |||
| 353 | 14 | private function hintCalendarModel( $dataItem ) { |
|
| 361 | |||
| 362 | } |
||
| 363 |
Loading history...
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italyis not defined by the methodfinale(...).The most likely cause is that the parameter was removed, but the annotation was not.