jon48 /
webtrees-lib
Complex classes like FunctionsPrint 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 FunctionsPrint, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 24 | class FunctionsPrint { |
||
| 25 | |||
| 26 | /** |
||
| 27 | * Get an array converted to a list. For example |
||
| 28 | * array("red", "green", "yellow", "blue") => "red, green, yellow and blue" |
||
| 29 | * |
||
| 30 | * @param array $array Array to convert |
||
| 31 | * @return string List of elements |
||
| 32 | */ |
||
| 33 | public static function getListFromArray(array $array) { |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Return HTML code to include a flag icon in facts description |
||
| 52 | * |
||
| 53 | * @param \Fisharebest\Webtrees\Fact $fact Fact record |
||
| 54 | * @param \MyArtJaub\Webtrees\Map\MapProviderInterface $mapProvider Map Provider |
||
| 55 | * @return string HTML code of the inserted flag |
||
| 56 | */ |
||
| 57 | public static function htmlFactPlaceIcon( |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Return HTML code to include a flag icon |
||
| 73 | * |
||
| 74 | * @param \Fisharebest\Webtrees\Place $place |
||
| 75 | * @param string $icon_path |
||
| 76 | * @param number $size |
||
| 77 | * @return string HTML code of the inserted flag |
||
| 78 | */ |
||
| 79 | public static function htmlPlaceIcon(\Fisharebest\Webtrees\Place $place, $icon_path , $size = 50) { |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Returns HTML code to display a tag cloud from a list. |
||
| 85 | * List must be a list of arrays (one for each item to display) containing the following parameters: |
||
| 86 | * - "text" : text to display |
||
| 87 | * - "count" : count of items |
||
| 88 | * - "url" : url to the item |
||
| 89 | * |
||
| 90 | * @param array $list Array of items to display in the cloud |
||
| 91 | * @param bool $totals Display totals for an items |
||
| 92 | * @return string Tag Cloud HTML Code |
||
| 93 | */ |
||
| 94 | public static function htmlListCloud($list, $totals) { |
||
| 126 | |||
| 127 | |||
| 128 | /** |
||
| 129 | * Returns HTML code to include a place cloud |
||
| 130 | * |
||
| 131 | * @param array $places Array of places to display in the cloud |
||
| 132 | * @param bool $totals Display totals for a place |
||
| 133 | * @param \Fisharebest\Webtrees\Tree $tree Tree |
||
| 134 | * @return string Place Cloud HTML Code |
||
| 135 | */ |
||
| 136 | public static function htmlPlacesCloud($places, $totals, Tree $tree) { |
||
| 151 | |||
| 152 | /** |
||
| 153 | * Return HTML Code to display individual in non structured list (e.g. Patronymic Lineages) |
||
| 154 | * |
||
| 155 | * @param \Fisharebest\Webtrees\Individual $individual Individual to print |
||
| 156 | * @param bool $isStrong Bolden the name ? |
||
| 157 | * @return string HTML Code for individual item |
||
| 158 | */ |
||
| 159 | public static function htmlIndividualForList(\Fisharebest\Webtrees\Individual $individual, $isStrong = true){ |
||
| 182 | |||
| 183 | /** |
||
| 184 | * Format date to display short (just years) |
||
| 185 | * |
||
| 186 | * @param \Fisharebest\Webtrees\Fact $eventObj Fact to display date |
||
| 187 | * @param boolean $anchor option to print a link to calendar |
||
| 188 | * @return string HTML code for short date |
||
| 189 | */ |
||
| 190 | public static function formatFactDateShort(\Fisharebest\Webtrees\Fact $fact, $anchor=false) { |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Format fact place to display short |
||
| 213 | * |
||
| 214 | * @param \Fisharebest\Webtrees\Fact $eventObj Fact to display date |
||
| 215 | * @param string $format Format of the place |
||
| 216 | * @param boolean $anchor option to print a link to placelist |
||
| 217 | * @return string HTML code for short place |
||
| 218 | */ |
||
| 219 | public static function formatFactPlaceShort(\Fisharebest\Webtrees\Fact $fact, $format, $anchor=false){ |
||
| 230 | |||
| 231 | /** |
||
| 232 | * Format Sosa number to display next to individual details |
||
| 233 | * Possible format are: |
||
| 234 | * - 1 (default) : display an image if the individual is a Sosa, independently of the number of times he is |
||
| 235 | * - 2 : display a list of Sosa numbers, with an image, separated by an hyphen. |
||
| 236 | * |
||
| 237 | * @param array $sosatab List of Sosa numbers |
||
| 238 | * @param int $format Format to apply to the Sosa numbers |
||
| 239 | * @param string $size CSS size for the icon. A CSS style css_$size is required |
||
| 240 | * @return string HTML code for the formatted Sosa numbers |
||
| 241 | */ |
||
| 242 | public static function formatSosaNumbers(array $sosatab, $format = 1, $size = 'small'){ |
||
| 269 | |||
| 270 | /** |
||
| 271 | * Format IsSourced icons for display |
||
| 272 | * Possible format are: |
||
| 273 | * - 1 (default) : display an icon depending on the level of sources |
||
| 274 | * |
||
| 275 | * @param string $sourceType Type of the record : 'E', 'R' |
||
| 276 | * @param int $isSourced Level to display |
||
| 277 | * @param string $tag Fact to display status |
||
| 278 | * @param int $format Format to apply to the IsSourced parameter |
||
| 279 | * @param string $size CSS size for the icon. A CSS style css_$size is required |
||
| 280 | * @return string HTML code for IsSourced icon |
||
| 281 | */ |
||
| 282 | public static function formatIsSourcedIcon($sourceType, $isSourced, $tag='EVEN', $format = 1, $size='normal'){ |
||
| 347 | |||
| 348 | /** |
||
| 349 | * Check whether the date is compatible with the Google Chart range (between 1550 and 2030). |
||
| 350 | * |
||
| 351 | * @param Date $date |
||
| 352 | * @return boolean |
||
| 353 | */ |
||
| 354 | public static function isDateWithinChartsRange(Date $date) { |
||
| 357 | |||
| 358 | } |
||
| 359 |
Loading history...
In PHP, under loose comparison (like
==, or!=, orswitchconditions), values of different types might be equal.For
stringvalues, the empty string''is a special case, in particular the following results might be unexpected: