2 /***************************************************************************
3 * Copyright (C) 2003-2009 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the Free Software *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
22 // {{{ class Survey : root of any survey, contains all questions
25 // {{{ static properties and functions, regarding survey modes and question types
28 const MODE_XIDENT
= 2;
29 private static $longModes = array(self
::MODE_ALL
=> "sondage ouvert à tout le monde, anonyme",
30 self
::MODE_XANON
=> "sondage restreint aux polytechniciens, anonyme",
31 self
::MODE_XIDENT
=> "sondage restreint aux polytechniciens, non anonyme");
32 private static $shortModes = array(self
::MODE_ALL
=> "tout le monde, anonyme",
33 self
::MODE_XANON
=> "polytechniciens, anonyme",
34 self
::MODE_XIDENT
=> "polytechniciens, non anonyme");
36 public static function getModes($long = true
) {
37 return ($long)? self
::$longModes : self
::$shortModes;
40 private static $types = array('text' => 'Texte court',
41 'textarea' => 'Texte long',
43 'radio' => 'Choix multiples (une réponse)',
44 'checkbox' => 'Choix multiples (plusieurs réponses)',
45 'radiotable' => 'Questions multiples à choix multiples (une réponse)',
46 'checkboxtable' => 'Questions multiples à choix mutliples (plusieurs réponses)');
48 public static function getTypes()
53 public static function isType($t)
55 return array_key_exists($t, self
::$types);
59 // {{{ properties, constructor and basic methods
69 public function __construct($args, $id = -1, $valid = false
, $questions = null
)
73 $this->valid
= $valid;
74 $this->questions
= ($questions == null
)?
array() : $questions;
77 public function update($args)
79 $this->title
= $args['title'];
80 $this->description
= $args['description'];
81 $this->end
= $args['end'];
82 $this->mode
= (isset($args['mode']))?
$args['mode'] : self
::MODE_ALL
;
83 if ($this->mode
== self
::MODE_ALL
) {
86 $args['promos'] = str_replace(' ', '', $args['promos']);
87 $this->promos
= ($args['promos'] == '' ||
preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $args['promos']))?
$args['promos'] : '#';
91 // {{{ functions to access general information
92 public function isMode($mode)
94 return ($this->mode
== $mode);
97 public function checkPromo($promo)
99 if ($this->promos
== '') {
102 $promos = explode(',', $this->promos
);
103 foreach ($promos as $p) {
104 if ((preg_match('#^\d{4}$#', $p) && $p == $promo) ||
105 (preg_match('#^\d{4}-$#', $p) && intval(substr($p, 0, 4)) <= $promo) ||
106 (preg_match('#^-\d{4}$#', $p) && intval(substr($p, 1)) >= $promo) ||
107 (preg_match('#^\d{4}-\d{4}$#', $p) && intval(substr($p, 0, 4)) <= $promo && intval(substr($p, 5)) >= $promo)) {
114 public function isValid()
119 public function isEnded()
121 return (strtotime($this->end
) - time() <= 0);
124 public function getTitle()
130 // {{{ function toArray() : converts a question (or the whole survey) to array, with results if the survey is ended
131 public function toArray($i = 'all')
133 if ($i != 'all' && $i != 'root') { // if a specific question is requested, then just returns this question converted to array
135 if (array_key_exists($i, $this->questions
)) {
136 return $this->questions
[$i]->toArray();
140 } else { // else returns the root converted to array in any case
141 $a = array('title' => $this->title
,
142 'description' => $this->description
,
144 'mode' => $this->mode
,
145 'promos' => $this->promos
,
146 'valid' => $this->valid
,
148 if ($this->id
!= -1) {
149 $a['id'] = $this->id
;
151 if ($this->isEnded()) { // if the survey is ended, then adds here the number of votes
152 $sql = 'SELECT COUNT(id)
154 WHERE survey_id={?};';
155 $tot = XDB
::query($sql, $this->id
);
156 $a['votes'] = $tot->fetchOneCell();
158 if ($i == 'all' && count($this->questions
) > 0) { // if the whole survey is requested, then returns all the questions converted to array
160 for ($k = 0; $k < count($this->questions
); $k++
) {
161 $q = $this->questions
[$k]->toArray();
163 if ($this->isEnded()) { // if the survey is ended, then adds here the results of this question
164 $q['result'] = $this->questions
[$k]->getResultArray($this->id
, $k);
168 $a['questions'] = $qArr;
175 // {{{ function toCSV() : builds a CSV file containing all the results of the survey
176 public function toCSV($sep = ',', $enc = '"', $asep='|')
178 $nbq = count($this->questions
);
179 //require_once dirname(__FILE__) . '/../../classes/varstream.php';
183 $csv = fopen('var://csv_output', 'w');
184 $line = ($this->isMode(self
::MODE_XIDENT
))?
array('id', 'Nom', 'Prenom', 'Promo') : array('id');
186 for ($qid = 0; $qid < $nbq; $qid++
) {
187 $qids[$qid] = count($line); // stores the first id of a question (in case of questions with subquestions)
188 array_splice($line, count($line), 0, $this->questions
[$qid]->getCSVColumns()); // the first line contains the questions
192 if ($this->isMode(self
::MODE_XIDENT
)) { // if the mode is non anonymous
193 $users = User
::getBulkUsersWithUIDs(XDB
::fetchAllAssoc('vid', 'SELECT v.id AS vid, v.user_id
194 FROM survey_votes AS v
195 WHERE v.survey_id = {?}
199 $sql = 'SELECT v.id AS vid, a.question_id AS qid, a.answer AS answer
200 FROM survey_votes AS v
201 LEFT JOIN survey_answers AS a
203 WHERE v.survey_id={?}
204 ORDER BY vid ASC, qid ASC, answer ASC;';
205 $res = XDB
::iterator($sql, $this->id
); // retrieves all answers from database
208 while (($cur = $res->next()) != null
) {
209 if ($vid != $cur['vid']) { // if the vote id changes, then starts a new line
210 fputcsv($csv, $line, $sep, $enc); // stores the former line into $csv_output
212 $line = array_fill(0, $nbf, ''); // creates an array full of empty string
213 $line[0] = $vid_; // the first field is a 'clean' vote id (not the one stored in database)
214 if ($this->isMode(self
::MODE_XIDENT
)) { // if the mode is non anonymous
215 if (array_key_exists($vid, $users)) { // and if the user data can be found
216 $line[1] = $users[$vid]->lastName(); // adds the user data (in the first fields of the line)
217 $line[2] = $users[$vid]->firstName();;
218 $line[3] = $users[$vid]->promo();
223 $ans = $this->questions
[$cur['qid']]->formatAnswer($cur['answer']); // formats the current answer
224 if (!is_null($ans)) {
225 if (is_array($ans)) {
226 $fid = $qids[$cur['qid']] +
$ans['id']; // computes the field id
229 $fid = $qids[$cur['qid']];
232 if ($line[$fid] != '') { // if this field already contains something
233 $line[$fid] .= $asep; // then adds a separator before adding the new answer
235 $line[$fid] .= $a; // adds the current answer to the correct field
238 fputcsv($csv, $line, $sep, $enc); // stores the last line into $csv_output
243 // {{{ function factory($type, $args) : builds a question according to the given type
244 public function factory($t, $args)
248 return new SurveyText($args);
250 return new SurveyTextarea($args);
252 return new SurveyNum($args);
254 return new SurveyRadio($args);
256 return new SurveyCheckbox($args);
258 return new SurveyRadioTable($args);
259 case 'checkboxtable':
260 return new SurveyCheckboxTable($args);
267 // {{{ questions manipulation functions
268 public function addQuestion($i, $c)
271 if ($this->valid ||
$i > count($this->questions
)) {
274 array_splice($this->questions
, $i, 0, array($c));
279 public function delQuestion($i)
282 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
285 array_splice($this->questions
, $i, 1);
290 public function editQuestion($i, $a)
296 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
299 $this->questions
[$i]->update($a);
306 // {{{ function checkSyntax() : checks syntax of the questions (currently the root only) before storing the survey in database
307 private static $errorMessages = array(
308 "datepassed" => "la date de fin de sondage est déjà dépassée : vous devez préciser une date future",
309 "promoformat" => "les restrictions à certaines promotions sont mal formattées"
312 public function checkSyntax()
315 // checks that the end date given is not already passed
316 // (unless the survey has already been validated : an admin can have a validated survey expired)
317 if (!$this->valid
&& $this->isEnded()) {
318 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["datepassed"]);
320 if ($this->promos
!= '' && !preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $this->promos
)) {
321 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["promoformat"]);
323 return (empty($rArr))? null
: $rArr;
327 // {{{ functions that manipulate surveys in database
328 // {{{ static function retrieveList() : gets the list of available survey (current, old and not validated surveys)
329 public static function retrieveList($type, $tpl = true
)
334 $where = 'end > NOW()';
338 $where = 'end <= NOW()';
343 $sql = 'SELECT id, title, end, mode
348 return XDB
::iterator($sql);
350 return XDB
::iterRow($sql);
355 // {{{ static function retrieveSurvey() : gets a survey in database (and unserialize the survey object structure)
356 public static function retrieveSurvey($sid)
358 $sql = 'SELECT questions, title, description, end, mode, promos
361 $res = XDB
::query($sql, $sid);
362 $data = $res->fetchOneAssoc();
363 if (is_null($data) ||
!is_array($data)) {
366 $survey = new Survey($data, $sid, true
, unserialize($data['questions']));
371 // {{{ static function retrieveSurveyInfo() : gets information about a survey (title, description, end date, restrictions) but does not unserialize the survey object structure
372 public static function retrieveSurveyInfo($sid)
374 $sql = 'SELECT title, description, end, mode, promos
377 $res = XDB
::query($sql, $sid);
378 return $res->fetchOneAssoc();
382 // {{{ static function retrieveSurveyReq() : gets a survey request to validate
383 public static function retrieveSurveyReq($id)
385 require_once 'validations.inc.php';
386 $surveyreq = Validate
::get_request_by_id($id);
387 if ($surveyreq == null
) {
390 $data = array('title' => $surveyreq->title
,
391 'description' => $surveyreq->description
,
392 'end' => $surveyreq->end
,
393 'mode' => $surveyreq->mode
,
394 'promos' => $surveyreq->promos
);
395 $survey = new Survey($data, $id, false
, $surveyreq->questions
);
400 // {{{ function proposeSurvey() : stores a proposition of survey in database (before validation)
401 public function proposeSurvey()
403 require_once 'validations.inc.php';
404 $surveyreq = new SurveyReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
, S
::user());
405 return $surveyreq->submit();
409 // {{{ function updateSurvey() : updates a survey in database (before validation)
410 public function updateSurvey()
413 $sql = 'UPDATE survey_surveys
421 return XDB
::execute($sql, serialize($this->questions
), $this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->id
);
423 require_once 'validations.inc.php';
424 $surveyreq = Validate
::get_request_by_id($this->id
);
425 if ($surveyreq == null
) {
428 return $surveyreq->updateReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
);
433 // {{{ functions vote() and hasVoted() : handles vote to a survey
434 public function vote($uid, $args)
436 XDB
::execute('INSERT INTO survey_votes
437 SET survey_id={?}, user_id={?};', $this->id
, $uid); // notes the user as having voted
438 $vid = XDB
::insertId();
439 for ($i = 0; $i < count($this->questions
); $i++
) {
440 $ans = $this->questions
[$i]->checkAnswer($args[$i]);
441 if (!is_null($ans) && is_array($ans)) {
442 foreach ($ans as $a) {
443 XDB
::execute('INSERT INTO survey_answers
446 answer = {?}', $vid, $i, $a);
452 public function hasVoted($uid)
454 $res = XDB
::query('SELECT id
456 WHERE survey_id={?} AND user_id={?};', $this->id
, $uid); // checks whether the user has already voted
457 return ($res->numRows() != 0);
461 // {{{ static function deleteSurvey() : deletes a survey (and all its votes)
462 public static function deleteSurvey($sid)
464 $sql = 'DELETE s.*, v.*, a.*
465 FROM survey_surveys AS s
466 LEFT JOIN survey_votes AS v
468 LEFT JOIN survey_answers AS a
471 return XDB
::execute($sql, $sid);
475 // {{{ static function purgeVotes() : clears all votes concerning a survey (I'm not sure whether it's really useful)
476 public static function purgeVotes($sid)
478 $sql = 'DELETE v.*, a.*
479 FROM survey_votes AS v
480 LEFT JOIN survey_answers AS a
482 WHERE v.survey_id={?};';
483 return XDB
::execute($sql, $sid);
491 // {{{ abstract class SurveyQuestion
492 abstract class SurveyQuestion
494 // {{{ common properties, constructor, and basic methods
498 public function __construct($args)
500 $this->update($args);
503 public function update($a)
505 $this->question
= $a['question'];
506 $this->comment
= $a['comment'];
509 abstract protected function getQuestionType();
512 // {{{ function toArray() : converts to array
513 public function toArray()
515 return array('type' => $this->getQuestionType(), 'question' => $this->question
, 'comment' => $this->comment
);
519 // {{{ function checkSyntax() : checks question elements (before storing into database), not currently needed (with new structure)
520 protected function checkSyntax()
526 // {{{ function checkAnswer : returns a correct answer (or a null value if error)
527 public function checkAnswer($ans)
533 // {{{ functions regarding the results of a survey
534 abstract public function getResultArray($sid, $qid);
536 public function formatAnswer($ans)
541 public function getCSVColumns()
543 return $this->question
;
549 // {{{ abstract class SurveySimple and its derived classes : "open" questions
550 // {{{ abstract class SurveySimple extends SurveyQuestion
551 abstract class SurveySimple
extends SurveyQuestion
553 public function checkAnswer($ans)
558 public function getResultArray($sid, $qid)
560 $sql = 'SELECT answer
562 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
566 $res = XDB
::query($sql, $sid, $qid);
567 return $res->fetchAllAssoc();
572 // {{{ class SurveyText extends SurveySimple : simple text field, allowing a few words
573 class SurveyText
extends SurveySimple
575 public function getQuestionType()
582 // {{{ class SurveyTextarea extends SurveySimple : textarea field, allowing longer comments
583 class SurveyTextarea
extends SurveySimple
585 public function getQuestionType()
592 // {{{ class SurveyNum extends SurveySimple : allows numerical answers
593 class SurveyNum
extends SurveySimple
595 public function checkAnswer($ans)
597 return array(intval($ans));
600 protected function getQuestionType()
608 // {{{ abstract class SurveyList and its derived classes : restricted questions that allows only a list of possible answers
609 // {{{ abstract class SurveyList extends SurveyQuestion
610 abstract class SurveyList
extends SurveyQuestion
614 public function update($args)
616 parent
::update($args);
617 $this->choices
= array();
618 foreach ($args['choices'] as $val) {
619 if (trim($val) ||
trim($val) == '0') {
620 $this->choices
[] = $val;
625 public function toArray()
627 $rArr = parent
::toArray();
628 $rArr['choices'] = $this->choices
;
632 public function getResultArray($sid, $qid)
634 $sql = 'SELECT answer, COUNT(id) AS count
636 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
638 GROUP BY answer ASC';
639 $res = XDB
::query($sql, $sid, $qid);
640 return $res->fetchAllAssoc();
643 public function formatAnswer($ans)
645 if (array_key_exists($ans, $this->choices
)) {
646 return $this->choices
[$ans];
654 // {{{ class SurveyRadio extends SurveyList : radio question, allows one answer among the list offered
655 class SurveyRadio
extends SurveyList
657 public function checkAnswer($ans)
660 return (array_key_exists($a, $this->choices
))?
array($a) : null
;
663 protected function getQuestionType()
670 // {{{ class SurveyCheckbox extends SurveyList : checkbox question, allows any number of answers among the list offered
671 class SurveyCheckbox
extends SurveyList
673 public function checkAnswer($ans)
676 foreach ($ans as $a) {
678 if (array_key_exists($a, $this->choices
)) {
682 return (count($rep) == 0)? null
: $rep;
685 protected function getQuestionType()
693 // {{{ abstract class SurveyTable and its derived classes : table question, each column represents a choice, each line represents a question
694 // {{{ abstract class SurveyTable extends SurveyList
695 abstract class SurveyTable
extends SurveyList
697 protected $subquestions;
699 public function update($args)
701 parent
::update($args);
702 $this->subquestions
= array();
703 foreach ($args['subquestions'] as $val) {
704 if (trim($val) ||
trim($val) == '0') {
705 $this->subquestions
[] = $val;
710 public function toArray()
712 $rArr = parent
::toArray();
713 $rArr['subquestions'] = $this->subquestions
;
717 public function getResultArray($sid, $qid)
719 $sql = 'SELECT answer, COUNT(id) AS count
721 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
723 GROUP BY answer ASC';
724 $res = XDB
::iterator($sql, $sid, $qid);
726 for ($i = 0; $i < count($this->subquestions
); $i++
) {
727 $result[$i] = array_fill(0, count($this->choices
), 0);
729 while ($r = $res->next()) {
730 list($i, $j) = explode(':', $r['answer']);
731 $result[$i][$j] = $r['count'];
736 public function formatAnswer($ans)
738 list($q, $c) = explode(':', $ans);
739 if (array_key_exists($q, $this->subquestions
) && array_key_exists($c, $this->choices
)) {
740 return array('id' => $q, 'answer' => $this->choices
[$c]);
746 public function getCSVColumns()
748 $q = parent
::getCSVColumns();
749 if (empty($this->subquestions
)) {
753 for ($k = 0; $k < count($this->subquestions
); $k++
) {
754 $a[$k] = $q.' : '.$this->subquestions
[$k];
761 // {{{ class SurveyRadioTable extends SurveyTable : SurveyTable with radio type choices
762 class SurveyRadioTable
extends SurveyTable
764 public function checkAnswer($ans)
767 foreach ($ans as $k => $a) {
768 if (!array_key_exists($k, $this->subquestions
)) {
772 if (array_key_exists($a, $this->choices
)) {
773 $rep[] = $k . ':' . $a;
776 return (count($rep) == 0)? null
: $rep;
779 protected function getQuestionType()
787 // {{{ class SurveyCheckboxTable extends SurveyTable : SurveyTable with checkbox type choices
788 class SurveyCheckboxTable
extends SurveyTable
790 public function checkAnswer($ans)
793 foreach ($ans as $k => $aa) {
794 if (!array_key_exists($k, $this->subquestions
)) {
797 foreach ($aa as $a) {
799 if (array_key_exists($a, $this->choices
)) {
800 $rep[] = $k . ':' . $a;
804 return (count($rep) == 0)? null
: $rep;
807 protected function getQuestionType()
809 return "checkboxtable";
816 // vim:set et sw=4 sts=4 ts=4 foldmethod=marker enc=utf-8: