123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478 |
- <?php
- /* For licensing terms, see /license.txt */
- use Chamilo\CourseBundle\Entity\CSurveyInvitation;
- /**
- * Class SurveyManager.
- *
- * @package chamilo.survey
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University:
- * cleanup, refactoring and rewriting large parts (if not all) of the code
- * @author Julio Montoya <gugli100@gmail.com>, Personality Test modification
- * and rewriting large parts of the code
- * @author cfasanando
- *
- * @todo move this file to inc/lib
- * @todo use consistent naming for the functions (save vs store for instance)
- */
- class SurveyManager
- {
- /**
- * @param $code
- *
- * @return string
- */
- public static function generate_unique_code($code)
- {
- if (empty($code)) {
- return false;
- }
- $course_id = api_get_course_int_id();
- $table = Database::get_course_table(TABLE_SURVEY);
- $code = Database::escape_string($code);
- $num = 0;
- $new_code = $code;
- while (true) {
- $sql = "SELECT * FROM $table
- WHERE code = '$new_code' AND c_id = $course_id";
- $result = Database::query($sql);
- if (Database::num_rows($result)) {
- $num++;
- $new_code = $code.$num;
- } else {
- break;
- }
- }
- return $code.$num;
- }
- /**
- * Deletes all survey invitations of a user.
- *
- * @param int $user_id
- *
- * @return bool
- * @assert ('') === false
- */
- public static function delete_all_survey_invitations_by_user($user_id)
- {
- $user_id = (int) $user_id;
- if (empty($user_id)) {
- return false;
- }
- $table_survey_invitation = Database::get_course_table(TABLE_SURVEY_INVITATION);
- $table_survey = Database::get_course_table(TABLE_SURVEY);
- $sql = "SELECT survey_invitation_id, survey_code
- FROM $table_survey_invitation WHERE user = '$user_id' AND c_id <> 0 ";
- $result = Database::query($sql);
- while ($row = Database::fetch_array($result, 'ASSOC')) {
- $survey_invitation_id = $row['survey_invitation_id'];
- $survey_code = $row['survey_code'];
- $sql2 = "DELETE FROM $table_survey_invitation
- WHERE survey_invitation_id = '$survey_invitation_id' AND c_id <> 0";
- if (Database::query($sql2)) {
- $sql3 = "UPDATE $table_survey SET
- invited = invited-1
- WHERE c_id <> 0 AND code ='$survey_code'";
- Database::query($sql3);
- }
- }
- }
- /**
- * @param string $course_code
- * @param int $session_id
- *
- * @return array
- * @assert ('') === false
- */
- public static function get_surveys($course_code, $session_id = 0)
- {
- if (empty($course_code)) {
- return false;
- }
- $course_info = api_get_course_info($course_code);
- if (empty($course_info)) {
- return false;
- }
- $sessionCondition = api_get_session_condition($session_id, true, true);
- $table = Database::get_course_table(TABLE_SURVEY);
- $sql = "SELECT * FROM $table
- WHERE c_id = {$course_info['real_id']} $sessionCondition ";
- $result = Database::query($sql);
- $result = Database::store_result($result, 'ASSOC');
- return $result;
- }
- /**
- * Retrieves all the survey information.
- *
- * @param int $survey_id the id of the survey
- * @param bool $shared this parameter determines if
- * we have to get the information of a survey from the central (shared) database or from the
- * course database
- * @param string course code optional
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version February 2007
- * @assert ('') === false
- *
- * @return array
- *
- * @todo this is the same function as in create_new_survey.php
- */
- public static function get_survey(
- $survey_id,
- $shared = 0,
- $course_code = '',
- $simple_return = false
- ) {
- $my_course_id = api_get_course_id();
- // Table definition
- if (!empty($course_code)) {
- $my_course_id = $course_code;
- } elseif (isset($_GET['course'])) {
- $my_course_id = Security::remove_XSS($_GET['course']);
- }
- $courseInfo = api_get_course_info($my_course_id);
- $survey_id = (int) $survey_id;
- $table_survey = Database::get_course_table(TABLE_SURVEY);
- if ($shared != 0) {
- $table_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
- $sql = "SELECT * FROM $table_survey
- WHERE survey_id='".$survey_id."' ";
- } else {
- if (empty($courseInfo)) {
- return [];
- }
- $sql = "SELECT * FROM $table_survey
- WHERE
- survey_id='".$survey_id."' AND
- c_id = ".$courseInfo['real_id'];
- }
- $result = Database::query($sql);
- $return = [];
- if (Database::num_rows($result) > 0) {
- $return = Database::fetch_array($result, 'ASSOC');
- if ($simple_return) {
- return $return;
- }
- // We do this (temporarily) to have the array match the quickform elements immediately
- // idealiter the fields in the db match the quickform fields
- $return['survey_code'] = $return['code'];
- $return['survey_title'] = $return['title'];
- $return['survey_subtitle'] = $return['subtitle'];
- $return['survey_language'] = $return['lang'];
- $return['start_date'] = $return['avail_from'];
- $return['end_date'] = $return['avail_till'];
- $return['survey_share'] = $return['is_shared'];
- $return['survey_introduction'] = $return['intro'];
- $return['survey_thanks'] = $return['surveythanks'];
- $return['survey_type'] = $return['survey_type'];
- $return['one_question_per_page'] = $return['one_question_per_page'];
- $return['show_form_profile'] = $return['show_form_profile'];
- $return['input_name_list'] = isset($return['input_name_list']) ? $return['input_name_list'] : null;
- $return['shuffle'] = $return['shuffle'];
- $return['parent_id'] = $return['parent_id'];
- $return['survey_version'] = $return['survey_version'];
- $return['anonymous'] = $return['anonymous'];
- $return['c_id'] = isset($return['c_id']) ? $return['c_id'] : 0;
- $return['session_id'] = isset($return['session_id']) ? $return['session_id'] : 0;
- }
- return $return;
- }
- /**
- * @param string $code
- *
- * @return string
- */
- public static function generateSurveyCode($code)
- {
- return strtolower(CourseManager::generate_course_code($code));
- }
- /**
- * This function stores a survey in the database.
- *
- * @param array $values
- *
- * @return array $return the type of return message that has to be displayed and the message in it
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version February 2007
- */
- public static function store_survey($values)
- {
- $allowSurveyAvailabilityDatetime = api_get_configuration_value('allow_survey_availability_datetime');
- $_user = api_get_user_info();
- $course_id = api_get_course_int_id();
- $session_id = api_get_session_id();
- $courseCode = api_get_course_id();
- $table_survey = Database::get_course_table(TABLE_SURVEY);
- $shared_survey_id = 0;
- if (!isset($values['survey_id'])) {
- // Check if the code doesn't soon exists in this language
- $sql = 'SELECT 1 FROM '.$table_survey.'
- WHERE
- c_id = '.$course_id.' AND
- code = "'.Database::escape_string($values['survey_code']).'" AND
- lang = "'.Database::escape_string($values['survey_language']).'"';
- $rs = Database::query($sql);
- if (Database::num_rows($rs) > 0) {
- Display::addFlash(
- Display::return_message(
- get_lang('ThisSurveyCodeSoonExistsInThisLanguage'),
- 'error'
- )
- );
- $return['type'] = 'error';
- $return['id'] = isset($values['survey_id']) ? $values['survey_id'] : 0;
- return $return;
- }
- if (!isset($values['anonymous'])) {
- $values['anonymous'] = 0;
- }
- $values['anonymous'] = (int) $values['anonymous'];
- $extraParams = [];
- if ($values['anonymous'] == 0) {
- // Input_name_list
- $values['show_form_profile'] = isset($values['show_form_profile']) ? $values['show_form_profile'] : 0;
- $extraParams['show_form_profile'] = $values['show_form_profile'];
- if ($values['show_form_profile'] == 1) {
- // Input_name_list
- $fields = explode(',', $values['input_name_list']);
- $field_values = '';
- foreach ($fields as &$field) {
- if ($field != '') {
- if ($values[$field] == '') {
- $values[$field] = 0;
- }
- $field_values .= $field.':'.$values[$field].'@';
- }
- }
- $extraParams['form_fields'] = $field_values;
- } else {
- $extraParams['form_fields'] = '';
- }
- } else {
- // Input_name_list
- $extraParams['show_form_profile'] = 0;
- $extraParams['form_fields'] = '';
- }
- $extraParams['one_question_per_page'] = isset($values['one_question_per_page']) ? $values['one_question_per_page'] : 0;
- $extraParams['shuffle'] = isset($values['shuffle']) ? $values['shuffle'] : 0;
- if ($values['survey_type'] == 1) {
- $extraParams['survey_type'] = 1;
- $extraParams['parent_id'] = $values['parent_id'];
- // Logic for versioning surveys
- if (!empty($values['parent_id'])) {
- $versionValue = '';
- $sql = 'SELECT survey_version
- FROM '.$table_survey.'
- WHERE
- c_id = '.$course_id.' AND
- parent_id = '.intval($values['parent_id']).'
- ORDER BY survey_version DESC
- LIMIT 1';
- $rs = Database::query($sql);
- if (Database::num_rows($rs) === 0) {
- $sql = 'SELECT survey_version FROM '.$table_survey.'
- WHERE
- c_id = '.$course_id.' AND
- survey_id = '.intval($values['parent_id']);
- $rs = Database::query($sql);
- $getversion = Database::fetch_array($rs, 'ASSOC');
- if (empty($getversion['survey_version'])) {
- $versionValue = ++$getversion['survey_version'];
- } else {
- $versionValue = $getversion['survey_version'];
- }
- } else {
- $row = Database::fetch_array($rs, 'ASSOC');
- $pos = api_strpos($row['survey_version']);
- if ($pos === false) {
- $row['survey_version'] = $row['survey_version'] + 1;
- $versionValue = $row['survey_version'];
- } else {
- $getlast = explode('\.', $row['survey_version']);
- $lastversion = array_pop($getlast);
- $lastversion = $lastversion + 1;
- $add = implode('.', $getlast);
- if ($add != '') {
- $insertnewversion = $add.'.'.$lastversion;
- } else {
- $insertnewversion = $lastversion;
- }
- $versionValue = $insertnewversion;
- }
- }
- $extraParams['survey_version'] = $versionValue;
- }
- }
- $params = [
- 'c_id' => $course_id,
- 'code' => self::generateSurveyCode($values['survey_code']),
- 'title' => $values['survey_title'],
- 'subtitle' => $values['survey_subtitle'],
- 'author' => $_user['user_id'],
- 'lang' => $values['survey_language'],
- 'is_shared' => $shared_survey_id,
- 'template' => 'template',
- 'intro' => $values['survey_introduction'],
- 'surveythanks' => $values['survey_thanks'],
- 'creation_date' => api_get_utc_datetime(),
- 'anonymous' => $values['anonymous'],
- 'session_id' => api_get_session_id(),
- 'visible_results' => $values['visible_results'],
- ];
- if (!empty($values['start_date'])) {
- if ($allowSurveyAvailabilityDatetime) {
- $params['avail_from'] = api_get_utc_datetime($values['start_date'].':00');
- } else {
- $params['avail_from'] = $values['start_date'];
- }
- }
- if (!empty($values['end_date'])) {
- if ($allowSurveyAvailabilityDatetime) {
- $params['avail_till'] = api_get_utc_datetime($values['end_date'].':00');
- } else {
- $params['avail_till'] = $values['end_date'];
- }
- }
- if (isset($values['survey_type']) && !empty($values['survey_type'])) {
- $params['survey_type'] = $values['survey_type'];
- }
- $params = array_merge($params, $extraParams);
- $survey_id = Database::insert($table_survey, $params);
- if ($survey_id > 0) {
- $sql = "UPDATE $table_survey SET survey_id = $survey_id
- WHERE iid = $survey_id";
- Database::query($sql);
- // Insert into item_property
- api_item_property_update(
- api_get_course_info(),
- TOOL_SURVEY,
- $survey_id,
- 'SurveyAdded',
- api_get_user_id()
- );
- }
- if ($values['survey_type'] == 1 && !empty($values['parent_id'])) {
- self::copy_survey($values['parent_id'], $survey_id);
- }
- Display::addFlash(
- Display::return_message(
- get_lang('SurveyCreatedSuccesfully'),
- 'success'
- )
- );
- $return['id'] = $survey_id;
- } else {
- // Check whether the code doesn't soon exists in this language
- $sql = 'SELECT 1 FROM '.$table_survey.'
- WHERE
- c_id = '.$course_id.' AND
- code = "'.Database::escape_string($values['survey_code']).'" AND
- lang = "'.Database::escape_string($values['survey_language']).'" AND
- survey_id !='.intval($values['survey_id']);
- $rs = Database::query($sql);
- if (Database::num_rows($rs) > 0) {
- Display::addFlash(
- Display::return_message(
- get_lang('ThisSurveyCodeSoonExistsInThisLanguage'),
- 'error'
- )
- );
- $return['type'] = 'error';
- $return['id'] = isset($values['survey_id']) ? $values['survey_id'] : 0;
- return $return;
- }
- if (!isset($values['anonymous'])
- || (isset($values['anonymous']) && $values['anonymous'] == '')
- ) {
- $values['anonymous'] = 0;
- }
- $extraParams = [];
- $extraParams['one_question_per_page'] = isset($values['one_question_per_page']) ? $values['one_question_per_page'] : null;
- $extraParams['shuffle'] = isset($values['shuffle']) ? $values['shuffle'] : null;
- if ($values['anonymous'] == 0) {
- $extraParams['show_form_profile'] = isset($values['show_form_profile']) ? $values['show_form_profile'] : '';
- if ($extraParams['show_form_profile'] == 1) {
- $fields = explode(',', $values['input_name_list']);
- $field_values = '';
- foreach ($fields as &$field) {
- if ($field != '') {
- if (!isset($values[$field]) ||
- (isset($values[$field]) && $values[$field] == '')
- ) {
- $values[$field] = 0;
- }
- $field_values .= $field.':'.$values[$field].'@';
- }
- }
- $extraParams['form_fields'] = $field_values;
- } else {
- $extraParams['form_fields'] = '';
- }
- } else {
- $extraParams['show_form_profile'] = 0;
- $extraParams['form_fields'] = '';
- }
- $params = [
- 'title' => $values['survey_title'],
- 'subtitle' => $values['survey_subtitle'],
- 'author' => $_user['user_id'],
- 'lang' => $values['survey_language'],
- 'avail_from' => $allowSurveyAvailabilityDatetime
- ? api_get_utc_datetime($values['start_date'].':00')
- : $values['start_date'],
- 'avail_till' => $allowSurveyAvailabilityDatetime
- ? api_get_utc_datetime($values['end_date'].':59')
- : $values['end_date'],
- 'is_shared' => $shared_survey_id,
- 'template' => 'template',
- 'intro' => $values['survey_introduction'],
- 'surveythanks' => $values['survey_thanks'],
- 'anonymous' => $values['anonymous'],
- 'session_id' => api_get_session_id(),
- 'visible_results' => $values['visible_results'],
- ];
- $params = array_merge($params, $extraParams);
- Database::update(
- $table_survey,
- $params,
- [
- 'c_id = ? AND survey_id = ?' => [
- $course_id,
- $values['survey_id'],
- ],
- ]
- );
- // Update into item_property (update)
- api_item_property_update(
- api_get_course_info(),
- TOOL_SURVEY,
- $values['survey_id'],
- 'SurveyUpdated',
- api_get_user_id()
- );
- Display::addFlash(
- Display::return_message(
- get_lang('SurveyUpdatedSuccesfully'),
- 'confirmation'
- )
- );
- $return['id'] = $values['survey_id'];
- }
- $survey_id = (int) $return['id'];
- // Gradebook
- $gradebook_option = false;
- if (isset($values['survey_qualify_gradebook'])) {
- $gradebook_option = $values['survey_qualify_gradebook'] > 0;
- }
- $gradebook_link_type = 8;
- $link_info = GradebookUtils::isResourceInCourseGradebook(
- $courseCode,
- $gradebook_link_type,
- $survey_id,
- $session_id
- );
- $gradebook_link_id = isset($link_info['id']) ? $link_info['id'] : false;
- if ($gradebook_option) {
- if ($survey_id > 0) {
- $title_gradebook = ''; // Not needed here.
- $description_gradebook = ''; // Not needed here.
- $survey_weight = floatval($_POST['survey_weight']);
- $max_score = 1;
- if (!$gradebook_link_id) {
- GradebookUtils::add_resource_to_course_gradebook(
- $values['category_id'],
- $courseCode,
- $gradebook_link_type,
- $survey_id,
- $title_gradebook,
- $survey_weight,
- $max_score,
- $description_gradebook,
- 1,
- $session_id
- );
- } else {
- GradebookUtils::updateResourceFromCourseGradebook(
- $gradebook_link_id,
- $courseCode,
- $survey_weight
- );
- }
- }
- } else {
- // Delete everything of the gradebook for this $linkId
- GradebookUtils::remove_resource_from_course_gradebook($gradebook_link_id);
- }
- return $return;
- }
- /**
- * This function stores a shared survey in the central database.
- *
- * @param array $values
- *
- * @return array $return the type of return message that has to be displayed and the message in it
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version February 2007
- */
- public function store_shared_survey($values)
- {
- $_user = api_get_user_info();
- $_course = api_get_course_info();
- // Table definitions
- $table_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
- if (!$values['survey_id'] ||
- !is_numeric($values['survey_id']) ||
- $values['survey_share']['survey_share'] == 'true'
- ) {
- $sql = "INSERT INTO $table_survey (code, title, subtitle, author, lang, template, intro, surveythanks, creation_date, course_code) VALUES (
- '".Database::escape_string($values['survey_code'])."',
- '".Database::escape_string($values['survey_title'])."',
- '".Database::escape_string($values['survey_subtitle'])."',
- '".intval($_user['user_id'])."',
- '".Database::escape_string($values['survey_language'])."',
- '".Database::escape_string('template')."',
- '".Database::escape_string($values['survey_introduction'])."',
- '".Database::escape_string($values['survey_thanks'])."',
- '".api_get_utc_datetime()."',
- '".$_course['id']."')";
- Database::query($sql);
- $return = Database::insert_id();
- $sql = "UPDATE $table_survey SET survey_id = $return WHERE iid = $return";
- Database::query($sql);
- } else {
- $sql = "UPDATE $table_survey SET
- code = '".Database::escape_string($values['survey_code'])."',
- title = '".Database::escape_string($values['survey_title'])."',
- subtitle = '".Database::escape_string($values['survey_subtitle'])."',
- author = '".intval($_user['user_id'])."',
- lang = '".Database::escape_string($values['survey_language'])."',
- template = '".Database::escape_string('template')."',
- intro = '".Database::escape_string($values['survey_introduction'])."',
- surveythanks = '".Database::escape_string($values['survey_thanks'])."'
- WHERE survey_id = '".Database::escape_string($values['survey_share']['survey_share'])."'";
- Database::query($sql);
- $return = $values['survey_share']['survey_share'];
- }
- return $return;
- }
- /**
- * This function deletes a survey (and also all the question in that survey.
- *
- * @param int $survey_id id of the survey that has to be deleted
- * @param bool $shared
- * @param int $course_id
- *
- * @return true
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version January 2007
- */
- public static function delete_survey($survey_id, $shared = false, $course_id = 0)
- {
- // Database table definitions
- if (empty($course_id)) {
- $course_id = api_get_course_int_id();
- }
- $survey_id = (int) $survey_id;
- if (empty($survey_id)) {
- return false;
- }
- $course_info = api_get_course_info_by_id($course_id);
- $course_id = $course_info['real_id'];
- $table_survey = Database::get_course_table(TABLE_SURVEY);
- $table_survey_question_group = Database::get_course_table(TABLE_SURVEY_QUESTION_GROUP);
- if ($shared) {
- $table_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
- // Deleting the survey
- $sql = "DELETE FROM $table_survey
- WHERE survey_id='".$survey_id."'";
- Database::query($sql);
- } else {
- $sql = "DELETE FROM $table_survey
- WHERE c_id = $course_id AND survey_id='".$survey_id."'";
- Database::query($sql);
- }
- // Deleting groups of this survey
- $sql = "DELETE FROM $table_survey_question_group
- WHERE c_id = $course_id AND survey_id='".$survey_id."'";
- Database::query($sql);
- // Deleting the questions of the survey
- self::delete_all_survey_questions($survey_id, $shared);
- // Update into item_property (delete)
- api_item_property_update(
- $course_info,
- TOOL_SURVEY,
- $survey_id,
- 'SurveyDeleted',
- api_get_user_id()
- );
- Skill::deleteSkillsFromItem($survey_id, ITEM_TYPE_SURVEY);
- return true;
- }
- /**
- * @param int $survey_id
- * @param int $new_survey_id
- * @param int $targetCourseId
- *
- * @return bool
- */
- public static function copy_survey(
- $survey_id,
- $new_survey_id = null,
- $targetCourseId = null
- ) {
- $course_id = api_get_course_int_id();
- if (!$targetCourseId) {
- $targetCourseId = $course_id;
- }
- // Database table definitions
- $table_survey = Database::get_course_table(TABLE_SURVEY);
- $table_survey_question_group = Database::get_course_table(TABLE_SURVEY_QUESTION_GROUP);
- $table_survey_question = Database::get_course_table(TABLE_SURVEY_QUESTION);
- $table_survey_options = Database::get_course_table(TABLE_SURVEY_QUESTION_OPTION);
- $survey_id = (int) $survey_id;
- // Get groups
- $survey_data = self::get_survey($survey_id, 0, null, true);
- if (empty($survey_data)) {
- return true;
- }
- if (empty($new_survey_id)) {
- $params = $survey_data;
- $params['code'] = self::generate_unique_code($params['code']);
- $params['c_id'] = $targetCourseId;
- unset($params['survey_id']);
- $params['session_id'] = api_get_session_id();
- $params['title'] = $params['title'].' '.get_lang('Copy');
- unset($params['iid']);
- $new_survey_id = Database::insert($table_survey, $params);
- if ($new_survey_id) {
- $sql = "UPDATE $table_survey SET survey_id = $new_survey_id
- WHERE iid = $new_survey_id";
- Database::query($sql);
- // Insert into item_property
- api_item_property_update(
- api_get_course_info(),
- TOOL_SURVEY,
- $new_survey_id,
- 'SurveyAdded',
- api_get_user_id()
- );
- }
- } else {
- $new_survey_id = (int) $new_survey_id;
- }
- $sql = "SELECT * FROM $table_survey_question_group
- WHERE c_id = $course_id AND survey_id='".$survey_id."'";
- $res = Database::query($sql);
- while ($row = Database::fetch_array($res, 'ASSOC')) {
- $params = [
- 'c_id' => $targetCourseId,
- 'name' => $row['name'],
- 'description' => $row['description'],
- 'survey_id' => $new_survey_id,
- ];
- $insertId = Database::insert($table_survey_question_group, $params);
- $sql = "UPDATE $table_survey_question_group SET id = iid
- WHERE iid = $insertId";
- Database::query($sql);
- $group_id[$row['id']] = $insertId;
- }
- // Get questions
- $sql = "SELECT * FROM $table_survey_question
- WHERE c_id = $course_id AND survey_id='".$survey_id."'";
- $res = Database::query($sql);
- while ($row = Database::fetch_array($res, 'ASSOC')) {
- $params = [
- 'c_id' => $targetCourseId,
- 'survey_id' => $new_survey_id,
- 'survey_question' => $row['survey_question'],
- 'survey_question_comment' => $row['survey_question_comment'],
- 'type' => $row['type'],
- 'display' => $row['display'],
- 'sort' => $row['sort'],
- 'shared_question_id' => $row['shared_question_id'],
- 'max_value' => $row['max_value'],
- 'survey_group_pri' => $row['survey_group_pri'],
- 'survey_group_sec1' => $row['survey_group_sec1'],
- 'survey_group_sec2' => $row['survey_group_sec2'],
- ];
- if (api_get_configuration_value('allow_required_survey_questions')) {
- if (isset($row['is_required'])) {
- $params['is_required'] = $row['is_required'];
- }
- }
- $insertId = Database::insert($table_survey_question, $params);
- if ($insertId) {
- $sql = "UPDATE $table_survey_question SET question_id = iid WHERE iid = $insertId";
- Database::query($sql);
- $question_id[$row['question_id']] = $insertId;
- }
- }
- // Get questions options
- $sql = "SELECT * FROM $table_survey_options
- WHERE c_id = $course_id AND survey_id='".$survey_id."'";
- $res = Database::query($sql);
- while ($row = Database::fetch_array($res, 'ASSOC')) {
- $params = [
- 'c_id' => $targetCourseId,
- 'question_id' => $question_id[$row['question_id']],
- 'survey_id' => $new_survey_id,
- 'option_text' => $row['option_text'],
- 'sort' => $row['sort'],
- 'value' => $row['value'],
- ];
- $insertId = Database::insert($table_survey_options, $params);
- if ($insertId) {
- $sql = "UPDATE $table_survey_options SET question_option_id = $insertId
- WHERE iid = $insertId";
- Database::query($sql);
- }
- }
- return $new_survey_id;
- }
- /**
- * This function duplicates a survey (and also all the question in that survey.
- *
- * @param int $surveyId id of the survey that has to be duplicated
- * @param int $courseId id of the course which survey has to be duplicated
- *
- * @return true
- *
- * @author Eric Marguin <e.marguin@elixir-interactive.com>, Elixir Interactive
- *
- * @version October 2007
- */
- public static function empty_survey($surveyId, $courseId = 0)
- {
- // Database table definitions
- $table_survey_invitation = Database::get_course_table(TABLE_SURVEY_INVITATION);
- $table_survey_answer = Database::get_course_table(TABLE_SURVEY_ANSWER);
- $table_survey = Database::get_course_table(TABLE_SURVEY);
- $courseId = (int) $courseId;
- $courseId = empty($courseId) ? api_get_course_int_id() : $courseId;
- $surveyId = (int) $surveyId;
- $datas = self::get_survey($surveyId);
- $session_where = '';
- if (api_get_session_id() != 0) {
- $session_where = ' AND session_id = "'.api_get_session_id().'" ';
- }
- $sql = 'DELETE FROM '.$table_survey_invitation.'
- WHERE
- c_id = '.$courseId.' AND
- survey_code = "'.Database::escape_string($datas['code']).'" '.$session_where.' ';
- Database::query($sql);
- $sql = 'DELETE FROM '.$table_survey_answer.'
- WHERE c_id = '.$courseId.' AND survey_id='.$surveyId;
- Database::query($sql);
- $sql = 'UPDATE '.$table_survey.' SET invited=0, answered=0
- WHERE c_id = '.$courseId.' AND survey_id='.$surveyId;
- Database::query($sql);
- return true;
- }
- /**
- * This function recalculates the number of people who have taken the survey (=filled at least one question).
- *
- * @param array $survey_data
- * @param array $user
- * @param string $survey_code
- *
- * @return bool
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version February 2007
- */
- public static function update_survey_answered($survey_data, $user, $survey_code)
- {
- if (empty($survey_data)) {
- return false;
- }
- // Database table definitions
- $table_survey = Database::get_course_table(TABLE_SURVEY);
- $table_survey_invitation = Database::get_course_table(TABLE_SURVEY_INVITATION);
- $survey_id = (int) $survey_data['survey_id'];
- $course_id = (int) $survey_data['c_id'];
- $session_id = $survey_data['session_id'];
- // Getting a list with all the people who have filled the survey
- /*$people_filled = self::get_people_who_filled_survey($survey_id, false, $course_id);
- $number = count($people_filled);*/
- // Storing this value in the survey table
- $sql = "UPDATE $table_survey
- SET answered = answered + 1
- WHERE
- c_id = $course_id AND
- survey_id = ".$survey_id;
- Database::query($sql);
- $allow = api_get_configuration_value('survey_answered_at_field');
- // Requires DB change:
- // ALTER TABLE c_survey_invitation ADD answered_at DATETIME DEFAULT NULL;
- $answeredAt = '';
- if ($allow) {
- $answeredAt = "answered_at = '".api_get_utc_datetime()."',";
- }
- // Storing that the user has finished the survey.
- $sql = "UPDATE $table_survey_invitation
- SET $answeredAt answered = 1
- WHERE
- c_id = $course_id AND
- session_id = $session_id AND
- user ='".Database::escape_string($user)."' AND
- survey_code='".Database::escape_string($survey_code)."'";
- Database::query($sql);
- }
- /**
- * This function return the "icon" of the question type.
- *
- * @param string $type
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version February 2007
- */
- public static function icon_question($type)
- {
- // the possible question types
- $possible_types = [
- 'personality',
- 'yesno',
- 'multiplechoice',
- 'multipleresponse',
- 'open',
- 'dropdown',
- 'comment',
- 'pagebreak',
- 'percentage',
- 'score',
- ];
- // the images array
- $icon_question = [
- 'yesno' => 'yesno.png',
- 'personality' => 'yesno.png',
- 'multiplechoice' => 'mcua.png',
- 'multipleresponse' => 'mcma.png',
- 'open' => 'open_answer.png',
- 'dropdown' => 'dropdown.png',
- 'percentage' => 'percentagequestion.png',
- 'score' => 'scorequestion.png',
- 'comment' => 'commentquestion.png',
- 'pagebreak' => 'page_end.png',
- ];
- if (in_array($type, $possible_types)) {
- return $icon_question[$type];
- } else {
- return false;
- }
- }
- /**
- * This function retrieves all the information of a question.
- *
- * @param int $question_id the id of the question
- * @param bool $shared
- *
- * @return array
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version January 2007
- *
- * @todo one sql call should do the trick
- */
- public static function get_question($question_id, $shared = false)
- {
- // Table definitions
- $tbl_survey_question = Database::get_course_table(TABLE_SURVEY_QUESTION);
- $table_survey_question_option = Database::get_course_table(TABLE_SURVEY_QUESTION_OPTION);
- $course_id = api_get_course_int_id();
- $question_id = (int) $question_id;
- $sql = "SELECT * FROM $tbl_survey_question
- WHERE c_id = $course_id AND question_id='".$question_id."'
- ORDER BY `sort` ";
- $sqlOption = " SELECT * FROM $table_survey_question_option
- WHERE c_id = $course_id AND question_id='".$question_id."'
- ORDER BY `sort` ";
- if ($shared) {
- $tbl_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
- $table_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
- $sql = "SELECT * FROM $tbl_survey_question
- WHERE question_id='".$question_id."'
- ORDER BY `sort` ";
- $sqlOption = "SELECT * FROM $table_survey_question_option
- WHERE question_id='".$question_id."'
- ORDER BY `sort` ";
- }
- // Getting the information of the question
- $result = Database::query($sql);
- $row = Database::fetch_array($result, 'ASSOC');
- $return['survey_id'] = $row['survey_id'];
- $return['question_id'] = $row['question_id'];
- $return['type'] = $row['type'];
- $return['question'] = $row['survey_question'];
- $return['horizontalvertical'] = $row['display'];
- $return['shared_question_id'] = $row['shared_question_id'];
- $return['maximum_score'] = $row['max_value'];
- $return['is_required'] = api_get_configuration_value('allow_required_survey_questions')
- ? $row['is_required']
- : false;
- if ($row['survey_group_pri'] != 0) {
- $return['assigned'] = $row['survey_group_pri'];
- $return['choose'] = 1;
- } else {
- $return['assigned1'] = $row['survey_group_sec1'];
- $return['assigned2'] = $row['survey_group_sec2'];
- $return['choose'] = 2;
- }
- // Getting the information of the question options
- $result = Database::query($sqlOption);
- while ($row = Database::fetch_array($result, 'ASSOC')) {
- /** @todo this should be renamed to options instead of answers */
- $return['answers'][] = $row['option_text'];
- $return['values'][] = $row['value'];
- /** @todo this can be done more elegantly (used in reporting) */
- $return['answersid'][] = $row['question_option_id'];
- }
- return $return;
- }
- /**
- * This function gets all the question of any given survey.
- *
- * @param int $surveyId the id of the survey
- * @param int $courseId
- *
- * @return array containing all the questions of the survey
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version February 2007
- *
- * @todo one sql call should do the trick
- */
- public static function get_questions($surveyId, $courseId = 0)
- {
- $tbl_survey_question = Database::get_course_table(TABLE_SURVEY_QUESTION);
- $table_survey_question_option = Database::get_course_table(TABLE_SURVEY_QUESTION_OPTION);
- $courseId = (int) $courseId;
- $surveyId = (int) $surveyId;
- if (empty($courseId)) {
- $courseId = api_get_course_int_id();
- }
- // Getting the information of the question
- $sql = "SELECT * FROM $tbl_survey_question
- WHERE c_id = $courseId AND survey_id='".$surveyId."'";
- $result = Database::query($sql);
- $return = [];
- while ($row = Database::fetch_array($result, 'ASSOC')) {
- $return[$row['question_id']]['survey_id'] = $row['survey_id'];
- $return[$row['question_id']]['question_id'] = $row['question_id'];
- $return[$row['question_id']]['type'] = $row['type'];
- $return[$row['question_id']]['question'] = $row['survey_question'];
- $return[$row['question_id']]['horizontalvertical'] = $row['display'];
- $return[$row['question_id']]['maximum_score'] = $row['max_value'];
- $return[$row['question_id']]['sort'] = $row['sort'];
- $return[$row['question_id']]['survey_question_comment'] = $row['survey_question_comment'];
- }
- // Getting the information of the question options
- $sql = "SELECT * FROM $table_survey_question_option
- WHERE c_id = $courseId AND survey_id='".$surveyId."'";
- $result = Database::query($sql);
- while ($row = Database::fetch_array($result, 'ASSOC')) {
- $return[$row['question_id']]['answers'][] = $row['option_text'];
- }
- return $return;
- }
- /**
- * This function saves a question in the database.
- * This can be either an update of an existing survey or storing a new survey.
- *
- * @param array $survey_data
- * @param array $form_content all the information of the form
- *
- * @return string
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version January 2007
- */
- public static function save_question($survey_data, $form_content)
- {
- $return_message = '';
- if (strlen($form_content['question']) > 1) {
- // Checks length of the question
- $empty_answer = false;
- if ($survey_data['survey_type'] == 1) {
- if (empty($form_content['choose'])) {
- $return_message = 'PleaseChooseACondition';
- return $return_message;
- }
- if (($form_content['choose'] == 2) &&
- ($form_content['assigned1'] == $form_content['assigned2'])
- ) {
- $return_message = 'ChooseDifferentCategories';
- return $return_message;
- }
- }
- if ($form_content['type'] != 'percentage') {
- if (isset($form_content['answers'])) {
- for ($i = 0; $i < count($form_content['answers']); $i++) {
- if (strlen($form_content['answers'][$i]) < 1) {
- $empty_answer = true;
- break;
- }
- }
- }
- }
- if ($form_content['type'] == 'score') {
- if (strlen($form_content['maximum_score']) < 1) {
- $empty_answer = true;
- }
- }
- $course_id = api_get_course_int_id();
- if (!$empty_answer) {
- // Table definitions
- $tbl_survey_question = Database::get_course_table(TABLE_SURVEY_QUESTION);
- // Getting all the information of the survey
- $survey_data = self::get_survey($form_content['survey_id']);
- // Storing the question in the shared database
- if (is_numeric($survey_data['survey_share']) && $survey_data['survey_share'] != 0) {
- $shared_question_id = self::save_shared_question($form_content, $survey_data);
- $form_content['shared_question_id'] = $shared_question_id;
- }
- // Storing a new question
- if ($form_content['question_id'] == '' || !is_numeric($form_content['question_id'])) {
- // Finding the max sort order of the questions in the given survey
- $sql = "SELECT max(sort) AS max_sort
- FROM $tbl_survey_question
- WHERE c_id = $course_id AND survey_id='".intval($form_content['survey_id'])."'";
- $result = Database::query($sql);
- $row = Database::fetch_array($result, 'ASSOC');
- $max_sort = $row['max_sort'];
- // Some variables defined for survey-test type
- $extraParams = [];
- if (isset($_POST['choose'])) {
- if ($_POST['choose'] == 1) {
- $extraParams['survey_group_pri'] = $_POST['assigned'];
- } elseif ($_POST['choose'] == 2) {
- $extraParams['survey_group_sec1'] = $_POST['assigned1'];
- $extraParams['survey_group_sec2'] = $_POST['assigned2'];
- }
- }
- $questionComment = isset($form_content['question_comment'])
- ? $form_content['question_comment']
- : '';
- $maxScore = isset($form_content['maximum_score']) ? $form_content['maximum_score'] : '';
- $display = isset($form_content['horizontalvertical']) ? $form_content['horizontalvertical'] : '';
- $params = [
- 'c_id' => $course_id,
- 'survey_id' => $form_content['survey_id'],
- 'survey_question' => $form_content['question'],
- 'survey_question_comment' => $questionComment,
- 'type' => $form_content['type'],
- 'display' => $display,
- 'sort' => $max_sort + 1,
- 'shared_question_id' => $form_content['shared_question_id'],
- 'max_value' => $maxScore,
- ];
- if (api_get_configuration_value('allow_required_survey_questions')) {
- $params['is_required'] = isset($form_content['is_required']);
- }
- $params = array_merge($params, $extraParams);
- $question_id = Database::insert($tbl_survey_question, $params);
- if ($question_id) {
- $sql = "UPDATE $tbl_survey_question SET question_id = $question_id
- WHERE iid = $question_id";
- Database::query($sql);
- $form_content['question_id'] = $question_id;
- $return_message = 'QuestionAdded';
- }
- } else {
- // Updating an existing question
- $extraParams = [];
- if (isset($_POST['choose'])) {
- if ($_POST['choose'] == 1) {
- $extraParams['survey_group_pri'] = $_POST['assigned'];
- $extraParams['survey_group_sec1'] = 0;
- $extraParams['survey_group_sec2'] = 0;
- } elseif ($_POST['choose'] == 2) {
- $extraParams['survey_group_pri'] = 0;
- $extraParams['survey_group_sec1'] = $_POST['assigned1'];
- $extraParams['survey_group_sec2'] = $_POST['assigned2'];
- }
- }
- $maxScore = isset($form_content['maximum_score']) ? $form_content['maximum_score'] : null;
- $questionComment = isset($form_content['question_comment'])
- ? $form_content['question_comment']
- : null;
- // Adding the question to the survey_question table
- $params = [
- 'survey_question' => $form_content['question'],
- 'survey_question_comment' => $questionComment,
- 'display' => $form_content['horizontalvertical'],
- ];
- if (api_get_configuration_value('allow_required_survey_questions')) {
- $params['is_required'] = isset($form_content['is_required']);
- }
- $params = array_merge($params, $extraParams);
- Database::update(
- $tbl_survey_question,
- $params,
- [
- 'c_id = ? AND question_id = ?' => [
- $course_id,
- $form_content['question_id'],
- ],
- ]
- );
- $return_message = 'QuestionUpdated';
- }
- if (!empty($form_content['survey_id'])) {
- //Updating survey
- api_item_property_update(
- api_get_course_info(),
- TOOL_SURVEY,
- $form_content['survey_id'],
- 'SurveyUpdated',
- api_get_user_id()
- );
- }
- // Storing the options of the question
- self::save_question_options($form_content, $survey_data);
- } else {
- $return_message = 'PleasFillAllAnswer';
- }
- } else {
- $return_message = 'PleaseEnterAQuestion';
- }
- if (!empty($return_message)) {
- Display::addFlash(Display::return_message(get_lang($return_message)));
- }
- return $return_message;
- }
- /**
- * This function saves the question in the shared database.
- *
- * @param array $form_content all the information of the form
- * @param array $survey_data all the information of the survey
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version February 2007
- *
- * @return int
- *
- * @todo editing of a shared question
- */
- public function save_shared_question($form_content, $survey_data)
- {
- $_course = api_get_course_info();
- // Table definitions
- $tbl_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
- // Storing a new question
- if ($form_content['shared_question_id'] == '' ||
- !is_numeric($form_content['shared_question_id'])
- ) {
- // Finding the max sort order of the questions in the given survey
- $sql = "SELECT max(sort) AS max_sort FROM $tbl_survey_question
- WHERE survey_id='".intval($survey_data['survey_share'])."'
- AND code='".Database::escape_string($_course['id'])."'";
- $result = Database::query($sql);
- $row = Database::fetch_array($result, 'ASSOC');
- $max_sort = $row['max_sort'];
- // Adding the question to the survey_question table
- $sql = "INSERT INTO $tbl_survey_question (survey_id, survey_question, survey_question_comment, type, display, sort, code) VALUES (
- '".Database::escape_string($survey_data['survey_share'])."',
- '".Database::escape_string($form_content['question'])."',
- '".Database::escape_string($form_content['question_comment'])."',
- '".Database::escape_string($form_content['type'])."',
- '".Database::escape_string($form_content['horizontalvertical'])."',
- '".Database::escape_string($max_sort + 1)."',
- '".Database::escape_string($_course['id'])."')";
- Database::query($sql);
- $shared_question_id = Database::insert_id();
- } else {
- // Updating an existing question
- // adding the question to the survey_question table
- $sql = "UPDATE $tbl_survey_question SET
- survey_question = '".Database::escape_string($form_content['question'])."',
- survey_question_comment = '".Database::escape_string($form_content['question_comment'])."',
- display = '".Database::escape_string($form_content['horizontalvertical'])."'
- WHERE
- question_id = '".intval($form_content['shared_question_id'])."' AND
- code = '".Database::escape_string($_course['id'])."'";
- Database::query($sql);
- $shared_question_id = $form_content['shared_question_id'];
- }
- return $shared_question_id;
- }
- /**
- * This functions moves a question of a survey up or down.
- *
- * @param string $direction
- * @param int $survey_question_id
- * @param int $survey_id
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version January 2007
- */
- public static function move_survey_question(
- $direction,
- $survey_question_id,
- $survey_id
- ) {
- // Table definition
- $table_survey_question = Database::get_course_table(TABLE_SURVEY_QUESTION);
- $course_id = api_get_course_int_id();
- if ($direction == 'moveup') {
- $sort = 'DESC';
- }
- if ($direction == 'movedown') {
- $sort = 'ASC';
- }
- $survey_id = (int) $survey_id;
- // Finding the two questions that needs to be swapped
- $sql = "SELECT * FROM $table_survey_question
- WHERE c_id = $course_id AND survey_id='".$survey_id."'
- ORDER BY sort $sort";
- $result = Database::query($sql);
- $found = false;
- while ($row = Database::fetch_array($result, 'ASSOC')) {
- if ($found) {
- $question_id_two = $row['question_id'];
- $question_sort_two = $row['sort'];
- $found = false;
- }
- if ($row['question_id'] == $survey_question_id) {
- $found = true;
- $question_id_one = $row['question_id'];
- $question_sort_one = $row['sort'];
- }
- }
- $sql = "UPDATE $table_survey_question
- SET sort = '".Database::escape_string($question_sort_two)."'
- WHERE c_id = $course_id AND question_id='".intval($question_id_one)."'";
- Database::query($sql);
- $sql = "UPDATE $table_survey_question
- SET sort = '".Database::escape_string($question_sort_one)."'
- WHERE c_id = $course_id AND question_id='".intval($question_id_two)."'";
- Database::query($sql);
- }
- /**
- * This function deletes all the questions of a given survey
- * This function is normally only called when a survey is deleted.
- *
- * @param int $survey_id the id of the survey that has to be deleted
- *
- * @return bool
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version January 2007
- */
- public static function delete_all_survey_questions($survey_id, $shared = false)
- {
- $course_id = api_get_course_int_id();
- $survey_id = (int) $survey_id;
- // Table definitions
- $table_survey_question = Database::get_course_table(TABLE_SURVEY_QUESTION);
- $course_condition = " c_id = $course_id AND ";
- if ($shared) {
- $course_condition = '';
- $table_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
- }
- $sql = "DELETE FROM $table_survey_question
- WHERE $course_condition survey_id = '".$survey_id."'";
- // Deleting the survey questions
- Database::query($sql);
- // Deleting all the options of the questions of the survey
- self::delete_all_survey_questions_options($survey_id, $shared);
- // Deleting all the answers on this survey
- self::delete_all_survey_answers($survey_id);
- return true;
- }
- /**
- * This function deletes a survey question and all its options.
- *
- * @param int $survey_id the id of the survey
- * @param int $question_id the id of the question
- * @param bool $shared
- *
- * @todo also delete the answers to this question
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version March 2007
- */
- public static function delete_survey_question($survey_id, $question_id, $shared = false)
- {
- $survey_id = (int) $survey_id;
- $question_id = (int) $question_id;
- $course_id = api_get_course_int_id();
- if ($shared) {
- self::delete_shared_survey_question($survey_id, $question_id);
- }
- // Table definitions
- $table = Database::get_course_table(TABLE_SURVEY_QUESTION);
- // Deleting the survey questions
- $sql = "DELETE FROM $table
- WHERE
- c_id = $course_id AND
- survey_id='".$survey_id."' AND
- question_id='".$question_id."'";
- Database::query($sql);
- // Deleting the options of the question of the survey
- self::delete_survey_question_option($survey_id, $question_id, $shared);
- }
- /**
- * This function deletes a shared survey question from the main database and all its options.
- *
- * @param int $question_id the id of the question
- *
- * @todo delete all the options of this question
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version March 2007
- */
- public static function delete_shared_survey_question($survey_id, $question_id)
- {
- // Table definitions
- $table_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
- $table_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
- // First we have to get the shared_question_id
- $question_data = self::get_question($question_id);
- // Deleting the survey questions
- $sql = "DELETE FROM $table_survey_question
- WHERE question_id='".intval($question_data['shared_question_id'])."'";
- Database::query($sql);
- // Deleting the options of the question of the survey question
- $sql = "DELETE FROM $table_survey_question_option
- WHERE question_id='".intval($question_data['shared_question_id'])."'";
- Database::query($sql);
- }
- /**
- * This function stores the options of the questions in the table.
- *
- * @param array $form_content
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version January 2007
- *
- * @todo writing the update statement when editing a question
- */
- public static function save_question_options($form_content, $survey_data)
- {
- $course_id = api_get_course_int_id();
- // A percentage question type has options 1 -> 100
- if ($form_content['type'] == 'percentage') {
- for ($i = 1; $i < 101; $i++) {
- $form_content['answers'][] = $i;
- }
- }
- if (is_numeric($survey_data['survey_share']) && $survey_data['survey_share'] != 0) {
- self::save_shared_question_options($form_content, $survey_data);
- }
- // Table definition
- $table_survey_question_option = Database::get_course_table(TABLE_SURVEY_QUESTION_OPTION);
- // We are editing a question so we first have to remove all the existing options from the database
- if (is_numeric($form_content['question_id'])) {
- $sql = "DELETE FROM $table_survey_question_option
- WHERE c_id = $course_id AND question_id = '".intval($form_content['question_id'])."'";
- Database::query($sql);
- }
- $counter = 1;
- if (isset($form_content['answers']) && is_array($form_content['answers'])) {
- for ($i = 0; $i < count($form_content['answers']); $i++) {
- $values = isset($form_content['values']) ? $form_content['values'][$i] : '';
- $params = [
- 'c_id' => $course_id,
- 'question_id' => $form_content['question_id'],
- 'survey_id' => $form_content['survey_id'],
- 'option_text' => $form_content['answers'][$i],
- 'value' => $values,
- 'sort' => $counter,
- ];
- $insertId = Database::insert($table_survey_question_option, $params);
- if ($insertId) {
- $sql = "UPDATE $table_survey_question_option
- SET question_option_id = $insertId
- WHERE iid = $insertId";
- Database::query($sql);
- $counter++;
- }
- }
- }
- }
- /**
- * This function stores the options of the questions in the shared table.
- *
- * @param array $form_content
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version February 2007
- *
- * @todo writing the update statement when editing a question
- */
- public function save_shared_question_options($form_content, $survey_data)
- {
- if (is_array($form_content) && is_array($form_content['answers'])) {
- // Table definition
- $table = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
- // We are editing a question so we first have to remove all the existing options from the database
- $sql = "DELETE FROM $table
- WHERE question_id = '".Database::escape_string($form_content['shared_question_id'])."'";
- Database::query($sql);
- $counter = 1;
- foreach ($form_content['answers'] as &$answer) {
- $params = [
- 'question_id' => $form_content['shared_question_id'],
- 'survey_id' => $survey_data['is_shared'],
- 'option_text' => $answer,
- 'sort' => $counter,
- ];
- Database::insert($table, $params);
- $counter++;
- }
- }
- }
- /**
- * This function deletes all the options of the questions of a given survey
- * This function is normally only called when a survey is deleted.
- *
- * @param int $survey_id the id of the survey that has to be deleted
- *
- * @return true
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version January 2007
- */
- public static function delete_all_survey_questions_options($survey_id, $shared = false)
- {
- // Table definitions
- $table_survey_question_option = Database::get_course_table(TABLE_SURVEY_QUESTION_OPTION);
- $course_id = api_get_course_int_id();
- $course_condition = " c_id = $course_id AND ";
- if ($shared) {
- $course_condition = '';
- $table_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
- }
- $sql = "DELETE FROM $table_survey_question_option
- WHERE $course_condition survey_id='".intval($survey_id)."'";
- // Deleting the options of the survey questions
- Database::query($sql);
- return true;
- }
- /**
- * This function deletes the options of a given question.
- *
- * @param int $survey_id
- * @param int $question_id
- * @param bool $shared
- *
- * @return bool
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- * @author Julio Montoya
- *
- * @version March 2007
- */
- public static function delete_survey_question_option(
- $survey_id,
- $question_id,
- $shared = false
- ) {
- $course_id = api_get_course_int_id();
- $course_condition = " c_id = $course_id AND ";
- // Table definitions
- $table = Database::get_course_table(TABLE_SURVEY_QUESTION_OPTION);
- if ($shared) {
- $course_condition = '';
- $table = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
- }
- // Deleting the options of the survey questions
- $sql = "DELETE FROM $table
- WHERE
- $course_condition survey_id='".intval($survey_id)."' AND
- question_id='".intval($question_id)."'";
- Database::query($sql);
- return true;
- }
- /**
- * SURVEY ANSWERS FUNCTIONS.
- */
- /**
- * This function deletes all the answers anyone has given on this survey
- * This function is normally only called when a survey is deleted.
- *
- * @param $survey_id the id of the survey that has to be deleted
- *
- * @return true
- *
- * @todo write the function
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version January 2007,december 2008
- */
- public static function delete_all_survey_answers($survey_id)
- {
- $course_id = api_get_course_int_id();
- $table = Database::get_course_table(TABLE_SURVEY_ANSWER);
- $survey_id = (int) $survey_id;
- $sql = "DELETE FROM $table
- WHERE c_id = $course_id AND survey_id = $survey_id";
- Database::query($sql);
- return true;
- }
- /**
- * @param int $user_id
- * @param int $survey_id
- * @param int $course_id
- *
- * @return bool
- */
- public static function is_user_filled_survey($user_id, $survey_id, $course_id)
- {
- $table = Database::get_course_table(TABLE_SURVEY_ANSWER);
- $user_id = (int) $user_id;
- $course_id = (int) $course_id;
- $survey_id = (int) $survey_id;
- $sql = "SELECT DISTINCT user
- FROM $table
- WHERE
- c_id = $course_id AND
- user = $user_id AND
- survey_id = $survey_id";
- $result = Database::query($sql);
- if (Database::num_rows($result)) {
- return true;
- }
- return false;
- }
- /**
- * This function gets all the persons who have filled the survey.
- *
- * @param int $survey_id
- *
- * @return array
- *
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- *
- * @version February 2007
- */
- public static function get_people_who_filled_survey(
- $survey_id,
- $all_user_info = false,
- $course_id = null
- ) {
- // Database table definition
- $table_survey_answer = Database::get_course_table(TABLE_SURVEY_ANSWER);
- $table_user = Database::get_main_table(TABLE_MAIN_USER);
- // Variable initialisation
- $return = [];
- if (empty($course_id)) {
- $course_id = api_get_course_int_id();
- } else {
- $course_id = (int) $course_id;
- }
- $survey_id = (int) $survey_id;
- if ($all_user_info) {
- $order_clause = api_sort_by_first_name()
- ? ' ORDER BY user.firstname, user.lastname'
- : ' ORDER BY user.lastname, user.firstname';
- $sql = "SELECT DISTINCT
- answered_user.user as invited_user,
- user.firstname,
- user.lastname,
- user.user_id
- FROM $table_survey_answer answered_user
- LEFT JOIN $table_user as user ON answered_user.user = user.user_id
- WHERE
- answered_user.c_id = $course_id AND
- survey_id= '".$survey_id."' ".
- $order_clause;
- } else {
- $sql = "SELECT DISTINCT user FROM $table_survey_answer
- WHERE c_id = $course_id AND survey_id= '".$survey_id."' ";
- if (api_get_configuration_value('survey_anonymous_show_answered')) {
- $tblInvitation = Database::get_course_table(TABLE_SURVEY_INVITATION);
- $tblSurvey = Database::get_course_table(TABLE_SURVEY);
- $sql = "SELECT i.user FROM $tblInvitation i
- INNER JOIN $tblSurvey s
- ON i.survey_code = s.code
- AND i.c_id = s.c_id
- AND i.session_id = s.session_id
- WHERE i.answered IS TRUE AND s.iid = $survey_id";
- }
- }
- $res = Database::query($sql);
- while ($row = Database::fetch_array($res, 'ASSOC')) {
- if ($all_user_info) {
- $userInfo = api_get_user_info($row['user_id']);
- $row['user_info'] = $userInfo;
- $return[] = $row;
- } else {
- $return[] = $row['user'];
- }
- }
- return $return;
- }
- /**
- * @return bool
- */
- public static function survey_generation_hash_available()
- {
- if (extension_loaded('mcrypt')) {
- return true;
- }
- return false;
- }
- /**
- * @param int $survey_id
- * @param int $course_id
- * @param int $session_id
- * @param int $group_id
- *
- * @return string
- */
- public static function generate_survey_hash($survey_id, $course_id, $session_id, $group_id)
- {
- $hash = hash('sha512', api_get_security_key().'_'.$course_id.'_'.$session_id.'_'.$group_id.'_'.$survey_id);
- return $hash;
- }
- /**
- * @param int $survey_id
- * @param int $course_id
- * @param int $session_id
- * @param int $group_id
- * @param string $hash
- *
- * @return bool
- */
- public static function validate_survey_hash($survey_id, $course_id, $session_id, $group_id, $hash)
- {
- $generatedHash = self::generate_survey_hash($survey_id, $course_id, $session_id, $group_id);
- if ($generatedHash == $hash) {
- return true;
- }
- return false;
- }
- /**
- * @param int $survey_id
- * @param int $course_id
- * @param int $session_id
- * @param int $group_id
- *
- * @return string
- */
- public static function generate_survey_link(
- $survey_id,
- $course_id,
- $session_id,
- $group_id
- ) {
- $code = self::generate_survey_hash(
- $survey_id,
- $course_id,
- $session_id,
- $group_id
- );
- return api_get_path(WEB_CODE_PATH).'survey/link.php?h='.$code.'&i='.$survey_id.'&c='.intval($course_id).'&s='
- .intval($session_id).'&g='.$group_id;
- }
- /**
- * Check if the current user has mandatory surveys no-answered
- * and redirect to fill the first found survey.
- */
- public static function protectByMandatory()
- {
- if (strpos($_SERVER['SCRIPT_NAME'], 'fillsurvey.php') !== false) {
- return;
- }
- $userId = api_get_user_id();
- $courseId = api_get_course_int_id();
- $sessionId = api_get_session_id();
- if (!$userId) {
- return;
- }
- if (!$courseId) {
- return;
- }
- try {
- /** @var CSurveyInvitation $invitation */
- $invitation = Database::getManager()
- ->createQuery("
- SELECT i FROM ChamiloCourseBundle:CSurveyInvitation i
- INNER JOIN ChamiloCourseBundle:CSurvey s
- WITH (s.code = i.surveyCode AND s.cId = i.cId AND s.sessionId = i.sessionId)
- INNER JOIN ChamiloCoreBundle:ExtraFieldValues efv WITH efv.itemId = s.iid
- INNER JOIN ChamiloCoreBundle:ExtraField ef WITH efv.field = ef.id
- WHERE
- i.answered = 0 AND
- i.cId = :course AND
- i.user = :user AND
- i.sessionId = :session AND
- :now BETWEEN s.availFrom AND s.availTill AND
- ef.variable = :variable AND
- efv.value = 1 AND
- s.surveyType != 3
- ORDER BY s.availTill ASC
- ")
- ->setMaxResults(1)
- ->setParameters([
- 'course' => $courseId,
- 'user' => $userId,
- 'session' => $sessionId,
- 'now' => new DateTime('UTC', new DateTimeZone('UTC')),
- 'variable' => 'is_mandatory',
- ])
- ->getSingleResult();
- } catch (Exception $e) {
- $invitation = null;
- }
- if (!$invitation) {
- return;
- }
- Display::addFlash(
- Display::return_message(get_lang('MandatorySurveyNoAnswered'), 'warning')
- );
- $url = SurveyUtil::generateFillSurveyLink(
- $invitation->getInvitationCode(),
- api_get_course_info(),
- api_get_session_id()
- );
- header('Location: '.$url);
- exit;
- }
- /**
- * This function empty surveys (invitations and answers).
- *
- * @param int $surveyId id of the survey to empty
- *
- * @return bool
- */
- public static function emptySurveyFromId($surveyId)
- {
- // Database table definitions
- $surveyInvitationTable = Database:: get_course_table(TABLE_SURVEY_INVITATION);
- $surveyAnswerTable = Database:: get_course_table(TABLE_SURVEY_ANSWER);
- $surveyTable = Database:: get_course_table(TABLE_SURVEY);
- $surveyId = (int) $surveyId;
- $surveyData = self::get_survey($surveyId);
- if (empty($surveyData)) {
- return false;
- }
- $surveyCode = $surveyData['survey_code'];
- $courseId = (int) $surveyData['c_id'];
- $sessionId = (int) $surveyData['session_id'];
- $sql = "DELETE FROM $surveyInvitationTable
- WHERE session_id = $sessionId AND c_id = $courseId AND survey_code = '$surveyCode' ";
- Database::query($sql);
- $sql = "DELETE FROM $surveyAnswerTable
- WHERE survey_id = $surveyId AND c_id = $courseId ";
- Database::query($sql);
- $sql = "UPDATE $surveyTable
- SET invited = 0, answered = 0
- WHERE survey_id = $surveyId AND c_id = $courseId AND session_id = $sessionId ";
- Database::query($sql);
- return true;
- }
- /**
- * This function copy survey specifying course id and session id where will be copied.
- *
- * @param int $surveyId
- * @param int $targetCourseId target course id
- * @param int $targetSessionId target session id
- *
- * @return bool|int when fails or return the new survey id
- */
- public static function copySurveySession($surveyId, $targetCourseId, $targetSessionId)
- {
- // Database table definitions
- $surveyTable = Database::get_course_table(TABLE_SURVEY);
- $surveyQuestionGroupTable = Database::get_course_table(TABLE_SURVEY_QUESTION_GROUP);
- $surveyQuestionTable = Database::get_course_table(TABLE_SURVEY_QUESTION);
- $surveyOptionsTable = Database::get_course_table(TABLE_SURVEY_QUESTION_OPTION);
- $surveyId = (int) $surveyId;
- $targetCourseId = (int) $targetCourseId;
- $targetSessionId = (int) $targetSessionId;
- $surveyData = self::get_survey($surveyId, 0, '', true);
- if (empty($surveyData) || empty($targetCourseId)) {
- return false;
- }
- $originalCourseId = $surveyData['c_id'];
- $originalSessionId = $surveyData['session_id'];
- $surveyData['code'] = self::generate_unique_code($surveyData['code']);
- $surveyData['c_id'] = $targetCourseId;
- $surveyData['session_id'] = $targetSessionId;
- // Add a "Copy" suffix if copied inside the same course
- if ($targetCourseId == $originalCourseId) {
- $surveyData['title'] = $surveyData['title'].' '.get_lang('Copy');
- }
- unset($surveyData['iid']);
- unset($surveyData['id']);
- $newSurveyId = Database::insert($surveyTable, $surveyData);
- if ($newSurveyId) {
- $sql = "UPDATE $surveyTable SET survey_id = $newSurveyId
- WHERE iid = $newSurveyId";
- Database::query($sql);
- $sql = "SELECT * FROM $surveyQuestionGroupTable
- WHERE survey_id = $surveyId AND c_id = $originalCourseId ";
- $res = Database::query($sql);
- while ($row = Database::fetch_array($res, 'ASSOC')) {
- $params = [
- 'c_id' => $targetCourseId,
- 'name' => $row['name'],
- 'description' => $row['description'],
- 'survey_id' => $newSurveyId,
- ];
- $insertId = Database::insert($surveyQuestionGroupTable, $params);
- if ($insertId) {
- $sql = "UPDATE $surveyQuestionGroupTable SET id = iid WHERE iid = $insertId";
- Database::query($sql);
- $group_id[$row['id']] = $insertId;
- }
- }
- // Get questions
- $sql = "SELECT * FROM $surveyQuestionTable
- WHERE survey_id = $surveyId AND c_id = $originalCourseId";
- $res = Database::query($sql);
- while ($row = Database::fetch_array($res, 'ASSOC')) {
- $params = [
- 'c_id' => $targetCourseId,
- 'survey_id' => $newSurveyId,
- 'survey_question' => $row['survey_question'],
- 'survey_question_comment' => $row['survey_question_comment'],
- 'type' => $row['type'],
- 'display' => $row['display'],
- 'sort' => $row['sort'],
- 'shared_question_id' => $row['shared_question_id'],
- 'max_value' => $row['max_value'],
- 'survey_group_pri' => $row['survey_group_pri'],
- 'survey_group_sec1' => $row['survey_group_sec1'],
- 'survey_group_sec2' => $row['survey_group_sec2'],
- ];
- if (api_get_configuration_value('allow_required_survey_questions')) {
- if (isset($row['is_required'])) {
- $params['is_required'] = $row['is_required'];
- }
- }
- $insertId = Database::insert($surveyQuestionTable, $params);
- if ($insertId) {
- $sql = "UPDATE $surveyQuestionTable
- SET question_id = iid
- WHERE iid = $insertId";
- Database::query($sql);
- $question_id[$row['question_id']] = $insertId;
- }
- }
- // Get questions options
- $sql = "SELECT * FROM $surveyOptionsTable
- WHERE survey_id = $surveyId AND c_id = $originalCourseId";
- $res = Database::query($sql);
- while ($row = Database::fetch_array($res, 'ASSOC')) {
- $params = [
- 'c_id' => $targetCourseId,
- 'question_id' => $question_id[$row['question_id']],
- 'survey_id' => $newSurveyId,
- 'option_text' => $row['option_text'],
- 'sort' => $row['sort'],
- 'value' => $row['value'],
- ];
- $insertId = Database::insert($surveyOptionsTable, $params);
- if ($insertId) {
- $sql = "UPDATE $surveyOptionsTable SET question_option_id = $insertId WHERE iid = $insertId";
- Database::query($sql);
- }
- }
- return $newSurveyId;
- }
- return false;
- }
- /**
- * @param array $surveyData
- *
- * @return bool
- */
- public static function removeMultiplicateQuestions($surveyData)
- {
- if (empty($surveyData)) {
- return false;
- }
- $surveyId = $surveyData['survey_id'];
- $courseId = $surveyData['c_id'];
- if (empty($surveyId) || empty($courseId)) {
- return false;
- }
- $questions = self::get_questions($surveyId);
- foreach ($questions as $question) {
- // Questions marked with "geneated" were created using the "multiplicate" feature.
- if ($question['survey_question_comment'] === 'generated') {
- self::delete_survey_question($surveyId, $question['question_id']);
- }
- }
- }
- /**
- * @param array $surveyData
- *
- * @return bool
- */
- public static function multiplicateQuestions($surveyData)
- {
- if (empty($surveyData)) {
- return false;
- }
- $surveyId = $surveyData['survey_id'];
- $courseId = $surveyData['c_id'];
- if (empty($surveyId) || empty($courseId)) {
- return false;
- }
- $questions = self::get_questions($surveyId);
- $obj = new UserGroup();
- $options['where'] = [' usergroup.course_id = ? ' => $courseId];
- $classList = $obj->getUserGroupInCourse($options);
- $classTag = '{{class_name}}';
- $studentTag = '{{student_full_name}}';
- $classCounter = 0;
- foreach ($classList as $class) {
- $className = $class['name'];
- foreach ($questions as $question) {
- $users = $obj->get_users_by_usergroup($class['id']);
- if (empty($users)) {
- continue;
- }
- $text = $question['question'];
- if (strpos($text, $classTag) !== false) {
- $replacedText = str_replace($classTag, $className, $text);
- $values = [
- 'c_id' => $courseId,
- 'question_comment' => 'generated',
- 'type' => $question['type'],
- 'display' => $question['horizontalvertical'],
- 'question' => $replacedText,
- 'survey_id' => $surveyId,
- 'question_id' => 0,
- 'shared_question_id' => 0,
- ];
- self::save_question($surveyData, $values);
- $classCounter++;
- continue;
- }
- foreach ($users as $userId) {
- $userInfo = api_get_user_info($userId);
- if (strpos($text, $studentTag) !== false) {
- $replacedText = str_replace($studentTag, $userInfo['complete_name'], $text);
- $values = [
- 'c_id' => $courseId,
- 'question_comment' => 'generated',
- 'type' => $question['type'],
- 'display' => $question['horizontalvertical'],
- 'maximum_score' => $question['maximum_score'],
- 'question' => $replacedText,
- 'survey_id' => $surveyId,
- 'question_id' => 0,
- 'shared_question_id' => 0,
- ];
- $answers = [];
- if (!empty($question['answers'])) {
- foreach ($question['answers'] as $answer) {
- $replacedText = str_replace($studentTag, $userInfo['complete_name'], $answer);
- $answers[] = $replacedText;
- }
- }
- $values['answers'] = $answers;
- self::save_question($surveyData, $values);
- }
- }
- if ($classCounter < count($classList)) {
- // Add end page
- $values = [
- 'c_id' => $courseId,
- 'question_comment' => 'generated',
- 'type' => 'pagebreak',
- 'display' => 'horizontal',
- 'question' => get_lang('QuestionForNextClass'),
- 'survey_id' => $surveyId,
- 'question_id' => 0,
- 'shared_question_id' => 0,
- ];
- self::save_question($surveyData, $values);
- }
- }
- }
- }
- /**
- * @param array $survey
- *
- * @return int
- */
- public static function getCountPages($survey)
- {
- if (empty($survey) || !isset($survey['iid'])) {
- return 0;
- }
- $courseId = $survey['c_id'];
- $surveyId = $survey['survey_id'];
- $table = Database::get_course_table(TABLE_SURVEY_QUESTION);
- // pagebreak
- $sql = "SELECT COUNT(iid) FROM $table
- WHERE
- survey_question NOT LIKE '%{{%' AND
- type = 'pagebreak' AND
- c_id = $courseId AND
- survey_id = $surveyId";
- $result = Database::query($sql);
- $numberPageBreaks = Database::result($result, 0, 0);
- // No pagebreak
- $sql = "SELECT COUNT(iid) FROM $table
- WHERE
- survey_question NOT LIKE '%{{%' AND
- type != 'pagebreak' AND
- c_id = $courseId AND
- survey_id = $surveyId";
- $result = Database::query($sql);
- $countOfQuestions = Database::result($result, 0, 0);
- if ($survey['one_question_per_page'] == 1) {
- if (!empty($countOfQuestions)) {
- return $countOfQuestions;
- }
- return 1;
- }
- if (empty($numberPageBreaks)) {
- return 1;
- }
- return $numberPageBreaks + 1;
- }
- /**
- * Check whether this survey has ended. If so, display message and exit rhis script.
- *
- * @param array $surveyData Survey data
- */
- public static function checkTimeAvailability($surveyData)
- {
- if (empty($surveyData)) {
- api_not_allowed(true);
- }
- $allowSurveyAvailabilityDatetime = api_get_configuration_value('allow_survey_availability_datetime');
- $utcZone = new DateTimeZone('UTC');
- $startDate = new DateTime($surveyData['start_date'], $utcZone);
- $endDate = new DateTime($surveyData['end_date'], $utcZone);
- $currentDate = new DateTime('now', $utcZone);
- if (!$allowSurveyAvailabilityDatetime) {
- $currentDate->modify('today');
- }
- if ($currentDate < $startDate) {
- api_not_allowed(
- true,
- Display:: return_message(
- get_lang('SurveyNotAvailableYet'),
- 'warning',
- false
- )
- );
- }
- if ($currentDate > $endDate) {
- api_not_allowed(
- true,
- Display:: return_message(
- get_lang('SurveyNotAvailableAnymore'),
- 'warning',
- false
- )
- );
- }
- }
- /**
- * @param int $userId
- * @param string $surveyCode
- * @param int $courseId
- * @param int $sessionId
- * @param int $groupId
- *
- * @return array|CSurveyInvitation[]
- */
- public static function getUserInvitationsForSurveyInCourse(
- $userId,
- $surveyCode,
- $courseId,
- $sessionId = 0,
- $groupId = 0
- ) {
- $invitationRepo = Database::getManager()->getRepository('ChamiloCourseBundle:CSurveyInvitation');
- $invitations = $invitationRepo->findBy(
- [
- 'user' => $userId,
- 'cId' => $courseId,
- 'sessionId' => $sessionId,
- 'groupId' => $groupId,
- 'surveyCode' => $surveyCode,
- ],
- ['invitationDate' => 'DESC']
- );
- return $invitations;
- }
- /**
- * @param array $userInfo
- * @param int $answered
- *
- * @return string
- */
- public static function surveyReport($userInfo, $answered = 0)
- {
- $userId = isset($userInfo['user_id']) ? (int) $userInfo['user_id'] : 0;
- $answered = (int) $answered;
- if (empty($userId)) {
- return '';
- }
- $em = Database::getManager();
- $repo = $em->getRepository('ChamiloCourseBundle:CSurveyInvitation');
- $repoSurvey = $em->getRepository('ChamiloCourseBundle:CSurvey');
- $invitations = $repo->findBy(['user' => $userId, 'answered' => $answered]);
- $mainUrl = api_get_path(WEB_CODE_PATH).'survey/survey.php?';
- $content = '';
- if (empty($answered)) {
- $content .= Display::page_subheader(get_lang('Unanswered'));
- } else {
- $content .= Display::page_subheader(get_lang('Answered'));
- }
- if (!empty($invitations)) {
- $table = new HTML_Table(['class' => 'table']);
- $table->setHeaderContents(0, 0, get_lang('SurveyName'));
- $table->setHeaderContents(0, 1, get_lang('Course'));
- // Not answered
- /** @var CSurveyInvitation $invitation */
- $row = 1;
- foreach ($invitations as $invitation) {
- $courseId = $invitation->getCId();
- $courseInfo = api_get_course_info_by_id($courseId);
- $sessionId = $invitation->getSessionId();
- $surveyCode = $invitation->getSurveyCode();
- $survey = $repoSurvey->findOneBy([
- 'cId' => $courseId,
- 'sessionId' => $sessionId,
- 'code' => $surveyCode,
- ]);
- if (empty($survey)) {
- continue;
- }
- $url = $mainUrl.'survey_id='.$survey->getSurveyId().'&cidReq='.$courseInfo['code'].'&id_session='.$sessionId;
- $title = $survey->getTitle();
- $title = Display::url($title, $url);
- if (!empty($sessionId)) {
- $sessionInfo = api_get_session_info($sessionId);
- $courseInfo['name'] .= ' ('.$sessionInfo['name'].')';
- }
- $surveyData = SurveyManager::get_survey($survey->getSurveyId(), 0, $courseInfo['code']);
- $table->setCellContents($row, 0, $title);
- $table->setCellContents($row, 1, $courseInfo['name']);
- if (!empty($answered) && $surveyData['anonymous'] == 0) {
- $answers = SurveyUtil::displayCompleteReport(
- $surveyData,
- $userId,
- false,
- false,
- false
- );
- $table->setCellContents(++$row, 0, $answers);
- $table->setCellContents(++$row, 1, '');
- }
- $row++;
- }
- $content .= $table->toHtml();
- } else {
- $content .= Display::return_message(get_lang('NoData'));
- }
- return $content;
- }
- }
|