Minor - Adapting code comments to phpdoc

skala
Yannick Warnier 14 years ago
parent 39daf877a3
commit 6c33498a64
  1. 13
      main/exercice/answer.class.php
  2. 5
      main/exercice/exercise.class.php
  3. 10
      main/exercice/exercise_result.class.php
  4. 3
      main/exercice/exercise_result.php
  5. 4
      main/exercice/exercise_show.php
  6. 31
      main/exercice/export/qti/qti_classes.php
  7. 2
      main/exercice/export/qti/qti_export.php
  8. 4
      main/exercice/export/qti2/qti2_export.php
  9. 4
      main/exercice/export/scorm/scorm_export.php
  10. 9
      main/exercice/freeanswer.class.php
  11. 15
      main/exercice/hotspot.class.php
  12. 10
      main/exercice/matching.class.php
  13. 6
      main/exercice/multiple_answer_combination_true_false.class.php
  14. 19
      main/exercice/multiple_answer_true_false.class.php
  15. 1
      main/exercice/question.class.php
  16. 4
      main/exercice/question_pool.php
  17. 8
      main/inc/lib/WCAG/WCAG_rendering.php
  18. 13
      main/inc/lib/access_url_edit_sessions_to_url_functions.lib.php
  19. 12
      main/inc/lib/access_url_edit_users_to_url_functions.lib.php
  20. 5
      main/inc/lib/add_course.lib.inc.php
  21. 4
      main/inc/lib/attendance.lib.php
  22. 15
      main/inc/lib/banner.lib.php
  23. 5
      main/inc/lib/blog.lib.php
  24. 4
      main/inc/lib/course_request.lib.php
  25. 12
      main/inc/lib/dashboard.lib.php
  26. 5
      main/inc/lib/debug.lib.php
  27. 8
      main/inc/lib/document.lib.php
  28. 9
      main/inc/lib/export.lib.inc.php
  29. 3
      main/inc/lib/fileManage.lib.php
  30. 8
      main/inc/lib/fileUpload.lib.php
  31. 12
      main/inc/lib/geometry.lib.php
  32. 20
      main/inc/lib/group_portal_manager.lib.php
  33. 10
      main/inc/lib/groupmanager.lib.php
  34. 23
      main/inc/lib/image.lib.php
  35. 7
      main/inc/lib/internationalization_database/conversion/character_map_selector.php
  36. 7
      main/inc/lib/internationalization_database/language_detection/update_language_profiles.php
  37. 4
      main/inc/lib/internationalization_database/name_order_conventions.php
  38. 5
      main/inc/lib/internationalization_database/non_utf8_encodings.php
  39. 8
      main/inc/lib/mail.lib.inc.php
  40. 13
      main/inc/lib/mp3player/is_autostart.as.php
  41. 3
      main/inc/lib/nanogong/receiver.php
  42. 10
      main/inc/lib/notification.lib.php
  43. 7
      main/inc/lib/pdf.lib.php
  44. 8
      main/inc/lib/pear/HTML/QuickForm/Rule/CompareDate.php
  45. 29
      main/inc/lib/pear/HTML/QuickForm/Rule/Date.php
  46. 4
      main/inc/lib/pear/HTML/QuickForm/advmultiselect.php
  47. 1
      main/inc/lib/pear/HTML/Table.php
  48. 1
      main/inc/lib/pear/Pager/Common.php
  49. 5
      main/inc/lib/pear/Pager/Pager_savebc.php
  50. 6
      main/inc/lib/pear/excelreader/reader.php
  51. 5
      main/inc/lib/search/DokeosQuery.php
  52. 12
      main/inc/lib/search/IndexableChunk.class.php
  53. 5
      main/inc/lib/search/search_widget.php
  54. 10
      main/inc/lib/search/tool_processors/document_processor.class.php
  55. 9
      main/inc/lib/search/tool_processors/learnpath_processor.class.php
  56. 9
      main/inc/lib/search/tool_processors/link_processor.class.php
  57. 9
      main/inc/lib/search/tool_processors/quiz_processor.class.php
  58. 6
      main/inc/lib/search/tool_processors/search_processor.class.php
  59. 8
      main/inc/lib/search/xapian/XapianIndexer.class.php
  60. 6
      main/inc/lib/search/xapian/XapianQuery.php
  61. 8
      main/inc/lib/sessionmanager.lib.php
  62. 11
      main/inc/lib/sortabletable.class.php
  63. 5
      main/inc/lib/specific_fields_manager.lib.php
  64. 8
      main/inc/lib/tablesort.lib.php
  65. 5
      main/inc/lib/text.lib.php
  66. 24
      main/inc/lib/tracking.lib.php
  67. 7
      main/inc/lib/upload.xajax.php
  68. 19
      main/inc/lib/usermanager.lib.php
  69. 9
      main/inc/lib/xajax/tests/changeLister.php

@ -1,6 +1,5 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This class allows to instantiate an object of type Answer * This class allows to instantiate an object of type Answer
* 5 arrays are created to receive the attributes of each answer belonging to a specified question * 5 arrays are created to receive the attributes of each answer belonging to a specified question
@ -8,11 +7,15 @@
* @author Olivier Brouckaert * @author Olivier Brouckaert
* @version $Id: answer.class.php 21172 2009-06-01 20:58:05Z darkvela $ * @version $Id: answer.class.php 21172 2009-06-01 20:58:05Z darkvela $
*/ */
/**
* Code
*/
if(!class_exists('Answer')): if(!class_exists('Answer')):
/**
class Answer * Answer class
{ * @package chamilo.exercise
*/
class Answer {
public $questionId; public $questionId;
// these are arrays // these are arrays

@ -24,7 +24,10 @@ $debug = 0; //All exercise scripts should depend in this debug variable
require_once dirname(__FILE__).'/../inc/lib/exercise_show_functions.lib.php'; require_once dirname(__FILE__).'/../inc/lib/exercise_show_functions.lib.php';
if(!class_exists('Exercise')): if(!class_exists('Exercise')):
/**
* Exercise class
* @package chamilo.exercise
*/
class Exercise { class Exercise {
public $id; public $id;

@ -7,10 +7,14 @@
* @author Yannick Warnier * @author Yannick Warnier
* @version $Id: $ * @version $Id: $
*/ */
/**
* Code
*/
if(!class_exists('ExerciseResult')): if(!class_exists('ExerciseResult')):
/*
* Exercise results class
* @package chamilo.exercise
*/
class ExerciseResult class ExerciseResult
{ {
private $exercises_list = array(); //stores the list of exercises private $exercises_list = array(); //stores the list of exercises

@ -14,6 +14,9 @@
* *
* @todo split more code up in functions, move functions to library? * @todo split more code up in functions, move functions to library?
*/ */
/**
* Code
*/
/* INIT SECTION */ /* INIT SECTION */
require_once 'exercise.class.php'; require_once 'exercise.class.php';
require_once 'exercise.lib.php'; require_once 'exercise.lib.php';

@ -3,13 +3,13 @@
/** /**
* Shows the exercise results * Shows the exercise results
* *
* @package chamilo.exercise
* @author Julio Montoya Armas Added switchable fill in blank option added * @author Julio Montoya Armas Added switchable fill in blank option added
* @version $Id: exercise_show.php 22256 2009-07-20 17:40:20Z ivantcholakov $ * @version $Id: exercise_show.php 22256 2009-07-20 17:40:20Z ivantcholakov $
* @package chamilo.exercise * @package chamilo.exercise
* @todo remove the debug code and use the general debug library * @todo remove the debug code and use the general debug library
* @todo small letters for table variables * @todo small letters for table variables
* */ *
*/
/** /**
* Code * Code
*/ */

@ -1,5 +1,5 @@
<?php // $Id: $ <?php // $Id: $
if ( count( get_included_files() ) == 1 ) die( '---' ); /* For licensing terms, see /license.txt */
/** /**
* @copyright (c) 2007 Dokeos * @copyright (c) 2007 Dokeos
* @copyright (c) 2001-2006 Universite catholique de Louvain (UCL) * @copyright (c) 2001-2006 Universite catholique de Louvain (UCL)
@ -7,9 +7,13 @@ if ( count( get_included_files() ) == 1 ) die( '---' );
* @license http://www.gnu.org/copyleft/gpl.html (GPL) GENERAL PUBLIC LICENSE * @license http://www.gnu.org/copyleft/gpl.html (GPL) GENERAL PUBLIC LICENSE
* *
* @author Claro Team <cvs@claroline.net> * @author Claro Team <cvs@claroline.net>
* @author Yannick Warnier <yannick.warnier@dokeos.com> * @author Yannick Warnier <yannick.warnier@beeznest.com>
* @package dokeos.exercise * @package chamilo.exercise
*/
/**
* Code
*/ */
if ( count( get_included_files() ) == 1 ) die( '---' );
require_once('../../exercise.class.php'); require_once('../../exercise.class.php');
require_once('../../question.class.php'); require_once('../../question.class.php');
require_once('../../answer.class.php'); require_once('../../answer.class.php');
@ -32,7 +36,10 @@ define('FIB', 3);
define('MATCHING', 4); define('MATCHING', 4);
define('FREE_ANSWER', 5); define('FREE_ANSWER', 5);
define('HOTSPOT', 6); define('HOTSPOT', 6);
/**
*
* @package chamilo.exercise
*/
class ImsQuestion extends Question class ImsQuestion extends Question
{ {
/** /**
@ -91,6 +98,10 @@ class ImsQuestion extends Question
} }
} }
/**
*
* @package chamilo.exercise
*/
class ImsAnswerMultipleChoice extends answerMultipleChoice class ImsAnswerMultipleChoice extends answerMultipleChoice
{ {
/** /**
@ -231,6 +242,10 @@ class ImsAnswerMultipleChoice extends answerMultipleChoice
} }
} }
/**
*
* @package chamilo.exercise
*/
class ImsAnswerTrueFalse extends answerTrueFalse class ImsAnswerTrueFalse extends answerTrueFalse
{ {
/** /**
@ -339,6 +354,10 @@ class ImsAnswerTrueFalse extends answerTrueFalse
} }
} }
/**
*
* @package chamilo.exercise
*/
class ImsAnswerFillInBlanks extends answerFillInBlanks class ImsAnswerFillInBlanks extends answerFillInBlanks
{ {
/** /**
@ -455,6 +474,10 @@ class ImsAnswerFillInBlanks extends answerFillInBlanks
} }
} }
/**
*
* @package chamilo.exercise
*/
class ImsAnswerMatching extends answerMatching class ImsAnswerMatching extends answerMatching
{ {
/** /**

@ -174,7 +174,7 @@ class ImsSection
* *
* Every start_*() and corresponding end_*(), as well as export_*() methods return a string. * Every start_*() and corresponding end_*(), as well as export_*() methods return a string.
* *
* @warning Attached files are NOT exported. * Warning: Attached files are NOT exported.
* @package chamilo.exercise.qti * @package chamilo.exercise.qti
* @author Amand Tihon <amand@alrj.org> * @author Amand Tihon <amand@alrj.org>
*/ */

@ -28,7 +28,7 @@ define(HOT_SPOT_ORDER, 7);
* *
* Every start_*() and corresponding end_*(), as well as export_*() methods return a string. * Every start_*() and corresponding end_*(), as well as export_*() methods return a string.
* *
* @note Attached files are NOT exported. * note: Attached files are NOT exported.
* @package chamilo.exercise * @package chamilo.exercise
*/ */
class ImsAssessmentItem class ImsAssessmentItem
@ -302,7 +302,7 @@ class ImsSection
* *
* Every start_*() and corresponding end_*(), as well as export_*() methods return a string. * Every start_*() and corresponding end_*(), as well as export_*() methods return a string.
* *
* @warning Attached files are NOT exported. * warning: Attached files are NOT exported.
* @author Amand Tihon <amand@alrj.org> * @author Amand Tihon <amand@alrj.org>
* @package chamilo.exercise * @package chamilo.exercise
*/ */

@ -28,7 +28,8 @@ define(HOT_SPOT_ORDER, 7);
* *
* Every start_*() and corresponding end_*(), as well as export_*() methods return a string. * Every start_*() and corresponding end_*(), as well as export_*() methods return a string.
* *
* @warning Attached files are NOT exported. * Attached files are NOT exported.
* @package chamilo.exercise.scorm
*/ */
class ScormAssessmentItem class ScormAssessmentItem
{ {
@ -258,6 +259,7 @@ class ScormAssessmentItem
* - max_attempts * - max_attempts
* - show_answer * - show_answer
* - anonymous_attempts * - anonymous_attempts
* @package chamilo.exercise.scorm
*/ */
class ScormSection class ScormSection
{ {

@ -8,10 +8,13 @@
* @author Eric Marguin * @author Eric Marguin
* @version $Id: admin.php 10680 2007-01-11 21:26:23Z pcool $ * @version $Id: admin.php 10680 2007-01-11 21:26:23Z pcool $
*/ */
/**
* Code
*/
if(!class_exists('FreeAnswer')): if(!class_exists('FreeAnswer')):
/**
* @package chamilo.exercise
*/
class FreeAnswer extends Question { class FreeAnswer extends Question {
static $typePicture = 'open_answer.gif'; static $typePicture = 'open_answer.gif';

@ -1,15 +1,14 @@
<?php //$id:$ <?php //$id:$
/* For licensing terms, see /dokeos_license.txt */ /* For licensing terms, see /dokeos_license.txt */
//error_log(__FILE__);
/** /**
* File containing the HotSpot class. * File containing the HotSpot class.
* @package dokeos.exercise * @package chamilo.exercise
* @author Eric Marguin * @author Eric Marguin
* @version $Id: admin.php 10680 2007-01-11 21:26:23Z pcool $ * @version $Id: admin.php 10680 2007-01-11 21:26:23Z pcool $
*/ */
/**
* Code
*/
if(!class_exists('HotSpot')): if(!class_exists('HotSpot')):
/** /**
@ -19,7 +18,7 @@ if(!class_exists('HotSpot')):
* extending the class question * extending the class question
* *
* @author Eric Marguin * @author Eric Marguin
* @package dokeos.exercise * @package chamilo.exercise
**/ **/
class HotSpot extends Question { class HotSpot extends Question {
@ -90,7 +89,9 @@ class HotSpot extends Question {
// nothing // nothing
} }
} }
/**
* @package chamilo.exercise
*/
class HotSpotDelineation extends HotSpot { class HotSpotDelineation extends HotSpot {
static $typePicture = 'hotspot_delineation.gif'; static $typePicture = 'hotspot_delineation.gif';

@ -1,6 +1,5 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
if(!class_exists('Matching')):
/** /**
CLASS Matching CLASS Matching
* *
@ -10,7 +9,14 @@ if(!class_exists('Matching')):
* @author Eric Marguin * @author Eric Marguin
* @package chamilo.exercise * @package chamilo.exercise
**/ **/
/**
* Code
*/
if(!class_exists('Matching')):
/**
* Matching questions type class
* @package chamilo.exercise
*/
class Matching extends Question { class Matching extends Question {

@ -10,7 +10,7 @@
* Code * Code
*/ */
if(!class_exists('MultipleAnswerCombinationTrueFalse')): if(!class_exists('MultipleAnswerCombinationTrueFalse')):
require 'multiple_answer_combination.class.php';
/** /**
CLASS MultipleAnswer CLASS MultipleAnswer
* *
@ -18,10 +18,8 @@ if(!class_exists('MultipleAnswerCombinationTrueFalse')):
* extending the class question * extending the class question
* *
* @author Eric Marguin * @author Eric Marguin
* @package dokeos.exercise * @package chamilo.exercise
**/ **/
require 'multiple_answer_combination.class.php';
class MultipleAnswerCombinationTrueFalse extends MultipleAnswerCombination { class MultipleAnswerCombinationTrueFalse extends MultipleAnswerCombination {
static $typePicture = 'mcmaco.gif'; static $typePicture = 'mcmaco.gif';

@ -1,18 +1,21 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
if(!class_exists('MultipleAnswerTrueFalse')):
/** /**
CLASS MultipleAnswer * CLASS MultipleAnswer
*
* This class allows to instantiate an object of type MULTIPLE_ANSWER (MULTIPLE CHOICE, MULTIPLE ANSWER),
* extending the class question
* *
* This class allows to instantiate an object of type MULTIPLE_ANSWER
* (MULTIPLE CHOICE, MULTIPLE ANSWER), extending the class question
* @author Julio Montoya * @author Julio Montoya
* @package chamilo.exercise * @package chamilo.exercise
**/ **/
/**
* Code
*/
if(!class_exists('MultipleAnswerTrueFalse')):
/**
* Class
* @package chamilo.exercise
*/
class MultipleAnswerTrueFalse extends Question { class MultipleAnswerTrueFalse extends Question {
static $typePicture = 'mcmao.gif'; static $typePicture = 'mcmao.gif';

@ -33,6 +33,7 @@ define('MULTIPLE_ANSWER_COMBINATION_TRUE_FALSE', 12);
* *
* @author Olivier Brouckaert, original author * @author Olivier Brouckaert, original author
* @author Patrick Cool, LaTeX support * @author Patrick Cool, LaTeX support
* @package chamilo.exercise
*/ */
abstract class Question abstract class Question
{ {

@ -9,7 +9,9 @@
* @author Olivier Brouckaert * @author Olivier Brouckaert
* @author Julio Montoya adding support to query all questions from all session, courses, exercises * @author Julio Montoya adding support to query all questions from all session, courses, exercises
*/ */
/**
* Code
*/
// name of the language file that needs to be included // name of the language file that needs to be included
$language_file='exercice'; $language_file='exercice';

@ -18,7 +18,12 @@
// +----------------------------------------------------------------------+ // +----------------------------------------------------------------------+
// //
// $Id: wai_rendering.php,v 1.0 2006/10/07 20:12:17 avb Exp $ // $Id: wai_rendering.php,v 1.0 2006/10/07 20:12:17 avb Exp $
/**
* @package chamilo.include
*/
/**
* Code
*/
include_once ('../inc/global.inc.php'); include_once ('../inc/global.inc.php');
include_once (api_get_path(LIBRARY_PATH).'formvalidator/FormValidator.class.php'); include_once (api_get_path(LIBRARY_PATH).'formvalidator/FormValidator.class.php');
@ -27,6 +32,7 @@ include_once (api_get_path(LIBRARY_PATH).'formvalidator/FormValidator.class.php'
* *
* @author Patrick Vandermaesen <pvandermaesen@noctis.be> * @author Patrick Vandermaesen <pvandermaesen@noctis.be>
* @version 1.0 * @version 1.0
* @package chamilo.include
*/ */
class WCAG_Rendering { class WCAG_Rendering {

@ -1,5 +1,5 @@
<?php <?php
/* For licensing terms, see /chamilo_license.txt */ /* For licensing terms, see /license.txt */
/** /**
* Access_url_edit_session_to_url class * Access_url_edit_session_to_url class
* Contains several functions dealing with displaying, * Contains several functions dealing with displaying,
@ -9,11 +9,16 @@
* @author Toon Keppens <toon@vi-host.net> * @author Toon Keppens <toon@vi-host.net>
* @author Julio Montoya - Cleaning code * @author Julio Montoya - Cleaning code
* @author Ricardo Rodriguez - Separated the function and code * @author Ricardo Rodriguez - Separated the function and code
* * @package chamilo.include
*/
/**
* Code
*/ */
require_once ('xajax/xajax.inc.php'); require_once ('xajax/xajax.inc.php');
/**
* Class
* @package chamilo.include
*/
class Accessurleditsessionstourl { class Accessurleditsessionstourl {
function search_sessions($needle, $id) function search_sessions($needle, $id)

@ -9,12 +9,16 @@
* @author Toon Keppens <toon@vi-host.net> * @author Toon Keppens <toon@vi-host.net>
* @author Julio Montoya - Cleaning code * @author Julio Montoya - Cleaning code
* @author Ricardo Rodriguez - Separated the function and code * @author Ricardo Rodriguez - Separated the function and code
* * @package chamilo.library
*/
/**
* Code
*/ */
require_once ('xajax/xajax.inc.php'); require_once ('xajax/xajax.inc.php');
/**
* Class
* @package chamilo.library
*/
class Accessurledituserstourl{ class Accessurledituserstourl{
function search_users($needle, $id) function search_users($needle, $id)

@ -1,6 +1,5 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This is the course creation library for Chamilo. * This is the course creation library for Chamilo.
* Include/require it in your code for using its functionality. * Include/require it in your code for using its functionality.
@ -9,7 +8,9 @@
* @todo Clean up horrible structure, script is unwieldy, for example easier way to deal with * @todo Clean up horrible structure, script is unwieldy, for example easier way to deal with
* different tool visibility settings: ALL_TOOLS_INVISIBLE, ALL_TOOLS_VISIBLE, CORE_TOOLS_VISIBLE... * different tool visibility settings: ALL_TOOLS_INVISIBLE, ALL_TOOLS_VISIBLE, CORE_TOOLS_VISIBLE...
*/ */
/**
* Code
*/
require_once api_get_path(LIBRARY_PATH).'database.lib.php'; require_once api_get_path(LIBRARY_PATH).'database.lib.php';
require_once api_get_path(LIBRARY_PATH).'mail.lib.inc.php'; require_once api_get_path(LIBRARY_PATH).'mail.lib.inc.php';

@ -1,17 +1,15 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This file contains class used like library, provides functions for attendance tool. It's also used like model to attendance_controller (MVC pattern) * This file contains class used like library, provides functions for attendance tool. It's also used like model to attendance_controller (MVC pattern)
* @author Christian Fasanando <christian1827@gmail.com> * @author Christian Fasanando <christian1827@gmail.com>
* @author Julio Montoya <gugli100@gmail.com> improvements * @author Julio Montoya <gugli100@gmail.com> improvements
* @package chamilo.attendance * @package chamilo.attendance
*/ */
/** /**
* Attendance can be used to instanciate objects or as a library to manage attendances * Attendance can be used to instanciate objects or as a library to manage attendances
* @package chamilo.attendance
*/ */
class Attendance class Attendance
{ {
private $session_id; private $session_id;

@ -1,19 +1,18 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
//require_once(api_get_path(SYS_CODE_PATH).'inc/banner.inc.php'); ?? The banner.inc.php calls the banner.lib.php /**
* Code
* @package chamilo.include
*/
/** /**
* Determines the possible tabs (=sections) that are available. * Determines the possible tabs (=sections) that are available.
* This function is used when creating the tabs in the third header line and all the sections * This function is used when creating the tabs in the third header line and
* that do not appear there (as determined by the platform admin on the Dokeos configuration settings page) * all the sections that do not appear there (as determined by the
* platform admin on the Dokeos configuration settings page)
* will appear in the right hand menu that appears on several other pages * will appear in the right hand menu that appears on several other pages
*
* @return array containing all the possible tabs * @return array containing all the possible tabs
*
* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
*/ */
function get_tabs() { function get_tabs() {
global $_course; global $_course;

@ -1,6 +1,5 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* Blog class * Blog class
* Contains several functions dealing with displaying, * Contains several functions dealing with displaying,
@ -12,6 +11,10 @@
* @author Julio Montoya - Cleaning code * @author Julio Montoya - Cleaning code
* *
*/ */
/**
* Class
* @package chamilo.blogs
*/
class Blog { class Blog {
/** /**
* Get the title of a blog * Get the title of a blog

@ -16,6 +16,10 @@ define(COURSE_REQUEST_PENDING, 0);
define(COURSE_REQUEST_ACCEPTED, 1); define(COURSE_REQUEST_ACCEPTED, 1);
define(COURSE_REQUEST_REJECTED, 2); define(COURSE_REQUEST_REJECTED, 2);
/**
* Course request manager
* @package chamilo.library
*/
class CourseRequestManager { class CourseRequestManager {
/** /**

@ -1,21 +1,20 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This file contains a class used like library, provides functions for dashboard. * This file contains a class used like library, provides functions for dashboard.
* @author Christian Fasanando <christian1827@gmail.com> * @author Christian Fasanando <christian1827@gmail.com>
* @package chamilo.dashboard * @package chamilo.dashboard
*/ */
/**
* Code
*/
// required files // required files
require_once api_get_path(LIBRARY_PATH).'usermanager.lib.php'; require_once api_get_path(LIBRARY_PATH).'usermanager.lib.php';
/** /**
* DashboardManager can be used to manage dashboard * DashboardManager can be used to manage dashboard
* @package chamilo.dashboard * @package chamilo.dashboard
*/ */
class DashboardManager class DashboardManager {
{
/** /**
* contructor * contructor
*/ */
@ -533,6 +532,3 @@ class DashboardManager
} }
} }
?>

@ -5,6 +5,11 @@
* Include/require it in your code to use its functionality. * Include/require it in your code to use its functionality.
* @package chamilo.debug * @package chamilo.debug
*/ */
/**
* This is the debug library for Chamilo.
* Include/require it in your code to use its functionality.
* @package chamilo.debug
*/
class Debug { class Debug {
/** /**
* This function displays the contend of a variable, array or object in a nicely formatted way. * This function displays the contend of a variable, array or object in a nicely formatted way.

@ -9,7 +9,9 @@
* *
* @package chamilo.library * @package chamilo.library
*/ */
/**
* Code
*/
require_once api_get_path(LIBRARY_PATH).'course.lib.php'; require_once api_get_path(LIBRARY_PATH).'course.lib.php';
require_once api_get_path(LIBRARY_PATH).'usermanager.lib.php'; require_once api_get_path(LIBRARY_PATH).'usermanager.lib.php';
@ -24,7 +26,9 @@ if (empty($default_quota)) {
$default_quota = 100000000; $default_quota = 100000000;
} }
define('DEFAULT_DOCUMENT_QUOTA', $default_quota); define('DEFAULT_DOCUMENT_QUOTA', $default_quota);
/**
* @package chamilo.library
*/
class DocumentManager { class DocumentManager {
private function __construct() { private function __construct() {

@ -8,9 +8,14 @@
* *
* @package chamilo.library * @package chamilo.library
*/ */
/**
* Code
*/
require_once 'document.lib.php'; require_once 'document.lib.php';
/**
*
* @package chamilo.library
*/
class Export { class Export {
private function __construct() { private function __construct() {

@ -1,6 +1,5 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This is the file manage library for Chamilo. * This is the file manage library for Chamilo.
* Include/require it in your code to use its functionality. * Include/require it in your code to use its functionality.
@ -626,7 +625,7 @@ function mkdirs($path, $mode = '0770') {
* @param sting $path wanted path * @param sting $path wanted path
* @param boolean $verbose fix if comments must be printed * @param boolean $verbose fix if comments must be printed
* @param string $mode fix if chmod is same of parent or default (Note: This misterious parameter is not used). * @param string $mode fix if chmod is same of parent or default (Note: This misterious parameter is not used).
* @global string $langCreatedIn string to say "create in" * Note string $langCreatedIn string used to say "create in"
*/ */
function mkpath($path, $verbose = false, $mode = 'herit') { function mkpath($path, $verbose = false, $mode = 'herit') {
global $langCreatedIn, $_configuration; global $langCreatedIn, $_configuration;

@ -10,7 +10,9 @@
* @package chamilo.library * @package chamilo.library
* @todo test and reorganise * @todo test and reorganise
*/ */
/**
* Code
*/
require_once api_get_path(LIBRARY_PATH).'document.lib.php'; require_once api_get_path(LIBRARY_PATH).'document.lib.php';
/** /**
@ -342,7 +344,7 @@ function handle_uploaded_document($_course, $uploaded_file, $base_work_dir, $upl
/** /**
* Checks if there is enough place to add a file on a directory * Checks if there is enough place to add a file on a directory
* on the base of a maximum directory size allowed * on the base of a maximum directory size allowed
* @deprecated use enough_space instead! * deprecated: use enough_space instead!
* @author - Hugues Peeters <peeters@ipm.ucl.ac.be> * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
* @param - file_size (int) - size of the file in byte * @param - file_size (int) - size of the file in byte
* @param - dir (string) - Path of the directory * @param - dir (string) - Path of the directory
@ -928,7 +930,7 @@ function get_levels($filename) {
* *
* @author Olivier Cauberghe <olivier.cauberghe@ugent.be> * @author Olivier Cauberghe <olivier.cauberghe@ugent.be>
* @param path,filename * @param path,filename
* @action Adds an entry to the document table with the default settings. * action: Adds an entry to the document table with the default settings.
*/ */
function set_default_settings($upload_path, $filename, $filetype = 'file') { function set_default_settings($upload_path, $filename, $filetype = 'file') {
global $dbTable,$_configuration; global $dbTable,$_configuration;

@ -1,11 +1,14 @@
<?php <?php
/* For licensing terms, see /license.txt */
/** /**
* Author: Arnaud Ligot (CBlue SPRL) <arnaud@cblue.be> *
* @author: Arnaud Ligot (CBlue SPRL) <arnaud@cblue.be>
* @package chamilo.include.geometry
*/
/**
* Code
*/ */
DEFINE('DEBUG', false); DEFINE('DEBUG', false);
/** /**
* poly_init - build the array which will store the image of the polygone * poly_init - build the array which will store the image of the polygone
* *
@ -13,6 +16,7 @@ DEFINE('DEBUG', false);
* @param max[y] Y resolution * @param max[y] Y resolution
* *
* @returns an array such as: for all i in [0..max[x][ : for all j in [0..max[y][ : array[i][j] = FALSE * @returns an array such as: for all i in [0..max[x][ : for all j in [0..max[y][ : array[i][j] = FALSE
* @package chamilo.include.geometry
*/ */
function poly_init($max) { function poly_init($max) {
return array_fill(0, $max["x"]-1, return array_fill(0, $max["x"]-1,

@ -6,6 +6,9 @@
* @author Julio Montoya <gugli100@gmail.com> * @author Julio Montoya <gugli100@gmail.com>
* @package chamilo.library * @package chamilo.library
*/ */
/**
* Code
*/
// Group permissions // Group permissions
define('GROUP_PERMISSION_OPEN' , '1'); define('GROUP_PERMISSION_OPEN' , '1');
define('GROUP_PERMISSION_CLOSED', '2'); define('GROUP_PERMISSION_CLOSED', '2');
@ -25,9 +28,11 @@ define('GROUP_IMAGE_SIZE_MEDIUM', 3);
define('GROUP_IMAGE_SIZE_SMALL', 4); define('GROUP_IMAGE_SIZE_SMALL', 4);
define('GROUP_TITLE_LENGTH', 50); define('GROUP_TITLE_LENGTH', 50);
/**
class GroupPortalManager * Class
{ * @package chamilo.library
*/
class GroupPortalManager {
/** /**
* Creates a new group * Creates a new group
* *
@ -183,7 +188,6 @@ class GroupPortalManager
} }
/** Gets the inner join from users and group table /** Gets the inner join from users and group table
* @return int access url id
* @return array Database::store_result of the result * @return array Database::store_result of the result
* @author Julio Montoya * @author Julio Montoya
* */ * */
@ -221,8 +225,8 @@ class GroupPortalManager
} }
/** Gets the inner join of users and group table /** Gets the inner join of users and group table
* @return int quantity of records * @param int quantity of records
* @return bool show groups with image or not * @param bool show groups with image or not
* @return array with group content * @return array with group content
* @author Julio Montoya * @author Julio Montoya
* */ * */
@ -259,8 +263,8 @@ class GroupPortalManager
} }
/** Gets the last groups created /** Gets the last groups created
* @return int quantity of records * @param int quantity of records
* @return bool show groups with image or not * @param bool show groups with image or not
* @return array with group content * @return array with group content
* @author Julio Montoya * @author Julio Montoya
* */ * */

@ -1,6 +1,12 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
*
* @package chamilo.library
*/
/**
* Code
*/
require_once 'database.lib.php'; require_once 'database.lib.php';
require_once 'course.lib.php'; require_once 'course.lib.php';
require_once 'tablesort.lib.php'; require_once 'tablesort.lib.php';
@ -52,7 +58,7 @@ define("DEFAULT_GROUP_CATEGORY", 2);
/** /**
* This library contains some functions for group-management. * This library contains some functions for group-management.
* @author Bart Mollet * @author Bart Mollet
* @package dokeos.library * @package chamilo.library
* @todo Add $course_code parameter to all functions. So this GroupManager can * @todo Add $course_code parameter to all functions. So this GroupManager can
* be used outside a session. * be used outside a session.
*/ */

@ -1,15 +1,19 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This class provides a layer to manage images * This class provides a layer to manage images
* @author Julio Montoya <gugli100@gmail.com> * @author Julio Montoya <gugli100@gmail.com>
* @package chamilo.include.image
* @todo move in a DB configuration setting
*/
/**
* Code
*/ */
//@todo move in a DB configuration setting
define('IMAGE_PROCESSOR', 'gd'); // imagick or gd strings define('IMAGE_PROCESSOR', 'gd'); // imagick or gd strings
/**
* Image class
* @package chamilo.include.image
*/
class Image { class Image {
var $image_wrapper = null; var $image_wrapper = null;
@ -40,6 +44,10 @@ class Image {
} }
} }
/**
* Image wrapper class
* @package chamilo.include.image
*/
abstract class ImageWrapper { abstract class ImageWrapper {
var $debug = true; var $debug = true;
var $path; var $path;
@ -75,6 +83,7 @@ abstract class ImageWrapper {
* *
* @author jmontoya * @author jmontoya
* *
* @package chamilo.include.image
*/ */
class ImagickWrapper extends ImageWrapper { class ImagickWrapper extends ImageWrapper {
var $image; var $image;
@ -178,10 +187,8 @@ class ImagickWrapper extends ImageWrapper {
/** /**
* php-gd wrapper * php-gd wrapper
* * @package chamilo.include.image
*
*/ */
class GDWrapper extends ImageWrapper { class GDWrapper extends ImageWrapper {
var $bg; var $bg;

@ -1,6 +1,11 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
* @package chamilo.include.internationalization
*/
/**
* Code
*/
// See http://demo.icu-project.org/icu-bin/convexp // See http://demo.icu-project.org/icu-bin/convexp
return array( return array(

@ -1,6 +1,11 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
* @package chamilo.include.internationalization
*/
/**
* Code
*/
$_current_dir = str_replace('\\', '/', realpath(dirname(__FILE__))).'/'; $_current_dir = str_replace('\\', '/', realpath(dirname(__FILE__))).'/';
$_sys_code_path = str_replace('\\', '/', realpath($_current_dir.'../../../../')).'/'; $_sys_code_path = str_replace('\\', '/', realpath($_current_dir.'../../../../')).'/';

@ -1,6 +1,8 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
* @package chamilo.include.internationalization
*/
/** /**
* The following table contains two types of conventions concerning person names: * The following table contains two types of conventions concerning person names:
* *

@ -1,6 +1,9 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
* Code
* @package chamilo.include.internationalization
*/
/** /**
* Historical data about non UTF-8 encodings that might be used in Chamilo LMS. * Historical data about non UTF-8 encodings that might be used in Chamilo LMS.
* The following list may have some inconsistencies. * The following list may have some inconsistencies.

@ -1,6 +1,12 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
*
* @package chamilo.library
*/
/**
* Code
*/
require_once api_get_path(LIBRARY_PATH).'phpmailer/class.phpmailer.php'; require_once api_get_path(LIBRARY_PATH).'phpmailer/class.phpmailer.php';
require_once api_get_path(CONFIGURATION_PATH).'mail.conf.php'; require_once api_get_path(CONFIGURATION_PATH).'mail.conf.php';

@ -1,12 +1,15 @@
<?php <?php
/* For licensing terms, see /license.txt */
/** /**
This script is used by the mp3 player to see if it should start automatically or not * This script is used by the mp3 player to see if it should start
* automatically or not
* @package chamilo.include
*/
/**
* Code
*/ */
require ('../../global.inc.php'); require ('../../global.inc.php');
switch ($_SESSION['whereami']) {
switch($_SESSION['whereami'])
{
case 'lp/build' : case 'lp/build' :

@ -9,6 +9,9 @@
* @author Juan Carlos Raña Trabado * @author Juan Carlos Raña Trabado
* @since 5/mar/2011 * @since 5/mar/2011
*/ */
/**
* Code
*/
require_once '../../../inc/global.inc.php'; require_once '../../../inc/global.inc.php';
require_once api_get_path(LIBRARY_PATH).'fileUpload.lib.php'; require_once api_get_path(LIBRARY_PATH).'fileUpload.lib.php';

@ -1,12 +1,13 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This class provides methods for the Notification management. * This class provides methods for the Notification management.
* Include/require it in your code to use its features. * Include/require it in your code to use its features.
* @package chamilo.library * @package chamilo.library
*/ */
/**
* Code
*/
require_once 'model.lib.php'; require_once 'model.lib.php';
require_once 'usermanager.lib.php'; require_once 'usermanager.lib.php';
@ -35,7 +36,10 @@ define('NOTIFY_GROUP_NO', '0');
define('NOTIFICATION_TYPE_MESSAGE', 1); define('NOTIFICATION_TYPE_MESSAGE', 1);
define('NOTIFICATION_TYPE_INVITATION', 2); define('NOTIFICATION_TYPE_INVITATION', 2);
define('NOTIFICATION_TYPE_GROUP', 3); define('NOTIFICATION_TYPE_GROUP', 3);
/**
* Notification class
* @package chamilo.library
*/
class Notification extends Model { class Notification extends Model {
var $table; var $table;

@ -3,9 +3,14 @@
/** /**
* @package chamilo.library * @package chamilo.library
*/ */
/**
* Code
*/
define('_MPDF_PATH', api_get_path(LIBRARY_PATH).'mpdf/'); define('_MPDF_PATH', api_get_path(LIBRARY_PATH).'mpdf/');
require_once _MPDF_PATH.'mpdf.php'; require_once _MPDF_PATH.'mpdf.php';
/**
* @package chamilo.library
*/
class PDF { class PDF {
var $pdf; var $pdf;

@ -17,9 +17,13 @@
// +----------------------------------------------------------------------+ // +----------------------------------------------------------------------+
// //
// $Id: Compare.php 6184 2005-09-07 10:08:17Z bmol $ // $Id: Compare.php 6184 2005-09-07 10:08:17Z bmol $
/**
* @package chamilo.library
*/
/**
* Code
*/
require_once 'HTML/QuickForm/Rule.php'; require_once 'HTML/QuickForm/Rule.php';
/** /**
* Rule to compare two form fields * Rule to compare two form fields
* *

@ -1,29 +1,16 @@
<?php <?php
// $Id: Date.php 6187 2005-09-07 10:23:57Z bmol $ /* For licensing terms, see /license.txt */
/* /**
============================================================================== * QuickForm rule to check a date
Dokeos - elearning and course management software * @package chamilo.include
*/
Copyright (c) 2004-2005 Dokeos S.A. /**
Copyright (c) Bart Mollet, Hogeschool Gent * Code
For a full list of contributors, see "credits.txt".
The full license can be read in "license.txt".
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
See the GNU General Public License for more details.
Contact address: Dokeos, 44 rue des palais, B-1030 Brussels, Belgium
Mail: info@dokeos.com
==============================================================================
*/ */
require_once ('HTML/QuickForm/Rule.php'); require_once ('HTML/QuickForm/Rule.php');
/** /**
* QuickForm rule to check a date * QuickForm rule to check a date
* @package chamilo.include
*/ */
class Html_Quickform_Rule_Date extends HTML_QuickForm_Rule class Html_Quickform_Rule_Date extends HTML_QuickForm_Rule
{ {

@ -40,7 +40,9 @@
* @link http://pear.php.net/package/HTML_QuickForm_advmultiselect * @link http://pear.php.net/package/HTML_QuickForm_advmultiselect
* @since File available since Release 0.4.0 * @since File available since Release 0.4.0
*/ */
/**
* Code
*/
require_once 'HTML/QuickForm/select.php'; require_once 'HTML/QuickForm/select.php';
/** /**

@ -1,6 +1,5 @@
<?php <?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/** /**
* PEAR::HTML_Table makes the design of HTML tables easy, flexible, reusable and * PEAR::HTML_Table makes the design of HTML tables easy, flexible, reusable and
* efficient. * efficient.

@ -1,6 +1,5 @@
<?php <?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/** /**
* Contains the Pager_Common class * Contains the Pager_Common class
* *

@ -14,6 +14,7 @@
* @version CVS: $Id: Pager_savebc.php,v 1.3 2007/10/28 22:37:01 quipo Exp $ * @version CVS: $Id: Pager_savebc.php,v 1.3 2007/10/28 22:37:01 quipo Exp $
* @link http://pear.php.net/package/Pager * @link http://pear.php.net/package/Pager
*/ */
/**
* Code
*/
require_once 'Pager.php'; require_once 'Pager.php';
?>

@ -1,6 +1,5 @@
<?php <?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/** /**
* A class for reading Microsoft Excel Spreadsheets. * A class for reading Microsoft Excel Spreadsheets.
* *
@ -25,8 +24,9 @@
* @link http://pear.php.net/package/Spreadsheet_Excel_Reader * @link http://pear.php.net/package/Spreadsheet_Excel_Reader
* @see OLE, Spreadsheet_Excel_Writer * @see OLE, Spreadsheet_Excel_Writer
*/ */
/**
* Code
*/
//require_once 'PEAR.php'; //require_once 'PEAR.php';
require_once 'OLERead.inc'; require_once 'OLERead.inc';
//require_once 'OLE.php'; //require_once 'OLE.php';

@ -2,7 +2,10 @@
/* For licensing terms, see /dokeos_license.txt */ /* For licensing terms, see /dokeos_license.txt */
/* /*
* Script defining generic functions against a search engine api. Just only if one day the search engine changes * Script defining generic functions against a search engine api. Just only if one day the search engine changes
* @package: dokeos.search * @package: chamilo.include.search
*/
/**
* Code
*/ */
require 'xapian/XapianQuery.php'; require 'xapian/XapianQuery.php';

@ -1,6 +1,11 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
* @package chamilo.include.search
*/
/**
* Code
*/
// some constants to avoid serialize string keys on serialized data array // some constants to avoid serialize string keys on serialized data array
define('SE_COURSE_ID', 0); define('SE_COURSE_ID', 0);
define('SE_TOOL_ID', 1); define('SE_TOOL_ID', 1);
@ -14,7 +19,10 @@ define('SE_DOCTYPE_EXERCISE_QUESTION', 1);
// xapian prefixes // xapian prefixes
define('XAPIAN_PREFIX_COURSEID','C'); define('XAPIAN_PREFIX_COURSEID','C');
define('XAPIAN_PREFIX_TOOLID', 'O'); define('XAPIAN_PREFIX_TOOLID', 'O');
/**
* Class
* @package chamilo.include.search
*/
abstract class _IndexableChunk abstract class _IndexableChunk
{ {

@ -2,7 +2,10 @@
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* Search widget. Shows the search screen contents. * Search widget. Shows the search screen contents.
* @package chamilo.search * @package chamilo.include.search
*/
/**
* Code
*/ */
require_once dirname(__FILE__) . '/IndexableChunk.class.php'; require_once dirname(__FILE__) . '/IndexableChunk.class.php';
require_once api_get_path(LIBRARY_PATH).'specific_fields_manager.lib.php'; require_once api_get_path(LIBRARY_PATH).'specific_fields_manager.lib.php';

@ -1,9 +1,17 @@
<?php <?php
/* For licensing terms, see /license.txt */
/**
*
* @package chamilo.include.search
*/
/**
* Code
*/
include_once dirname(__FILE__) . '/../../../global.inc.php'; include_once dirname(__FILE__) . '/../../../global.inc.php';
require_once dirname(__FILE__) . '/search_processor.class.php'; require_once dirname(__FILE__) . '/search_processor.class.php';
/** /**
* Process documents before pass it to search listing scripts * Process documents before pass it to search listing scripts
* @package chamilo.include.search
*/ */
class document_processor extends search_processor { class document_processor extends search_processor {

@ -1,10 +1,19 @@
<?php <?php
/* For licensing terms, see /license.txt */
/**
*
* @package chamilo.include.search
*/
/**
* Code
*/
include_once dirname(__FILE__) . '/../../../global.inc.php'; include_once dirname(__FILE__) . '/../../../global.inc.php';
require_once dirname(__FILE__) . '/search_processor.class.php'; require_once dirname(__FILE__) . '/search_processor.class.php';
require_once dirname(__FILE__) . '/../IndexableChunk.class.php'; require_once dirname(__FILE__) . '/../IndexableChunk.class.php';
/** /**
* Process learning paths before pass it to search listing scripts * Process learning paths before pass it to search listing scripts
* @package chamilo.include.search
*/ */
class learnpath_processor extends search_processor { class learnpath_processor extends search_processor {
public $learnpaths = array(); public $learnpaths = array();

@ -1,9 +1,18 @@
<?php <?php
/* For licensing terms, see /license.txt */
/**
*
* @package chamilo.include.search
*/
/**
* Code
*/
include_once dirname(__FILE__) . '/../../../global.inc.php'; include_once dirname(__FILE__) . '/../../../global.inc.php';
require_once dirname(__FILE__) . '/search_processor.class.php'; require_once dirname(__FILE__) . '/search_processor.class.php';
/** /**
* Process links before pass it to search listing scripts * Process links before pass it to search listing scripts
* @package chamilo.include.search
*/ */
class link_processor extends search_processor { class link_processor extends search_processor {
public $links = array(); public $links = array();

@ -1,9 +1,18 @@
<?php <?php
/* For licensing terms, see /license.txt */
/**
*
* @package chamilo.include.search
*/
/**
* Code
*/
include_once dirname(__FILE__) . '/../../../global.inc.php'; include_once dirname(__FILE__) . '/../../../global.inc.php';
require_once dirname(__FILE__) . '/search_processor.class.php'; require_once dirname(__FILE__) . '/search_processor.class.php';
/** /**
* Process exercises before pass it to search listing scripts * Process exercises before pass it to search listing scripts
* @package chamilo.include.search
*/ */
class quiz_processor extends search_processor { class quiz_processor extends search_processor {
public $exercices = array(); public $exercices = array();

@ -1,5 +1,8 @@
<?php <?php
/* For licensing terms, see /license.txt */
/**
* @package chamilo.include.search
*/
/** /**
* Base class to make tool processors * Base class to make tool processors
* *
@ -10,6 +13,7 @@
* Classes that extends this one should be named like: TOOL_<toolname> on * Classes that extends this one should be named like: TOOL_<toolname> on
* TOOL_<toolname>.class.php * TOOL_<toolname>.class.php
* See lp_list_search for an example of calling the process. * See lp_list_search for an example of calling the process.
* @package chamilo.include.search
*/ */
abstract class search_processor { abstract class search_processor {
/** /**

@ -1,6 +1,12 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
*
* @package chamilo.include.search
*/
/**
* Code
*/
require_once 'xapian.php'; require_once 'xapian.php';
require_once dirname(__FILE__) . '/../IndexableChunk.class.php'; require_once dirname(__FILE__) . '/../IndexableChunk.class.php';

@ -1,5 +1,11 @@
<?php <?php
/* For licensing terms, see /dokeos_license.txt */ /* For licensing terms, see /dokeos_license.txt */
/**
* @package chamilo.include.search
*/
/**
* Code
*/
require_once 'xapian.php'; require_once 'xapian.php';
require_once dirname(__FILE__) . '/../IndexableChunk.class.php'; require_once dirname(__FILE__) . '/../IndexableChunk.class.php';
//TODO: think another way without including specific fields here //TODO: think another way without including specific fields here

@ -5,7 +5,9 @@
* All main sessions functions should be placed here. * All main sessions functions should be placed here.
* @package chamilo.library * @package chamilo.library
*/ */
/**
* Code
*/
/* LIBRARIES */ /* LIBRARIES */
require_once 'display.lib.php'; require_once 'display.lib.php';
require_once 'course.lib.php'; require_once 'course.lib.php';
@ -161,8 +163,10 @@ class SessionManager {
* Creates a new course code based in given code * Creates a new course code based in given code
* *
* @param string wanted code * @param string wanted code
* @example $wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3 * <code>
* $wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3
* if the course code doest not exist in the DB the same course code will be returned * if the course code doest not exist in the DB the same course code will be returned
* </code>
* @return string wanted unused code * @return string wanted unused code
*/ */
function generate_nice_next_session_name($session_name) { function generate_nice_next_session_name($session_name) {

@ -1,10 +1,14 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
* @package chamilo.library
*/
/**
* Code
*/
require_once 'pear/HTML/Table.php'; require_once 'pear/HTML/Table.php';
require_once 'pear/Pager/Pager.php'; require_once 'pear/Pager/Pager.php';
require_once 'tablesort.lib.php'; require_once 'tablesort.lib.php';
/** /**
* This class allows you to display a sortable data-table. It is possible to * This class allows you to display a sortable data-table. It is possible to
* split the data in several pages. * split the data in several pages.
@ -15,6 +19,7 @@ require_once 'tablesort.lib.php';
* - click on the table header to sort the data * - click on the table header to sort the data
* - choose how many items you see per page * - choose how many items you see per page
* - navigate through all data-pages * - navigate through all data-pages
* @package chamilo.library
*/ */
class SortableTable extends HTML_Table { class SortableTable extends HTML_Table {
/** /**
@ -837,6 +842,7 @@ class SortableTable extends HTML_Table {
/** /**
* Sortable table which can be used for data available in an array * Sortable table which can be used for data available in an array
* @package chamilo.library
*/ */
class SortableTableFromArray extends SortableTable { class SortableTableFromArray extends SortableTable {
/** /**
@ -886,6 +892,7 @@ class SortableTableFromArray extends SortableTable {
* $column_order is an array that lets us decide the ordering of the columns * $column_order is an array that lets us decide the ordering of the columns
* i.e: $column_header=array('a','b','c','d','e'); $column_order=array(1,2,5,4,5); * i.e: $column_header=array('a','b','c','d','e'); $column_order=array(1,2,5,4,5);
* These means that the 3th column (letter "c") will be sort like the order we use in the 5th column * These means that the 3th column (letter "c") will be sort like the order we use in the 5th column
* @package chamilo.library
*/ */
class SortableTableFromArrayConfig extends SortableTable { class SortableTableFromArrayConfig extends SortableTable {

@ -1,8 +1,11 @@
<?php <?php
/** /**
* Manage specific tools * Manage specific tools
* @package chamilo.library
*/
/**
* Code
*/ */
// Database table definitions // Database table definitions
$table_sf = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD); $table_sf = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD);
$table_sf_val = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES); $table_sf_val = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);

@ -1,15 +1,19 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This is a library with some functions to sort tabular data * This is a library with some functions to sort tabular data
* *
* @package chamilo.library * @package chamilo.library
*/ */
/**
* Code
*/
define('SORT_DATE', 3); define('SORT_DATE', 3);
define('SORT_IMAGE', 4); define('SORT_IMAGE', 4);
/**
* @package chamilo.library
*/
class TableSort { class TableSort {
/** /**

@ -1,6 +1,5 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This is the text library for Chamilo. * This is the text library for Chamilo.
* It is loaded during the global initialization, * It is loaded during the global initialization,
@ -8,10 +7,6 @@
* *
* @package chamilo.library * @package chamilo.library
*/ */
/* HTML processing functions */
/** /**
* This function strips all html-tags found in the input string and outputs a pure text. * This function strips all html-tags found in the input string and outputs a pure text.
* Mostly, the function is to be used before language or encoding detection of the input string. * Mostly, the function is to be used before language or encoding detection of the input string.

@ -7,9 +7,14 @@
* @package chamilo.library * @package chamilo.library
* @author Julio Montoya <gugli100@gmail.com> (Score average fixes) * @author Julio Montoya <gugli100@gmail.com> (Score average fixes)
*/ */
/**
* Code
*/
define('SESSION_LINK_TARGET','_self'); define('SESSION_LINK_TARGET','_self');
/**
* Class
* @package chamilo.library
*/
class Tracking { class Tracking {
/** /**
@ -2774,7 +2779,9 @@ class Tracking {
return $html; return $html;
} }
} }
/**
* @package chamilo.tracking
*/
class TrackingCourseLog { class TrackingCourseLog {
function count_item_resources() { function count_item_resources() {
@ -3314,7 +3321,9 @@ class TrackingCourseLog {
return $users; return $users;
} }
} }
/**
* @package chamilo.tracking
*/
class TrackingUserLog { class TrackingUserLog {
/** /**
@ -3685,11 +3694,10 @@ class TrackingUserLog {
"; ";
} }
} }
} }
/**
* @package chamilo.tracking
*/
class TrackingUserLogCSV { class TrackingUserLogCSV {
/** /**

@ -1,5 +1,10 @@
<?php <?php
/**
* @chamilo.library
*/
/**
* Code
*/
include(dirname(__FILE__).'/../global.inc.php'); include(dirname(__FILE__).'/../global.inc.php');
require_once api_get_path(LIBRARY_PATH).'xajax/xajax.inc.php'; require_once api_get_path(LIBRARY_PATH).'xajax/xajax.inc.php';
$xajax_upload = new Xajax(); $xajax_upload = new Xajax();

@ -3,11 +3,12 @@
/** /**
* This library provides functions for user management. * This library provides functions for user management.
* Include/require it in your code to use its functionality. * Include/require it in your code to use its functionality.
*
* @package chamilo.library * @package chamilo.library
* @author Julio Montoya <gugli100@gmail.com> Social network groups added 2009/12 * @author Julio Montoya <gugli100@gmail.com> Social network groups added 2009/12
*/ */
/**
* Code
*/
// Constants for user extra field types. // Constants for user extra field types.
define('USER_FIELD_TYPE_TEXT', 1); define('USER_FIELD_TYPE_TEXT', 1);
define('USER_FIELD_TYPE_TEXTAREA', 2); define('USER_FIELD_TYPE_TEXTAREA', 2);
@ -38,9 +39,11 @@ define('USER_RELATION_TYPE_GOODFRIEND', 4); // should be deprecated is useless
define('USER_RELATION_TYPE_ENEMY', 5); // should be deprecated is useless define('USER_RELATION_TYPE_ENEMY', 5); // should be deprecated is useless
define('USER_RELATION_TYPE_DELETED', 6); define('USER_RELATION_TYPE_DELETED', 6);
define('USER_RELATION_TYPE_RRHH', 7); define('USER_RELATION_TYPE_RRHH', 7);
/**
class UserManager * Class
{ * @package chamilo.include.user
*/
class UserManager {
private function __construct () { private function __construct () {
} }
@ -1341,11 +1344,11 @@ class UserManager
* and simply re-add them all then all the user who have already filled this form will loose their selected value. * and simply re-add them all then all the user who have already filled this form will loose their selected value.
* 3. we add the options that are newly added * 3. we add the options that are newly added
* *
* @example current options are a;b;c and the user changes this to a;b;x (removing c and adding x) * <code> current options are a;b;c and the user changes this to a;b;x (removing c and adding x)
* we first remove c (and also the entry in the option_value table for the users who have chosen this) * we first remove c (and also the entry in the option_value table for the users who have chosen this)
* we then add x * we then add x
* a and b are neither removed nor added * a and b are neither removed nor added
* * </code>
* @param integer $fieldid the id of the field we are editing * @param integer $fieldid the id of the field we are editing
* @param string $fieldvarname the internal variable name of the field * @param string $fieldvarname the internal variable name of the field
* @param int $fieldtype the type of the field * @param int $fieldtype the type of the field
@ -2140,7 +2143,7 @@ class UserManager
/** /**
* Gets the API key (or keys) and return them into an array * Gets the API key (or keys) and return them into an array
* @param int Optional user id (defaults to the result of api_get_user_id()) * @param int Optional user id (defaults to the result of api_get_user_id())
* @result array Non-indexed array containing the list of API keys for this user, or FALSE on error * @return array Non-indexed array containing the list of API keys for this user, or FALSE on error
*/ */
public static function get_api_keys($user_id = null, $api_service = 'dokeos') { public static function get_api_keys($user_id = null, $api_service = 'dokeos') {
if ($user_id != strval(intval($user_id))) return false; if ($user_id != strval(intval($user_id))) return false;

@ -1 +1,8 @@
<?php
/**
* placeholder
* @package chamilo.include
*/
/**
* Placeholder
*/

Loading…
Cancel
Save