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 $sql = 'SELECT v.id AS vid, a.nom, a.prenom, a.promo
194 FROM survey_votes AS v
195 INNER JOIN auth_user_md5 AS a
196 ON a.user_id=v.user_id
197 WHERE v.survey_id={?}
199 $res = XDB
::iterator($sql, $this->id
); // retrieves all users data
200 for ($u = $res->next(); $u != null
; $u = $res->next()) {
201 $users[$u['vid']] = array('nom' => $u['nom'], 'prenom' => $u['prenom'], 'promo' => $u['promo']);
204 $sql = 'SELECT v.id AS vid, a.question_id AS qid, a.answer AS answer
205 FROM survey_votes AS v
206 LEFT JOIN survey_answers AS a
208 WHERE v.survey_id={?}
209 ORDER BY vid ASC, qid ASC, answer ASC;';
210 $res = XDB
::iterator($sql, $this->id
); // retrieves all answers from database
214 while ($cur != null
) {
215 if ($vid != $cur['vid']) { // if the vote id changes, then starts a new line
216 fputcsv($csv, $line, $sep, $enc); // stores the former line into $csv_output
218 $line = array_fill(0, $nbf, ''); // creates an array full of empty string
219 $line[0] = $vid_; // the first field is a 'clean' vote id (not the one stored in database)
220 if ($this->isMode(self
::MODE_XIDENT
)) { // if the mode is non anonymous
221 if (array_key_exists($vid, $users) && is_array($users[$vid])) { // and if the user data can be found
222 $line[1] = $users[$vid]['nom']; // adds the user data (in the first fields of the line)
223 $line[2] = $users[$vid]['prenom'];
224 $line[3] = $users[$vid]['promo'];
229 $ans = $this->questions
[$cur['qid']]->formatAnswer($cur['answer']); // formats the current answer
230 if (!is_null($ans)) {
231 if (is_array($ans)) {
232 $fid = $qids[$cur['qid']] +
$ans['id']; // computes the field id
235 $fid = $qids[$cur['qid']];
238 if ($line[$fid] != '') { // if this field already contains something
239 $line[$fid] .= $asep; // then adds a separator before adding the new answer
241 $line[$fid] .= $a; // adds the current answer to the correct field
243 $cur = $res->next(); // gets next answer
245 fputcsv($csv, $line, $sep, $enc); // stores the last line into $csv_output
250 // {{{ function factory($type, $args) : builds a question according to the given type
251 public function factory($t, $args)
255 return new SurveyText($args);
257 return new SurveyTextarea($args);
259 return new SurveyNum($args);
261 return new SurveyRadio($args);
263 return new SurveyCheckbox($args);
265 return new SurveyRadioTable($args);
266 case 'checkboxtable':
267 return new SurveyCheckboxTable($args);
274 // {{{ questions manipulation functions
275 public function addQuestion($i, $c)
278 if ($this->valid ||
$i > count($this->questions
)) {
281 array_splice($this->questions
, $i, 0, array($c));
286 public function delQuestion($i)
289 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
292 array_splice($this->questions
, $i, 1);
297 public function editQuestion($i, $a)
303 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
306 $this->questions
[$i]->update($a);
313 // {{{ function checkSyntax() : checks syntax of the questions (currently the root only) before storing the survey in database
314 private static $errorMessages = array(
315 "datepassed" => "la date de fin de sondage est déjà dépassée : vous devez préciser une date future",
316 "promoformat" => "les restrictions à certaines promotions sont mal formattées"
319 public function checkSyntax()
322 // checks that the end date given is not already passed
323 // (unless the survey has already been validated : an admin can have a validated survey expired)
324 if (!$this->valid
&& $this->isEnded()) {
325 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["datepassed"]);
327 if ($this->promos
!= '' && !preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $this->promos
)) {
328 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["promoformat"]);
330 return (empty($rArr))? null
: $rArr;
334 // {{{ functions that manipulate surveys in database
335 // {{{ static function retrieveList() : gets the list of available survey (current, old and not validated surveys)
336 public static function retrieveList($type, $tpl = true
)
341 $where = 'end > NOW()';
345 $where = 'end <= NOW()';
350 $sql = 'SELECT id, title, end, mode
355 return XDB
::iterator($sql);
357 return XDB
::iterRow($sql);
362 // {{{ static function retrieveSurvey() : gets a survey in database (and unserialize the survey object structure)
363 public static function retrieveSurvey($sid)
365 $sql = 'SELECT questions, title, description, end, mode, promos
368 $res = XDB
::query($sql, $sid);
369 $data = $res->fetchOneAssoc();
370 if (is_null($data) ||
!is_array($data)) {
373 $survey = new Survey($data, $sid, true
, unserialize($data['questions']));
378 // {{{ static function retrieveSurveyInfo() : gets information about a survey (title, description, end date, restrictions) but does not unserialize the survey object structure
379 public static function retrieveSurveyInfo($sid)
381 $sql = 'SELECT title, description, end, mode, promos
384 $res = XDB
::query($sql, $sid);
385 return $res->fetchOneAssoc();
389 // {{{ static function retrieveSurveyReq() : gets a survey request to validate
390 public static function retrieveSurveyReq($id)
392 require_once 'validations.inc.php';
393 $surveyreq = Validate
::get_request_by_id($id);
394 if ($surveyreq == null
) {
397 $data = array('title' => $surveyreq->title
,
398 'description' => $surveyreq->description
,
399 'end' => $surveyreq->end
,
400 'mode' => $surveyreq->mode
,
401 'promos' => $surveyreq->promos
);
402 $survey = new Survey($data, $id, false
, $surveyreq->questions
);
407 // {{{ function proposeSurvey() : stores a proposition of survey in database (before validation)
408 public function proposeSurvey()
410 require_once 'validations.inc.php';
411 $surveyreq = new SurveyReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
, S
::user());
412 return $surveyreq->submit();
416 // {{{ function updateSurvey() : updates a survey in database (before validation)
417 public function updateSurvey()
420 $sql = 'UPDATE survey_surveys
428 return XDB
::execute($sql, serialize($this->questions
), $this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->id
);
430 require_once 'validations.inc.php';
431 $surveyreq = Validate
::get_request_by_id($this->id
);
432 if ($surveyreq == null
) {
435 return $surveyreq->updateReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
);
440 // {{{ functions vote() and hasVoted() : handles vote to a survey
441 public function vote($uid, $args)
443 XDB
::execute('INSERT INTO survey_votes
444 SET survey_id={?}, user_id={?};', $this->id
, $uid); // notes the user as having voted
445 $vid = XDB
::insertId();
446 for ($i = 0; $i < count($this->questions
); $i++
) {
447 $ans = $this->questions
[$i]->checkAnswer($args[$i]);
448 if (!is_null($ans) && is_array($ans)) {
449 foreach ($ans as $a) {
450 XDB
::execute('INSERT INTO survey_answers
453 answer = {?}', $vid, $i, $a);
459 public function hasVoted($uid)
461 $res = XDB
::query('SELECT id
463 WHERE survey_id={?} AND user_id={?};', $this->id
, $uid); // checks whether the user has already voted
464 return ($res->numRows() != 0);
468 // {{{ static function deleteSurvey() : deletes a survey (and all its votes)
469 public static function deleteSurvey($sid)
471 $sql = 'DELETE s.*, v.*, a.*
472 FROM survey_surveys AS s
473 LEFT JOIN survey_votes AS v
475 LEFT JOIN survey_answers AS a
478 return XDB
::execute($sql, $sid);
482 // {{{ static function purgeVotes() : clears all votes concerning a survey (I'm not sure whether it's really useful)
483 public static function purgeVotes($sid)
485 $sql = 'DELETE v.*, a.*
486 FROM survey_votes AS v
487 LEFT JOIN survey_answers AS a
489 WHERE v.survey_id={?};';
490 return XDB
::execute($sql, $sid);
498 // {{{ abstract class SurveyQuestion
499 abstract class SurveyQuestion
501 // {{{ common properties, constructor, and basic methods
505 public function __construct($args)
507 $this->update($args);
510 public function update($a)
512 $this->question
= $a['question'];
513 $this->comment
= $a['comment'];
516 abstract protected function getQuestionType();
519 // {{{ function toArray() : converts to array
520 public function toArray()
522 return array('type' => $this->getQuestionType(), 'question' => $this->question
, 'comment' => $this->comment
);
526 // {{{ function checkSyntax() : checks question elements (before storing into database), not currently needed (with new structure)
527 protected function checkSyntax()
533 // {{{ function checkAnswer : returns a correct answer (or a null value if error)
534 public function checkAnswer($ans)
540 // {{{ functions regarding the results of a survey
541 abstract public function getResultArray($sid, $qid);
543 public function formatAnswer($ans)
548 public function getCSVColumns()
550 return $this->question
;
556 // {{{ abstract class SurveySimple and its derived classes : "open" questions
557 // {{{ abstract class SurveySimple extends SurveyQuestion
558 abstract class SurveySimple
extends SurveyQuestion
560 public function checkAnswer($ans)
565 public function getResultArray($sid, $qid)
567 $sql = 'SELECT answer
569 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
573 $res = XDB
::query($sql, $sid, $qid);
574 return $res->fetchAllAssoc();
579 // {{{ class SurveyText extends SurveySimple : simple text field, allowing a few words
580 class SurveyText
extends SurveySimple
582 public function getQuestionType()
589 // {{{ class SurveyTextarea extends SurveySimple : textarea field, allowing longer comments
590 class SurveyTextarea
extends SurveySimple
592 public function getQuestionType()
599 // {{{ class SurveyNum extends SurveySimple : allows numerical answers
600 class SurveyNum
extends SurveySimple
602 public function checkAnswer($ans)
604 return array(intval($ans));
607 protected function getQuestionType()
615 // {{{ abstract class SurveyList and its derived classes : restricted questions that allows only a list of possible answers
616 // {{{ abstract class SurveyList extends SurveyQuestion
617 abstract class SurveyList
extends SurveyQuestion
621 public function update($args)
623 parent
::update($args);
624 $this->choices
= array();
625 foreach ($args['choices'] as $val) {
626 if (trim($val) ||
trim($val) == '0') {
627 $this->choices
[] = $val;
632 public function toArray()
634 $rArr = parent
::toArray();
635 $rArr['choices'] = $this->choices
;
639 public function getResultArray($sid, $qid)
641 $sql = 'SELECT answer, COUNT(id) AS count
643 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
645 GROUP BY answer ASC';
646 $res = XDB
::query($sql, $sid, $qid);
647 return $res->fetchAllAssoc();
650 public function formatAnswer($ans)
652 if (array_key_exists($ans, $this->choices
)) {
653 return $this->choices
[$ans];
661 // {{{ class SurveyRadio extends SurveyList : radio question, allows one answer among the list offered
662 class SurveyRadio
extends SurveyList
664 public function checkAnswer($ans)
667 return (array_key_exists($a, $this->choices
))?
array($a) : null
;
670 protected function getQuestionType()
677 // {{{ class SurveyCheckbox extends SurveyList : checkbox question, allows any number of answers among the list offered
678 class SurveyCheckbox
extends SurveyList
680 public function checkAnswer($ans)
683 foreach ($ans as $a) {
685 if (array_key_exists($a, $this->choices
)) {
689 return (count($rep) == 0)? null
: $rep;
692 protected function getQuestionType()
700 // {{{ abstract class SurveyTable and its derived classes : table question, each column represents a choice, each line represents a question
701 // {{{ abstract class SurveyTable extends SurveyList
702 abstract class SurveyTable
extends SurveyList
704 protected $subquestions;
706 public function update($args)
708 parent
::update($args);
709 $this->subquestions
= array();
710 foreach ($args['subquestions'] as $val) {
711 if (trim($val) ||
trim($val) == '0') {
712 $this->subquestions
[] = $val;
717 public function toArray()
719 $rArr = parent
::toArray();
720 $rArr['subquestions'] = $this->subquestions
;
724 public function getResultArray($sid, $qid)
726 $sql = 'SELECT answer, COUNT(id) AS count
728 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
730 GROUP BY answer ASC';
731 $res = XDB
::iterator($sql, $sid, $qid);
733 for ($i = 0; $i < count($this->subquestions
); $i++
) {
734 $result[$i] = array_fill(0, count($this->choices
), 0);
736 while ($r = $res->next()) {
737 list($i, $j) = explode(':', $r['answer']);
738 $result[$i][$j] = $r['count'];
743 public function formatAnswer($ans)
745 list($q, $c) = explode(':', $ans);
746 if (array_key_exists($q, $this->subquestions
) && array_key_exists($c, $this->choices
)) {
747 return array('id' => $q, 'answer' => $this->choices
[$c]);
753 public function getCSVColumns()
755 $q = parent
::getCSVColumns();
756 if (empty($this->subquestions
)) {
760 for ($k = 0; $k < count($this->subquestions
); $k++
) {
761 $a[$k] = $q.' : '.$this->subquestions
[$k];
768 // {{{ class SurveyRadioTable extends SurveyTable : SurveyTable with radio type choices
769 class SurveyRadioTable
extends SurveyTable
771 public function checkAnswer($ans)
774 foreach ($ans as $k => $a) {
775 if (!array_key_exists($k, $this->subquestions
)) {
779 if (array_key_exists($a, $this->choices
)) {
780 $rep[] = $k . ':' . $a;
783 return (count($rep) == 0)? null
: $rep;
786 protected function getQuestionType()
794 // {{{ class SurveyCheckboxTable extends SurveyTable : SurveyTable with checkbox type choices
795 class SurveyCheckboxTable
extends SurveyTable
797 public function checkAnswer($ans)
800 foreach ($ans as $k => $aa) {
801 if (!array_key_exists($k, $this->subquestions
)) {
804 foreach ($aa as $a) {
806 if (array_key_exists($a, $this->choices
)) {
807 $rep[] = $k . ':' . $a;
811 return (count($rep) == 0)? null
: $rep;
814 protected function getQuestionType()
816 return "checkboxtable";
823 // vim:set et sw=4 sts=4 ts=4 foldmethod=marker enc=utf-8: