Hi All,
While I'm refactoring some files relating to display query results (currently display_tbl.lib.php, common.lib.php), I can method names are used regardless of the inside functionality.
Ex :- "PMA_displayHtmlRadio" in common.lib.php method return a string of HTML content. But the name tells the function displays HTML itself. As I feel these things should be modified.
As library files, they never should render HTML inside the functions themselves. Better thing is to return a string of PHP having the HTML content.
So my suggestion is to use the phrase "get" for the every method which return any data type. So that developer can understand it returns something just looking at the name. Following are some suggested names. (Some of them are already discussed in this mailing list)
Ex: PMA_displayHtmlRadio -> PMA_getRadioFields PMA_generateSliderEffect -> PMA_getDivForSliderEffect PMA_generateHtmlDropdown -> PMA_getDropdown PMA_displayTableNavigationButton -> getTableNavigationButton (All above functions return strings)
Hope to join a discussion on this.
Regards !