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 $this->promos
= ($args['promos'] == '' ||
preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $args['promos']))?
$args['promos'] : '#';
90 // {{{ functions to access general information
91 public function isMode($mode)
93 return ($this->mode
== $mode);
96 public function checkPromo($promo)
98 if ($this->promos
== '') {
101 $promos = explode(',', $this->promos
);
102 foreach ($promos as $p) {
103 if ((preg_match('#^\d{4}$#', $p) && $p == $promo) ||
104 (preg_match('#^\d{4}-$#', $p) && intval(substr($p, 0, 4)) <= $promo) ||
105 (preg_match('#^-\d{4}$#', $p) && intval(substr($p, 1)) >= $promo) ||
106 (preg_match('#^\d{4}-\d{4}$#', $p) && intval(substr($p, 0, 4)) <= $promo && intval(substr($p, 5)) >= $promo)) {
113 public function isValid()
118 public function isEnded()
120 return (strtotime($this->end
) - time() <= 0);
123 public function getTitle()
129 // {{{ function toArray() : converts a question (or the whole survey) to array, with results if the survey is ended
130 public function toArray($i = 'all')
132 if ($i != 'all' && $i != 'root') { // if a specific question is requested, then just returns this question converted to array
134 if (array_key_exists($i, $this->questions
)) {
135 return $this->questions
[$i]->toArray();
139 } else { // else returns the root converted to array in any case
140 $a = array('title' => $this->title
,
141 'description' => $this->description
,
143 'mode' => $this->mode
,
144 'promos' => $this->promos
,
145 'valid' => $this->valid
,
147 if ($this->id
!= -1) {
148 $a['id'] = $this->id
;
150 if ($this->isEnded()) { // if the survey is ended, then adds here the number of votes
151 $sql = 'SELECT COUNT(id)
153 WHERE survey_id={?};';
154 $tot = XDB
::query($sql, $this->id
);
155 $a['votes'] = $tot->fetchOneCell();
157 if ($i == 'all' && count($this->questions
) > 0) { // if the whole survey is requested, then returns all the questions converted to array
159 for ($k = 0; $k < count($this->questions
); $k++
) {
160 $q = $this->questions
[$k]->toArray();
162 if ($this->isEnded()) { // if the survey is ended, then adds here the results of this question
163 $q['result'] = $this->questions
[$k]->getResultArray($this->id
, $k);
167 $a['questions'] = $qArr;
174 // {{{ function toCSV() : builds a CSV file containing all the results of the survey
175 public function toCSV($sep = ',', $enc = '"', $asep='|')
177 $nbq = count($this->questions
);
178 //require_once dirname(__FILE__) . '/../../classes/varstream.php';
182 $csv = fopen('var://csv_output', 'w');
183 $line = ($this->isMode(self
::MODE_XIDENT
))?
array('id', 'Nom', 'Prenom', 'Promo') : array('id');
185 for ($qid = 0; $qid < $nbq; $qid++
) {
186 $qids[$qid] = count($line); // stores the first id of a question (in case of questions with subquestions)
187 array_splice($line, count($line), 0, $this->questions
[$qid]->getCSVColumns()); // the first line contains the questions
191 if ($this->isMode(self
::MODE_XIDENT
)) { // if the mode is non anonymous
192 $users = User
::getBulkUsersWithUIDs(XDB
::fetchAllAssoc('vid', 'SELECT v.id AS vid, v.user_id
193 FROM survey_votes AS v
194 WHERE v.survey_id = {?}
198 $sql = 'SELECT v.id AS vid, a.question_id AS qid, a.answer AS answer
199 FROM survey_votes AS v
200 LEFT JOIN survey_answers AS a
202 WHERE v.survey_id={?}
203 ORDER BY vid ASC, qid ASC, answer ASC;';
204 $res = XDB
::iterator($sql, $this->id
); // retrieves all answers from database
207 while (($cur = $res->next()) != null
) {
208 if ($vid != $cur['vid']) { // if the vote id changes, then starts a new line
209 fputcsv($csv, $line, $sep, $enc); // stores the former line into $csv_output
211 $line = array_fill(0, $nbf, ''); // creates an array full of empty string
212 $line[0] = $vid_; // the first field is a 'clean' vote id (not the one stored in database)
213 if ($this->isMode(self
::MODE_XIDENT
)) { // if the mode is non anonymous
214 if (array_key_exists($vid, $users)) { // and if the user data can be found
215 $line[1] = $users[$vid]->lastName(); // adds the user data (in the first fields of the line)
216 $line[2] = $users[$vid]->firstName();;
217 $line[3] = $users[$vid]->promo();
222 $ans = $this->questions
[$cur['qid']]->formatAnswer($cur['answer']); // formats the current answer
223 if (!is_null($ans)) {
224 if (is_array($ans)) {
225 $fid = $qids[$cur['qid']] +
$ans['id']; // computes the field id
228 $fid = $qids[$cur['qid']];
231 if ($line[$fid] != '') { // if this field already contains something
232 $line[$fid] .= $asep; // then adds a separator before adding the new answer
234 $line[$fid] .= $a; // adds the current answer to the correct field
237 fputcsv($csv, $line, $sep, $enc); // stores the last line into $csv_output
242 // {{{ function factory($type, $args) : builds a question according to the given type
243 public function factory($t, $args)
247 return new SurveyText($args);
249 return new SurveyTextarea($args);
251 return new SurveyNum($args);
253 return new SurveyRadio($args);
255 return new SurveyCheckbox($args);
257 return new SurveyRadioTable($args);
258 case 'checkboxtable':
259 return new SurveyCheckboxTable($args);
266 // {{{ questions manipulation functions
267 public function addQuestion($i, $c)
270 if ($this->valid ||
$i > count($this->questions
)) {
273 array_splice($this->questions
, $i, 0, array($c));
278 public function delQuestion($i)
281 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
284 array_splice($this->questions
, $i, 1);
289 public function editQuestion($i, $a)
295 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
298 $this->questions
[$i]->update($a);
305 // {{{ function checkSyntax() : checks syntax of the questions (currently the root only) before storing the survey in database
306 private static $errorMessages = array(
307 "datepassed" => "la date de fin de sondage est déjà dépassée : vous devez préciser une date future",
308 "promoformat" => "les restrictions à certaines promotions sont mal formattées"
311 public function checkSyntax()
314 // checks that the end date given is not already passed
315 // (unless the survey has already been validated : an admin can have a validated survey expired)
316 if (!$this->valid
&& $this->isEnded()) {
317 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["datepassed"]);
319 if ($this->promos
!= '' && !preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $this->promos
)) {
320 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["promoformat"]);
322 return (empty($rArr))? null
: $rArr;
326 // {{{ functions that manipulate surveys in database
327 // {{{ static function retrieveList() : gets the list of available survey (current, old and not validated surveys)
328 public static function retrieveList($type, $tpl = true
)
333 $where = 'end > NOW()';
337 $where = 'end <= NOW()';
342 $sql = 'SELECT id, title, end, mode
347 return XDB
::iterator($sql);
349 return XDB
::iterRow($sql);
354 // {{{ static function retrieveSurvey() : gets a survey in database (and unserialize the survey object structure)
355 public static function retrieveSurvey($sid)
357 $sql = 'SELECT questions, title, description, end, mode, promos
360 $res = XDB
::query($sql, $sid);
361 $data = $res->fetchOneAssoc();
362 if (is_null($data) ||
!is_array($data)) {
365 $survey = new Survey($data, $sid, true
, unserialize($data['questions']));
370 // {{{ static function retrieveSurveyInfo() : gets information about a survey (title, description, end date, restrictions) but does not unserialize the survey object structure
371 public static function retrieveSurveyInfo($sid)
373 $sql = 'SELECT title, description, end, mode, promos
376 $res = XDB
::query($sql, $sid);
377 return $res->fetchOneAssoc();
381 // {{{ static function retrieveSurveyReq() : gets a survey request to validate
382 public static function retrieveSurveyReq($id)
384 require_once 'validations.inc.php';
385 $surveyreq = Validate
::get_request_by_id($id);
386 if ($surveyreq == null
) {
389 $data = array('title' => $surveyreq->title
,
390 'description' => $surveyreq->description
,
391 'end' => $surveyreq->end
,
392 'mode' => $surveyreq->mode
,
393 'promos' => $surveyreq->promos
);
394 $survey = new Survey($data, $id, false
, $surveyreq->questions
);
399 // {{{ function proposeSurvey() : stores a proposition of survey in database (before validation)
400 public function proposeSurvey()
402 require_once 'validations.inc.php';
403 $surveyreq = new SurveyReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
, S
::user());
404 return $surveyreq->submit();
408 // {{{ function updateSurvey() : updates a survey in database (before validation)
409 public function updateSurvey()
412 $sql = 'UPDATE survey_surveys
420 return XDB
::execute($sql, serialize($this->questions
), $this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->id
);
422 require_once 'validations.inc.php';
423 $surveyreq = Validate
::get_request_by_id($this->id
);
424 if ($surveyreq == null
) {
427 return $surveyreq->updateReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
);
432 // {{{ functions vote() and hasVoted() : handles vote to a survey
433 public function vote($uid, $args)
435 XDB
::execute('INSERT INTO survey_votes
436 SET survey_id={?}, user_id={?};', $this->id
, $uid); // notes the user as having voted
437 $vid = XDB
::insertId();
438 for ($i = 0; $i < count($this->questions
); $i++
) {
439 $ans = $this->questions
[$i]->checkAnswer($args[$i]);
440 if (!is_null($ans) && is_array($ans)) {
441 foreach ($ans as $a) {
442 XDB
::execute('INSERT INTO survey_answers
445 answer = {?}', $vid, $i, $a);
451 public function hasVoted($uid)
453 $res = XDB
::query('SELECT id
455 WHERE survey_id={?} AND user_id={?};', $this->id
, $uid); // checks whether the user has already voted
456 return ($res->numRows() != 0);
460 // {{{ static function deleteSurvey() : deletes a survey (and all its votes)
461 public static function deleteSurvey($sid)
463 $sql = 'DELETE s.*, v.*, a.*
464 FROM survey_surveys AS s
465 LEFT JOIN survey_votes AS v
467 LEFT JOIN survey_answers AS a
470 return XDB
::execute($sql, $sid);
474 // {{{ static function purgeVotes() : clears all votes concerning a survey (I'm not sure whether it's really useful)
475 public static function purgeVotes($sid)
477 $sql = 'DELETE v.*, a.*
478 FROM survey_votes AS v
479 LEFT JOIN survey_answers AS a
481 WHERE v.survey_id={?};';
482 return XDB
::execute($sql, $sid);
490 // {{{ abstract class SurveyQuestion
491 abstract class SurveyQuestion
493 // {{{ common properties, constructor, and basic methods
497 public function __construct($args)
499 $this->update($args);
502 public function update($a)
504 $this->question
= $a['question'];
505 $this->comment
= $a['comment'];
508 abstract protected function getQuestionType();
511 // {{{ function toArray() : converts to array
512 public function toArray()
514 return array('type' => $this->getQuestionType(), 'question' => $this->question
, 'comment' => $this->comment
);
518 // {{{ function checkSyntax() : checks question elements (before storing into database), not currently needed (with new structure)
519 protected function checkSyntax()
525 // {{{ function checkAnswer : returns a correct answer (or a null value if error)
526 public function checkAnswer($ans)
532 // {{{ functions regarding the results of a survey
533 abstract public function getResultArray($sid, $qid);
535 public function formatAnswer($ans)
540 public function getCSVColumns()
542 return $this->question
;
548 // {{{ abstract class SurveySimple and its derived classes : "open" questions
549 // {{{ abstract class SurveySimple extends SurveyQuestion
550 abstract class SurveySimple
extends SurveyQuestion
552 public function checkAnswer($ans)
557 public function getResultArray($sid, $qid)
559 $sql = 'SELECT answer
561 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
565 $res = XDB
::query($sql, $sid, $qid);
566 return $res->fetchAllAssoc();
571 // {{{ class SurveyText extends SurveySimple : simple text field, allowing a few words
572 class SurveyText
extends SurveySimple
574 public function getQuestionType()
581 // {{{ class SurveyTextarea extends SurveySimple : textarea field, allowing longer comments
582 class SurveyTextarea
extends SurveySimple
584 public function getQuestionType()
591 // {{{ class SurveyNum extends SurveySimple : allows numerical answers
592 class SurveyNum
extends SurveySimple
594 public function checkAnswer($ans)
596 return array(intval($ans));
599 protected function getQuestionType()
607 // {{{ abstract class SurveyList and its derived classes : restricted questions that allows only a list of possible answers
608 // {{{ abstract class SurveyList extends SurveyQuestion
609 abstract class SurveyList
extends SurveyQuestion
613 public function update($args)
615 parent
::update($args);
616 $this->choices
= array();
617 foreach ($args['choices'] as $val) {
618 if (trim($val) ||
trim($val) == '0') {
619 $this->choices
[] = $val;
624 public function toArray()
626 $rArr = parent
::toArray();
627 $rArr['choices'] = $this->choices
;
631 public function getResultArray($sid, $qid)
633 $sql = 'SELECT answer, COUNT(id) AS count
635 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
637 GROUP BY answer ASC';
638 $res = XDB
::query($sql, $sid, $qid);
639 return $res->fetchAllAssoc();
642 public function formatAnswer($ans)
644 if (array_key_exists($ans, $this->choices
)) {
645 return $this->choices
[$ans];
653 // {{{ class SurveyRadio extends SurveyList : radio question, allows one answer among the list offered
654 class SurveyRadio
extends SurveyList
656 public function checkAnswer($ans)
659 return (array_key_exists($a, $this->choices
))?
array($a) : null
;
662 protected function getQuestionType()
669 // {{{ class SurveyCheckbox extends SurveyList : checkbox question, allows any number of answers among the list offered
670 class SurveyCheckbox
extends SurveyList
672 public function checkAnswer($ans)
675 foreach ($ans as $a) {
677 if (array_key_exists($a, $this->choices
)) {
681 return (count($rep) == 0)? null
: $rep;
684 protected function getQuestionType()
692 // {{{ abstract class SurveyTable and its derived classes : table question, each column represents a choice, each line represents a question
693 // {{{ abstract class SurveyTable extends SurveyList
694 abstract class SurveyTable
extends SurveyList
696 protected $subquestions;
698 public function update($args)
700 parent
::update($args);
701 $this->subquestions
= array();
702 foreach ($args['subquestions'] as $val) {
703 if (trim($val) ||
trim($val) == '0') {
704 $this->subquestions
[] = $val;
709 public function toArray()
711 $rArr = parent
::toArray();
712 $rArr['subquestions'] = $this->subquestions
;
716 public function getResultArray($sid, $qid)
718 $sql = 'SELECT answer, COUNT(id) AS count
720 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
722 GROUP BY answer ASC';
723 $res = XDB
::iterator($sql, $sid, $qid);
725 for ($i = 0; $i < count($this->subquestions
); $i++
) {
726 $result[$i] = array_fill(0, count($this->choices
), 0);
728 while ($r = $res->next()) {
729 list($i, $j) = explode(':', $r['answer']);
730 $result[$i][$j] = $r['count'];
735 public function formatAnswer($ans)
737 list($q, $c) = explode(':', $ans);
738 if (array_key_exists($q, $this->subquestions
) && array_key_exists($c, $this->choices
)) {
739 return array('id' => $q, 'answer' => $this->choices
[$c]);
745 public function getCSVColumns()
747 $q = parent
::getCSVColumns();
748 if (empty($this->subquestions
)) {
752 for ($k = 0; $k < count($this->subquestions
); $k++
) {
753 $a[$k] = $q.' : '.$this->subquestions
[$k];
760 // {{{ class SurveyRadioTable extends SurveyTable : SurveyTable with radio type choices
761 class SurveyRadioTable
extends SurveyTable
763 public function checkAnswer($ans)
766 foreach ($ans as $k => $a) {
767 if (!array_key_exists($k, $this->subquestions
)) {
771 if (array_key_exists($a, $this->choices
)) {
772 $rep[] = $k . ':' . $a;
775 return (count($rep) == 0)? null
: $rep;
778 protected function getQuestionType()
786 // {{{ class SurveyCheckboxTable extends SurveyTable : SurveyTable with checkbox type choices
787 class SurveyCheckboxTable
extends SurveyTable
789 public function checkAnswer($ans)
792 foreach ($ans as $k => $aa) {
793 if (!array_key_exists($k, $this->subquestions
)) {
796 foreach ($aa as $a) {
798 if (array_key_exists($a, $this->choices
)) {
799 $rep[] = $k . ':' . $a;
803 return (count($rep) == 0)? null
: $rep;
806 protected function getQuestionType()
808 return "checkboxtable";
815 // vim:set et sw=4 sts=4 ts=4 foldmethod=marker enc=utf-8: