cilogon /
service-lib
| Conditions | 11 |
| Paths | 97 |
| Total Lines | 76 |
| Code Lines | 41 |
| Lines | 0 |
| Ratio | 0 % |
| Tests | 0 |
| CRAP Score | 132 |
| Changes | 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:
Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.
There are several approaches to avoid long parameter lists:
| 1 | <?php |
||
| 45 | public static function getMyProxyCredential( |
||
| 46 | $username, |
||
| 47 | $passphrase = '', |
||
| 48 | $server = MYPROXY_HOST, |
||
| 49 | $port = MYPROXY_PORT, |
||
| 50 | $lifetime = MYPROXY_LIFETIME, |
||
| 51 | $usercert = '', |
||
| 52 | $userkey = '', |
||
| 53 | $certreq = '', |
||
| 54 | $env = '' |
||
| 55 | ) { |
||
| 56 | $retstr = ''; |
||
| 57 | |||
| 58 | // Make sure the username passed in is not empty |
||
| 59 | if (strlen($username) == 0) { |
||
| 60 | Util::sendErrorAlert( |
||
| 61 | 'getMyProxyCredential Error', |
||
| 62 | 'MyProxy Error = Missing MyProxy username' |
||
| 63 | ); |
||
| 64 | return $retstr; |
||
| 65 | } |
||
| 66 | |||
| 67 | // Don't allow weird port numbers, i.e. negative or over 65535 |
||
| 68 | if (($port < 0) || ($port > 65535)) { |
||
| 69 | $port = MYPROXY_PORT; |
||
| 70 | } |
||
| 71 | |||
| 72 | // Don't allow weird lifetimes, i.e. negative or over 5 years |
||
| 73 | if (($lifetime < 0) || ($lifetime > 43800)) { |
||
| 74 | $lifetime = MYPROXY_LIFETIME; |
||
| 75 | } |
||
| 76 | |||
| 77 | // If the usercert (X509_USER_CERT) is specified, check to see if |
||
| 78 | // the userkey (X509_USER_KEY) was as well. If not, set userkey to |
||
| 79 | // usercert, in effect making usercert act like X509_USER_PROXY. Then, |
||
| 80 | // set the USER_CERT_ENV variable to bundle the two parameters into a |
||
| 81 | // single variable holding the two X509_USER_* environment variables. |
||
| 82 | $USER_CERT_ENV = ''; |
||
| 83 | if (strlen($usercert) > 0) { |
||
| 84 | if (strlen($userkey) == 0) { |
||
| 85 | $userkey = $usercert; |
||
| 86 | } |
||
| 87 | $USER_CERT_ENV = 'X509_USER_CERT=' . escapeshellarg($usercert) . |
||
| 88 | ' ' . |
||
| 89 | 'X509_USER_KEY=' . escapeshellarg($userkey); |
||
| 90 | } |
||
| 91 | |||
| 92 | // Run the myproxy-logon command and capture the output and any error |
||
| 93 | unset($output); |
||
|
Comprehensibility
Best Practice
introduced
by
|
|||
| 94 | $cmd = '/bin/env ' . |
||
| 95 | $USER_CERT_ENV . ' ' . |
||
| 96 | $env . ' ' . |
||
| 97 | 'MYPROXY_SOCKET_TIMEOUT=1 ' . |
||
| 98 | MYPROXY_LOGON . ' ' . |
||
| 99 | ' -s ' . escapeshellarg($server) . |
||
| 100 | " -p $port" . |
||
| 101 | " -t $lifetime" . |
||
| 102 | ' -l ' . escapeshellarg($username) . |
||
| 103 | ' -S -o -' . |
||
| 104 | ((strlen($certreq) > 0) ? |
||
| 105 | (' --certreq - <<< ' . escapeshellarg($certreq)) : '') . |
||
| 106 | ((strlen($passphrase) > 0) ? |
||
| 107 | (' <<< ' . escapeshellarg($passphrase)) : ' -n') . |
||
| 108 | ' 2>&1'; |
||
| 109 | exec($cmd, $output, $return_val); |
||
| 110 | $retstr = implode("\n", $output); |
||
| 111 | |||
| 112 | if ($return_val > 0) { |
||
| 113 | Util::sendErrorAlert( |
||
| 114 | 'getMyProxyCredential Error', |
||
| 115 | "MyProxy Error = $return_val\nMyProxy Output= $retstr" |
||
| 116 | ); |
||
| 117 | $retstr = ''; |
||
| 118 | } |
||
| 119 | |||
| 120 | return $retstr; |
||
| 121 | } |
||
| 137 |
Loading history...