@@ -228,6 +228,9 @@ discard block |
||
228 | 228 | Purpose: set MAGPIE_ERROR, and trigger error |
229 | 229 | \*=======================================================================*/ |
230 | 230 | |
231 | +/** |
|
232 | + * @param integer $lvl |
|
233 | + */ |
|
231 | 234 | function error ($errormsg, $lvl=E_USER_WARNING) { |
232 | 235 | global $MAGPIE_ERROR; |
233 | 236 | |
@@ -242,6 +245,9 @@ discard block |
||
242 | 245 | } |
243 | 246 | } |
244 | 247 | |
248 | +/** |
|
249 | + * @param integer $lvl |
|
250 | + */ |
|
245 | 251 | function debug ($debugmsg, $lvl=E_USER_NOTICE) { |
246 | 252 | trigger_error("MagpieRSS [debug] $debugmsg", $lvl); |
247 | 253 | } |
@@ -288,6 +294,9 @@ discard block |
||
288 | 294 | Input: an HTTP response object (see Snoopy) |
289 | 295 | Output: parsed RSS object (see rss_parse) |
290 | 296 | \*=======================================================================*/ |
297 | +/** |
|
298 | + * @param Snoopy $resp |
|
299 | + */ |
|
291 | 300 | function _response_to_rss ($resp) { |
292 | 301 | $rss = new MagpieRSS( $resp->results, MAGPIE_OUTPUT_ENCODING, MAGPIE_INPUT_ENCODING, MAGPIE_DETECT_ENCODING ); |
293 | 302 |
@@ -449,6 +449,10 @@ discard block |
||
449 | 449 | /** |
450 | 450 | * return XML parser, and possibly re-encoded source |
451 | 451 | * |
452 | + * @param string $source |
|
453 | + * @param string $out_enc |
|
454 | + * @param string|null $in_enc |
|
455 | + * @param boolean $detect |
|
452 | 456 | */ |
453 | 457 | public function create_parser($source, $out_enc, $in_enc, $detect) { |
454 | 458 | if ( substr(phpversion(),0,1) == 5) { |
@@ -558,6 +562,9 @@ discard block |
||
558 | 562 | } |
559 | 563 | } |
560 | 564 | |
565 | + /** |
|
566 | + * @param integer $lvl |
|
567 | + */ |
|
561 | 568 | public function error ($errormsg, $lvl=E_USER_WARNING) { |
562 | 569 | // append PHP's error message if track_errors enabled |
563 | 570 | if ( isset($php_errormsg) ) { |
@@ -593,6 +600,9 @@ discard block |
||
593 | 600 | define("CASE_LOWER",0); |
594 | 601 | |
595 | 602 | |
603 | + /** |
|
604 | + * @param integer $case |
|
605 | + */ |
|
596 | 606 | function array_change_key_case($array,$case=CASE_LOWER) { |
597 | 607 | if ($case=CASE_LOWER) $cmd=strtolower; |
598 | 608 | elseif ($case=CASE_UPPER) $cmd=strtoupper; |
@@ -23,6 +23,9 @@ |
||
23 | 23 | //echo $data[ROOT_START_BLOCK_POS]; |
24 | 24 | //function log |
25 | 25 | |
26 | +/** |
|
27 | + * @param integer $pos |
|
28 | + */ |
|
26 | 29 | function GetInt4d($data, $pos) |
27 | 30 | { |
28 | 31 | $value = ord($data[$pos]) | (ord($data[$pos+1]) << 8) | (ord($data[$pos+2]) << 16) | (ord($data[$pos+3]) << 24); |
@@ -137,7 +137,7 @@ discard block |
||
137 | 137 | * @author Kjell-Inge Gustafsson <[email protected]> |
138 | 138 | * @since 2.4.8 - 2008-10-21 |
139 | 139 | * @param string $value |
140 | - * @return void |
|
140 | + * @return false|null |
|
141 | 141 | */ |
142 | 142 | function setCalscale( $value ) { |
143 | 143 | if( empty( $value )) return FALSE; |
@@ -273,7 +273,7 @@ discard block |
||
273 | 273 | * @author Kjell-Inge Gustafsson <[email protected]> |
274 | 274 | * @since 2.4.8 - 2008-10-23 |
275 | 275 | * @param string $value |
276 | - * @return void |
|
276 | + * @return boolean |
|
277 | 277 | */ |
278 | 278 | function setVersion( $value ) { |
279 | 279 | if( empty( $value )) return FALSE; |
@@ -397,7 +397,7 @@ discard block |
||
397 | 397 | * @since 2.5.1 - 2008-11-02 |
398 | 398 | * @param string $propName, optional |
399 | 399 | * @param int @propix, optional, if specific property is wanted in case of multiply occurences |
400 | - * @param bool $inclParam=FALSE |
|
400 | + * @param bool $inclParam |
|
401 | 401 | * @return mixed |
402 | 402 | */ |
403 | 403 | function getProperty( $propName=FALSE, $propix=FALSE, $inclParam=FALSE ) { |
@@ -448,9 +448,6 @@ discard block |
||
448 | 448 | * |
449 | 449 | * @author Kjell-Inge Gustafsson <[email protected]> |
450 | 450 | * @since 2.2.13 - 2007-11-04 |
451 | - * @param mixed $args variable number of function arguments, |
|
452 | - * first argument is ALWAYS component name, |
|
453 | - * second ALWAYS component value! |
|
454 | 451 | * @return bool |
455 | 452 | */ |
456 | 453 | function setProperty () { |
@@ -480,7 +477,7 @@ discard block |
||
480 | 477 | * @author Kjell-Inge Gustafsson <[email protected]> |
481 | 478 | * @since 2.4.10 - 2008-10-23 |
482 | 479 | * @param string $config |
483 | - * @return value |
|
480 | + * @return string |
|
484 | 481 | */ |
485 | 482 | function getConfig( $config ) { |
486 | 483 | switch( strtoupper( $config )) { |
@@ -701,7 +698,7 @@ discard block |
||
701 | 698 | * @since 2.4.10 - 2008-08-05 |
702 | 699 | * @param mixed $arg1 ordno / component type / component uid |
703 | 700 | * @param mixed $arg2 optional, ordno if arg1 = component type |
704 | - * @return void |
|
701 | + * @return boolean |
|
705 | 702 | */ |
706 | 703 | function deleteComponent( $arg1, $arg2=FALSE ) { |
707 | 704 | $argType = $index = null; |
@@ -1060,7 +1057,7 @@ discard block |
||
1060 | 1057 | * @param object $component calendar component |
1061 | 1058 | * @param mixed $arg1 optional, ordno/component type/ component uid |
1062 | 1059 | * @param mixed $arg2 optional, ordno if arg1 = component type |
1063 | - * @return void |
|
1060 | + * @return boolean |
|
1064 | 1061 | */ |
1065 | 1062 | function setComponent( $component, $arg1=FALSE, $arg2=FALSE ) { |
1066 | 1063 | if( '' >= $component->getConfig( 'language')) |
@@ -2311,7 +2308,7 @@ discard block |
||
2311 | 2308 | * @param int $min optional |
2312 | 2309 | * @param int $sec optional |
2313 | 2310 | * @param array $params optional |
2314 | - * @return TRUE |
|
2311 | + * @return boolean |
|
2315 | 2312 | */ |
2316 | 2313 | function setDtstamp( $year, $month=FALSE, $day=FALSE, $hour=FALSE, $min=FALSE, $sec=FALSE, $params=FALSE ) { |
2317 | 2314 | if( empty( $year )) |
@@ -2794,7 +2791,7 @@ discard block |
||
2794 | 2791 | * @param int $min optional |
2795 | 2792 | * @param int $sec optional |
2796 | 2793 | * @param array $params optional |
2797 | - * @return boll |
|
2794 | + * @return boolean |
|
2798 | 2795 | */ |
2799 | 2796 | function setLastModified( $year=FALSE, $month=FALSE, $day=FALSE, $hour=FALSE, $min=FALSE, $sec=FALSE, $params=FALSE ) { |
2800 | 2797 | if( empty( $year )) |
@@ -3215,7 +3212,6 @@ discard block |
||
3215 | 3212 | * |
3216 | 3213 | * @author Kjell-Inge Gustafsson <[email protected]> |
3217 | 3214 | * @since 2.5.1 - 2008-11-07 |
3218 | - * @param float $relid |
|
3219 | 3215 | * @param array $params, optional |
3220 | 3216 | * @param index $index, optional |
3221 | 3217 | * @return bool |
@@ -3253,7 +3249,7 @@ discard block |
||
3253 | 3249 | * @since 2.4.8 - 2008-11-04 |
3254 | 3250 | * @param string $value |
3255 | 3251 | * @param array $params optional |
3256 | - * @return void |
|
3252 | + * @return boolean |
|
3257 | 3253 | */ |
3258 | 3254 | function setRepeat( $value, $params=FALSE ) { |
3259 | 3255 | if( empty( $value )) if( $this->getConfig( 'allowEmpty' )) $value = null; else return FALSE; |
@@ -3376,7 +3372,7 @@ discard block |
||
3376 | 3372 | * @param array $rruleset |
3377 | 3373 | * @param array $params, optional |
3378 | 3374 | * @param integer $index, optional |
3379 | - * @return void |
|
3375 | + * @return boolean |
|
3380 | 3376 | */ |
3381 | 3377 | function setRrule( $rruleset, $params=FALSE, $index=FALSE ) { |
3382 | 3378 | if( empty( $rruleset )) if( $this->getConfig( 'allowEmpty' )) $rruleset = null; else return FALSE; |
@@ -3802,7 +3798,7 @@ discard block |
||
3802 | 3798 | * @since 2.4.8 - 2008-11-04 |
3803 | 3799 | * @param string $value |
3804 | 3800 | * @param string $params optional |
3805 | - * @return boll |
|
3801 | + * @return boolean |
|
3806 | 3802 | */ |
3807 | 3803 | function setTzurl( $value, $params=FALSE ) { |
3808 | 3804 | if( empty( $value )) if( $this->getConfig( 'allowEmpty' )) $value = null; else return FALSE; |
@@ -3931,7 +3927,7 @@ discard block |
||
3931 | 3927 | * @param string $label |
3932 | 3928 | * @param mixed $value |
3933 | 3929 | * @param array $params optional |
3934 | - * @return bool |
|
3930 | + * @return null|boolean |
|
3935 | 3931 | */ |
3936 | 3932 | function setXprop( $label, $value, $params=FALSE ) { |
3937 | 3933 | if( empty( $label )) return; |
@@ -4098,7 +4094,7 @@ discard block |
||
4098 | 4094 | * @author Kjell-Inge Gustafsson <[email protected]> |
4099 | 4095 | * @since 0.9.22 - 2007-04-10 |
4100 | 4096 | * @param array $params optional |
4101 | - * @param array $ctrKeys optional |
|
4097 | + * @param string[] $ctrKeys optional |
|
4102 | 4098 | * @return string |
4103 | 4099 | */ |
4104 | 4100 | function _createParams( $params=array(), $ctrKeys=array() ) { |
@@ -4140,7 +4136,6 @@ discard block |
||
4140 | 4136 | * |
4141 | 4137 | * @author Kjell-Inge Gustafsson <[email protected]> |
4142 | 4138 | * @since 2.4.16 - 2008-10-25 |
4143 | - * @param array $date, date to check |
|
4144 | 4139 | * @param int $parno, no of date parts (i.e. year, month.. .) |
4145 | 4140 | * @return array $params, property parameters |
4146 | 4141 | */ |
@@ -4196,7 +4191,6 @@ discard block |
||
4196 | 4191 | * @author Kjell-Inge Gustafsson <[email protected]> |
4197 | 4192 | * @since 2.2.11 - 2007-11-03 |
4198 | 4193 | * @param array $startdate, optional |
4199 | - * @param array $duration, optional |
|
4200 | 4194 | * @return array duration |
4201 | 4195 | */ |
4202 | 4196 | function _date2duration( $startdate=FALSE, $enddate=FALSE ) { |
@@ -4230,7 +4224,7 @@ discard block |
||
4230 | 4224 | * @since 2.4.8 - 2008-10-30 |
4231 | 4225 | * @param array $datetime datetime/(date) |
4232 | 4226 | * @param string $tz timezone |
4233 | - * @return timestamp |
|
4227 | + * @return integer |
|
4234 | 4228 | */ |
4235 | 4229 | function _date2timestamp( $datetime, $tz=null ) { |
4236 | 4230 | $output = null; |
@@ -4580,6 +4574,7 @@ discard block |
||
4580 | 4574 | * @param int $hitVal optional, return value if found |
4581 | 4575 | * @param int $elseVal optional, return value if not found |
4582 | 4576 | * @param int $preSet optional, return value if already preset |
4577 | + * @param string $expkey |
|
4583 | 4578 | * @return int |
4584 | 4579 | */ |
4585 | 4580 | function _existRem( &$array, $expkey, $expval=FALSE, $hitVal=null, $elseVal=null, $preSet=null ) { |
@@ -4689,7 +4684,7 @@ discard block |
||
4689 | 4684 | * |
4690 | 4685 | * @author Kjell-Inge Gustafsson <[email protected]> |
4691 | 4686 | * @since 2.4.8 - 2008-10-22 |
4692 | - * @param array $recurlabel |
|
4687 | + * @param string $recurlabel |
|
4693 | 4688 | * @param array $recurdata |
4694 | 4689 | * @return string |
4695 | 4690 | */ |
@@ -5229,6 +5224,10 @@ discard block |
||
5229 | 5224 | else |
5230 | 5225 | return FALSE; |
5231 | 5226 | } |
5227 | + |
|
5228 | + /** |
|
5229 | + * @param integer $wkst |
|
5230 | + */ |
|
5232 | 5231 | function _recurIntervalIx( $freq, $date, $wkst ) { |
5233 | 5232 | /* create interval index */ |
5234 | 5233 | switch( $freq ) { |
@@ -5537,7 +5536,6 @@ discard block |
||
5537 | 5536 | * |
5538 | 5537 | * @author Kjell-Inge Gustafsson <[email protected]> |
5539 | 5538 | * @since 2.4.16 - 2008-10-19 |
5540 | - * @param string $offset |
|
5541 | 5539 | * @return integer |
5542 | 5540 | */ |
5543 | 5541 | function _tz2offset( $tz ) { |
@@ -5999,8 +5997,8 @@ discard block |
||
5999 | 5997 | * @since 2.5.1 - 2008-11-02 |
6000 | 5998 | * @param string $propName, optional |
6001 | 5999 | * @param int @propix, optional, if specific property is wanted in case of multiply occurences |
6002 | - * @param bool $inclParam=FALSE |
|
6003 | - * @param bool $specform=FALSE |
|
6000 | + * @param bool $inclParam |
|
6001 | + * @param bool $specform |
|
6004 | 6002 | * @return mixed |
6005 | 6003 | */ |
6006 | 6004 | function getProperty( $propName=FALSE, $propix=FALSE, $inclParam=FALSE, $specform=FALSE ) { |
@@ -6193,9 +6191,6 @@ discard block |
||
6193 | 6191 | * |
6194 | 6192 | * @author Kjell-Inge Gustafsson <[email protected]> |
6195 | 6193 | * @since 2.5.1 - 2008-11-05 |
6196 | - * @param mixed $args variable number of function arguments, |
|
6197 | - * first argument is ALWAYS component name, |
|
6198 | - * second ALWAYS component value! |
|
6199 | 6194 | * @return void |
6200 | 6195 | */ |
6201 | 6196 | function setProperty() { |
@@ -6309,7 +6304,7 @@ discard block |
||
6309 | 6304 | * @author Kjell-Inge Gustafsson <[email protected]> |
6310 | 6305 | * @since 2.5.2 - 2008-10-23 |
6311 | 6306 | * @param mixed $unparsedtext, optional, strict rfc2445 formatted, single property string or array of property strings |
6312 | - * @return bool FALSE if error occurs during parsing |
|
6307 | + * @return boolean|null FALSE if error occurs during parsing |
|
6313 | 6308 | * |
6314 | 6309 | */ |
6315 | 6310 | function parse( $unparsedtext=null ) { |
@@ -6611,7 +6606,7 @@ discard block |
||
6611 | 6606 | * @since 2.5.1 - 2008-10-15 |
6612 | 6607 | * @param mixed $arg1 ordno / component type / component uid |
6613 | 6608 | * @param mixed $arg2 optional, ordno if arg1 = component type |
6614 | - * @return void |
|
6609 | + * @return boolean |
|
6615 | 6610 | */ |
6616 | 6611 | function deleteComponent( $arg1, $arg2=FALSE ) { |
6617 | 6612 | if( !isset( $this->components )) return FALSE; |
@@ -6814,7 +6809,7 @@ discard block |
||
6814 | 6809 | * |
6815 | 6810 | * @author Kjell-Inge Gustafsson <[email protected]> |
6816 | 6811 | * @since 2.2.8 - 2006-09-03 |
6817 | - * @param string $value |
|
6812 | + * @param string $string |
|
6818 | 6813 | * @return string |
6819 | 6814 | */ |
6820 | 6815 | function _size75( $string ) { |
@@ -10,7 +10,7 @@ |
||
10 | 10 | require_once api_get_path(SYS_PATH) . 'main/auth/external_login/functions.inc.php'; |
11 | 11 | |
12 | 12 | /** |
13 | - * @return true if cas is configured |
|
13 | + * @return boolean if cas is configured |
|
14 | 14 | * |
15 | 15 | **/ |
16 | 16 | function cas_configured() |
@@ -523,7 +523,7 @@ discard block |
||
523 | 523 | /** |
524 | 524 | * Logs a string in debug mode. |
525 | 525 | * |
526 | - * @param $str the string to write |
|
526 | + * @param string $str the string to write |
|
527 | 527 | * |
528 | 528 | * @private |
529 | 529 | */ |
@@ -545,7 +545,7 @@ discard block |
||
545 | 545 | * This method is used by interface methods to print an error and where the function |
546 | 546 | * was originally called from. |
547 | 547 | * |
548 | - * @param $msg the message to print |
|
548 | + * @param string $msg the message to print |
|
549 | 549 | * |
550 | 550 | * @private |
551 | 551 | */ |
@@ -678,7 +678,7 @@ discard block |
||
678 | 678 | /** |
679 | 679 | * This method returns the phpCAS version. |
680 | 680 | * |
681 | - * @return the phpCAS version. |
|
681 | + * @return string phpCAS version. |
|
682 | 682 | */ |
683 | 683 | function getVersion() |
684 | 684 | { |
@@ -1105,7 +1105,7 @@ discard block |
||
1105 | 1105 | * @warning should not be called only after phpCAS::forceAuthentication() |
1106 | 1106 | * or phpCAS::checkAuthentication(). |
1107 | 1107 | * |
1108 | - * @return the login name of the authenticated user |
|
1108 | + * @return string login name of the authenticated user |
|
1109 | 1109 | */ |
1110 | 1110 | function getUser() |
1111 | 1111 | { |
@@ -73,7 +73,7 @@ discard block |
||
73 | 73 | * |
74 | 74 | * Used by CASClient::PrintHTMLHeader() and CASClient::printHTMLFooter(). |
75 | 75 | * |
76 | - * @param $str the string to filter and output |
|
76 | + * @param string $str the string to filter and output |
|
77 | 77 | * |
78 | 78 | * @private |
79 | 79 | */ |
@@ -185,7 +185,7 @@ discard block |
||
185 | 185 | /** |
186 | 186 | * This method returns the language used by phpCAS. |
187 | 187 | * |
188 | - * @return a string representing the language |
|
188 | + * @return string string representing the language |
|
189 | 189 | * |
190 | 190 | * @private |
191 | 191 | */ |
@@ -211,7 +211,7 @@ discard block |
||
211 | 211 | /** |
212 | 212 | * This method returns a string depending on the language. |
213 | 213 | * |
214 | - * @param $str the index of the string in $_string. |
|
214 | + * @param integer $str the index of the string in $_string. |
|
215 | 215 | * |
216 | 216 | * @return the string corresponding to $index in $string. |
217 | 217 | * |
@@ -232,7 +232,7 @@ discard block |
||
232 | 232 | * This method is used to set the language used by phpCAS. |
233 | 233 | * @note Can be called only once. |
234 | 234 | * |
235 | - * @param $lang a string representing the language. |
|
235 | + * @param string $lang a string representing the language. |
|
236 | 236 | * |
237 | 237 | * @public |
238 | 238 | * @sa CAS_LANG_FRENCH, CAS_LANG_ENGLISH |
@@ -426,7 +426,7 @@ discard block |
||
426 | 426 | |
427 | 427 | /** |
428 | 428 | * This method is used to retrieve the service validating URL of the CAS server. |
429 | - * @return a URL. |
|
429 | + * @return string URL. |
|
430 | 430 | * @private |
431 | 431 | */ |
432 | 432 | function getServerServiceValidateURL() |
@@ -448,7 +448,7 @@ discard block |
||
448 | 448 | |
449 | 449 | /** |
450 | 450 | * This method is used to retrieve the SAML validating URL of the CAS server. |
451 | - * @return a URL. |
|
451 | + * @return string URL. |
|
452 | 452 | * @private |
453 | 453 | */ |
454 | 454 | function getServerSamlValidateURL() |
@@ -468,7 +468,7 @@ discard block |
||
468 | 468 | |
469 | 469 | /** |
470 | 470 | * This method is used to retrieve the proxy validating URL of the CAS server. |
471 | - * @return a URL. |
|
471 | + * @return string URL. |
|
472 | 472 | * @private |
473 | 473 | */ |
474 | 474 | function getServerProxyValidateURL() |
@@ -549,7 +549,7 @@ discard block |
||
549 | 549 | |
550 | 550 | /** |
551 | 551 | * This method checks to see if the request is secured via HTTPS |
552 | - * @return true if https, false otherwise |
|
552 | + * @return boolean if https, false otherwise |
|
553 | 553 | * @private |
554 | 554 | */ |
555 | 555 | function isHttps() |
@@ -570,7 +570,7 @@ discard block |
||
570 | 570 | * CASClient constructor. |
571 | 571 | * |
572 | 572 | * @param $server_version the version of the CAS server |
573 | - * @param $proxy TRUE if the CAS client is a CAS proxy, FALSE otherwise |
|
573 | + * @param boolean $proxy TRUE if the CAS client is a CAS proxy, FALSE otherwise |
|
574 | 574 | * @param $server_hostname the hostname of the CAS server |
575 | 575 | * @param $server_port the port the CAS server is running on |
576 | 576 | * @param $server_uri the URI the CAS server is responding on |
@@ -778,7 +778,7 @@ discard block |
||
778 | 778 | * @warning should be called only after CASClient::forceAuthentication() or |
779 | 779 | * CASClient::isAuthenticated(), otherwise halt with an error. |
780 | 780 | * |
781 | - * @return the login name of the authenticated user |
|
781 | + * @return string login name of the authenticated user |
|
782 | 782 | */ |
783 | 783 | function getUser() |
784 | 784 | { |
@@ -860,7 +860,7 @@ discard block |
||
860 | 860 | /** |
861 | 861 | * This method is called to be sure that the user is authenticated. When not |
862 | 862 | * authenticated, halt by redirecting to the CAS server; otherwise return TRUE. |
863 | - * @return TRUE when the user is authenticated; otherwise halt. |
|
863 | + * @return boolean when the user is authenticated; otherwise halt. |
|
864 | 864 | * @public |
865 | 865 | */ |
866 | 866 | function forceAuthentication() |
@@ -906,7 +906,7 @@ discard block |
||
906 | 906 | |
907 | 907 | /** |
908 | 908 | * This method is called to check whether the user is authenticated or not. |
909 | - * @return TRUE when the user is authenticated, FALSE otherwise. |
|
909 | + * @return boolean when the user is authenticated, FALSE otherwise. |
|
910 | 910 | * @public |
911 | 911 | */ |
912 | 912 | function checkAuthentication() |
@@ -960,7 +960,7 @@ discard block |
||
960 | 960 | * This method is called to check if the user is authenticated (previously or by |
961 | 961 | * tickets given in the URL). |
962 | 962 | * |
963 | - * @return TRUE when the user is authenticated. Also may redirect to the same URL without the ticket. |
|
963 | + * @return boolean when the user is authenticated. Also may redirect to the same URL without the ticket. |
|
964 | 964 | * |
965 | 965 | * @public |
966 | 966 | */ |
@@ -1026,7 +1026,7 @@ discard block |
||
1026 | 1026 | |
1027 | 1027 | /** |
1028 | 1028 | * This method tells if the current session is authenticated. |
1029 | - * @return true if authenticated based soley on $_SESSION variable |
|
1029 | + * @return boolean if authenticated based soley on $_SESSION variable |
|
1030 | 1030 | * @since 0.4.22 by Brendan Arnold |
1031 | 1031 | */ |
1032 | 1032 | function isSessionAuthenticated() |
@@ -1040,7 +1040,7 @@ discard block |
||
1040 | 1040 | * |
1041 | 1041 | * @note This function switches to callback mode when needed. |
1042 | 1042 | * |
1043 | - * @return TRUE when the user has already been authenticated; FALSE otherwise. |
|
1043 | + * @return boolean when the user has already been authenticated; FALSE otherwise. |
|
1044 | 1044 | * |
1045 | 1045 | * @private |
1046 | 1046 | */ |
@@ -1154,7 +1154,7 @@ discard block |
||
1154 | 1154 | } |
1155 | 1155 | |
1156 | 1156 | /** |
1157 | - * @return true if the current request is a logout request. |
|
1157 | + * @return boolean if the current request is a logout request. |
|
1158 | 1158 | * @private |
1159 | 1159 | */ |
1160 | 1160 | function isLogoutRequest() |
@@ -1270,7 +1270,7 @@ discard block |
||
1270 | 1270 | |
1271 | 1271 | /** |
1272 | 1272 | * This method returns the Service Ticket provided in the URL of the request. |
1273 | - * @return The service ticket. |
|
1273 | + * @return string service ticket. |
|
1274 | 1274 | * @private |
1275 | 1275 | */ |
1276 | 1276 | function getST() |
@@ -1290,7 +1290,7 @@ discard block |
||
1290 | 1290 | |
1291 | 1291 | /** |
1292 | 1292 | * This method tells if a Service Ticket was stored. |
1293 | - * @return TRUE if a Service Ticket has been stored. |
|
1293 | + * @return boolean if a Service Ticket has been stored. |
|
1294 | 1294 | * @private |
1295 | 1295 | */ |
1296 | 1296 | function hasST() |
@@ -1365,7 +1365,7 @@ discard block |
||
1365 | 1365 | * $text_reponse and $tree_response on success. These parameters are used later |
1366 | 1366 | * by CASClient::validatePGT() for CAS proxies. |
1367 | 1367 | * Used for all CAS 1.0 validations |
1368 | - * @param $validate_url the URL of the request to the CAS server. |
|
1368 | + * @param string $validate_url the URL of the request to the CAS server. |
|
1369 | 1369 | * @param $text_response the response of the CAS server, as is (XML text). |
1370 | 1370 | * @param $tree_response the response of the CAS server, as a DOM XML tree. |
1371 | 1371 | * |
@@ -1497,7 +1497,7 @@ discard block |
||
1497 | 1497 | * $text_reponse and $tree_response on success. These parameters are used later |
1498 | 1498 | * by CASClient::validatePGT() for CAS proxies. |
1499 | 1499 | * |
1500 | - * @param $validate_url the URL of the request to the CAS server. |
|
1500 | + * @param string $validate_url the URL of the request to the CAS server. |
|
1501 | 1501 | * @param $text_response the response of the CAS server, as is (XML text). |
1502 | 1502 | * @param $tree_response the response of the CAS server, as a DOM XML tree. |
1503 | 1503 | * |
@@ -1684,7 +1684,7 @@ discard block |
||
1684 | 1684 | |
1685 | 1685 | /** |
1686 | 1686 | * This method returns the Proxy Granting Ticket given by the CAS server. |
1687 | - * @return The Proxy Granting Ticket. |
|
1687 | + * @return string Proxy Granting Ticket. |
|
1688 | 1688 | * @private |
1689 | 1689 | */ |
1690 | 1690 | function getPGT() |
@@ -1704,7 +1704,7 @@ discard block |
||
1704 | 1704 | |
1705 | 1705 | /** |
1706 | 1706 | * This method tells if a Proxy Granting Ticket was stored. |
1707 | - * @return TRUE if a Proxy Granting Ticket has been stored. |
|
1707 | + * @return boolean if a Proxy Granting Ticket has been stored. |
|
1708 | 1708 | * @private |
1709 | 1709 | */ |
1710 | 1710 | function hasPGT() |
@@ -1739,7 +1739,7 @@ discard block |
||
1739 | 1739 | /** |
1740 | 1740 | * This method sets/unsets callback mode. |
1741 | 1741 | * |
1742 | - * @param $callback_mode TRUE to set callback mode, FALSE otherwise. |
|
1742 | + * @param boolean $callback_mode TRUE to set callback mode, FALSE otherwise. |
|
1743 | 1743 | * |
1744 | 1744 | * @private |
1745 | 1745 | */ |
@@ -1752,7 +1752,7 @@ discard block |
||
1752 | 1752 | * This method returns TRUE when the CAs client is running i callback mode, |
1753 | 1753 | * FALSE otherwise. |
1754 | 1754 | * |
1755 | - * @return A boolean. |
|
1755 | + * @return boolean boolean. |
|
1756 | 1756 | * |
1757 | 1757 | * @private |
1758 | 1758 | */ |
@@ -1776,7 +1776,7 @@ discard block |
||
1776 | 1776 | * fact the URL of the current request without any CGI parameter, except if |
1777 | 1777 | * phpCAS::setFixedCallbackURL() was used). |
1778 | 1778 | * |
1779 | - * @return The callback URL |
|
1779 | + * @return string callback URL |
|
1780 | 1780 | * |
1781 | 1781 | * @private |
1782 | 1782 | */ |
@@ -1820,6 +1820,7 @@ discard block |
||
1820 | 1820 | * This method sets the callback url. |
1821 | 1821 | * |
1822 | 1822 | * @param $callback_url url to set callback |
1823 | + * @param string $url |
|
1823 | 1824 | * |
1824 | 1825 | * @private |
1825 | 1826 | */ |
@@ -1904,7 +1905,7 @@ discard block |
||
1904 | 1905 | /** |
1905 | 1906 | * This method reads a PGT from its Iou and deletes the corresponding storage entry. |
1906 | 1907 | * |
1907 | - * @param $pgt_iou the PGT Iou |
|
1908 | + * @param string $pgt_iou the PGT Iou |
|
1908 | 1909 | * |
1909 | 1910 | * @return The PGT corresponding to the Iou, FALSE when not found. |
1910 | 1911 | * |
@@ -2037,7 +2038,7 @@ discard block |
||
2037 | 2038 | * @param $err_code an error code (PHPCAS_SERVICE_OK on success). |
2038 | 2039 | * @param $err_msg an error message (empty on success). |
2039 | 2040 | * |
2040 | - * @return a Proxy Ticket, or FALSE on error. |
|
2041 | + * @return false|string Proxy Ticket, or FALSE on error. |
|
2041 | 2042 | * |
2042 | 2043 | * @private |
2043 | 2044 | */ |
@@ -2140,14 +2141,14 @@ discard block |
||
2140 | 2141 | /** |
2141 | 2142 | * This method is used to acces a remote URL. |
2142 | 2143 | * |
2143 | - * @param $url the URL to access. |
|
2144 | + * @param string $url the URL to access. |
|
2144 | 2145 | * @param $cookies an array containing cookies strings such as 'name=val' |
2145 | 2146 | * @param $headers an array containing the HTTP header lines of the response |
2146 | 2147 | * (an empty array on failure). |
2147 | 2148 | * @param $body the body of the response, as a string (empty on failure). |
2148 | 2149 | * @param $err_msg an error message, filled on failure. |
2149 | 2150 | * |
2150 | - * @return TRUE on success, FALSE otherwise (in this later case, $err_msg |
|
2151 | + * @return boolean on success, FALSE otherwise (in this later case, $err_msg |
|
2151 | 2152 | * contains an error message). |
2152 | 2153 | * |
2153 | 2154 | * @private |
@@ -2250,7 +2251,7 @@ discard block |
||
2250 | 2251 | /** |
2251 | 2252 | * This method is used to build the SAML POST body sent to /samlValidate URL. |
2252 | 2253 | * |
2253 | - * @return the SOAP-encased SAMLP artifact (the ticket). |
|
2254 | + * @return string SOAP-encased SAMLP artifact (the ticket). |
|
2254 | 2255 | * |
2255 | 2256 | * @private |
2256 | 2257 | */ |
@@ -2289,7 +2290,7 @@ discard block |
||
2289 | 2290 | * @param $output the output of the service (also used to give an error |
2290 | 2291 | * message on failure). |
2291 | 2292 | * |
2292 | - * @return TRUE on success, FALSE otherwise (in this later case, $err_code |
|
2293 | + * @return boolean on success, FALSE otherwise (in this later case, $err_code |
|
2293 | 2294 | * gives the reason why it failed and $output contains an error message). |
2294 | 2295 | * |
2295 | 2296 | * @public |
@@ -2436,7 +2437,7 @@ discard block |
||
2436 | 2437 | |
2437 | 2438 | /** |
2438 | 2439 | * This method returns the Proxy Ticket provided in the URL of the request. |
2439 | - * @return The proxy ticket. |
|
2440 | + * @return string proxy ticket. |
|
2440 | 2441 | * @private |
2441 | 2442 | */ |
2442 | 2443 | function getPT() |
@@ -2457,7 +2458,7 @@ discard block |
||
2457 | 2458 | |
2458 | 2459 | /** |
2459 | 2460 | * This method tells if a Proxy Ticket was stored. |
2460 | - * @return TRUE if a Proxy Ticket has been stored. |
|
2461 | + * @return boolean if a Proxy Ticket has been stored. |
|
2461 | 2462 | * @private |
2462 | 2463 | */ |
2463 | 2464 | function hasPT() |
@@ -2467,7 +2468,7 @@ discard block |
||
2467 | 2468 | |
2468 | 2469 | /** |
2469 | 2470 | * This method returns the SAML Ticket provided in the URL of the request. |
2470 | - * @return The SAML ticket. |
|
2471 | + * @return string SAML ticket. |
|
2471 | 2472 | * @private |
2472 | 2473 | */ |
2473 | 2474 | function getSA() |
@@ -2487,7 +2488,7 @@ discard block |
||
2487 | 2488 | |
2488 | 2489 | /** |
2489 | 2490 | * This method tells if a SAML Ticket was stored. |
2490 | - * @return TRUE if a SAML Ticket has been stored. |
|
2491 | + * @return boolean if a SAML Ticket has been stored. |
|
2491 | 2492 | * @private |
2492 | 2493 | */ |
2493 | 2494 | function hasSA() |
@@ -2507,6 +2508,7 @@ discard block |
||
2507 | 2508 | /** |
2508 | 2509 | * This method is used to validate a ST or PT; halt on failure |
2509 | 2510 | * Used for all CAS 2.0 validations |
2511 | + * @param string $validate_url |
|
2510 | 2512 | * @return bool TRUE when successfull, halt otherwise by calling CASClient::authError(). |
2511 | 2513 | * |
2512 | 2514 | * @private |
@@ -2623,7 +2625,7 @@ discard block |
||
2623 | 2625 | * This method returns the URL of the current request (without any ticket |
2624 | 2626 | * CGI parameter). |
2625 | 2627 | * |
2626 | - * @return The URL |
|
2628 | + * @return string URL |
|
2627 | 2629 | * |
2628 | 2630 | * @private |
2629 | 2631 | */ |
@@ -2701,7 +2703,7 @@ discard block |
||
2701 | 2703 | /** |
2702 | 2704 | * This method sets the URL of the current request |
2703 | 2705 | * |
2704 | - * @param $url url to set for service |
|
2706 | + * @param string $url url to set for service |
|
2705 | 2707 | * |
2706 | 2708 | * @private |
2707 | 2709 | */ |
@@ -2716,9 +2718,9 @@ discard block |
||
2716 | 2718 | /** |
2717 | 2719 | * This method is used to print the HTML output when the user was not authenticated. |
2718 | 2720 | * |
2719 | - * @param $failure the failure that occured |
|
2721 | + * @param string $failure the failure that occured |
|
2720 | 2722 | * @param $cas_url the URL the CAS server was asked for |
2721 | - * @param $no_response the response from the CAS server (other |
|
2723 | + * @param boolean $no_response the response from the CAS server (other |
|
2722 | 2724 | * parameters are ignored if TRUE) |
2723 | 2725 | * @param $bad_response bad response from the CAS server ($err_code |
2724 | 2726 | * and $err_msg ignored if TRUE) |
@@ -811,6 +811,9 @@ discard block |
||
811 | 811 | $this->myDOMXPath = new DOMXPath($this->myOwnerDocument->myDOMNode); |
812 | 812 | } |
813 | 813 | |
814 | + /** |
|
815 | + * @param string $eval_str |
|
816 | + */ |
|
814 | 817 | function xpath_eval($eval_str, $contextnode = null) |
815 | 818 | { |
816 | 819 | if (method_exists($this->myDOMXPath, 'evaluate')) { |
@@ -824,6 +827,10 @@ discard block |
||
824 | 827 | return ($xp->type === XPATH_UNDEFINED) ? false : $xp; |
825 | 828 | } |
826 | 829 | |
830 | + /** |
|
831 | + * @param string $prefix |
|
832 | + * @param string $namespaceURI |
|
833 | + */ |
|
827 | 834 | function xpath_register_ns($prefix, $namespaceURI) |
828 | 835 | { |
829 | 836 | return $this->myDOMXPath->registerNamespace($prefix, $namespaceURI); |
@@ -61,7 +61,7 @@ discard block |
||
61 | 61 | * This method returns the name of the directory where PGT's should be stored |
62 | 62 | * on the filesystem. |
63 | 63 | * |
64 | - * @return the name of a directory (with leading and trailing '/') |
|
64 | + * @return string name of a directory (with leading and trailing '/') |
|
65 | 65 | * |
66 | 66 | * @private |
67 | 67 | */ |
@@ -81,7 +81,7 @@ discard block |
||
81 | 81 | /** |
82 | 82 | * This method returns the format to use when storing PGT's on the filesystem. |
83 | 83 | * |
84 | - * @return a string corresponding to the format used (plain or xml). |
|
84 | + * @return string string corresponding to the format used (plain or xml). |
|
85 | 85 | * |
86 | 86 | * @private |
87 | 87 | */ |