chamilo / chamilo-lms

main/inc/lib/search/ChamiloQuery.php

Doc Comments +4 added lines, -1 removed lines

@@ -23,6 +23,9 @@ 
     return chamilo_preprocess_results($results);
 }
 
+/**
+ * @param string $query_string
+ */
 function chamilo_query_simple_query($query_string, $offset=0, $length=10, $extra=NULL) {
     return xapian_query($query_string, NULL, $offset, $length, $extra);
 }
@@ -30,7 +33,7 @@ 
 /**
  * Wrapper for getting boolean queries
  *
- * @param   string    $query_string   The term string
+ * @param string $term
  */
 function chamilo_get_boolean_query($term) {
   return xapian_get_boolean_query($term);

main/inc/lib/search/IndexableChunk.class.php

Doc Comments +3 added lines

@@ -57,6 +57,7 @@ 
      * Add a value to the indexed item
      * @param  string  Key
      * @param  string  Value
+     * @param string $key
      * @return  void
      */
     function addValue($key, $value) {
@@ -101,6 +102,7 @@ 
 
     /**
      * Let add course id term
+     * @param string $course_id
      */
     public function addCourseId($course_id)
     {
@@ -109,6 +111,7 @@ 
 
     /**
      * Let add tool id term
+     * @param string $tool_id
      */
     public function addToolId($tool_id)
     {

main/inc/lib/search/search_widget.php

Doc Comments +2 added lines

@@ -273,6 +273,8 @@
 
 /**
  * Show search form
+ * @param string $action
+ * @param boolean $show_thesaurus
  */
 function display_search_form($action, $show_thesaurus, $sf_terms, $op) {
     $type = (!empty($_REQUEST['type'])? htmlentities($_REQUEST['type']): 'normal');

main/inc/lib/search/xapian/XapianIndexer.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -98,7 +98,7 @@ 
 
     /**
      * Simple getter for the db attribute
-     * @return  object  The db attribute
+     * @return  null|XapianWritableDatabase  The db attribute
      */
     function getDb()
     {
@@ -108,6 +108,7 @@ 
     /**
      * Add this chunk to the chunk array attribute
      * @param  string  Chunk of text
+     * @param IndexableChunk $chunk
      * @return  void
      */
     function addChunk($chunk)
@@ -179,7 +180,7 @@ 
      * Get document data on a xapian document
      *
      * @param XapianDocument $doc xapian document to push into the db
-     * @return mixed xapian document data or FALSE if error
+     * @return string xapian document data or FALSE if error
      */
     function get_document_data($doc)
     {
@@ -286,7 +287,7 @@ 
      * Replace a document in the actual db
      *
      * @param XapianDocument $doc xapian document to push into the db
-     * @param Xapian::docid $did xapian document id of the document to replace
+     * @param integer $did xapian document id of the document to replace
      */
     function replace_document($doc, $did)
     {

main/inc/lib/security.lib.php

Doc Comments +4 added lines, -1 removed lines

@@ -45,6 +45,8 @@ 
      * checker path (directory)
      * @param	string	Absolute path to be checked (with trailing slash)
      * @param	string	Checker path under which the path should be (absolute path, with trailing slash, get it from api_get_path(SYS_COURSE_PATH))
+     * @param string $abs_path
+     * @param string $checker_path
      * @return	bool	True if the path is under the checker, false otherwise
      */
     public static function check_abs_path($abs_path, $checker_path)
@@ -300,6 +302,7 @@ 
      * @param string	The variable to filter for XSS, this params can be a string or an array (example : array(x,y))
      * @param int The user status,constant allowed (STUDENT, COURSEMANAGER, ANONYMOUS, COURSEMANAGERLOWSECURITY)
      * @param bool $filter_terms
+     * @param integer $user_status
      * @return	mixed	Filtered string or array
      */
     public static function remove_XSS($var, $user_status = null, $filter_terms = false)
@@ -453,7 +456,7 @@ 
      * This method provides specific protection (against XSS and other kinds of attacks) for static images (icons) used by the system.
      * Image paths are supposed to be given by programmers - people who know what they do, anyway, this method encourages
      * a safe practice for generating icon paths, without using heavy solutions based on HTMLPurifier for example.
-     * @param string $img_path          The input path of the image, it could be relative or absolute URL.
+     * @param string $image_path          The input path of the image, it could be relative or absolute URL.
      * @return string                   Returns sanitized image path or an empty string when the image path is not secure.
      * @author Ivan Tcholakov, March 2011
      */

main/inc/lib/sessionmanager.lib.php

Doc Comments +25 added lines, -20 removed lines

@@ -1336,9 +1336,9 @@ 
      * @param integer   $sessionCategoryId
      * @param int       $visibility
      * @param string    $description
-     * @param bool      $showDescription
+     * @param integer      $showDescription
      * @param int       $duration
-     * @param array     $extraFields
+     * @param boolean|null     $extraFields
      * @param int       $sessionAdminId
      * @param boolean $sendSubscriptionNotification Optional.
      *          Whether send a mail notification to users being subscribed
@@ -1558,7 +1558,7 @@ 
      * @param array $user_list
      * @param int $session_visibility
      * @param bool $empty_users
-     * @return bool
+     * @return false|null
      */
     public static function suscribe_users_to_session(
         $id_session,
@@ -1830,7 +1830,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -1896,7 +1896,7 @@ 
      * @param string $course_code
      * @param int $session_visibility
      * @param bool $removeUsersNotInList
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session_course(
         $user_list,
@@ -2079,7 +2079,7 @@ 
      * @param	bool	$removeExistingCoursesWithUsers Whether to unsubscribe
      * existing courses and users (true, default) or not (false)
      * @param $copyEvaluation from base course to session course
-     * @return	void	Nothing, or false on error
+     * @return	false|null	Nothing, or false on error
      * */
     public static function add_courses_to_session(
         $sessionId,
@@ -2275,6 +2275,8 @@ 
      *
      * @param int Session id
      * @param int Course id
+     * @param integer $session_id
+     * @param integer $course_id
      * @return bool True in case of success, false otherwise
      */
     public static function unsubscribe_course_from_session($session_id, $course_id)
@@ -2330,7 +2332,7 @@ 
      * @param	string	$variable Field's internal variable name
      * @param	int		$fieldType Field's type
      * @param	string	$displayText Field's language var name
-     * @return int     new extra field id
+     * @return boolean     new extra field id
      */
     public static function create_session_extra_field($variable, $fieldType, $displayText)
     {
@@ -2349,7 +2351,7 @@ 
      * @param	integer	Course ID
      * @param	string	Field variable name
      * @param	string	Field value
-     * @return	boolean	true if field updated, false otherwise
+     * @return	boolean|null	true if field updated, false otherwise
      */
     public static function update_session_extra_field_value($sessionId, $variable, $value = '')
     {
@@ -2554,7 +2556,7 @@ 
      * @param	array	id_checked
      * @param	bool	include delete session
      * @param	bool	optional, true if the function is called by a webservice, false otherwise.
-     * @return	void	Nothing, or false on error
+     * @return	boolean	Nothing, or false on error
      * The parameters is a array to delete sessions
      * */
     public static function delete_session_category($id_checked, $delete_session = false, $from_ws = false)
@@ -2605,7 +2607,7 @@ 
      * @param  array $conditions a list of condition example :
      * array('status' => STUDENT) or
      * array('s.name' => array('operator' => 'LIKE', value = '%$needle%'))
-     * @param  array $order_by a list of fields on which sort
+     * @param  string[] $order_by a list of fields on which sort
      * @return array An array with all sessions of the platform.
      * @todo   optional course code parameter, optional sorting parameters...
      */
@@ -3043,6 +3045,7 @@ 
      * @param string $orderCondition
      * @param string $keyword
      * @param string $description
+     * @param integer $status
      * @return array sessions
      */
     public static function getSessionsFollowedByUser(
@@ -3255,8 +3258,8 @@ 
     /**
      * Gets the list of courses by session filtered by access_url
      *
-     * @param $userId
-     * @param $sessionId
+     * @param integer $userId
+     * @param null|integer $sessionId
      * @param null $from
      * @param null $limit
      * @param null $column
@@ -3381,6 +3384,7 @@ 
     /**
      * Gets the count of courses by session filtered by access_url
      * @param int session id
+     * @param integer $session_id
      * @return array list of courses
      */
     public static function getCourseCountBySessionId($session_id, $keyword = null)
@@ -3632,6 +3636,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -3943,7 +3948,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4007,7 +4012,7 @@ 
      *  true: if the session exists it will be updated.
      *  false: if session exists a new session will be created adding a counter session1, session2, etc
      * @param int $defaultUserId
-     * @param mixed $logger
+     * @param Logger $logger
      * @param array $extraFields convert a file row to an extra field. Example in CSV file there's a SessionID then it will
      * converted to extra_external_session_id if you set this: array('SessionId' => 'extra_external_session_id')
      * @param string $extraFieldId
@@ -5249,7 +5254,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5401,7 +5405,7 @@ 
     /**
      * Get the list of course tools that have to be dealt with in case of
      * registering any course to a session
-     * @return array The list of tools to be dealt with (literal names)
+     * @return string[] The list of tools to be dealt with (literal names)
      */
     public static function getCourseToolToBeManaged()
     {
@@ -5415,7 +5419,7 @@ 
      * Calls the methods bound to each tool when a course is registered into a session
      * @param int $sessionId
      * @param int $courseId
-     * @return void
+     * @return boolean|null
      */
     public static function installCourse($sessionId, $courseId)
     {
@@ -6055,6 +6059,7 @@ 
      * @param int $categoryId The internal ID of the session category
      * @param string $target Value to search for in the session field values
      * @param array $extraFields A list of fields to be scanned and returned
+     * @param DateTime $publicationDate
      * @return mixed
      */
     public static function getShortSessionListAndExtraByCategory($categoryId, $target, $extraFields = null, $publicationDate = null)
@@ -7384,7 +7389,7 @@ 
     /**
      * Get link to the admin page for this session
      * @param   int $id Session ID
-     * @return mixed    URL to the admin page to manage the session, or false on error
+     * @return false|string    URL to the admin page to manage the session, or false on error
      */
     public static function getAdminPath($id)
     {
@@ -7401,7 +7406,7 @@ 
      * If a course is provided, build the link to the course
      * @param   int $id Session ID
      * @param   int $courseId Course ID (optional) in case the link has to send straight to the course
-     * @return mixed    URL to the page to use the session, or false on error
+     * @return false|string    URL to the page to use the session, or false on error
      */
     public static function getPath($id, $courseId = 0)
     {
@@ -7499,7 +7504,7 @@ 
     /**
      * Return true if coach is allowed to access this session
      * @param int $sessionId
-     * @return bool
+     * @return integer
      */
     public static function isSessionDateOkForCoach($sessionId)
     {

main/inc/lib/skill.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -326,6 +326,7 @@ 
 
     /**
      * Gets an element
+     * @param integer $gradebook_id
      */
     public function get_skill_info($skill_id, $gradebook_id)
     {
@@ -544,7 +545,7 @@ 
      * Gets an element
      * @param int $id
      *
-     * @return array|mixed
+     * @return integer
      */
     public function get($id)
     {
@@ -885,7 +886,7 @@ 
     /**
      * Get user's skills
      *
-     * @param int $userId User's id
+     * @param integer $user_id User's id
      * @param bool $get_skill_data
      */
     public function get_user_skills($user_id, $get_skill_data = false)

main/inc/lib/skill.visualizer.lib.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
         $this->center_x = intval($offset_x + $this->canvas_x/2 - $this->block_size/2);
     }
 
+    /**
+     * @param string $class
+     */
     function prepare_skill_box($skill, $position, $class)
     {
         $block_id = $skill['id'];

main/inc/lib/social.lib.php

Doc Comments +14 added lines, -4 removed lines

@@ -63,6 +63,8 @@ 
      * @param int user id
      * @param int user friend id
      * @param string
+     * @param integer $user_id
+     * @param integer $user_friend
      * @author isaac flores paz
      */
     public static function get_relation_between_contacts($user_id, $user_friend)
@@ -94,6 +96,8 @@ 
      * @param int group id
      * @param string name to search
      * @param bool true will load firstname, lastname, and image name
+     * @param integer $user_id
+     * @param integer $id_group
      * @return array
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code, function renamed, $load_extra_info option added
      * @author isaac flores paz
@@ -170,6 +174,9 @@ 
      * @param int user friend id
      * @param string title of the message
      * @param string content of the message
+     * @param integer $user_id
+     * @param string $message_title
+     * @param string $message_content
      * @return boolean
      * @author isaac flores paz
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
@@ -241,6 +248,7 @@ 
      * Get number messages of the inbox
      * @author isaac flores paz
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @return int
      */
     public static function get_message_number_invitation_by_user_id($user_receiver_id)
@@ -283,6 +291,7 @@ 
      * Get invitation list sent by user
      * @author Julio Montoya <gugli100@gmail.com>
      * @param int user id
+     * @param integer $user_id
      * @return array()
      */
     public static function get_list_invitation_sent_by_user_id($user_id)
@@ -325,6 +334,7 @@ 
      * Denies invitation
      * @param int user sender id
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @author isaac flores paz
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
      */
@@ -360,7 +370,7 @@ 
      * @author Isaac Flores Paz <isaac.flores.paz@gmail.com>
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
      * @param void
-     * @return string message invitation
+     * @return false|null message invitation
      */
     public static function send_invitation_friend_user($userfriend_id, $subject_message = '', $content_message = '')
     {
@@ -1229,7 +1239,7 @@ 
      * @param string $messageContent of the message
      * @param int $messageId id parent
      * @param string $messageStatus status type of message
-     * @return boolean
+     * @return false|string
      * @author Yannick Warnier
      */
     public static function sendWallMessage($userId, $friendId, $messageContent, $messageId = 0, $messageStatus = '')
@@ -1318,7 +1328,7 @@ 
      * Gets all messages from someone's wall (within specific limits)
      * @param int $userId id of wall shown
      * @param string $messageStatus status wall message
-     * @param int|string $parentId id message (Post main)
+     * @param integer|null $parentId id message (Post main)
      * @param date $start Date from which we want to show the messages, in UTC time
      * @param int $limit Limit for the number of parent messages we want to show
      * @param int $offset Wall message query offset
@@ -1647,7 +1657,7 @@ 
     /**
     * Delete messages delete logic
     * @param int $id id message to delete.
-    * @return bool status query
+    * @return Statement|null status query
     */
     public static function deleteMessage($id)
     {