@@ -266,6 +266,7 @@ discard block |
||
| 266 | 266 | * @global bool $is_platformAdmin |
| 267 | 267 | * @global bool $is_allowedCreateCourse |
| 268 | 268 | * @global object $_user |
| 269 | + * @param boolean $reset |
|
| 269 | 270 | */ |
| 270 | 271 | public static function init_user($user_id, $reset) |
| 271 | 272 | { |
@@ -355,7 +356,7 @@ discard block |
||
| 355 | 356 | * @global type $is_allowed_in_course |
| 356 | 357 | * |
| 357 | 358 | * @param type $course_id |
| 358 | - * @param type $reset |
|
| 359 | + * @param boolean $reset |
|
| 359 | 360 | */ |
| 360 | 361 | static function init_course($course_id, $reset) |
| 361 | 362 | { |
@@ -616,6 +616,8 @@ discard block |
||
| 616 | 616 | * @param int message id |
| 617 | 617 | * @param int message user id (receiver user id or sender user id) |
| 618 | 618 | * @param int group id (optional) |
| 619 | + * @param integer $message_id |
|
| 620 | + * @param integer $message_uid |
|
| 619 | 621 | * @return void |
| 620 | 622 | */ |
| 621 | 623 | public static function delete_message_attachment_file($message_id, $message_uid, $group_id = 0) |
@@ -660,7 +662,7 @@ discard block |
||
| 660 | 662 | * update messages by user id and message id |
| 661 | 663 | * @param int $user_id |
| 662 | 664 | * @param int $message_id |
| 663 | - * @return resource |
|
| 665 | + * @return false|null |
|
| 664 | 666 | */ |
| 665 | 667 | public static function update_message($user_id, $message_id) |
| 666 | 668 | { |
@@ -680,7 +682,7 @@ discard block |
||
| 680 | 682 | * @param int $user_id |
| 681 | 683 | * @param int $message_id |
| 682 | 684 | * @param string $type |
| 683 | - * @return bool |
|
| 685 | + * @return false|null |
|
| 684 | 686 | */ |
| 685 | 687 | public static function update_message_status($user_id, $message_id,$type) |
| 686 | 688 | { |
@@ -717,6 +719,7 @@ discard block |
||
| 717 | 719 | /** |
| 718 | 720 | * get messages by group id |
| 719 | 721 | * @param int group id |
| 722 | + * @param integer $group_id |
|
| 720 | 723 | * @return array |
| 721 | 724 | */ |
| 722 | 725 | public static function get_messages_by_group($group_id) |
@@ -1433,7 +1436,7 @@ discard block |
||
| 1433 | 1436 | * Sort date by desc from a multi-dimensional array |
| 1434 | 1437 | * @param array $array1 first array to compare |
| 1435 | 1438 | * @param array $array2 second array to compare |
| 1436 | - * @return bool |
|
| 1439 | + * @return integer |
|
| 1437 | 1440 | */ |
| 1438 | 1441 | public function order_desc_date($array1, $array2) |
| 1439 | 1442 | { |
@@ -1511,7 +1514,6 @@ discard block |
||
| 1511 | 1514 | /** |
| 1512 | 1515 | * @param $id |
| 1513 | 1516 | * @param array $params |
| 1514 | - * @param string $display |
|
| 1515 | 1517 | * @return string |
| 1516 | 1518 | */ |
| 1517 | 1519 | public static function generate_invitation_form($id, $params = array()) |
@@ -25,6 +25,7 @@ |
||
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | 27 | * Useful finder - experimental akelos like only use in notification.lib.php send function |
| 28 | + * @param string $type |
|
| 28 | 29 | */ |
| 29 | 30 | public function find($type, $options = null) |
| 30 | 31 | { |
@@ -219,7 +219,7 @@ |
||
| 219 | 219 | * @param array $user_list recipients: user list of ids |
| 220 | 220 | * @param string $title |
| 221 | 221 | * @param string $content |
| 222 | - * @param array $sender_info |
|
| 222 | + * @param array $senderInfo |
|
| 223 | 223 | * result of api_get_user_info() or GroupPortalManager:get_group_data() |
| 224 | 224 | */ |
| 225 | 225 | public function save_notification( |
@@ -306,7 +306,7 @@ discard block |
||
| 306 | 306 | /** |
| 307 | 307 | * gets the current debug data for this instance |
| 308 | 308 | * |
| 309 | - * @return debug data |
|
| 309 | + * @return string data |
|
| 310 | 310 | * @access public |
| 311 | 311 | */ |
| 312 | 312 | function &getDebug() {
|
@@ -319,7 +319,7 @@ discard block |
||
| 319 | 319 | * gets the current debug data for this instance as an XML comment |
| 320 | 320 | * this may change the contents of the debug data |
| 321 | 321 | * |
| 322 | - * @return debug data as an XML comment |
|
| 322 | + * @return string data as an XML comment |
|
| 323 | 323 | * @access public |
| 324 | 324 | */ |
| 325 | 325 | function &getDebugAsXMLComment() {
|
@@ -352,7 +352,7 @@ discard block |
||
| 352 | 352 | /** |
| 353 | 353 | * returns error string if present |
| 354 | 354 | * |
| 355 | - * @return mixed error string or false |
|
| 355 | + * @return string|false error string or false |
|
| 356 | 356 | * @access public |
| 357 | 357 | */ |
| 358 | 358 | function getError(){
|
@@ -365,7 +365,7 @@ discard block |
||
| 365 | 365 | /** |
| 366 | 366 | * sets error string |
| 367 | 367 | * |
| 368 | - * @return boolean $string error string |
|
| 368 | + * @return boolean|null $string error string |
|
| 369 | 369 | * @access private |
| 370 | 370 | */ |
| 371 | 371 | function setError($str){
|
@@ -801,7 +801,7 @@ discard block |
||
| 801 | 801 | * returns false, if not prefixed |
| 802 | 802 | * |
| 803 | 803 | * @param string $str The prefixed string |
| 804 | - * @return mixed The prefix or false if there is no prefix |
|
| 804 | + * @return string|false The prefix or false if there is no prefix |
|
| 805 | 805 | * @access public |
| 806 | 806 | */ |
| 807 | 807 | function getPrefix($str){
|
@@ -832,7 +832,7 @@ discard block |
||
| 832 | 832 | * or false if no prefixes registered for the given namespace |
| 833 | 833 | * |
| 834 | 834 | * @param string $ns The namespace |
| 835 | - * @return mixed The prefix, false if the namespace has no prefixes |
|
| 835 | + * @return string The prefix, false if the namespace has no prefixes |
|
| 836 | 836 | * @access public |
| 837 | 837 | */ |
| 838 | 838 | function getPrefixFromNamespace($ns) {
|
@@ -898,7 +898,7 @@ discard block |
||
| 898 | 898 | * |
| 899 | 899 | * @param int $timestamp Unix time stamp |
| 900 | 900 | * @param boolean $utc Whether the time stamp is UTC or local |
| 901 | -* @return mixed ISO 8601 date string or false |
|
| 901 | +* @return string|false ISO 8601 date string or false |
|
| 902 | 902 | * @access public |
| 903 | 903 | */ |
| 904 | 904 | function timestamp_to_iso8601($timestamp,$utc=true){
|
@@ -843,7 +843,7 @@ discard block |
||
| 843 | 843 | * |
| 844 | 844 | * @param array $headers The HTTP headers |
| 845 | 845 | * @param string $data unprocessed request data from client |
| 846 | - * @return mixed value of the message, decoded into a PHP type |
|
| 846 | + * @return false|null value of the message, decoded into a PHP type |
|
| 847 | 847 | * @access private |
| 848 | 848 | */ |
| 849 | 849 | function parseRequest($headers, $data) {
|
@@ -951,10 +951,10 @@ discard block |
||
| 951 | 951 | * @param string $name the name of the PHP function, class.method or class..method |
| 952 | 952 | * @param array $in assoc array of input values: key = param name, value = param type |
| 953 | 953 | * @param array $out assoc array of output values: key = param name, value = param type |
| 954 | - * @param mixed $namespace the element namespace for the method or false |
|
| 955 | - * @param mixed $soapaction the soapaction for the method or false |
|
| 956 | - * @param mixed $style optional (rpc|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically |
|
| 957 | - * @param mixed $use optional (encoded|literal) or false |
|
| 954 | + * @param string $namespace the element namespace for the method or false |
|
| 955 | + * @param string $soapaction the soapaction for the method or false |
|
| 956 | + * @param string $style optional (rpc|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically |
|
| 957 | + * @param string $use optional (encoded|literal) or false |
|
| 958 | 958 | * @param string $documentation optional Description to include in WSDL |
| 959 | 959 | * @param string $encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded) |
| 960 | 960 | * @access public |
@@ -1041,11 +1041,12 @@ discard block |
||
| 1041 | 1041 | * Acts as a flag to enable internal WSDL generation |
| 1042 | 1042 | * |
| 1043 | 1043 | * @param string $serviceName, name of the service |
| 1044 | - * @param mixed $namespace optional 'tns' service namespace or false |
|
| 1044 | + * @param string $namespace optional 'tns' service namespace or false |
|
| 1045 | 1045 | * @param mixed $endpoint optional URL of service endpoint or false |
| 1046 | 1046 | * @param string $style optional (rpc|document) WSDL style (also specified by operation) |
| 1047 | 1047 | * @param string $transport optional SOAP transport |
| 1048 | - * @param mixed $schemaTargetNamespace optional 'types' targetNamespace for service schema or false |
|
| 1048 | + * @param mixed $schemaTargetNamespace optional 'types' targetNamespace for service schema or false |
|
| 1049 | + * @param string $serviceName |
|
| 1049 | 1050 | */ |
| 1050 | 1051 | function configureWSDL($serviceName,$namespace = false,$endpoint = false,$style='rpc', $transport = 'http://schemas.xmlsoap.org/soap/http', $schemaTargetNamespace = false) |
| 1051 | 1052 | {
|
@@ -169,10 +169,6 @@ discard block |
||
| 169 | 169 | /** |
| 170 | 170 | * establish an HTTP connection |
| 171 | 171 | * |
| 172 | - * @param integer $timeout set connection timeout in seconds |
|
| 173 | - * @param integer $response_timeout set response timeout in seconds |
|
| 174 | - * @return boolean true if connected, false if not |
|
| 175 | - * @access private |
|
| 176 | 172 | */ |
| 177 | 173 | function connect($connection_timeout=0,$response_timeout=30){
|
| 178 | 174 | // For PHP 4.3 with OpenSSL, change https scheme to ssl, then treat like |
@@ -731,7 +727,7 @@ discard block |
||
| 731 | 727 | * |
| 732 | 728 | * @param string $data message data |
| 733 | 729 | * @param array $cookies cookies to send |
| 734 | - * @return boolean true if OK, false if problem |
|
| 730 | + * @return boolean|null true if OK, false if problem |
|
| 735 | 731 | * @access private |
| 736 | 732 | */ |
| 737 | 733 | function sendRequest($data, $cookies = NULL) {
|
@@ -1166,7 +1162,7 @@ discard block |
||
| 1166 | 1162 | * sets the content-type for the SOAP message to be sent |
| 1167 | 1163 | * |
| 1168 | 1164 | * @param string $type the content type, MIME style |
| 1169 | - * @param mixed $charset character set used for encoding (or false) |
|
| 1165 | + * @param string $charset character set used for encoding (or false) |
|
| 1170 | 1166 | * @access public |
| 1171 | 1167 | */ |
| 1172 | 1168 | function setContentType($type, $charset = false) {
|
@@ -1199,6 +1195,10 @@ discard block |
||
| 1199 | 1195 | /* |
| 1200 | 1196 | * TODO: allow a Set-Cookie string to be parsed into multiple cookies |
| 1201 | 1197 | */ |
| 1198 | + |
|
| 1199 | + /** |
|
| 1200 | + * @param string $cookie_str |
|
| 1201 | + */ |
|
| 1202 | 1202 | function parseCookie($cookie_str) {
|
| 1203 | 1203 | $cookie_str = str_replace('; ', ';', $cookie_str) . ';';
|
| 1204 | 1204 | $data = preg_split('/;/', $cookie_str);
|
@@ -63,7 +63,7 @@ |
||
| 63 | 63 | * |
| 64 | 64 | * @param string $name optional name |
| 65 | 65 | * @param mixed $type optional type name |
| 66 | - * @param mixed $value optional value |
|
| 66 | + * @param integer $value optional value |
|
| 67 | 67 | * @param mixed $element_ns optional namespace of value |
| 68 | 68 | * @param mixed $type_ns optional namespace of type |
| 69 | 69 | * @param mixed $attributes associative array of attributes to add to element serialization |
@@ -743,6 +743,7 @@ |
||
| 743 | 743 | /** |
| 744 | 744 | * dynamically creates proxy class code |
| 745 | 745 | * |
| 746 | + * @param integer $r |
|
| 746 | 747 | * @return string PHP/NuSOAP code for the proxy class |
| 747 | 748 | * @access private |
| 748 | 749 | */ |