From acdda13b77ebe52b00b9ae77e5a6c6d2f2c581a6 Mon Sep 17 00:00:00 2001 From: jmontoyaa Date: Wed, 19 Apr 2017 14:59:23 +0200 Subject: [PATCH] Minor - format code --- main/webservices/cm_soap.php | 145 +-- main/webservices/cm_soap_announcements.php | 56 +- main/webservices/cm_soap_course.php | 423 ++++---- main/webservices/cm_soap_courses.php | 50 +- main/webservices/cm_soap_forum.php | 218 ++-- main/webservices/cm_soap_inbox.php | 158 ++- main/webservices/cm_soap_user.php | 148 +-- main/webservices/cm_webservice_course.php | 1089 +++++++++++--------- main/webservices/cm_webservice_courses.php | 13 +- main/webservices/cm_webservice_forum.php | 138 +-- main/webservices/cm_webservice_inbox.php | 82 +- main/webservices/cm_webservice_user.php | 44 +- main/webservices/courses_list.rest.php | 89 +- main/webservices/courses_list.soap.php | 74 +- 14 files changed, 1428 insertions(+), 1299 deletions(-) diff --git a/main/webservices/cm_soap.php b/main/webservices/cm_soap.php index be109cb647..593db3bb89 100755 --- a/main/webservices/cm_soap.php +++ b/main/webservices/cm_soap.php @@ -10,101 +10,106 @@ $libpath = api_get_path(LIBRARY_PATH); /** * SOAP error handler. Handles an error sending a SOAP fault */ -class WSCMSoapErrorHandler implements WSCMErrorHandler { - /** - * Handles the error by sending a SOAP fault through the server - * - * @param WSError Error to handle - */ - public function handle($error) { - $server = WSCMSoapServer::singleton(); - $server->fault(strval($error->code), $error->message); - } +class WSCMSoapErrorHandler implements WSCMErrorHandler +{ + /** + * Handles the error by sending a SOAP fault through the server + * + * @param WSError Error to handle + */ + public function handle($error) + { + $server = WSCMSoapServer::singleton(); + $server->fault(strval($error->code), $error->message); + } } /** * SOAP server wrapper implementing a Singleton */ -class WSCMSoapServer { - /** - * SOAP server instance - * - * @var soap_server - */ - private static $_instance; +class WSCMSoapServer +{ + /** + * SOAP server instance + * + * @var soap_server + */ + private static $_instance; - /** - * Private constructor - */ - private function __construct() { - } + /** + * Private constructor + */ + public function __construct() + { + } - /** - * Singleton method - */ - public static function singleton() { - if (!isset(self::$_instance)) { - self::$_instance = new soap_server(); - // Set the error handler - WSCMError::setErrorHandler(new WSCMSoapErrorHandler()); - // Configure the service - self::$_instance->configureWSDL('WSCMService', 'urn:WSCMService'); - } + /** + * Singleton method + */ + public static function singleton() + { + if (!isset(self::$_instance)) { + self::$_instance = new soap_server(); + // Set the error handler + WSCMError::setErrorHandler(new WSCMSoapErrorHandler()); + // Configure the service + self::$_instance->configureWSDL('WSCMService', 'urn:WSCMService'); + } - return self::$_instance; - } + return self::$_instance; + } } $s = WSCMSoapServer::singleton(); $s->wsdl->addComplexType( - 'result', - 'complexType', - 'struct', - 'all', - '', - array( - 'code' => array('name' => 'code', 'type' => 'xsd:int'), - 'message' => array('name' => 'message', 'type' => 'xsd:string') - ) + 'result', + 'complexType', + 'struct', + 'all', + '', + array( + 'code' => array('name' => 'code', 'type' => 'xsd:int'), + 'message' => array('name' => 'message', 'type' => 'xsd:string') + ) ); $s->wsdl->addComplexType( - 'extra_field', - 'complexType', - 'struct', - 'all', - '', - array( - 'field_name' => array('name' => 'field_name', 'type' => 'xsd:string'), - 'field_value' => array('name' => 'field_value', 'type' => 'xsd:string') - ) + 'extra_field', + 'complexType', + 'struct', + 'all', + '', + array( + 'field_name' => array('name' => 'field_name', 'type' => 'xsd:string'), + 'field_value' => array('name' => 'field_value', 'type' => 'xsd:string') + ) ); $s->register( - 'WSCM.verifyUserPass', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - ), - array('return' => 'xsd:string') + 'WSCM.verifyUserPass', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + ), + array('return' => 'xsd:string') ); $s->register( - 'WSCM.encryptPass', - array('password' => 'xsd:string'), - array('return' => 'xsd:string') + 'WSCM.encryptPass', + array('password' => 'xsd:string'), + array('return' => 'xsd:string') ); $s->register( - 'WSCM.test', - array(), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - '' + 'WSCM.test', + array(), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + '' ); require_once __DIR__.'/cm_soap_inbox.php'; diff --git a/main/webservices/cm_soap_announcements.php b/main/webservices/cm_soap_announcements.php index acb083fde0..57892f0957 100755 --- a/main/webservices/cm_soap_announcements.php +++ b/main/webservices/cm_soap_announcements.php @@ -12,39 +12,37 @@ require_once __DIR__.'/cm_soap.php'; */ $s = WSCMSoapServer::singleton(); - - $s->register( - 'WSCMAnnouncements.get_announcements_id', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o ID dos anuncios visiveis a um usuario de uma disciplina.' - + 'WSCMAnnouncements.get_announcements_id', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o ID dos anuncios visiveis a um usuario de uma disciplina.' + ); $s->register( - 'WSCMAnnouncements.get_announcement_data', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string', - 'announcement_id' => 'xsd:string', - 'field' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o conteudo do campo informado de um anuncio de chave ID. Campos retornaveis: sender, date, title e content' + 'WSCMAnnouncements.get_announcement_data', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + 'announcement_id' => 'xsd:string', + 'field' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o conteudo do campo informado de um anuncio de chave ID. Campos retornaveis: sender, date, title e content' ); diff --git a/main/webservices/cm_soap_course.php b/main/webservices/cm_soap_course.php index 2f2d0f065a..381fe7f14c 100755 --- a/main/webservices/cm_soap_course.php +++ b/main/webservices/cm_soap_course.php @@ -13,283 +13,278 @@ require_once __DIR__.'/cm_soap.php'; $s = WSCMSoapServer::singleton(); $s->wsdl->addComplexType( - 'course_id', - 'complexType', - 'struct', - 'all', - '', - array( - 'course_id_field_name' => array('name' => 'course_id_field_name', 'type' => 'xsd:string'), - 'course_id_value' => array('name' => 'course_id_value', 'type' => 'xsd:string') - ) + 'course_id', + 'complexType', + 'struct', + 'all', + '', + array( + 'course_id_field_name' => array('name' => 'course_id_field_name', 'type' => 'xsd:string'), + 'course_id_value' => array('name' => 'course_id_value', 'type' => 'xsd:string') + ) ); $s->wsdl->addComplexType( - 'course_result', - 'complexType', - 'struct', - 'all', - '', - array( - 'course_id_value' => array('name' => 'course_id_value', 'type' => 'xsd:string'), - 'result' => array('name' => 'result', 'type' => 'tns:result') - ) + 'course_result', + 'complexType', + 'struct', + 'all', + '', + array( + 'course_id_value' => array('name' => 'course_id_value', 'type' => 'xsd:string'), + 'result' => array('name' => 'result', 'type' => 'tns:result') + ) ); $s->wsdl->addComplexType( - 'course_result_array', - 'complexType', - 'array', - '', - 'SOAP-ENC:Array', - array(), - array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:course_result[]')), - 'tns:course_result' + 'course_result_array', + 'complexType', + 'array', + '', + 'SOAP-ENC:Array', + array(), + array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:course_result[]')), + 'tns:course_result' ); $s->register( - 'WSCMCourse.DeleteCourse', - array('secret_key' => 'xsd:string', 'course_id_field_name' => 'xsd:string', 'course_id_value' => 'xsd:string') + 'WSCMCourse.DeleteCourse', + array('secret_key' => 'xsd:string', 'course_id_field_name' => 'xsd:string', 'course_id_value' => 'xsd:string') ); $s->register( - 'WSCMCourse.DeleteCourses', - array('secret_key' => 'xsd:string', 'courses' => 'tns:course_id[]'), - array('return' => 'tns:course_result_array') + 'WSCMCourse.DeleteCourses', + array('secret_key' => 'xsd:string', 'courses' => 'tns:course_id[]'), + array('return' => 'tns:course_result_array') ); $s->register( - 'WSCMCourse.CreateCourse', - array( - 'secret_key' => 'xsd:string', - 'title' => 'xsd:string', - 'category_code' => 'xsd:string', - 'wanted_code' => 'xsd:string', - 'tutor_name' => 'xsd:string', - 'course_admin_user_id_field_name' => 'xsd:string', - 'course_admin_user_id_value' => 'xsd:string', - 'language' => 'xsd:string', - 'course_id_field_name' => 'xsd:string', - 'course_id_value' => 'xsd:string', - 'extras' => 'tns:extra_field[]' - ), - array('return' => 'xsd:int') + 'WSCMCourse.CreateCourse', + array( + 'secret_key' => 'xsd:string', + 'title' => 'xsd:string', + 'category_code' => 'xsd:string', + 'wanted_code' => 'xsd:string', + 'tutor_name' => 'xsd:string', + 'course_admin_user_id_field_name' => 'xsd:string', + 'course_admin_user_id_value' => 'xsd:string', + 'language' => 'xsd:string', + 'course_id_field_name' => 'xsd:string', + 'course_id_value' => 'xsd:string', + 'extras' => 'tns:extra_field[]' + ), + array('return' => 'xsd:int') ); $s->wsdl->addComplexType( - 'course_create', - 'complexType', - 'struct', - 'all', - '', - array( - 'title' => array('name' => 'title', 'type' => 'xsd:string'), - 'category_code' => array('name' => 'category_code', 'type' => 'xsd:string'), - 'wanted_code' => array('name' => 'wanted_code', 'type' => 'xsd:int'), - 'tutor_name' => array('name' => 'tutor_name', 'type' => 'xsd:string'), - 'course_admin_user_id_field_name' => array('name' => 'course_admin_user_id_field_name', 'type' => 'xsd:string'), - 'course_admin_user_id_value' => array('name' => 'course_admin_user_id_value', 'type' => 'xsd:string'), - 'language' => array('name' => 'language', 'type' => 'xsd:string'), - 'course_id_field_name' => array('name' => 'course_id_field_name', 'type' => 'xsd:string'), - 'course_id_value' => array('name' => 'course_id_value', 'type' => 'xsd:string'), - 'extras' => array('name' => 'extras', 'type' => 'tns:extra_field[]') - ) + 'course_create', + 'complexType', + 'struct', + 'all', + '', + array( + 'title' => array('name' => 'title', 'type' => 'xsd:string'), + 'category_code' => array('name' => 'category_code', 'type' => 'xsd:string'), + 'wanted_code' => array('name' => 'wanted_code', 'type' => 'xsd:int'), + 'tutor_name' => array('name' => 'tutor_name', 'type' => 'xsd:string'), + 'course_admin_user_id_field_name' => array('name' => 'course_admin_user_id_field_name', 'type' => 'xsd:string'), + 'course_admin_user_id_value' => array('name' => 'course_admin_user_id_value', 'type' => 'xsd:string'), + 'language' => array('name' => 'language', 'type' => 'xsd:string'), + 'course_id_field_name' => array('name' => 'course_id_field_name', 'type' => 'xsd:string'), + 'course_id_value' => array('name' => 'course_id_value', 'type' => 'xsd:string'), + 'extras' => array('name' => 'extras', 'type' => 'tns:extra_field[]') + ) ); $s->wsdl->addComplexType( - 'course_create_result', - 'complexType', - 'struct', - 'all', - '', - array( - 'course_id_value' => array('name' => 'course_id_value', 'type' => 'xsd:string'), - 'course_id_generated' => array('name' => 'course_id_generated', 'type' => 'xsd:int'), - 'result' => array('name' => 'result', 'type' => 'tns:result') - ) + 'course_create_result', + 'complexType', + 'struct', + 'all', + '', + array( + 'course_id_value' => array('name' => 'course_id_value', 'type' => 'xsd:string'), + 'course_id_generated' => array('name' => 'course_id_generated', 'type' => 'xsd:int'), + 'result' => array('name' => 'result', 'type' => 'tns:result') + ) ); $s->wsdl->addComplexType( - 'course_create_result_array', - 'complexType', - 'array', - '', - 'SOAP-ENC:Array', - array(), - array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:course_create_result[]')), - 'tns:course_create_result' + 'course_create_result_array', + 'complexType', + 'array', + '', + 'SOAP-ENC:Array', + array(), + array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:course_create_result[]')), + 'tns:course_create_result' ); $s->register( - 'WSCMCourse.CreateCourses', - array( - 'secret_key' => 'xsd:string', - 'courses' => 'tns:course_create[]' - ), - array('return' => 'tns:course_create_result_array') + 'WSCMCourse.CreateCourses', + array( + 'secret_key' => 'xsd:string', + 'courses' => 'tns:course_create[]' + ), + array('return' => 'tns:course_create_result_array') ); $s->register( - 'WSCMCourse.EditCourse', - array( - 'secret_key' => 'xsd:string', - 'course_id_field_name' => 'xsd:string', - 'course_id_value' => 'xsd:string', - 'title' => 'xsd:string', - 'category_code' => 'xsd:string', - 'department_name' => 'xsd:string', - 'department_url' => 'xsd:string', - 'language' => 'xsd:string', - 'visibility' => 'xsd:int', - 'subscribe' => 'xsd:int', - 'unsubscribe' => 'xsd:int', - 'visual_code' => 'xsd:string', - 'extras' => 'tns:extra_field[]' - ) + 'WSCMCourse.EditCourse', + array( + 'secret_key' => 'xsd:string', + 'course_id_field_name' => 'xsd:string', + 'course_id_value' => 'xsd:string', + 'title' => 'xsd:string', + 'category_code' => 'xsd:string', + 'department_name' => 'xsd:string', + 'department_url' => 'xsd:string', + 'language' => 'xsd:string', + 'visibility' => 'xsd:int', + 'subscribe' => 'xsd:int', + 'unsubscribe' => 'xsd:int', + 'visual_code' => 'xsd:string', + 'extras' => 'tns:extra_field[]' + ) ); $s->wsdl->addComplexType( - 'course', - 'complexType', - 'struct', - 'all', - '', - array( - 'id' => array('name' => 'id', 'type' => 'xsd:int'), - 'code' => array('name' => 'code', 'type' => 'xsd:string'), - 'title' => array('name' => 'title', 'type' => 'xsd:string'), - 'language' => array('name' => 'language', 'type' => 'xsd:string'), - 'visibility' => array('name' => 'visibility', 'type' => 'xsd:int'), - 'category_name' => array('name' => 'category_name', 'type' => 'xsd:string'), - 'number_students' => array('name' => 'number_students', 'type' => 'xsd:int'), - 'external_course_id' => array('name' => 'external_course_id', 'type' => 'xsd:string'), - ) + 'course', + 'complexType', + 'struct', + 'all', + '', + array( + 'id' => array('name' => 'id', 'type' => 'xsd:int'), + 'code' => array('name' => 'code', 'type' => 'xsd:string'), + 'title' => array('name' => 'title', 'type' => 'xsd:string'), + 'language' => array('name' => 'language', 'type' => 'xsd:string'), + 'visibility' => array('name' => 'visibility', 'type' => 'xsd:int'), + 'category_name' => array('name' => 'category_name', 'type' => 'xsd:string'), + 'number_students' => array('name' => 'number_students', 'type' => 'xsd:int'), + 'external_course_id' => array('name' => 'external_course_id', 'type' => 'xsd:string'), + ) ); $s->wsdl->addComplexType( - 'course_array', - 'complexType', - 'array', - '', - 'SOAP-ENC:Array', - array(), - array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:course[]')), - 'tns:course' + 'course_array', + 'complexType', + 'array', + '', + 'SOAP-ENC:Array', + array(), + array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:course[]')), + 'tns:course' ); $s->register( - 'WSCMCourse.ListCourses', - array( - 'secret_key' => 'xsd:string', - 'course_id_field_name' => 'xsd:string' - ), - array('return' => 'tns:course_array') + 'WSCMCourse.ListCourses', + array( + 'secret_key' => 'xsd:string', + 'course_id_field_name' => 'xsd:string' + ), + array('return' => 'tns:course_array') ); $s->register( - 'WSCMCourse.SubscribeUserToCourse', - array( - 'secret_key' => 'xsd:string', - 'course_id_field_name' => 'xsd:string', - 'course_id_value' => 'xsd:string', - 'user_id_field_name' => 'xsd:string', - 'user_id_value' => 'xsd:string', - 'status' => 'xsd:int' - ) + 'WSCMCourse.SubscribeUserToCourse', + array( + 'secret_key' => 'xsd:string', + 'course_id_field_name' => 'xsd:string', + 'course_id_value' => 'xsd:string', + 'user_id_field_name' => 'xsd:string', + 'user_id_value' => 'xsd:string', + 'status' => 'xsd:int' + ) ); $s->register( - 'WSCMCourse.UnsubscribeUserFromCourse', - array( - 'secret_key' => 'xsd:string', - 'course_id_field_name' => 'xsd:string', - 'course_id_value' => 'xsd:string', - 'user_id_field_name' => 'xsd:string', - 'user_id_value' => 'xsd:string' - ) + 'WSCMCourse.UnsubscribeUserFromCourse', + array( + 'secret_key' => 'xsd:string', + 'course_id_field_name' => 'xsd:string', + 'course_id_value' => 'xsd:string', + 'user_id_field_name' => 'xsd:string', + 'user_id_value' => 'xsd:string' + ) ); $s->wsdl->addComplexType( - 'course_description', - 'complexType', - 'struct', - 'all', - '', - array( - 'course_desc_id' => array('name' => 'course_desc_id', 'type' => 'xsd:int'), - 'course_desc_title' => array('name' => 'course_desc_title', 'type' => 'xsd:string'), - 'course_desc_content' => array('name' => 'course_desc_content', 'type' => 'xsd:string') - ) + 'course_description', + 'complexType', + 'struct', + 'all', + '', + array( + 'course_desc_id' => array('name' => 'course_desc_id', 'type' => 'xsd:int'), + 'course_desc_title' => array('name' => 'course_desc_title', 'type' => 'xsd:string'), + 'course_desc_content' => array('name' => 'course_desc_content', 'type' => 'xsd:string') + ) ); $s->wsdl->addComplexType( - 'course_description_array', - 'complexType', - 'array', - '', - 'SOAP-ENC:Array', - array(), - array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:course_description[]')), - 'tns:course_description' + 'course_description_array', + 'complexType', + 'array', + '', + 'SOAP-ENC:Array', + array(), + array(array('ref'=>'SOAP-ENC:arrayType', 'wsdl:arrayType' => 'tns:course_description[]')), + 'tns:course_description' ); $s->register( - 'WSCMCourse.GetCourseDescriptions', - array( - 'secret_key' => 'xsd:string', - 'course_id_field_name' => 'xsd:string', - 'course_id_value' => 'xsd:string' - ), - array('return' => 'tns:course_description_array') + 'WSCMCourse.GetCourseDescriptions', + array( + 'secret_key' => 'xsd:string', + 'course_id_field_name' => 'xsd:string', + 'course_id_value' => 'xsd:string' + ), + array('return' => 'tns:course_description_array') ); $s->register( - 'WSCMCourse.EditCourseDescription', - array( - 'secret_key' => 'xsd:string', - 'course_id_field_name' => 'xsd:string', - 'course_id_value' => 'xsd:string', - 'course_desc_id' => 'xsd:int', - 'course_desc_title' => 'xsd:string', - 'course_desc_content' => 'xsd:string' - ) + 'WSCMCourse.EditCourseDescription', + array( + 'secret_key' => 'xsd:string', + 'course_id_field_name' => 'xsd:string', + 'course_id_value' => 'xsd:string', + 'course_desc_id' => 'xsd:int', + 'course_desc_title' => 'xsd:string', + 'course_desc_content' => 'xsd:string' + ) ); $s->register( - 'WSCMCourse.unreadMessage', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna a quantidade de mensagens nao lidas na caixa de entrada do usuario.' - + 'WSCMCourse.unreadMessage', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna a quantidade de mensagens nao lidas na caixa de entrada do usuario.' ); - $s->register( - 'WSCMCourse.getIdMessage', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o ID das mensagens.' - + 'WSCMCourse.getIdMessage', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o ID das mensagens.' ); - $s->register( - 'WSCMCourse.nada', - array('username' => 'xsd:string', 'password' => 'xsd:string'), - array('return' => 'xsd:string') - ); - + 'WSCMCourse.nada', + array('username' => 'xsd:string', 'password' => 'xsd:string'), + array('return' => 'xsd:string') +); diff --git a/main/webservices/cm_soap_courses.php b/main/webservices/cm_soap_courses.php index 49c075ef82..911fd2cbce 100755 --- a/main/webservices/cm_soap_courses.php +++ b/main/webservices/cm_soap_courses.php @@ -12,36 +12,34 @@ require_once __DIR__.'/cm_soap.php'; */ $s = WSCMSoapServer::singleton(); - - $s->register( - 'WSCMCourses.get_courses_code', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o CODE dos cursos do username.' - + 'WSCMCourses.get_courses_code', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o CODE dos cursos do username.' + ); $s->register( - 'WSCMCourses.get_course_title', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string', - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o titulo/nome do curso de course_code informado' + 'WSCMCourses.get_course_title', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o titulo/nome do curso de course_code informado' ); diff --git a/main/webservices/cm_soap_forum.php b/main/webservices/cm_soap_forum.php index c7d68b6d31..62b1837fd1 100755 --- a/main/webservices/cm_soap_forum.php +++ b/main/webservices/cm_soap_forum.php @@ -12,138 +12,136 @@ require_once __DIR__.'/cm_soap.php'; */ $s = WSCMSoapServer::singleton(); - - $s->register( - 'WSCMForum.get_foruns_id', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o ID dos foruns de uma disciplina.' + 'WSCMForum.get_foruns_id', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o ID dos foruns de uma disciplina.' ); $s->register( - 'WSCMForum.get_forum_title', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string', - 'forum_id' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o valor do titulo de um forum_id.' + 'WSCMForum.get_forum_title', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + 'forum_id' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o valor do titulo de um forum_id.' ); $s->register( - 'WSCMForum.get_forum_threads_id', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string', - 'forum_id' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o ID das threads de um forum_id.' + 'WSCMForum.get_forum_threads_id', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + 'forum_id' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o ID das threads de um forum_id.' ); $s->register( - 'WSCMForum.get_forum_thread_data', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string', - 'thread_id' => 'xsd:string', - 'field' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o campo field de um thread_id. Campos possiveis: title, date, sender, sender_name.' + 'WSCMForum.get_forum_thread_data', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + 'thread_id' => 'xsd:string', + 'field' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o campo field de um thread_id. Campos possiveis: title, date, sender, sender_name.' ); $s->register( - 'WSCMForum.get_forum_thread_title', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string', - 'thread_id' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o campo title de uma thread_id.' + 'WSCMForum.get_forum_thread_title', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + 'thread_id' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o campo title de uma thread_id.' ); $s->register( - 'WSCMForum.get_posts_id', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string', - 'thread_id' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o ID dos posts de uma thread.' + 'WSCMForum.get_posts_id', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + 'thread_id' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o ID dos posts de uma thread.' ); $s->register( - 'WSCMForum.get_post_data', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string', - 'post_id' => 'xsd:string', - 'field' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o campo field de um post_id. Campos possiveis: title, text, date, sender ou sender_name.' + 'WSCMForum.get_post_data', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + 'post_id' => 'xsd:string', + 'field' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o campo field de um post_id. Campos possiveis: title, text, date, sender ou sender_name.' ); $s->register( - 'WSCMForum.send_post', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'course_code' => 'xsd:string', - 'forum_id' => 'xsd:string', - 'thread_id' => 'xsd:string', - 'title' => 'xsd:string', - 'content' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Envia um novo post ao forum_id.' + 'WSCMForum.send_post', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'course_code' => 'xsd:string', + 'forum_id' => 'xsd:string', + 'thread_id' => 'xsd:string', + 'title' => 'xsd:string', + 'content' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Envia um novo post ao forum_id.' ); diff --git a/main/webservices/cm_soap_inbox.php b/main/webservices/cm_soap_inbox.php index d089eb4e23..8eb4f260a5 100755 --- a/main/webservices/cm_soap_inbox.php +++ b/main/webservices/cm_soap_inbox.php @@ -12,106 +12,104 @@ require_once __DIR__.'/cm_soap.php'; */ $s = WSCMSoapServer::singleton(); - - $s->register( - 'WSCMInbox.unreadMessage', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna a quantidade de mensagens nao lidas na caixa de entrada do usuario.' - + 'WSCMInbox.unreadMessage', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna a quantidade de mensagens nao lidas na caixa de entrada do usuario.' + ); $s->register( - 'WSCMInbox.get_message_id', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'from' => 'xsd:string', - 'number_of_items' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o ID das mensagens de entrada entre o intervalo de from até number_of_items.' + 'WSCMInbox.get_message_id', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'from' => 'xsd:string', + 'number_of_items' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o ID das mensagens de entrada entre o intervalo de from até number_of_items.' ); $s->register( - 'WSCMInbox.get_message_data', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'id' => 'xsd:string', - 'field' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o conteudo do campo informado em field da mensagem de entrada id. Os campos retornados sao: sender, title, date, status e content.' + 'WSCMInbox.get_message_data', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'id' => 'xsd:string', + 'field' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o conteudo do campo informado em field da mensagem de entrada id. Os campos retornados sao: sender, title, date, status e content.' ); $s->register( - 'WSCMInbox.get_message_id_sent', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'from' => 'xsd:string', - 'number_of_items' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o ID das mensagens de saida entre o intervalo de from até number_of_items.' + 'WSCMInbox.get_message_id_sent', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'from' => 'xsd:string', + 'number_of_items' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o ID das mensagens de saida entre o intervalo de from até number_of_items.' ); $s->register( - 'WSCMInbox.get_message_data_sent', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'id' => 'xsd:string', - 'field' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o conteudo do campo informado em field da mensagem de saida id. Os campos retornados sao: sender, title, date, status e content.' + 'WSCMInbox.get_message_data_sent', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'id' => 'xsd:string', + 'field' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o conteudo do campo informado em field da mensagem de saida id. Os campos retornados sao: sender, title, date, status e content.' ); $s->register( - 'WSCMInbox.message_send', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'receiver_user_id' => 'xsd:string', - 'subject' => 'xsd:string', - 'content' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Envia uma mensagem via rede social. Retorna o id da mensagem enviada.' + 'WSCMInbox.message_send', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'receiver_user_id' => 'xsd:string', + 'subject' => 'xsd:string', + 'content' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Envia uma mensagem via rede social. Retorna o id da mensagem enviada.' ); diff --git a/main/webservices/cm_soap_user.php b/main/webservices/cm_soap_user.php index 569e09a9ad..fd7b7c5be8 100755 --- a/main/webservices/cm_soap_user.php +++ b/main/webservices/cm_soap_user.php @@ -13,93 +13,93 @@ require_once __DIR__.'/cm_soap.php'; $s = WSCMSoapServer::singleton(); $s->register( - 'WSCMUser.find_id_user', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'name' => 'xsd:string', - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o id de um usuario que contenha o parametro \'nome\' nos campos nome, sobrenome ou email (ordenado por nome).' + 'WSCMUser.find_id_user', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'name' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o id de um usuario que contenha o parametro \'nome\' nos campos nome, sobrenome ou email (ordenado por nome).' ); $s->register( - 'WSCMUser.get_user_name', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'id' => 'xsd:string', - 'field' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o primeiro, ultimo ou os dois nomes de um usuarios. No campo field deve ser informado firstname, lastname, bothfl (para fistname lastname) ou bothlf (para lastname firstname)' + 'WSCMUser.get_user_name', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'id' => 'xsd:string', + 'field' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o primeiro, ultimo ou os dois nomes de um usuarios. No campo field deve ser informado firstname, lastname, bothfl (para fistname lastname) ou bothlf (para lastname firstname)' ); $s->register( - 'WSCMUser.get_link_user_picture', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'id' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Retorna o link para a imagem do perfil do usuario.' + 'WSCMUser.get_link_user_picture', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'id' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Retorna o link para a imagem do perfil do usuario.' ); $s->register( - 'WSCMUser.send_invitation', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'userfriend_id' => 'xsd:string', - 'content_message' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Envia um convite para estabelecer amizado no portal. O campo userfriend_id o id do possivel amigo e o campo content_message e a mensagem de solicitacao.' + 'WSCMUser.send_invitation', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'userfriend_id' => 'xsd:string', + 'content_message' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Envia um convite para estabelecer amizado no portal. O campo userfriend_id o id do possivel amigo e o campo content_message e a mensagem de solicitacao.' ); $s->register( - 'WSCMUser.accept_friend', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'userfriend_id' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Aceita o convite realizado pelo userfriend_id.' + 'WSCMUser.accept_friend', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'userfriend_id' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Aceita o convite realizado pelo userfriend_id.' ); $s->register( - 'WSCMUser.denied_invitation', - array( - 'username' => 'xsd:string', - 'password' => 'xsd:string', - 'userfriend_id' => 'xsd:string' - ), - array('return' => 'xsd:string'), - 'urn:WSCMService', - '', - '', - '', - 'Recusa o contive de amizade feito pelo usuario userfriend_id.' + 'WSCMUser.denied_invitation', + array( + 'username' => 'xsd:string', + 'password' => 'xsd:string', + 'userfriend_id' => 'xsd:string', + ), + array('return' => 'xsd:string'), + 'urn:WSCMService', + '', + '', + '', + 'Recusa o contive de amizade feito pelo usuario userfriend_id.' ); diff --git a/main/webservices/cm_webservice_course.php b/main/webservices/cm_webservice_course.php index b292e54f19..c0b2d8416a 100755 --- a/main/webservices/cm_webservice_course.php +++ b/main/webservices/cm_webservice_course.php @@ -13,521 +13,588 @@ require_once __DIR__.'/cm_webservice.php'; */ class WSCMCourse extends WSCM { - /** - * Deletes a course (helper method) - * - * @param string Course id field name - * @param string Course id value - * @return mixed True if the course was successfully deleted, WSError otherwise - */ - protected function deleteCourseHelper($course_id_field_name, $course_id_value) { - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); - if ($course_id instanceof WSCMError) { - return $course_id; - } else { - $course_code = CourseManager::get_course_code_from_course_id($course_id); - CourseManager::delete_course($course_code); - return true; - } - } - - /** - * Deletes a course - * - * @param string API secret key - * @param string Course id field name - * @param string Course id value - */ - public function DeleteCourse($secret_key, $course_id_field_name, $course_id_value) { - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSError) { - $this->handleError($verifKey); - } else { - $result = $this->deleteCourseHelper($course_id_field_name, $course_id_value); - if ($result instanceof WSError) { - $this->handleError($result); - } - } - } - - /** - * Deletes multiple courses - * - * @param string API secret key - * @param array Array of courses with elements of the form array('course_id_field_name' => 'name_of_field', 'course_id_value' => 'value') - * @return array Array with elements like array('course_id_value' => 'value', 'result' => array('code' => 0, 'message' => 'Operation was successful')). Note that if the result array contains a code different - * than 0, an error occured - */ - public function DeleteCourses($secret_key, $courses) { - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSError) { - $this->handleError($verifKey); - } else { - $results = array(); - foreach ($courses as $course) { - $result_tmp = array(); - $result_op = $this->deleteCourseHelper($course['course_id_field_name'], $course['course_id_value']); - $result_tmp['course_id_value'] = $course['course_id_value']; - if ($result_op instanceof WSCMError) { - // Return the error in the results - $result_tmp['result'] = $result_op->toArray(); - } else { - $result_tmp['result'] = $this->getSuccessfulResult(); - } - $results[] = $result_tmp; - } - return $results; - } - } - - /** - * Creates a course (helper method) - * - * @param string Title - * @param string Category code - * @param string Wanted code. If it's not defined, it will be generated automatically - * @param string Tutor name - * @param string Course admin user id field name - * @param string Course admin user id value - * @param string Course language - * @param string Course id field name - * @param string Course id value - * @param array Course extra fields - * @return mixed Generated id if creation was successful, WSError otherwise - */ - protected function createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras) { - // Add the original course id field name and value to the extra fields if needed - $extras_associative = array(); - if ($course_id_field_name != "chamilo_course_id") { - $extras_associative[$course_id_field_name] = $course_id_value; - } - foreach ($extras as $extra) { - $extras_associative[$extra['field_name']] = $extra['field_value']; - } - $course_admin_id = $this->getUserId($course_admin_user_id_field_name, $course_admin_user_id_value); - if ($course_admin_id instanceof WSError) { - return $course_admin_id; - } - if ($wanted_code == '') { - $wanted_code = CourseManager::generate_course_code($title); - } - $result = create_course($wanted_code, $title, $tutor_name, $category_code, $language, $course_admin_id, $this->_configuration['db_prefix'], 0); - if (!$result) { - return new WSError(202, 'There was an error creating the course'); - } else { - // Update extra fields - foreach ($extras_associative as $fname => $fvalue) { - CourseManager::update_course_extra_field_value($result, $fname, $fvalue); - } - // Get course id - $course_info = CourseManager::get_course_information($result); - return $course_info['real_id']; - } - } - - /** - * Creates a course - * - * @param string API secret key - * @param string Title - * @param string Category code - * @param string Wanted code. If it's not defined, it will be generated automatically - * @param string Tutor name - * @param string Course admin user id field name - * @param string Course admin user id value - * @param string Course language - * @param string Course id field name - * @param string Course id value - * @param array Course extra fields - * @return int Course id generated - */ - public function CreateCourse($secret_key, $title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras) { - // First, verify the secret key - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSError) { - $this->handleError($verifKey); - } else { - $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras); - if ($result instanceof WSError) { - $this->handleError($result); - } else { - return $result; - } - } - } - - /** - * Create multiple courses - * - * @param string API secret key - * @param array Courses to be created, with elements following the structure presented in CreateCourse - * @return array Array with elements of the form array('course_id_value' => 'original value sent', 'course_id_generated' => 'value_generated', 'result' => array('code' => 0, 'message' => 'Operation was successful')) - */ - public function CreateCourses($secret_key, $courses) { - // First, verify the secret key - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSCMError) { - $this->handleError($verifKey); - } else { - $results = array(); - foreach ($courses as $course) { - $result_tmp = array(); - //reinitialize variables just in case - $title = $category_code = $wanted_code = $tutor_name = $course_admin_user_id_field_name = $course_admin_user_id_value = $language = $course_id_field_name = $course_id_value = $extras = null; - extract($course); - $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras); - if ($result instanceof WSCMError) { - $result_tmp['result'] = $result->toArray(); - $result_tmp['course_id_value'] = $course_id_value; - $result_tmp['course_id_generated'] = 0; - } else { - $result_tmp['result'] = $this->getSuccessfulResult(); - $result_tmp['course_id_value'] = $course_id_value; - $result_tmp['course_id_generated'] = $result; - } - $results[] = $result_tmp; - } - return $results; - } - } - - /** - * Edits a course (helper method) - * - * @param string Course id field name - * @param string Course id value - * @param string Title - * @param string Category code - * @param string Department name - * @param string Department url - * @param string Course language - * @param int Visibility - * @param int Subscribe (0 = denied, 1 = allowed) - * @param int Unsubscribe (0 = denied, 1 = allowed) - * @param string Visual code - * @param array Course extra fields - * @return mixed True in case of success, WSError otherwise - */ - protected function editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras) { - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); - if ($course_id instanceof WSCMError) { - return $course_id; - } else { - $attributes = array(); - if (!empty($title)) { - $attributes['title'] = $title; - } - if (!empty($category_code)) { - $attributes['category_code'] = $category_code; - } - if (!empty($department_name)) { - $attributes['department_name'] = $department_name; - } - if (!empty($department_url)) { - $attributes['department_url'] = $department_url; - } - if (!empty($language)) { - $attributes['course_language'] = $language; - } - if ($visibility != '') { - $attributes['visibility'] = (int) $visibility; - } - if ($subscribe != '') { - $attributes['subscribe'] = (int) $subscribe; - } - if ($unsubscribe != '') { - $attributes['unsubscribe'] = (int) $unsubscribe; - } - if (!empty($visual_code)) { - $attributes['visual_code'] = $visual_code; - } - if (!empty($attributes)) { - CourseManager::update_attributes($course_id, $attributes); - } - if (!empty($extras)) { - $course_code = CourseManager::get_course_code_from_course_id($course_id); - $extras_associative = array(); - foreach ($extras as $extra) { - $extras_associative[$extra['field_name']] = $extra['field_value']; - } - foreach ($extras_associative as $fname => $fvalue) { - CourseManager::update_extra_field_value($course_code, $fname, $fvalue); - } - } - return true; - } - } - - /** - * Edits a course - * - * @param string API secret key - * @param string Course id field name - * @param string Course id value - * @param string Title - * @param string Category code - * @param string Department name - * @param string Department url - * @param string Course language - * @param int Visibility - * @param int Subscribe (0 = denied, 1 = allowed) - * @param int Unsubscribe (0 = denied, 1 = allowed) - * @param string Visual code - * @param array Course extra fields - */ - public function EditCourse($secret_key, $course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras) { - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSCMError) { - $this->handleError($verifKey); - } else { - $result = $this->editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras); - if ($result instanceof WSCMError) { - $this->handleError($result); - } - } - } - - /** - * List courses - * - * @param string API secret key - * @param string Course id field name. Use "chamilo_course_id" to use internal id - * @return array An array with elements of the form ('id' => 'Course internal id', 'code' => 'Course code', 'title' => 'Course title', 'language' => 'Course language', 'visibility' => 'Course visibility', - * 'category_name' => 'Name of the category of the course', 'number_students' => 'Number of students in the course', 'external_course_id' => 'External course id') - */ - public function ListCourses($secret_key, $course_id_field_name) { - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSError) { - $this->handleError($verifKey); - } else { - $courses_result = array(); - $category_names = array(); - - $courses = CourseManager::get_courses_list(); - foreach ($courses as $course) { - $course_tmp = array(); - $course_tmp['id'] = $course['id']; - $course_tmp['code'] = $course['code']; - $course_tmp['title'] = $course['title']; - $course_tmp['language'] = $course['course_language']; - $course_tmp['visibility'] = $course['visibility']; - - // Determining category name - if ($category_names[$course['category_code']]) { - $course_tmp['category_name'] = $category_names[$course['category_code']]; - } else { - $category = CourseManager::get_course_category($course['category_code']); - $category_names[$course['category_code']] = $category['name']; - $course_tmp['category_name'] = $category['name']; - } - - // Determining number of students registered in course - $user_list = CourseManager::get_user_list_from_course_code($course['code']); - $course_tmp['number_students'] = count($user_list); - - // Determining external course id - $course_tmp['external_course_id'] = CourseManager::get_course_extra_field_value($course_id_field_name, $course['code']); - - - $courses_result[] = $course_tmp; - } - - return $courses_result; - } - } - - /** - * Subscribe or unsubscribe user to a course (helper method) - * - * @param string Course id field name. Use "chamilo_course_id" to use internal id - * @param string Course id value. - * @param string User id field name. Use "chamilo_user_id" to use internal id - * @param string User id value - * @param int Set to 1 to subscribe, 0 to unsubscribe - * @param int Status (STUDENT or TEACHER) Used for subscription only - * @return mixed True if subscription or unsubscription was successful, false otherwise - */ - protected function changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $state, $status = STUDENT) { - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); - if ($course_id instanceof WSError) { - return $course_id; - } else { - $user_id = $this->getUserId($user_id_field_name, $user_id_value); - if ($user_id instanceof WSError) { - return $user_id; - } else { - $course_code = CourseManager::get_course_code_from_course_id($course_id); - if ($state == 0) { - // Unsubscribe user - CourseManager::unsubscribe_user($user_id, $course_code); - return true; - } else { - // Subscribe user - if (CourseManager::subscribe_user($user_id, $course_code, $status)) { - return true; - } else { - return new WSError(203, 'An error occured subscribing to this course'); - } - } - } - } - } - - /** - * Subscribe user to a course - * - * @param string API secret key - * @param string Course id field name. Use "chamilo_course_id" to use internal id - * @param string Course id value. - * @param string User id field name. Use "chamilo_user_id" to use internal id - * @param string User id value - * @param int Status (1 = Teacher, 5 = Student) - */ - public function SubscribeUserToCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $status) { - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSError) { - $this->handleError($verifKey); - } else { - $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 1, $status); - if ($result instanceof WSError) { - $this->handleError($result); - } - } - } - - /** - * Unsusbscribe user from course - * - * @param string API secret key - * @param string Course id field name. Use "chamilo_course_id" to use internal id - * @param string Course id value. - * @param string User id field name. Use "chamilo_user_id" to use internal id - * @param string User id value - */ - public function UnsubscribeUserFromCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value) { - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSError) { - $this->handleError($verifKey); - } else { - $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 0); - if ($result instanceof WSError) { - $this->handleError($result); - } - } - } - - /** - * Returns the descriptions of a course, along with their id - * - * @param string API secret key - * @param string Course id field name - * @param string Course id value - * @return array Returns an array with elements of the form ('course_desc_id' => 1, 'course_desc_title' => 'Title', 'course_desc_content' => 'Content') - */ - public function GetCourseDescriptions($secret_key, $course_id_field_name, $course_id_value) { - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSError) { - $this->handleError($verifKey); - } else { - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); - if ($course_id instanceof WSError) { - return $course_id; - } else { - // Course exists, get its descriptions - $descriptions = CourseDescription::get_descriptions($course_id); - $results = array(); - foreach ($descriptions as $description) { - $results[] = array('course_desc_id' => $description->get_description_type(), - 'course_desc_title' => $description->get_title(), - 'course_desc_content' => $description->get_content()); - } - return $results; - } - } - } - - - /** - * Edit course description - * - * @param string API secret key - * @param string Course id field name - * @param string Course id value - * @param int Category id from course description - * @param string Description title - * @param string Course description content - */ - public function EditCourseDescription($secret_key, $course_id_field_name, $course_id_value, $course_desc_id, $course_desc_title, $course_desc_content) { - $verifKey = $this->verifyKey($secret_key); - if ($verifKey instanceof WSError) { - $this->handleError($verifKey); - } else { - $course_id = $this->getCourseId($course_id_field_name, $course_id_value); - if ($course_id instanceof WSError) { - return $course_id; - } else { - // Create the new course description - $cd = new CourseDescription(); - $cd->set_description_type($course_desc_id); - $cd->set_title($course_desc_title); - $cd->set_content($course_desc_content); - $cd->set_session_id(0); - - // Get course info + /** + * Deletes a course (helper method) + * + * @param string Course id field name + * @param string Course id value + * @return mixed True if the course was successfully deleted, WSError otherwise + */ + protected function deleteCourseHelper( + $course_id_field_name, + $course_id_value + ) { + $course_id = $this->getCourseId( + $course_id_field_name, + $course_id_value + ); + if ($course_id instanceof WSCMError) { + return $course_id; + } else { + $course_code = CourseManager::get_course_code_from_course_id( + $course_id + ); + CourseManager::delete_course($course_code); + + return true; + } + } + + /** + * Deletes a course + * + * @param string API secret key + * @param string Course id field name + * @param string Course id value + */ + public function DeleteCourse( + $secret_key, + $course_id_field_name, + $course_id_value + ) { + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $result = $this->deleteCourseHelper( + $course_id_field_name, + $course_id_value + ); + if ($result instanceof WSError) { + $this->handleError($result); + } + } + } + + /** + * Deletes multiple courses + * + * @param string API secret key + * @param array Array of courses with elements of the form array('course_id_field_name' => 'name_of_field', 'course_id_value' => 'value') + * @return array Array with elements like array('course_id_value' => 'value', 'result' => array('code' => 0, 'message' => 'Operation was successful')). Note that if the result array contains a code different + * than 0, an error occured + */ + public function DeleteCourses($secret_key, $courses) + { + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $results = array(); + foreach ($courses as $course) { + $result_tmp = array(); + $result_op = $this->deleteCourseHelper($course['course_id_field_name'], $course['course_id_value']); + $result_tmp['course_id_value'] = $course['course_id_value']; + if ($result_op instanceof WSCMError) { + // Return the error in the results + $result_tmp['result'] = $result_op->toArray(); + } else { + $result_tmp['result'] = $this->getSuccessfulResult(); + } + $results[] = $result_tmp; + } + return $results; + } + } + + /** + * Creates a course (helper method) + * + * @param string Title + * @param string Category code + * @param string Wanted code. If it's not defined, it will be generated automatically + * @param string Tutor name + * @param string Course admin user id field name + * @param string Course admin user id value + * @param string Course language + * @param string Course id field name + * @param string Course id value + * @param array Course extra fields + * @return mixed Generated id if creation was successful, WSError otherwise + */ + protected function createCourseHelper( + $title, + $category_code, + $wanted_code, + $tutor_name, + $course_admin_user_id_field_name, + $course_admin_user_id_value, + $language, + $course_id_field_name, + $course_id_value, + $extras + ) { + // Add the original course id field name and value to the extra fields if needed + $extras_associative = array(); + if ($course_id_field_name != "chamilo_course_id") { + $extras_associative[$course_id_field_name] = $course_id_value; + } + foreach ($extras as $extra) { + $extras_associative[$extra['field_name']] = $extra['field_value']; + } + $course_admin_id = $this->getUserId($course_admin_user_id_field_name, $course_admin_user_id_value); + if ($course_admin_id instanceof WSError) { + return $course_admin_id; + } + if ($wanted_code == '') { + $wanted_code = CourseManager::generate_course_code($title); + } + $result = create_course($wanted_code, $title, $tutor_name, $category_code, $language, $course_admin_id, $this->_configuration['db_prefix'], 0); + if (!$result) { + return new WSError(202, 'There was an error creating the course'); + } else { + // Update extra fields + foreach ($extras_associative as $fname => $fvalue) { + CourseManager::update_course_extra_field_value($result, $fname, $fvalue); + } + // Get course id + $course_info = CourseManager::get_course_information($result); + return $course_info['real_id']; + } + } + + /** + * Creates a course + * + * @param string API secret key + * @param string Title + * @param string Category code + * @param string Wanted code. If it's not defined, it will be generated automatically + * @param string Tutor name + * @param string Course admin user id field name + * @param string Course admin user id value + * @param string Course language + * @param string Course id field name + * @param string Course id value + * @param array Course extra fields + * @return int Course id generated + */ + public function CreateCourse( + $secret_key, + $title, + $category_code, + $wanted_code, + $tutor_name, + $course_admin_user_id_field_name, + $course_admin_user_id_value, + $language, + $course_id_field_name, + $course_id_value, + $extras + ) { + // First, verify the secret key + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras); + if ($result instanceof WSError) { + $this->handleError($result); + } else { + return $result; + } + } + } + + /** + * Create multiple courses + * + * @param string API secret key + * @param array Courses to be created, with elements following the structure presented in CreateCourse + * @return array Array with elements of the form array('course_id_value' => 'original value sent', 'course_id_generated' => 'value_generated', 'result' => array('code' => 0, 'message' => 'Operation was successful')) + */ + public function CreateCourses($secret_key, $courses) + { + // First, verify the secret key + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSCMError) { + $this->handleError($verifKey); + } else { + $results = array(); + foreach ($courses as $course) { + $result_tmp = array(); + //reinitialize variables just in case + $title = $category_code = $wanted_code = $tutor_name = $course_admin_user_id_field_name = $course_admin_user_id_value = $language = $course_id_field_name = $course_id_value = $extras = null; + extract($course); + $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras); + if ($result instanceof WSCMError) { + $result_tmp['result'] = $result->toArray(); + $result_tmp['course_id_value'] = $course_id_value; + $result_tmp['course_id_generated'] = 0; + } else { + $result_tmp['result'] = $this->getSuccessfulResult(); + $result_tmp['course_id_value'] = $course_id_value; + $result_tmp['course_id_generated'] = $result; + } + $results[] = $result_tmp; + } + return $results; + } + } + + /** + * Edits a course (helper method) + * + * @param string Course id field name + * @param string Course id value + * @param string Title + * @param string Category code + * @param string Department name + * @param string Department url + * @param string Course language + * @param int Visibility + * @param int Subscribe (0 = denied, 1 = allowed) + * @param int Unsubscribe (0 = denied, 1 = allowed) + * @param string Visual code + * @param array Course extra fields + * @return mixed True in case of success, WSError otherwise + */ + protected function editCourseHelper( + $course_id_field_name, + $course_id_value, + $title, + $category_code, + $department_name, + $department_url, + $language, + $visibility, + $subscribe, + $unsubscribe, + $visual_code, + $extras + ) { + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); + if ($course_id instanceof WSCMError) { + return $course_id; + } else { + $attributes = array(); + if (!empty($title)) { + $attributes['title'] = $title; + } + if (!empty($category_code)) { + $attributes['category_code'] = $category_code; + } + if (!empty($department_name)) { + $attributes['department_name'] = $department_name; + } + if (!empty($department_url)) { + $attributes['department_url'] = $department_url; + } + if (!empty($language)) { + $attributes['course_language'] = $language; + } + if ($visibility != '') { + $attributes['visibility'] = (int) $visibility; + } + if ($subscribe != '') { + $attributes['subscribe'] = (int) $subscribe; + } + if ($unsubscribe != '') { + $attributes['unsubscribe'] = (int) $unsubscribe; + } + if (!empty($visual_code)) { + $attributes['visual_code'] = $visual_code; + } + if (!empty($attributes)) { + CourseManager::update_attributes($course_id, $attributes); + } + if (!empty($extras)) { + $course_code = CourseManager::get_course_code_from_course_id($course_id); + $extras_associative = array(); + foreach ($extras as $extra) { + $extras_associative[$extra['field_name']] = $extra['field_value']; + } + foreach ($extras_associative as $fname => $fvalue) { + CourseManager::update_extra_field_value($course_code, $fname, $fvalue); + } + } + return true; + } + } + + /** + * Edits a course + * + * @param string API secret key + * @param string Course id field name + * @param string Course id value + * @param string Title + * @param string Category code + * @param string Department name + * @param string Department url + * @param string Course language + * @param int Visibility + * @param int Subscribe (0 = denied, 1 = allowed) + * @param int Unsubscribe (0 = denied, 1 = allowed) + * @param string Visual code + * @param array Course extra fields + */ + public function EditCourse( + $secret_key, + $course_id_field_name, + $course_id_value, + $title, + $category_code, + $department_name, + $department_url, + $language, + $visibility, + $subscribe, + $unsubscribe, + $visual_code, + $extras + ) { + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSCMError) { + $this->handleError($verifKey); + } else { + $result = $this->editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras); + if ($result instanceof WSCMError) { + $this->handleError($result); + } + } + } + + /** + * List courses + * + * @param string API secret key + * @param string Course id field name. Use "chamilo_course_id" to use internal id + * @return array An array with elements of the form ('id' => 'Course internal id', 'code' => 'Course code', 'title' => 'Course title', 'language' => 'Course language', 'visibility' => 'Course visibility', + * 'category_name' => 'Name of the category of the course', 'number_students' => 'Number of students in the course', 'external_course_id' => 'External course id') + */ + public function ListCourses($secret_key, $course_id_field_name) + { + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $courses_result = array(); + $category_names = array(); + + $courses = CourseManager::get_courses_list(); + foreach ($courses as $course) { + $course_tmp = array(); + $course_tmp['id'] = $course['id']; + $course_tmp['code'] = $course['code']; + $course_tmp['title'] = $course['title']; + $course_tmp['language'] = $course['course_language']; + $course_tmp['visibility'] = $course['visibility']; + + // Determining category name + if ($category_names[$course['category_code']]) { + $course_tmp['category_name'] = $category_names[$course['category_code']]; + } else { + $category = CourseManager::get_course_category($course['category_code']); + $category_names[$course['category_code']] = $category['name']; + $course_tmp['category_name'] = $category['name']; + } + + // Determining number of students registered in course + $user_list = CourseManager::get_user_list_from_course_code($course['code']); + $course_tmp['number_students'] = count($user_list); + + // Determining external course id + $course_tmp['external_course_id'] = CourseManager::get_course_extra_field_value($course_id_field_name, $course['code']); + $courses_result[] = $course_tmp; + } + + return $courses_result; + } + } + + /** + * Subscribe or unsubscribe user to a course (helper method) + * + * @param string Course id field name. Use "chamilo_course_id" to use internal id + * @param string Course id value. + * @param string User id field name. Use "chamilo_user_id" to use internal id + * @param string User id value + * @param int Set to 1 to subscribe, 0 to unsubscribe + * @param int Status (STUDENT or TEACHER) Used for subscription only + * @return mixed True if subscription or unsubscription was successful, false otherwise + */ + protected function changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $state, $status = STUDENT) { + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); + if ($course_id instanceof WSError) { + return $course_id; + } else { + $user_id = $this->getUserId($user_id_field_name, $user_id_value); + if ($user_id instanceof WSError) { + return $user_id; + } else { + $course_code = CourseManager::get_course_code_from_course_id($course_id); + if ($state == 0) { + // Unsubscribe user + CourseManager::unsubscribe_user($user_id, $course_code); + return true; + } else { + // Subscribe user + if (CourseManager::subscribe_user($user_id, $course_code, $status)) { + return true; + } else { + return new WSError(203, 'An error occured subscribing to this course'); + } + } + } + } + } + + /** + * Subscribe user to a course + * + * @param string API secret key + * @param string Course id field name. Use "chamilo_course_id" to use internal id + * @param string Course id value. + * @param string User id field name. Use "chamilo_user_id" to use internal id + * @param string User id value + * @param int Status (1 = Teacher, 5 = Student) + */ + public function SubscribeUserToCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $status) { + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 1, $status); + if ($result instanceof WSError) { + $this->handleError($result); + } + } + } + + /** + * Unsusbscribe user from course + * + * @param string API secret key + * @param string Course id field name. Use "chamilo_course_id" to use internal id + * @param string Course id value. + * @param string User id field name. Use "chamilo_user_id" to use internal id + * @param string User id value + */ + public function UnsubscribeUserFromCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value) { + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 0); + if ($result instanceof WSError) { + $this->handleError($result); + } + } + } + + /** + * Returns the descriptions of a course, along with their id + * + * @param string API secret key + * @param string Course id field name + * @param string Course id value + * @return array Returns an array with elements of the form ('course_desc_id' => 1, 'course_desc_title' => 'Title', 'course_desc_content' => 'Content') + */ + public function GetCourseDescriptions($secret_key, $course_id_field_name, $course_id_value) { + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); + if ($course_id instanceof WSError) { + return $course_id; + } else { + // Course exists, get its descriptions + $descriptions = CourseDescription::get_descriptions($course_id); + $results = array(); + foreach ($descriptions as $description) { + $results[] = array('course_desc_id' => $description->get_description_type(), + 'course_desc_title' => $description->get_title(), + 'course_desc_content' => $description->get_content()); + } + return $results; + } + } + } + + + /** + * Edit course description + * + * @param string API secret key + * @param string Course id field name + * @param string Course id value + * @param int Category id from course description + * @param string Description title + * @param string Course description content + */ + public function EditCourseDescription($secret_key, $course_id_field_name, $course_id_value, $course_desc_id, $course_desc_title, $course_desc_content) { + $verifKey = $this->verifyKey($secret_key); + if ($verifKey instanceof WSError) { + $this->handleError($verifKey); + } else { + $course_id = $this->getCourseId($course_id_field_name, $course_id_value); + if ($course_id instanceof WSError) { + return $course_id; + } else { + // Create the new course description + $cd = new CourseDescription(); + $cd->set_description_type($course_desc_id); + $cd->set_title($course_desc_title); + $cd->set_content($course_desc_content); + $cd->set_session_id(0); + + // Get course info $course_info = CourseManager::get_course_information( CourseManager::get_course_code_from_course_id($course_id) ); - // Check if this course description exists - $descriptions = CourseDescription::get_descriptions($course_id); - $exists = false; - foreach ($descriptions as $description) { - if ($description->get_description_type() == $course_desc_id) { - $exists = true; - } - } + // Check if this course description exists + $descriptions = CourseDescription::get_descriptions($course_id); + $exists = false; + foreach ($descriptions as $description) { + if ($description->get_description_type() == $course_desc_id) { + $exists = true; + } + } $cd->set_course_id($course_info['real_id']); - if (!$exists) { - $cd->set_progress(0); - $cd->insert(); - } else { - $cd->update(); - } - } - } - } - public function unreadMessage($username, $password) - { - if ($this->verifyUserPass($username, $password) == "valid") - { - $table_message = Database::get_main_table(TABLE_MESSAGE); - $user_id = UserManager::get_user_id_from_username($username); - $condition_msg_status = ' msg_status = 1 '; // define('MESSAGE_STATUS_UNREAD', '1'); - - $sql_query = "SELECT COUNT(*) as number_messages FROM $table_message WHERE $condition_msg_status AND user_receiver_id=".$user_id; - - $sql_result = Database::query($sql_query); - $result = Database::fetch_array($sql_result); - return $result['number_messages']; - } - return "0"; - } - - public function get_message_data($username, $password) - { - if ($this->verifyUserPass($username, $password) == "valid") - { - $user_id = get_user_id_from_username($username); - - } - - } - - public function nada($username, $password) - { - if ($this->verifyUserPass($username, $password) == "valid") - return $username.$password; - return $username; - } + if (!$exists) { + $cd->set_progress(0); + $cd->insert(); + } else { + $cd->update(); + } + } + } + } + public function unreadMessage($username, $password) + { + if ($this->verifyUserPass($username, $password) == "valid") + { + $table_message = Database::get_main_table(TABLE_MESSAGE); + $user_id = UserManager::get_user_id_from_username($username); + $condition_msg_status = ' msg_status = 1 '; // define('MESSAGE_STATUS_UNREAD', '1'); + + $sql_query = "SELECT COUNT(*) as number_messages FROM $table_message WHERE $condition_msg_status AND user_receiver_id=".$user_id; + + $sql_result = Database::query($sql_query); + $result = Database::fetch_array($sql_result); + return $result['number_messages']; + } + return "0"; + } + + public function get_message_data($username, $password) + { + if ($this->verifyUserPass($username, $password) == "valid") + { + $user_id = get_user_id_from_username($username); + + } + + } + + public function nada($username, $password) + { + if ($this->verifyUserPass($username, $password) == "valid") + return $username.$password; + return $username; + } diff --git a/main/webservices/cm_webservice_courses.php b/main/webservices/cm_webservice_courses.php index e4d161f48c..6784d89ca4 100755 --- a/main/webservices/cm_webservice_courses.php +++ b/main/webservices/cm_webservice_courses.php @@ -16,8 +16,8 @@ require_once __DIR__.'/cm_webservice.php'; */ class WSCMCourses extends WSCM { - - public function get_courses_code($username, $password) { + public function get_courses_code($username, $password) + { if ($this->verifyUserPass($username, $password) == "valid") { $user_id = UserManager::get_user_id_from_username($username); $listOfCourses = UserManager::get_personal_session_course_list($user_id); @@ -34,15 +34,14 @@ class WSCMCourses extends WSCM public function get_course_title($username, $password, $course_code) { - if ($this->verifyUserPass($username, $password) == "valid") - { + if ($this->verifyUserPass($username, $password) == "valid") { $course_info = CourseManager::get_course_information($course_code); + return $course_info['title']; - } else + } else { return get_lang('InvalidId'); - + } } - } /* diff --git a/main/webservices/cm_webservice_forum.php b/main/webservices/cm_webservice_forum.php index af5776a262..77d0eb6c61 100755 --- a/main/webservices/cm_webservice_forum.php +++ b/main/webservices/cm_webservice_forum.php @@ -21,27 +21,29 @@ class WSCMForum extends WSCM public function get_foruns_id($username, $password, $course_code) { - if($this->verifyUserPass($username, $password) == "valid") - { + if ($this->verifyUserPass($username, $password) == "valid") { $course_db = CourseManager::get_course_information($course_code); $foruns_info = get_forums($id='', $course_db['code']); $foruns_id = '#'; - foreach ($foruns_info as $forum) - { - if( isset($forum['forum_id'])) - { + foreach ($foruns_info as $forum) { + if (isset($forum['forum_id'])) { $foruns_id .= $forum['forum_id']."#"; } } + return $foruns_id; - } else + } else { return get_lang('InvalidId'); + } } - public function get_forum_title($username, $password, $course_code, $forum_id) - { - if($this->verifyUserPass($username, $password) == "valid") - { + public function get_forum_title( + $username, + $password, + $course_code, + $forum_id + ) { + if ($this->verifyUserPass($username, $password) == "valid") { $course_db = CourseManager::get_course_information($course_code); $table_forums = Database::get_course_table(TABLE_FORUM, $course_db['db_name']); $table_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY, $course_db['db_name']); @@ -56,13 +58,18 @@ class WSCMForum extends WSCM $forum_title = utf8_decode($forum_info['forum_title']); return $forum_title; - } else + } else { return get_lang('InvalidId'); + } } - public function get_forum_threads_id($username, $password, $course_code, $forum_id) - { - if($this->verifyUserPass($username, $password) == "valid") { + public function get_forum_threads_id( + $username, + $password, + $course_code, + $forum_id + ) { + if ($this->verifyUserPass($username, $password) == "valid") { $threads_info = get_threads($forum_id); $threads_id = '#'; foreach ($threads_info as $thread) @@ -75,14 +82,19 @@ class WSCMForum extends WSCM return $threads_id; - } else + } else { return get_lang('InvalidId'); + } } - public function get_forum_thread_data($username, $password, $course_code, $thread_id, $field) - { - if($this->verifyUserPass($username, $password) == "valid") - { + public function get_forum_thread_data( + $username, + $password, + $course_code, + $thread_id, + $field + ) { + if ($this->verifyUserPass($username, $password) == "valid") { $course_db = CourseManager::get_course_information($course_code); $table_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY, $course_db['db_name']); $table_threads = Database::get_course_table(TABLE_FORUM_THREAD, $course_db['db_name']); @@ -94,21 +106,21 @@ class WSCMForum extends WSCM $result=Database::query($sql); $thread_info=Database::fetch_array($result); - switch ($field) - { + switch ($field) { case 'title': $htmlcode = true; $field_table = "thread_title"; break; - case 'date' : + case 'date': $field_table = "thread_date"; break; - case 'sender' : + case 'sender': $field_table = "insert_user_id"; break; - case 'sender_name' : + case 'sender_name': $user_id = $thread_info['insert_user_id']; $user_info = api_get_user_info($user_id); + return $user_info['firstname']; break; default: @@ -117,14 +129,18 @@ class WSCMForum extends WSCM return $thread_info[$field_table]; - } else + } else { return get_lang('InvalidId'); + } } - public function get_forum_thread_title($username, $password, $course_code, $thread_id) - { - if($this->verifyUserPass($username, $password) == "valid") - { + public function get_forum_thread_title( + $username, + $password, + $course_code, + $thread_id + ) { + if ($this->verifyUserPass($username, $password) == "valid") { $course_db = CourseManager::get_course_information($course_code); $table_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY, $course_db['db_name']); $table_threads = Database::get_course_table(TABLE_FORUM_THREAD, $course_db['db_name']); @@ -141,15 +157,15 @@ class WSCMForum extends WSCM return $thread_info[$field_table]; - } else + } else { return get_lang('InvalidId'); + } } public function get_posts_id($username, $password, $course_code, $thread_id) { - if($this->verifyUserPass($username, $password) == "valid") - { + if ($this->verifyUserPass($username, $password) == "valid") { $course_db = CourseManager::get_course_information($course_code); $table_users = Database::get_main_table(TABLE_MAIN_USER); @@ -178,49 +194,53 @@ class WSCMForum extends WSCM $posts_id = '#'; - foreach ($posts_info as $post) - { - if( isset($post['post_id'])) - { + foreach ($posts_info as $post) { + if (isset($post['post_id'])) { $posts_id .= $post['post_id']."#"; } } + return $posts_id; - } else + } else { return get_lang('InvalidId'); + } } - public function get_post_data($username, $password, $course_code, $post_id, $field) - { - if($this->verifyUserPass($username, $password) == "valid") - { + public function get_post_data( + $username, + $password, + $course_code, + $post_id, + $field + ) { + if ($this->verifyUserPass($username, $password) == "valid") { $course_db = CourseManager::get_course_information($course_code); $table_posts = Database::get_course_table(TABLE_FORUM_POST, $course_db['db_name']); $table_users = Database::get_main_table(TABLE_MAIN_USER); - $sql="SELECT * FROM ".$table_posts."posts, ".$table_users." users WHERE posts.poster_id=users.user_id AND posts.post_id='".Database::escape_string($post_id)."'"; + $sql = "SELECT * FROM ".$table_posts."posts, ".$table_users." users + WHERE posts.poster_id=users.user_id AND posts.post_id='".Database::escape_string($post_id)."'"; $result=Database::query($sql); $post_info =Database::fetch_array($result); $htmlcode = false; - switch ($field) - { + switch ($field) { case 'title': $htmlcode = true; $field_table = "post_title"; break; - case 'text' : + case 'text': $htmlcode = true; $field_table = "post_text"; break; - case 'date' : + case 'date': $field_table = "post_date"; break; - case 'sender' : + case 'sender': $field_table = "user_id"; break; - case 'sender_name' : + case 'sender_name': $field_table = "firstname"; break; default: @@ -232,10 +252,16 @@ class WSCMForum extends WSCM return get_lang('InvalidId'); } - public function send_post($username, $password, $course_code, $forum_id, $thread_id, $title, $content) - { - if($this->verifyUserPass($username, $password) == "valid") - { + public function send_post( + $username, + $password, + $course_code, + $forum_id, + $thread_id, + $title, + $content + ) { + if ($this->verifyUserPass($username, $password) == "valid") { $em = Database::getManager(); $course_db = api_get_course_info($course_code); @@ -255,7 +281,6 @@ class WSCMForum extends WSCM $content = htmlentities($content); $postDate = new DateTime(api_get_utc_datetime(), new DateTimeZone('UTC')); - $post = new \Chamilo\CourseBundle\Entity\CForumPost(); $post ->setPostTitle($title) @@ -272,15 +297,10 @@ class WSCMForum extends WSCM $em->flush(); return "Post enviado!"; -//return $sql; - - //send_notification_mails($thread_id, $values); - } else return get_lang('InvalidId'); } - } /* diff --git a/main/webservices/cm_webservice_inbox.php b/main/webservices/cm_webservice_inbox.php index adacf5e002..48ce07fbe7 100755 --- a/main/webservices/cm_webservice_inbox.php +++ b/main/webservices/cm_webservice_inbox.php @@ -31,10 +31,13 @@ class WSCMInbox extends WSCM } - public function get_message_id($username, $password, $from, $number_of_items) - { - if ($this->verifyUserPass($username, $password) == "valid") - { + public function get_message_id( + $username, + $password, + $from, + $number_of_items + ) { + if ($this->verifyUserPass($username, $password) == "valid") { $user_id = UserManager::get_user_id_from_username($username); $table_message = Database::get_main_table(TABLE_MESSAGE); @@ -51,33 +54,32 @@ class WSCMInbox extends WSCM return $message; - } else + } else { return get_lang('InvalidId'); + } } public function get_message_data($username, $password, $message_id, $field) { - if ($this->verifyUserPass($username, $password) == "valid") - { + if ($this->verifyUserPass($username, $password) == "valid") { $htmlcode = false; $user_id = UserManager::get_user_id_from_username($username); - switch ($field) - { + switch ($field) { case 'sender': $field_table = "user_sender_id"; break; - case 'title' : + case 'title': $htmlcode = true; $field_table = "title"; break; - case 'date' : + case 'date': $field_table = "send_date"; break; - case 'status' : + case 'status': $field_table = "msg_status"; break; - case 'content' : + case 'content': $this->set_message_as_read($user_id, $message_id); $htmlcode = true; $field_table = "content"; @@ -95,16 +97,18 @@ class WSCMInbox extends WSCM $result = Database::fetch_row($sql_result); return (htmlcode) ? html_entity_decode($result[0]) : $result[0]; - } else + } else { return get_lang('InvalidId'); - - + } } - public function get_message_id_sent($username, $password, $from, $number_of_items) - { - if ($this->verifyUserPass($username, $password) == "valid") - { + public function get_message_id_sent( + $username, + $password, + $from, + $number_of_items + ) { + if ($this->verifyUserPass($username, $password) == "valid") { $user_id = UserManager::get_user_id_from_username($username); $table_message = Database::get_main_table(TABLE_MESSAGE); @@ -121,19 +125,16 @@ class WSCMInbox extends WSCM return $message; - } else + } else { return get_lang('InvalidId'); - + } } - public function get_message_data_sent($username, $password, $id, $field) { - if ($this->verifyUserPass($username, $password) == "valid") - { + if ($this->verifyUserPass($username, $password) == "valid") { $htmlcode = false; - switch ($field) - { + switch ($field) { case 'sender': $field_table = "user_sender_id"; break; @@ -156,12 +157,9 @@ class WSCMInbox extends WSCM } $user_id = UserManager::get_user_id_from_username($username); - $table_message = Database::get_main_table(TABLE_MESSAGE); - $sql_query = "SELECT ".$field_table." FROM $table_message ". - " WHERE user_sender_id=".$user_id." AND id=".$id; - + " WHERE user_sender_id=".$user_id." AND id=".$id; $sql_result = Database::query($sql_query); $result = Database::fetch_row($sql_result); @@ -169,15 +167,17 @@ class WSCMInbox extends WSCM } else return get_lang('InvalidId'); - - } - public function message_send($username, $password, $receiver_user_id, $subject, $content) - { + public function message_send( + $username, + $password, + $receiver_user_id, + $subject, + $content + ) { //TODO: verificar data de envio. Esta divergindo de data! - if ($this->verifyUserPass($username, $password) == "valid") - { + if ($this->verifyUserPass($username, $password) == "valid") { $group_id = intval(0); $parent_id = intval(0); $edit_message_id = intval(0); @@ -202,19 +202,19 @@ class WSCMInbox extends WSCM return $inbox_last_id; - } else + } else { return get_lang('InvalidId'); + } } - protected function set_message_as_read($user_id, $message_id) { + protected function set_message_as_read($user_id, $message_id) + { $table_message = Database::get_main_table(TABLE_MESSAGE); $query = "UPDATE $table_message SET msg_status = '".MESSAGE_STATUS_NEW."' WHERE user_receiver_id=".$user_id." AND id='".$message_id."';"; $result = Database::query($query); } - - } /* diff --git a/main/webservices/cm_webservice_user.php b/main/webservices/cm_webservice_user.php index 17fc99623f..d66f1022c1 100755 --- a/main/webservices/cm_webservice_user.php +++ b/main/webservices/cm_webservice_user.php @@ -11,39 +11,49 @@ require_once __DIR__.'/cm_webservice.php'; * * @author marcosousa */ - -class WSCMUser extends WSCM { +class WSCMUser extends WSCM +{ public function find_id_user($username, $password, $name) { - if ($this->verifyUserPass($username, $password) == "valid") { + if ($this->verifyUserPass($username, $password) == "valid") { $listResult = "#"; - $listArrayResult = Array(); - $listArray = Array(); + $listArrayResult = []; + $listArray = []; - $list = $this->get_user_list_like_start(array('firstname'=>$name), array('firstname')); - foreach ($list as $userData) { - $listArray[] = $userData['user_id']; - } + $list = $this->get_user_list_like_start( + array('firstname' => $name), + array('firstname') + ); + foreach ($list as $userData) { + $listArray[] = $userData['user_id']; + } - $list = $this->get_user_list_like_start(array('lastname'=>$name), array('firstname')); - foreach ($list as $userData) { - $listArray[] = $userData['user_id']; - } + $list = $this->get_user_list_like_start( + array('lastname' => $name), + array('firstname') + ); + foreach ($list as $userData) { + $listArray[] = $userData['user_id']; + } - $list = $this->get_user_list_like_start(array('email'=>$name), array('firstname')); + $list = $this->get_user_list_like_start( + array('email' => $name), + array('firstname') + ); foreach ($list as $userData) { $listArray[] = $userData['user_id']; } - $listArrayResult = array_unique($listArray); + $listArrayResult = array_unique($listArray); foreach ($listArrayResult as $result) { $listResult .= $result."#"; } return $listResult; } + return "0"; } @@ -140,10 +150,10 @@ class WSCMUser extends WSCM { *@todo Use the UserManager class * @todo security filter order by */ - private static function get_user_list_like_start($conditions = array(), $order_by = array()) + private static function get_user_list_like_start($conditions = [], $order_by = []) { $user_table = Database::get_main_table(TABLE_MAIN_USER); - $return_array = array(); + $return_array = []; $sql_query = "SELECT * FROM $user_table"; if (count($conditions) > 0) { $sql_query .= ' WHERE '; diff --git a/main/webservices/courses_list.rest.php b/main/webservices/courses_list.rest.php index c938f676bd..34b0b3a27b 100755 --- a/main/webservices/courses_list.rest.php +++ b/main/webservices/courses_list.rest.php @@ -20,34 +20,55 @@ require_once __DIR__.'/../inc/global.inc.php'; * @param mixed Array or string. Type of visibility of course (public, public-registered, private, closed) * @return array Courses list (code=>[title=>'title',url='http://...',teacher=>'...',language=>''],code=>[...],...) */ -function courses_list($security_key, $visibilities = 'public') { +function courses_list($security_key, $visibilities = 'public') +{ + global $_configuration; - global $_configuration; + // Check if this script is launch by server and if security key is ok. + if ($security_key != $_configuration['security_key']) { + return array('error_msg' => 'Security check failed'); + } - // Check if this script is launch by server and if security key is ok. - if ($security_key != $_configuration['security_key']) { - return array('error_msg' => 'Security check failed'); - } + $vis = array( + 'public' => '3', + 'public-registered' => '2', + 'private' => '1', + 'closed' => '0', + ); - $vis = array('public' => '3', 'public-registered' => '2', 'private' => '1', 'closed' => '0'); + $courses_list = array(); - $courses_list = array(); + if (!is_array($visibilities)) { + $tmp = $visibilities; + $visibilities = array($tmp); + } + foreach ($visibilities as $visibility) { + if (!in_array($visibility, array_keys($vis))) { + return array('error_msg' => 'Security check failed'); + } + $courses_list_tmp = CourseManager::get_courses_list( + null, + null, + null, + null, + $vis[$visibility] + ); + foreach ($courses_list_tmp as $index => $course) { + $course_info = CourseManager::get_course_information( + $course['code'] + ); + $courses_list[$course['code']] = array( + 'title' => api_utf8_encode( + $course_info['title'] + ), + 'url' => api_get_path(WEB_COURSE_PATH).$course_info['directory'].'/', + 'teacher' => api_utf8_encode($course_info['tutor_name']), + 'language' => $course_info['course_language'], + ); + } + } - if (!is_array($visibilities)) { - $tmp = $visibilities; - $visibilities = array($tmp); - } - foreach ($visibilities as $visibility) { - if (!in_array($visibility, array_keys($vis))) { - return array('error_msg' => 'Security check failed'); - } - $courses_list_tmp = CourseManager::get_courses_list(null, null, null, null, $vis[$visibility]); - foreach ($courses_list_tmp as $index => $course) { - $course_info = CourseManager::get_course_information($course['code']); - $courses_list[$course['code']] = array('title' => api_utf8_encode($course_info['title']), 'url' => api_get_path(WEB_COURSE_PATH).$course_info['directory'].'/', 'teacher' => api_utf8_encode($course_info['tutor_name']), 'language' => $course_info['course_language']); - } - } - return $courses_list; + return $courses_list; } header('Content-Type: text/xml; charset=utf-8'); @@ -55,17 +76,17 @@ echo ''; echo ''; if (empty($_POST['security-key']) || empty($_POST['visibility'])) { - echo 'Invalid parameters, this script expects a security-key and a visibility parameters'; + echo 'Invalid parameters, this script expects a security-key and a visibility parameters'; } else { - $courses_list = courses_list($_POST['security-key'], $_POST['visibility']); - foreach ($courses_list as $code => $cd) { - echo ''; - echo '' , $code , ''; - echo '' , $cd['title'] , ''; - echo '' , $cd['url'] , ''; - echo '' , $cd['teacher'] , ''; - echo '' , $cd['language'] , ''; - echo ''; - } + $courses_list = courses_list($_POST['security-key'], $_POST['visibility']); + foreach ($courses_list as $code => $cd) { + echo ''; + echo '' , $code , ''; + echo '' , $cd['title'] , ''; + echo '' , $cd['url'] , ''; + echo '' , $cd['teacher'] , ''; + echo '' , $cd['language'] , ''; + echo ''; + } } echo ''; diff --git a/main/webservices/courses_list.soap.php b/main/webservices/courses_list.soap.php index e56097f76c..851be8e0c0 100755 --- a/main/webservices/courses_list.soap.php +++ b/main/webservices/courses_list.soap.php @@ -22,18 +22,23 @@ $server->configureWSDL('WSCourseList', 'urn:WSCourseList'); // Register the data structures used by the service $server->wsdl->addComplexType( - 'courseDetails', - 'complexType', - 'struct', - 'all', - '', - array( - 'name'=>'code', 'type'=>'xsd:string', - 'name'=>'title', 'type'=>'xsd:string', - 'name'=>'url', 'type'=>'xsd:string', - 'name'=>'teacher', 'type'=>'xsd:string', - 'name'=>'language', 'type'=>'xsd:string', - ) + 'courseDetails', + 'complexType', + 'struct', + 'all', + '', + array( + 'name' => 'code', + 'type' => 'xsd:string', + 'name' => 'title', + 'type' => 'xsd:string', + 'name' => 'url', + 'type' => 'xsd:string', + 'name' => 'teacher', + 'type' => 'xsd:string', + 'name' => 'language', + 'type' => 'xsd:string', + ) ); $server->wsdl->addComplexType( @@ -72,14 +77,17 @@ $server->register('WSCourseList', // method name * @param mixed Array or string. Type of visibility of course (public, public-registered, private, closed) * @return array Courses list (code=>[title=>'title',url='http://...',teacher=>'...',language=>''],code=>[...],...) */ -function WSCourseList($username, $signature, $visibilities = 'public') { +function WSCourseList($username, $signature, $visibilities = 'public') +{ if (empty($username) or empty($signature)) { return -1; } global $_configuration; $info = api_get_user_info_from_username($username); $user_id = $info['user_id']; - if (!UserManager::is_admin($user_id)) { return -1; } + if (!UserManager::is_admin($user_id)) { + return -1; + } $list = UserManager::get_api_keys($user_id, 'dokeos'); $key = ''; @@ -97,19 +105,31 @@ function WSCourseList($username, $signature, $visibilities = 'public') { $courses_list = array(); - if (!is_array($visibilities)) { - $visibilities = split(',', $visibilities); - } - foreach ($visibilities as $visibility) { - if (!in_array($visibility, array_keys($vis))) { - return array('error_msg' => 'Security check failed'); - } - $courses_list_tmp = CourseManager::get_courses_list(null, null, null, null, $vis[$visibility]); - foreach ($courses_list_tmp as $index => $course) { - $course_info = CourseManager::get_course_information($course['code']); - $courses_list[] = array('code' => $course['code'], 'title' => api_utf8_encode($course_info['title']), 'url' => api_get_path(WEB_COURSE_PATH).$course_info['directory'].'/', 'teacher' => api_utf8_encode($course_info['tutor_name']), 'language' => $course_info['course_language']); - } - } + if (!is_array($visibilities)) { + $visibilities = split(',', $visibilities); + } + foreach ($visibilities as $visibility) { + if (!in_array($visibility, array_keys($vis))) { + return array('error_msg' => 'Security check failed'); + } + $courses_list_tmp = CourseManager::get_courses_list( + null, + null, + null, + null, + $vis[$visibility] + ); + foreach ($courses_list_tmp as $index => $course) { + $course_info = CourseManager::get_course_information($course['code']); + $courses_list[] = array( + 'code' => $course['code'], + 'title' => api_utf8_encode($course_info['title']), + 'url' => api_get_path(WEB_COURSE_PATH).$course_info['directory'].'/', + 'teacher' => api_utf8_encode($course_info['tutor_name']), + 'language' => $course_info['course_language'], + ); + } + } return $courses_list; }