chamilo / chamilo-lms

src/Chamilo/CourseBundle/Entity/CAnnouncement.php

Doc Comments +8 added lines, -8 removed lines

@@ -88,7 +88,7 @@ 
      * Set title
      *
      * @param string $title
-     * @return CAnnouncement
+     * @return Announcement
      */
     public function setTitle($title)
     {
@@ -111,7 +111,7 @@ 
      * Set content
      *
      * @param string $content
-     * @return CAnnouncement
+     * @return Announcement
      */
     public function setContent($content)
     {
@@ -134,7 +134,7 @@ 
      * Set endDate
      *
      * @param \DateTime $endDate
-     * @return CAnnouncement
+     * @return Announcement
      */
     public function setEndDate($endDate)
     {
@@ -157,7 +157,7 @@ 
      * Set displayOrder
      *
      * @param integer $displayOrder
-     * @return CAnnouncement
+     * @return Announcement
      */
     public function setDisplayOrder($displayOrder)
     {
@@ -180,7 +180,7 @@ 
      * Set emailSent
      *
      * @param boolean $emailSent
-     * @return CAnnouncement
+     * @return Announcement
      */
     public function setEmailSent($emailSent)
     {
@@ -203,7 +203,7 @@ 
      * Set sessionId
      *
      * @param integer $sessionId
-     * @return CAnnouncement
+     * @return Announcement
      */
     public function setSessionId($sessionId)
     {
@@ -226,7 +226,7 @@ 
      * Set id
      *
      * @param integer $id
-     * @return CAnnouncement
+     * @return Announcement
      */
     public function setId($id)
     {
@@ -249,7 +249,7 @@ 
      * Set cId
      *
      * @param integer $cId
-     * @return CAnnouncement
+     * @return Announcement
      */
     public function setCId($cId)
     {

src/Chamilo/FaqBundle/Entity/QuestionTranslation.php

Doc Comments +2 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
 
     /**
      * @param string $headline
-     * @return CategoryTranslation
+     * @return QuestionTranslation
      */
     public function setHeadline($headline)
     {
@@ -77,7 +77,7 @@ 
 
     /**
      * @param string $body
-     * @return CategoryTranslation
+     * @return QuestionTranslation
      */
     public function setBody($body)
     {

src/Chamilo/ThemeBundle/Model/MenuItemInterface.php

Doc Comments +12 added lines, -12 removed lines

@@ -20,29 +20,29 @@ 
     public function getIdentifier();
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getLabel();
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getRoute();
 
     /**
-     * @return mixed
+     * @return boolean
      */
     public function isActive();
 
     /**
-     * @param $isActive
+     * @param boolean $isActive
      *
-     * @return mixed
+     * @return MenuItemModel
      */
     public function setIsActive($isActive);
 
     /**
-     * @return mixed
+     * @return boolean
      */
     public function hasChildren();
 
@@ -54,14 +54,14 @@ 
     /**
      * @param MenuItemInterface $child
      *
-     * @return mixed
+     * @return MenuItemModel
      */
     public function addChild(MenuItemInterface $child);
 
     /**
      * @param MenuItemInterface $child
      *
-     * @return mixed
+     * @return MenuItemModel
      */
     public function removeChild(MenuItemInterface $child);
 
@@ -76,24 +76,24 @@ 
     public function getBadge();
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getBadgeColor();
 
     /**
-     * @return mixed
+     * @return MenuItemInterface
      */
     public function getParent();
 
     /**
-     * @return mixed
+     * @return boolean
      */
     public function hasParent();
 
     /**
      * @param MenuItemInterface $parent
      *
-     * @return mixed
+     * @return MenuItemModel
      */
     public function setParent(MenuItemInterface $parent = null);
 

src/Chamilo/UserBundle/Entity/Manager/UserManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
      *
      * @param string $token
      *
-     * @return UserInterface
+     * @return \FOS\UserBundle\Model\UserInterface
      */
     public function findUserByConfirmationToken($token)
     {

main/auth/cas/authcas.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
 require_once api_get_path(SYS_PATH) . 'main/auth/external_login/functions.inc.php';
 
 /**
- * @return true if cas is configured
+ * @return boolean if cas is configured
  *
  **/
 function cas_configured()

main/auth/cas/lib/CAS.php

Doc Comments +4 added lines, -4 removed lines

@@ -523,7 +523,7 @@ 
     /**

      * Logs a string in debug mode.

      *

-     * @param $str the string to write

+     * @param string $str the string to write

      *

      * @private

      */

@@ -545,7 +545,7 @@ 
      * This method is used by interface methods to print an error and where the function

      * was originally called from.

      *

-     * @param $msg the message to print

+     * @param string $msg the message to print

      *

      * @private

      */

@@ -678,7 +678,7 @@ 
     /**

      * This method returns the phpCAS version.

      *

-     * @return the phpCAS version.

+     * @return string phpCAS version.

      */

     function getVersion()

     {

@@ -1105,7 +1105,7 @@ 
      * @warning should not be called only after phpCAS::forceAuthentication()

      * or phpCAS::checkAuthentication().

      *

-     * @return the login name of the authenticated user

+     * @return string login name of the authenticated user

      */

     function getUser()

     {

main/auth/shibboleth/app/model/scaffold/user.class.php

Doc Comments +3 added lines

@@ -33,6 +33,7 @@ 
         
     /**
      *
+     * @param ShibbolethUser $data
      * @return User 
      */
     public static function create($data = null)
@@ -133,6 +134,7 @@ 
     
     /**
      *
+     * @param string $value
      * @return User 
      */
     public function get_by_user_id($value)
@@ -169,6 +171,7 @@ 
     
     /**
      *
+     * @param string $value
      * @return bool 
      */
     public function username_exists($value)

src/Chamilo/UserBundle/Entity/User.php

Doc Comments +7 added lines, -7 removed lines

@@ -991,7 +991,7 @@ 
     /**
      * Get pictureUri
      *
-     * @return Media
+     * @return string
      */
     public function getPictureUri()
     {
@@ -1368,7 +1368,7 @@ 
     }
 
     /**
-     * @return Media
+     * @return string
      */
     public function getAvatar()
     {
@@ -1637,7 +1637,7 @@ 
     /**
      * Returns the creation date.
      *
-     * @return \DateTime|null
+     * @return \DateTime
      */
     public function getCreatedAt()
     {
@@ -1661,7 +1661,7 @@ 
     /**
      * Returns the last update date.
      *
-     * @return \DateTime|null
+     * @return \DateTime
      */
     public function getUpdatedAt()
     {
@@ -1671,7 +1671,7 @@ 
     /**
      * Returns the expiration date.
      *
-     * @return \DateTime|null
+     * @return \DateTime
      */
     public function getExpiresAt()
     {
@@ -2137,7 +2137,7 @@ 
       /**
      * Returns the user roles
      *
-     * @return array The roles
+     * @return string[] The roles
      */
     public function getRoles()
     {
@@ -2463,7 +2463,7 @@ 
     /**
      * Check if the user has the skill
      * @param \Chamilo\CoreBundle\Entity\Skill $skill The skill
-     * @return boolean
+     * @return boolean|null
      */
     public function hasSkill(\Chamilo\CoreBundle\Entity\Skill $skill)
     {

main/inc/lib/sessionmanager.lib.php

Doc Comments +24 added lines, -17 removed lines

@@ -1336,7 +1336,7 @@ 
      * @param string    $description
      * @param int       $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
@@ -1565,7 +1565,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,
@@ -1837,7 +1837,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -1903,7 +1903,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,
@@ -2086,7 +2086,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,
@@ -2282,6 +2282,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)
@@ -2337,7 +2339,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)
     {
@@ -2561,7 +2563,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)
@@ -3056,6 +3058,7 @@ 
      * @param string $orderCondition
      * @param string $keyword
      * @param string $description
+     * @param integer $status
      * @return array sessions
      */
     public static function getSessionsFollowedByUser(
@@ -3268,8 +3271,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
@@ -3394,6 +3397,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)
@@ -3645,6 +3649,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -3960,7 +3965,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4024,7 +4029,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
@@ -5266,7 +5271,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5418,7 +5422,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()
     {
@@ -5432,7 +5436,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)
     {
@@ -6072,6 +6076,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)
@@ -6584,6 +6589,8 @@ 
      * Converts "start date" and "end date" to "From start date to end date" string
      * @param string $startDate
      * @param string $endDate
+     * @param boolean $showTime
+     * @param boolean $dateHuman
      *
      * @return string
      */
@@ -7402,7 +7409,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)
     {
@@ -7419,7 +7426,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)
     {
@@ -7517,7 +7524,7 @@ 
     /**
      * Return true if coach is allowed to access this session
      * @param int $sessionId
-     * @return bool
+     * @return integer
      */
     public static function isSessionDateOkForCoach($sessionId)
     {