Enalean /
tuleap
| Conditions | 32 |
| Paths | 6361 |
| Total Lines | 118 |
| Code Lines | 89 |
| Lines | 0 |
| Ratio | 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 // -*-php-*- |
||
| 102 | function run($dbi, $argstr, &$request, $basepage) { |
||
| 103 | global $DBParams; |
||
| 104 | //$request->setArg('nocache','1'); |
||
| 105 | extract($this->getArgs($argstr, $request)); |
||
| 106 | if (!$alias) |
||
| 107 | return $this->error(_("No DSN alias for SqlResult.ini specified")); |
||
| 108 | $sql = $this->_sql; |
||
| 109 | |||
| 110 | // apply custom filters |
||
| 111 | if ($where and strstr($sql, "%%where%%")) |
||
| 112 | $sql = str_replace("%%where%%", $where, $sql); |
||
| 113 | // TODO: use a SQL construction library? |
||
| 114 | if ($limit) { |
||
| 115 | $pagelist = new PageList(); |
||
| 116 | $limit = $pagelist->limit($limit); |
||
| 117 | if (strstr($sql, "%%limit%%")) |
||
| 118 | $sql = str_replace("%%limit%%", $limit, $sql); |
||
| 119 | else { |
||
| 120 | if (strstr($sql, "LIMIT")) |
||
| 121 | $sql = preg_replace("/LIMIT\s+[\d,]+\s+/m", "LIMIT ".$limit." ", $sql); |
||
| 122 | } |
||
| 123 | } |
||
| 124 | if (strstr($sql, "%%sortby%%")) { |
||
| 125 | if (!$sortby) |
||
| 126 | $sql = preg_replace("/ORDER BY .*%%sortby%%\s/m", "", $sql); |
||
| 127 | else |
||
| 128 | $sql = str_replace("%%sortby%%", $sortby, $sql); |
||
| 129 | } elseif (PageList::sortby($sortby,'db')) { // add sorting: support paging sortby links |
||
| 130 | if (preg_match("/\sORDER\s/",$sql)) |
||
| 131 | $sql = preg_replace("/ORDER BY\s\S+\s/m", "ORDER BY " . PageList::sortby($sortby,'db'), $sql); |
||
| 132 | else |
||
| 133 | $sql .= " ORDER BY " . PageList::sortby($sortby,'db'); |
||
| 134 | } |
||
| 135 | |||
| 136 | $inidsn = $this->getDsn($alias); |
||
| 137 | if (!$inidsn) |
||
| 138 | return $this->error(sprintf(_("No DSN for alias %s in SqlResult.ini found"), |
||
| 139 | $alias)); |
||
| 140 | // adodb or pear? adodb as default, since we distribute per default it. |
||
| 141 | // for pear there may be overrides. |
||
| 142 | // TODO: native PDO support (for now we use ADODB) |
||
| 143 | if ($DBParams['dbtype'] == 'SQL') { |
||
| 144 | $dbh = DB::connect($inidsn); |
||
| 145 | $all = $dbh->getAll($sql); |
||
| 146 | if (DB::isError($all)) { |
||
| 147 | return $this->error($all->getMessage(). ' ' . $all->userinfo); |
||
| 148 | } |
||
| 149 | } else { // unless PearDB use the included ADODB, regardless if dba, file or PDO, ... |
||
| 150 | if ($DBParams['dbtype'] != 'ADODB') { |
||
| 151 | // require_once('lib/WikiDB/adodb/adodb-errorhandler.inc.php'); |
||
| 152 | require_once('lib/WikiDB/adodb/adodb.inc.php'); |
||
| 153 | } |
||
| 154 | $parsed = parseDSN($inidsn); |
||
| 155 | $dbh = &ADONewConnection($parsed['phptype']); |
||
| 156 | $conn = $dbh->Connect($parsed['hostspec'],$parsed['username'], |
||
| 157 | $parsed['password'], $parsed['database']); |
||
| 158 | if (!$conn) |
||
| 159 | return $this->error($dbh->errorMsg()); |
||
| 160 | $GLOBALS['ADODB_FETCH_MODE'] = ADODB_FETCH_ASSOC; |
||
| 161 | $dbh->SetFetchMode(ADODB_FETCH_ASSOC); |
||
| 162 | |||
| 163 | $all = $dbh->getAll($sql); |
||
| 164 | |||
| 165 | $GLOBALS['ADODB_FETCH_MODE'] = ADODB_FETCH_NUM; |
||
| 166 | $dbh->SetFetchMode(ADODB_FETCH_NUM); |
||
| 167 | if (!$all) |
||
| 168 | return $this->error($dbh->errorMsg()); |
||
| 169 | } |
||
| 170 | $args = array(); |
||
| 171 | if ($limit) { // fill paging vars (see PageList) |
||
| 172 | $args = $pagelist->pagingTokens(count($all), count($all[0]), $limit); |
||
| 173 | if (!$args) $args = array(); |
||
| 174 | } |
||
| 175 | |||
| 176 | if ($template) { |
||
| 177 | $args = array_merge( |
||
| 178 | array('SqlResult' => $all, // the resulting array of rows |
||
| 179 | 'ordered' => $ordered, // whether to display as <ul>/<dt> or <ol> |
||
| 180 | 'where' => $where, |
||
| 181 | 'sortby' => $sortby, |
||
| 182 | 'limit' => $limit), |
||
| 183 | $args); // paging params override given params |
||
| 184 | return Template($template, $args); |
||
| 185 | } else { |
||
| 186 | if ($ordered) { |
||
| 187 | $html = HTML::ol(array('class'=>'sqlresult')); |
||
| 188 | if ($all) |
||
| 189 | foreach ($all as $row) { |
||
| 190 | $html->pushContent(HTML::li(array('class'=> $i++ % 2 ? 'evenrow' : 'oddrow'), $row[0])); |
||
| 191 | } |
||
| 192 | } else { |
||
| 193 | $html = HTML::table(array('class'=>'sqlresult')); |
||
| 194 | $i = 0; |
||
| 195 | if ($all) |
||
| 196 | foreach ($all as $row) { |
||
| 197 | $tr = HTML::tr(array('class'=> $i++ % 2 ? 'evenrow' : 'oddrow')); |
||
| 198 | if ($row) |
||
| 199 | foreach ($row as $col) { |
||
| 200 | $tr->pushContent(HTML::td($col)); |
||
| 201 | } |
||
| 202 | $html->pushContent($tr); |
||
| 203 | } |
||
| 204 | } |
||
| 205 | } |
||
| 206 | // do paging via pagelink template |
||
| 207 | if (!empty($args['NUMPAGES'])) { |
||
| 208 | $paging = Template("pagelink", $args); |
||
| 209 | $html = $table->pushContent(HTML::thead($paging), |
||
| 210 | HTML::tbody($html), |
||
| 211 | HTML::tfoot($paging)); |
||
| 212 | } |
||
| 213 | if (0 and DEBUG) { // test deferred error/warning/notice collapsing |
||
| 214 | trigger_error("test notice", E_USER_NOTICE); |
||
| 215 | trigger_error("test warning", E_USER_WARNING); |
||
| 216 | } |
||
| 217 | |||
| 218 | return $html; |
||
| 219 | } |
||
| 220 | |||
| 259 | ?> |
Loading history...
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_functionexpects aPostobject, and outputs the author of the post. The base classPostreturns a simple string and outputting a simple string will work just fine. However, the child classBlogPostwhich is a sub-type ofPostinstead decided to return anobject, and is therefore violating the SOLID principles. If aBlogPostwere passed tomy_function, PHP would not complain, but ultimately fail when executing thestrtouppercall in its body.