mambax7 /
newbb5
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php namespace XoopsModules\Newbb; |
||
| 36 | class ObjectTree extends \XoopsObjectTree |
||
| 37 | { |
||
| 38 | /** |
||
| 39 | * @param $objectArr |
||
| 40 | * @param null $rootId |
||
| 41 | */ |
||
| 42 | public function __construct(&$objectArr, $rootId = null) |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Make options for a select box from |
||
| 49 | * |
||
| 50 | * @param int $key ID of the object to display as the root of select options |
||
| 51 | * @param string $ret (reference to a string when called from outside) Result from previous recursions |
||
| 52 | * @param string $prefix_orig String to indent items at deeper levels |
||
| 53 | * @param string $prefix_curr String to indent the current item |
||
| 54 | * @param null|array $tags |
||
| 55 | * @internal param string $fieldName Name of the member variable from the |
||
| 56 | * node objects that should be used as the title for the options. |
||
| 57 | * @internal param string $selected Value to display as selected |
||
| 58 | * @access private |
||
| 59 | */ |
||
| 60 | protected function makeTreeItems($key, &$ret, $prefix_orig, $prefix_curr = '', $tags = null) |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Make a select box with options from the tree |
||
| 82 | * |
||
| 83 | * @param string $prefix String to indent deeper levels |
||
| 84 | * @param integer $key ID of the object to display as the root of select options |
||
| 85 | * @param null $tags |
||
| 86 | * @return array|string HTML select box |
||
| 87 | * @internal param string $name Name of the select box |
||
| 88 | * @internal param string $fieldName Name of the member variable from the |
||
| 89 | * node objects that should be used as the title for the options. |
||
| 90 | * @internal param string $selected Value to display as selected |
||
| 91 | * @internal param bool $addEmptyOption Set TRUE to add an empty option with value "0" at the top of the hierarchy |
||
| 92 | */ |
||
| 93 | public function &makeTree($prefix = '-', $key = 0, $tags = null) |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Make a select box with options from the tree |
||
| 103 | * |
||
| 104 | * @param string $name Name of the select box |
||
| 105 | * @param string $fieldName Name of the member variable from the |
||
| 106 | * node objects that should be used as the title for the options. |
||
| 107 | * @param string $prefix String to indent deeper levels |
||
| 108 | * @param string $selected Value to display as selected |
||
| 109 | * @param bool $addEmptyOption Set TRUE to add an empty option with value "0" at the top of the hierarchy |
||
| 110 | * @param integer $key ID of the object to display as the root of select options |
||
| 111 | * @param string $extra |
||
| 112 | * @return string HTML select box |
||
| 113 | * |
||
| 114 | * @deprecated since 2.5.9, please use makeSelectElement() |
||
| 115 | */ |
||
| 116 | public function makeSelBox( |
||
| 137 | |||
| 138 | /** |
||
| 139 | * Make a tree for the array of a given category |
||
| 140 | * |
||
| 141 | * @param string $key top key of the tree |
||
| 142 | * @param array $ret the tree |
||
| 143 | * @param integer $depth level of subcategories |
||
| 144 | * @return void |
||
| 145 | * @internal param array $tags fields to be used |
||
| 146 | */ |
||
| 147 | public function getAllChildObject($key, &$ret, $depth = 0) |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Make a tree for the array |
||
| 165 | * |
||
| 166 | * @param int|string $key top key of the tree |
||
| 167 | * @param integer $depth level of subcategories |
||
| 168 | * @return array |
||
| 169 | * @internal param array $tags fields to be used |
||
| 170 | */ |
||
| 171 | public function &makeObjectTree($key = 0, $depth = 0) |
||
| 181 | |||
| 182 | /** |
||
| 183 | * Make a tree for the array of a given category |
||
| 184 | * |
||
| 185 | * @param string $key top key of the tree |
||
| 186 | * @param array $ret the tree |
||
| 187 | * @param array $tags fields to be used |
||
| 188 | * @param integer $depth level of subcategories |
||
| 189 | * @return void |
||
| 190 | */ |
||
| 191 | public function getAllChildArray($key, &$ret, array $tags = [], $depth = 0) |
||
| 213 | |||
| 214 | /** |
||
| 215 | * Make a tree for the array |
||
| 216 | * |
||
| 217 | * @param int|string $key top key of the tree |
||
| 218 | * @param array $tags fields to be used |
||
| 219 | * @param integer $depth level of subcategories |
||
| 220 | * @return array |
||
| 221 | */ |
||
| 222 | public function &makeArrayTree($key = 0, $tags = null, $depth = 0) |
||
| 232 | |||
| 233 | /**#@+ |
||
| 234 | * get all parent forums |
||
| 235 | * |
||
| 236 | * @param string $key ID of the child object |
||
| 237 | * @param array $ret (empty when called from outside) Result from previous recursions |
||
| 238 | * @param int $uplevel (empty when called from outside) level of recursion |
||
| 239 | * @return array Array of parent nodes. |
||
| 240 | */ |
||
| 241 | public function &myGetParentForums($key, array $ret = [], $uplevel = 0) |
||
| 256 | |||
| 257 | /** |
||
| 258 | * @param $key |
||
| 259 | * @param bool $reverse |
||
| 260 | * @return array |
||
| 261 | */ |
||
| 262 | public function &getParentForums($key, $reverse = true) |
||
| 284 | /**#@-*/ |
||
| 285 | } |
||
| 286 | } |
||
| 287 |
Loading history...
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.